Re-add in simple scheduler for compatibility with legacy code, mark all scheduler...

[pub/lufa.git] / LUFA / Drivers / USB / Class / Host / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index e39333e..859c41d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -50,18 +50,22 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

-               /* Type Defines: */\r
+               /* Type Defines: */             \r
+                       /** Configuration information structure for \ref USB_ClassInfo_CDC_Host_t CDC host interface structures. */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r
+                               uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r
+                               uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */                   \r
+                       } USB_ClassInfo_CDC_Host_Config_t;\r
+               \r
+                       /** Current State information structure for \ref USB_ClassInfo_CDC_Host_t CDC host interface structures. */\r

                        typedef struct\r
                        {\r
                                uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
 \r
                        typedef struct\r
                        {\r
                                uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
 \r

-                               uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r

                                uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
                                uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r

-\r
-                               uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r

                                uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
                                uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r

-\r
-                               uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */\r

                                uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
 \r
                                uint8_t  ControlLineState; /**< Current control line states */\r
                                uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
 \r
                                uint8_t  ControlLineState; /**< Current control line states */\r


@@ -76,7 +80,27 @@
                                                                                  *   CDCDevice_LineCodingParity_t enum\r
                                                                                  */\r
                                        uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r
                                                                                  *   CDCDevice_LineCodingParity_t enum\r
                                                                                  */\r
                                        uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r

-                               } LineEncoding;\r
+                               } LineEncoding;                 \r
+                       } USB_ClassInfo_CDC_Host_State_t;\r
+\r
+                       /** Class state structure. An instance of this structure should be made within the user application,\r
+                        *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This\r
+                        *  stores each CDC interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const USB_ClassInfo_CDC_Host_Config_t Config; /**< Config data for the USB class interface within\r
+                                                                              *   the device. All elements in this section\r
+                                                                              *   <b>must</b> be set or the interface will fail\r
+                                                                              *   to enumerate and operate correctly.\r
+                                                                              */\r
+\r
+                               USB_ClassInfo_CDC_Host_State_t State; /**< State data for the USB class interface within\r
+                                                                      *   the device. All elements in this section\r
+                                                                      *   <b>may</b> be set to initial values, but may\r
+                                                                      *   also be ignored to default to sane values when\r
+                                                                      *   the interface is enumerated.\r
+                                                                      */\r

                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r


@@ -96,16 +120,20 @@
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r

-                       #define CDC_CONTROL_CLASS              0x02\r
-                       #define CDC_CONTROL_SUBCLASS           0x02\r
-                       #define CDC_CONTROL_PROTOCOL           0x01\r
-                       #define CDC_DATA_CLASS                 0x0A\r
-                       #define CDC_DATA_SUBCLASS              0x00\r
-                       #define CDC_DATA_PROTOCOL              0x00\r
+                       #define CDC_CONTROL_CLASS               0x02\r
+                       #define CDC_CONTROL_SUBCLASS            0x02\r
+                       #define CDC_CONTROL_PROTOCOL            0x01\r
+                       #define CDC_DATA_CLASS                  0x0A\r
+                       #define CDC_DATA_SUBCLASS               0x00\r
+                       #define CDC_DATA_PROTOCOL               0x00\r
+                       \r
+                       #define CDC_FOUND_DATAPIPE_IN           (1 << 0)\r
+                       #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)\r
+                       #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)\r

 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r

-                               static uint8_t CDC_Host_ProcessConfigDescriptor(void);\r
+                               static uint8_t CDC_Host_ProcessConfigDescriptor(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r

                                static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);\r
                                static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);\r
                                static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);\r
                                static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);\r
                                static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);\r
                                static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);\r