/** \ingroup Group_USBClassCDC\r
* @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver\r
*\r
+ * \section Sec_Dependencies Module Source Dependencies\r
+ * The following files must be built with any user project that uses this module:\r
+ * - LUFA/Drivers/USB/Class/Host/CDC.c\r
+ *\r
* \section Module Description\r
* Host Mode USB Class driver framework interface, for the CDC USB Class driver.\r
*\r
extern "C" {\r
#endif\r
\r
- /* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
- static uint8_t CDC_Host_ProcessConfigDescriptor(void);\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
- #endif\r
- \r
- void CDC_Host_Task(void);\r
- \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
+ * 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
+ typedef struct\r
+ {\r
+ const struct\r
+ {\r
+ uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r
+ uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r
+ uint8_t NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */ \r
+ } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+ * <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+ */\r
+ struct\r
+ {\r
+ uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\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
+\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
+ */\r
+ uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*\r
+ * masks.\r
+ */\r
+ } ControlLineStates;\r
+ \r
+ struct\r
+ {\r
+ bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */\r
+ \r
+ uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
+ uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the\r
+ * CDCDevice_CDC_LineCodingFormats_t enum\r
+ */\r
+ uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the\r
+ * CDCDevice_LineCodingParity_t enum\r
+ */\r
+ uint8_t DataBits; /**< Bits of data per character of the virtual serial port */\r
+ } LineEncoding;\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
+ */\r
+ } USB_ClassInfo_CDC_Host_t;\r
+ \r
+ /* Enums: */\r
+ enum\r
+ {\r
+ CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */\r
+ CDC_ENUMERROR_ControlError = 1, /**< A control request to the device failed to complete successfully */\r
+ CDC_ENUMERROR_DescriptorTooLarge = 2, /**< The device's Configuration Descriptor is too large to process */\r
+ CDC_ENUMERROR_InvalidConfigDataReturned = 3, /**< The device returned an invalid Configuration Descriptor */\r
+ CDC_ENUMERROR_NoCDCInterfaceFound = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */\r
+ CDC_ENUMERROR_NoEndpointFound = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */\r
+ } CDCHost_EnumerationFailure_ErrorCodes_t;\r
+ \r
+ /* Function Prototypes: */\r
+ void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\r
+\r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Macros: */\r
+ #define CDC_CONTROL_CLASS 0x02\r
+ #define CDC_CONTROL_SUBCLASS 0x02\r
+ #define CDC_CONTROL_PROTOCOL 0x01\r
+ #define CDC_DATA_CLASS 0x0A\r
+ #define CDC_DATA_SUBCLASS 0x00\r
+ #define CDC_DATA_PROTOCOL 0x00\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
+\r
+ /* Function Prototypes: */\r
+ #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
+ static uint8_t CDC_Host_ProcessConfigDescriptor(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\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
+ #endif\r
+\r
+ void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);\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
+ \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
+ \r
+ #endif\r
+ \r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
}\r
projects / pub / USBasp.git / blobdiff