};\r
\r
/* Type Defines: */\r
- /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration\r
- * as set by the host via a class specific request.\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. The contents of this structure should be set to their correct\r
+ * values when used, or ommitted to force the library to use default values.\r
*/\r
typedef struct\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
\r
- uint8_t ControlLineState; /**< Current control line state, as set by the host */\r
+ uint8_t ControlLineState; /**< Current control line states, as set by the host */\r
\r
struct\r
{\r
* \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
* given CDC interface is selected.\r
*\r
- * \param CDCInterfaceInfo Pointer to a structure containing an CDC Class configuration and state.\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*\r
* \return Boolean true if the endpoints were sucessfully configured, false otherwise\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 an CDC Class configuration and state.\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*/\r
void USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_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 an CDC Class configuration and state.\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
*/\r
void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
\r
- void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
- void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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
+ * user program by declaring a handler function with the same name and parameters listed here. The new line encoding\r
+ * settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.\r
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ */\r
+ void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_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
+ * 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 ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of\r
+ * CDC_CONTROL_LINE_OUT_* masks.\r
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ */ \r
+ void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_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
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\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 USB_CDC_SendString(USB_ClassInfo_CDC_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
+ *\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 USB_CDC_SendByte(USB_ClassInfo_CDC_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
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ *\r
+ * \return Total number of buffered bytes received from the host\r
+ */\r
uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_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
+ * underflow occurs.\r
+ *\r
+ * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.\r
+ *\r
+ * \return Next received byte from the host, or 0 if no data received\r
+ */\r
uint8_t USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
- void USB_CDC_SendSerialLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\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
+ * cleared via a second notification.\r
+ *\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 USB_CDC_SendSerialLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
projects / pub / lufa.git / blobdiff