Move DHCP negotiation timer into the DHCP connection application state structure...

[pub/USBasp.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 466f141..feb6bf8 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -56,6 +56,11 @@
                        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 within the user application,\r
@@ -92,12 +97,13 @@
                                        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 - to notify the device of changes to these values, call the\r
+                                                                                          *   \ref CDC_Host_SendControlLineStateChange() function.\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. This value is updated each time \ref CDC_Host_USBTask() is called.\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
@@ -109,7 +115,11 @@
                                                                                          *   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. When set\r
+                                                        *  by the host application, the \ref CDC_Host_SetLineEncoding() function must be called to push\r
+                                                        *  the changes to the device.\r
+                                                        */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
                                                  *   the interface is enumerated.\r
@@ -281,7 +291,7 @@
                        #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)\r
 \r
                /* Function Prototypes: */\r
-                       #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
+                       #if defined(__INCLUDE_FROM_CDC_CLASS_HOST_C)\r
                                static int CDC_Host_putchar(char c, FILE* Stream);\r
                                static int CDC_Host_getchar(FILE* Stream);\r
                                static int CDC_Host_getchar_Blocking(FILE* Stream);\r