Increased throughput of the USBtoSerial demo on systems that send multiple bytes...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index d248868..0c21444 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -73,6 +73,11 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_CDC_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.\r
+               #endif\r
+               \r

        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made for each CDC interface\r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made for each CDC interface\r


@@ -104,12 +109,13 @@
                                        struct\r
                                        {\r
                                                uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r
                                        struct\r
                                        {\r
                                                uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r

-                                                                                          *   masks.\r
+                                                                                          *   masks. This value is updated each time \ref CDC_Device_USBTask() is called.\r

                                                                                           */\r
                                                uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*\r
                                                                                           */\r
                                                uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*\r

-                                                                                          *   masks.\r
+                                                                                          *   masks - to notify the host of changes to these values, call the\r
+                                                                                          *   \ref CDC_Device_SendControlLineStateChange() function.\r

                                                                                           */\r
                                                                                           */\r

-                                       } ControlLineStates;\r
+                                       } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */\r

 \r
                                        struct\r
                                        {\r
 \r
                                        struct\r
                                        {\r


@@ -121,7 +127,9 @@
                                                                                          *   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; /** Line encoding used in the virtual serial port, for the device's information. This is generally\r
+                                                        *  only used if the virtual serial port data is to be reconstructed on a physical UART.\r
+                                                        */             \r

                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                          *   are reset to their defaults when the interface is enumerated.\r
                                          */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                          *   are reset to their defaults when the interface is enumerated.\r
                                          */\r


@@ -278,7 +286,7 @@
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r

-                       #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
+                       #if defined(__INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r

                                static int CDC_Device_putchar(char c, FILE* Stream);\r
                                static int CDC_Device_getchar(FILE* Stream);\r
                                static int CDC_Device_getchar_Blocking(FILE* Stream);\r
                                static int CDC_Device_putchar(char c, FILE* Stream);\r
                                static int CDC_Device_getchar(FILE* Stream);\r
                                static int CDC_Device_getchar_Blocking(FILE* Stream);\r