Finished CDC device class driver documentation.

[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 ee9e376..feb7ff2 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -234,10 +234,48 @@
                 */             \r
                void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
 \r
+               /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
+                *  string is discarded.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                *  \param Data  Pointer to the string to send to the host\r
+                *  \param Length  Size in bytes of the string to send to the host\r
+                */\r
                void     USB_CDC_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
+               \r
+               /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the\r
+                *  byte is discarded.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                *  \param Data  Byte of data to send to the host\r
+                */\r
                void     USB_CDC_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);\r
+               \r
+               /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                *\r
+                *  \return Total number of buffered bytes received from the host\r
+                */\r
                uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* 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
+                *  underflow occurs.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                *\r
+                *  \return Next received byte from the host, or 0 if no data received\r
+                */\r
                uint8_t  USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+               \r
+               /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control\r
+                *  lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are\r
+                *  cleared via a second notification.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                *  \param LineStateMask  Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states\r
+                */\r
                void     USB_CDC_SendSerialLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r