Document CDC Host class driver functions and enums.

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index 7332f56..0f3c794 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -176,7 +176,7 @@
                        uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
                        \r
                        /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function\r
-                        *  returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data\r
+                        *  returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is recieved to ensure that no data\r
                         *  underflow occurs.\r
                         *\r
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index b7c492a..03c9704 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -109,6 +109,7 @@
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r
+                       /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */\r
                        enum\r
                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
@@ -118,16 +119,75 @@
                        } CDCHost_EnumerationFailure_ErrorCodes_t;\r
        \r
                /* Function Prototypes: */\r
+                       /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state.\r
+                        */\r
                        void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+                       \r
+                       /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration\r
+                        *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's\r
+                        *  state values and configures the pipes required to communicate with the interface if it is found within the device.\r
+                        *  This should be called once after the stack has enumerated the attached device, while the host state machine is in\r
+                        *  the Addressed state.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state.\r
+                        *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor\r
+                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor\r
+                        */\r
                        uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                                                        uint8_t* DeviceConfigDescriptor);\r
                        \r
+                       /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding\r
+                        *  values of the interface have been changed to push the new settings to the USB device.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        */\r
                        uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+\r
+                       /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial\r
+                        *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second\r
+                        *  notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated\r
+                        *  to push the new states to the USB device.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        */\r
                        uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
                        \r
+                       /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the\r
+                        *  string is discarded.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        *  \param[in] Data  Pointer to the string to send to the device\r
+                        *  \param[in] Length  Size in bytes of the string to send to the device\r
+                        */\r
                        void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
+                       \r
+                       /** Sends a given byte to the attached USB device, if connected. If a host is not connected when the function is called, the\r
+                        *  byte is discarded.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        *  \param[in] Data  Byte of data to send to the device\r
+                        */\r
                        void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);\r
+\r
+                       /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        *\r
+                        *  \return Total number of buffered bytes received from the device\r
+                        */\r
                        uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+\r
+                       /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function\r
+                        *  returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is recieved to ensure that no data\r
+                        *  underflow occurs.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.\r
+                        *\r
+                        *  \return Next received byte from the device, or 0 if no data received\r
+                        */\r
                        uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
 \r
        /* Private Interface - For use in library only: */\r