Add FatFS library to the Webserver project, extend the HTTP server so that it now...

[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 397f3c5..466f141 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -1,13 +1,13 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
@@ -89,11 +89,6 @@
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
                                        uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used */\r
                                        \r
-                                       bool BidirectionalDataEndpoints; /**< Indicates if the attached CDC interface uses bidirectional data endpoints,\r
-                                                                         *   and this has only the IN pipe configured (with \ref Pipe_SetPipeToken()\r
-                                                                         *   used to switch the pipe's direction)\r
-                                                                         */\r
-\r
                                        struct\r
                                        {\r
                                                uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r
@@ -175,7 +170,12 @@
                        uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
+                        *  string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the\r
+                        *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+                        *  packed into a single pipe packet, increasing data throughput.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
@@ -186,8 +186,13 @@
                        uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length)\r
                                                    ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\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
+                       /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the\r
+                        *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the\r
+                        *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be \r
+                        *  packed into a single pipe packet, increasing data throughput.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
@@ -198,6 +203,9 @@
 \r
                        /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
@@ -208,6 +216,9 @@
                         *  returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data\r
                         *  underflow occurs.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
@@ -216,6 +227,9 @@
                        \r
                        /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
                         *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
                         *\r
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum\r