X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/7665bf323e76ed1ebcfd137e2ab0bd356b43a5e8..b2330934b9ccd51a59183eb2a11fdd95183df27b:/LUFA/Drivers/USB/Class/Device/CDC.h diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index 3e67b1b6b..390ebbcb6 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -151,8 +151,10 @@ }; /* Type Defines: */ - /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration - * as set by the host via a class specific request. + /** Class state structure. An instance of this structure should be made for each CDC interface + * within the user application, and passed to each of the CDC class driver functions as the + * CDCInterfaceInfo parameter. The contents of this structure should be set to their correct + * values when used, or ommitted to force the library to use default values. */ typedef struct { @@ -167,7 +169,7 @@ uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */ uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */ - uint8_t ControlLineState; /**< Current control line state, as set by the host */ + uint8_t ControlLineState; /**< Current control line states, as set by the host */ struct { @@ -195,7 +197,7 @@ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the * given CDC interface is selected. * - * \param CDCInterfaceInfo Pointer to a structure containing an CDC Class configuration and state. + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. * * \return Boolean true if the endpoints were sucessfully configured, false otherwise */ @@ -204,25 +206,79 @@ /** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. * - * \param CDCInterfaceInfo Pointer to a structure containing an CDC Class configuration and state. + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. */ void USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo); /** General management task for a given CDC class interface, required for the correct operation of the interface. This should * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). * - * \param CDCInterfaceInfo Pointer to a structure containing an CDC Class configuration and state. + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. */ void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo); + /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a + * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the + * user program by declaring a handler function with the same name and parameters listed here. The new line encoding + * settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + */ + void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo); + + /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a + * control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the + * user program by declaring a handler function with the same name and parameters listed here. The new control line states + * are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of + * CDC_CONTROL_LINE_OUT_* masks. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + */ + void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo); + /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the + * string is discarded. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + * \param Data Pointer to the string to send to the host + * \param Length Size in bytes of the string to send to the host + */ void USB_CDC_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length); + + /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the + * byte is discarded. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + * \param Data Byte of data to send to the host + */ void USB_CDC_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data); + + /** Determines the number of bytes received by the CDC interface from the host, waiting to be read. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + * + * \return Total number of buffered bytes received from the host + */ uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo); + + /** 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 + * returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data + * underflow occurs. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + * + * \return Next received byte from the host, or 0 if no data received + */ uint8_t USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void USB_CDC_SendSerialLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask); + + /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control + * lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are + * cleared via a second notification. + * + * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. + * \param LineStateMask Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states + */ + void USB_CDC_SendSerialLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask); /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)