Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Projects / XPLAINBridge / USARTDescriptors.h

diff --git a/Projects/XPLAINBridge/USARTDescriptors.h b/Projects/XPLAINBridge/USARTDescriptors.h
index 5654a3b..bf75b8a 100644 (file)
--- a/Projects/XPLAINBridge/USARTDescriptors.h
+++ b/Projects/XPLAINBridge/USARTDescriptors.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -32,7 +32,7 @@
  *
  *  Header file for USARTDescriptors.c.
  */
  *
  *  Header file for USARTDescriptors.c.
  */

- 
+

 #ifndef _USART_DESCRIPTORS_H_
 #define _USART_DESCRIPTORS_H_
 
 #ifndef _USART_DESCRIPTORS_H_
 #define _USART_DESCRIPTORS_H_
 


@@ -40,24 +40,23 @@
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>

-               #include <LUFA/Drivers/USB/Class/CDC.h>

 
        /* Macros: */
                /** Endpoint number of the CDC device-to-host notification IN endpoint. */
                #define CDC_NOTIFICATION_EPNUM         2
 
                /** Endpoint number of the CDC device-to-host data IN endpoint. */
 
        /* Macros: */
                /** Endpoint number of the CDC device-to-host notification IN endpoint. */
                #define CDC_NOTIFICATION_EPNUM         2
 
                /** Endpoint number of the CDC device-to-host data IN endpoint. */

-               #define CDC_TX_EPNUM                   3        
+               #define CDC_TX_EPNUM                   3

 
                /** Endpoint number of the CDC host-to-device data OUT endpoint. */
 
                /** Endpoint number of the CDC host-to-device data OUT endpoint. */

-               #define CDC_RX_EPNUM                   4        
+               #define CDC_RX_EPNUM                   4

 
                /** Size in bytes of the CDC device-to-host notification IN endpoint. */
                #define CDC_NOTIFICATION_EPSIZE        8
 
                /** Size in bytes of the CDC data IN and OUT endpoints. */
                #define CDC_TXRX_EPSIZE                16
 
                /** Size in bytes of the CDC device-to-host notification IN endpoint. */
                #define CDC_NOTIFICATION_EPSIZE        8
 
                /** Size in bytes of the CDC data IN and OUT endpoints. */
                #define CDC_TXRX_EPSIZE                16

-               
+

        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
                 *  application code, as the configuration descriptor contains several sub-descriptors which
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
                 *  application code, as the configuration descriptor contains several sub-descriptors which


@@ -67,9 +66,9 @@
                {
                        USB_Descriptor_Configuration_Header_t    Config;
                        USB_Descriptor_Interface_t               CDC_CCI_Interface;
                {
                        USB_Descriptor_Configuration_Header_t    Config;
                        USB_Descriptor_Interface_t               CDC_CCI_Interface;

-                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_IntHeader;
-                       CDC_FUNCTIONAL_DESCRIPTOR(1)             CDC_Functional_AbstractControlManagement;
-                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_Union;
+                       USB_CDC_Descriptor_FunctionalHeader_t    CDC_Functional_Header;
+                       USB_CDC_Descriptor_FunctionalACM_t       CDC_Functional_ACM;
+                       USB_CDC_Descriptor_FunctionalUnion_t     CDC_Functional_Union;

                        USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
                        USB_Descriptor_Interface_t               CDC_DCI_Interface;
                        USB_Descriptor_Endpoint_t                CDC_DataOutEndpoint;
                        USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
                        USB_Descriptor_Interface_t               CDC_DCI_Interface;
                        USB_Descriptor_Endpoint_t                CDC_DataOutEndpoint;


@@ -77,6 +76,9 @@
                } USART_USB_Descriptor_Configuration_t;
 
        /* Function Prototypes: */
                } USART_USB_Descriptor_Configuration_t;
 
        /* Function Prototypes: */

-               uint16_t USART_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress);
+               uint16_t USART_GetDescriptor(const uint16_t wValue,
+                                            const uint8_t wIndex,
+                                            const void** const DescriptorAddress);

 
 #endif
 
 #endif

+