projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Oops - with new changes to the way the device Configuration Descriptor is retrieved...
[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 b7c492a..f7dc088 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -79,7 +79,7 @@
                                \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
                                \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\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 endpoint, if used */\r
+                                       uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used */\r
 \r
                                        struct\r
                                        {\r
 \r
                                        struct\r
                                        {\r
@@ -109,26 +109,98 @@
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r
-                       enum\r
+                       /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */\r
+                       enum CDCHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */\r
                                CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */\r
                                CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */\r
                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */\r
                                CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */\r
                                CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */\r
-                       } CDCHost_EnumerationFailure_ErrorCodes_t;\r
+                       };\r
        \r
                /* Function Prototypes: */\r
        \r
                /* Function Prototypes: */\r
-                       void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\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) ATTR_NON_NULL_PTR_ARG(1);\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
+                        *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum\r
+                        */\r
                        uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                        uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,\r
-                                                       uint8_t* DeviceConfigDescriptor);\r
+                                                       uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\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) ATTR_NON_NULL_PTR_ARG(1);\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) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r
                        \r
-                       uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
-                       uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\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) ATTR_NON_NULL_PTR_ARG(1, 2);\r
                        \r
                        \r
-                       void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
-                       void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);\r
-                       uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
-                       uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\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) ATTR_NON_NULL_PTR_ARG(1);\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) ATTR_NON_NULL_PTR_ARG(1);\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) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies\r
+                        *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the\r
+                        *  user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
+                        *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as\r
+                        *  a mask of CDC_CONTROL_LINE_IN_* masks.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state\r
+                        */\r
+                       void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
@@ -142,16 +214,16 @@
                        \r
                        #define CDC_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)\r
                        \r
                        #define CDC_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)\r
-                       #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)\r
+                       #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)\r
 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
                                void CDC_Host_Event_Stub(void);\r
                                void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)\r
 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
                                void CDC_Host_Event_Stub(void);\r
                                void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)\r
-                                                                          ATTR_WEAK ATTR_ALIAS(CDC_Host_Event_Stub);\r
-                               static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);\r
+                                                                          ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);\r
+                               static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* CurrentDescriptor);\r
                        #endif  \r
        #endif\r
                                \r
                        #endif  \r
        #endif\r
                                \r
USB isp AVR programmer