Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

[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 d2e98c0..bb12c08 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB CDC Class driver.\r
+ *\r
+ *  Host mode driver for the library USB CDC Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassCDC\r
  *  @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassCDC\r
  *  @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver\r
  *\r


@@ -56,9 +65,16 @@
                        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
        /* 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
+                       /** \brief CDC Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r

                         *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This\r
                         *  stores each CDC interface's configuration and state information.\r
                         */\r
                         *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This\r
                         *  stores each CDC interface's configuration and state information.\r
                         */\r


@@ -89,20 +105,16 @@
                                        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
                                        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
                                        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
                                                                                           */\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
                                                                                           */\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


@@ -114,7 +126,11 @@
                                                                                          *   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. 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
                                } 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


@@ -175,7 +191,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
                        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
                         *\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 +207,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
                        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
                         *\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 +224,9 @@
 \r
                        /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.\r
                         *\r
 \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
                         *  \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 +237,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
                         *  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
                         *  \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 +248,9 @@
                        \r
                        /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
                         *\r
                        \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
                         *  \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


@@ -267,7 +302,7 @@
                        #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)\r
 \r
                /* Function Prototypes: */\r
                        #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
                                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