#endif\r
\r
/* Public Interface - May be used in end-application: */\r
+ /* Type Defines: */\r
+ /** Configuration information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */\r
+ typedef struct\r
+ {\r
+ uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
+\r
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
+ uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r
+\r
+ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
+ uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint */\r
+\r
+ uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */\r
+ uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
+ } USB_ClassInfo_CDC_Device_Config_t;\r
+ \r
+ /** Current State information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */\r
+ typedef struct\r
+ {\r
+ uint8_t ControlLineState; /**< Current control line states, as set by the host */\r
+\r
+ struct\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
+ } USB_ClassInfo_CDC_Device_State_t;\r
+ \r
+ /** Class state structure. An instance of this structure should be made for each CDC interface\r
+ * within the user application, and passed to each of the CDC class driver functions as the\r
+ * CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.\r
+ */\r
+ typedef struct\r
+ {\r
+ const USB_ClassInfo_CDC_Device_Config_t Config; /**< Config data for the USB class interface within\r
+ * the device. All elements in this section\r
+ * <b>must</b> be set or the interface will fail\r
+ * to enumerate and operate correctly.\r
+ */\r
+ \r
+ USB_ClassInfo_CDC_Device_State_t State; /**< State data for the USB class interface within\r
+ * the device. All elements in this section\r
+ * <b>may</b> be set to initial values, but may\r
+ * also be ignored to default to sane values when\r
+ * the interface is enumerated.\r
+ */\r
+ } USB_ClassInfo_CDC_Device_t;\r
+ \r
/* Function Prototypes: */ \r
/** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
* \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
*\r
* \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
*/\r
- bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);\r
\r
/** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be\r
* linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
*\r
* \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*/\r
- void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);\r
\r
/** General management task for a given CDC 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 CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*/\r
- void CDC_Device_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);\r
\r
/** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
* line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\r
*\r
* \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*/\r
- void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);\r
\r
/** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
* control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the\r
*\r
* \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*/ \r
- void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_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
* \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 CDC_Device_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
+ void CDC_Device_SendString(USB_ClassInfo_CDC_Device_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
* \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 CDC_Device_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);\r
+ void CDC_Device_SendByte(USB_ClassInfo_CDC_Device_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
*\r
* \return Total number of buffered bytes received from the host\r
*/\r
- uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_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
*\r
* \return Next received byte from the host, or 0 if no data received\r
*/\r
- uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+ uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_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
* \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 CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\r
+ void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, uint16_t LineStateMask);\r
\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Function Prototypes: */\r
#if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
void CDC_Device_Event_Stub(void);\r
- void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
+ void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)\r
ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
- void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
+ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)\r
ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
#endif\r
\r
projects / pub / USBasp.git / blobdiff