X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/d1e52660368d34d693131f6aff3c8fd8584162e5..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 bbe1c9838..390ebbcb6 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -28,6 +28,20 @@ this software. */ +/** \ingroup Group_USBDeviceClassDrivers + * @defgroup Group_USBClassCDCDevice CDC Device Class Driver - LUFA/Drivers/Class/Device/CDC.h + * + * \section Sec_Dependencies Module Source Dependencies + * The following files must be built with any user project that uses this module: + * - LUFA/Drivers/USB/Class/Device/CDC.c + * + * \section Module Description + * Functions, macros, variables, enums and types related to the management of USB CDC Class interfaces + * within a USB device, for the implementation of CDC-ACM virtual serial ports. + * + * @{ + */ + #ifndef _CDC_CLASS_H_ #define _CDC_CLASS_H_ @@ -36,66 +50,71 @@ #include + /* Enable C linkage for C++ Compilers: */ + #if defined(__cplusplus) + extern "C" { + #endif + /* Macros: */ /** CDC Class specific request to get the current virtual serial port configuration settings. */ - #define REQ_GetLineEncoding 0x21 + #define REQ_GetLineEncoding 0x21 /** CDC Class specific request to set the current virtual serial port configuration settings. */ - #define REQ_SetLineEncoding 0x20 + #define REQ_SetLineEncoding 0x20 /** CDC Class specific request to set the current virtual serial port handshake line states. */ - #define REQ_SetControlLineState 0x22 + #define REQ_SetControlLineState 0x22 /** Notification type constant for a change in the virtual serial port handshake line states, for * use with a USB_Notification_Header_t notification structure when sent to the host via the CDC * notification endpoint. */ - #define NOTIF_SerialState 0x20 + #define NOTIF_SerialState 0x20 /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request * from the host, to indicate that the DTR line state should be high. */ - #define CONTROL_LINE_OUT_DTR (1 << 0) + #define CDC_CONTROL_LINE_OUT_DTR (1 << 0) /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request * from the host, to indicate that theRTS line state should be high. */ - #define CONTROL_LINE_OUT_RTS (1 << 1) + #define CDC_CONTROL_LINE_OUT_RTS (1 << 1) /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification * from the device to the host, to indicate that the DCD line state is currently high. */ - #define CONTROL_LINE_IN_DCD (1 << 0) + #define CDC_CONTROL_LINE_IN_DCD (1 << 0) /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification * from the device to the host, to indicate that the DSR line state is currently high. */ - #define CONTROL_LINE_IN_DSR (1 << 1) + #define CDC_CONTROL_LINE_IN_DSR (1 << 1) /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification * from the device to the host, to indicate that the BREAK line state is currently high. */ - #define CONTROL_LINE_IN_BREAK (1 << 2) + #define CDC_CONTROL_LINE_IN_BREAK (1 << 2) /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification * from the device to the host, to indicate that the RING line state is currently high. */ - #define CONTROL_LINE_IN_RING (1 << 3) + #define CDC_CONTROL_LINE_IN_RING (1 << 3) /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, * to indicate that a framing error has occurred on the virtual serial port. */ - #define CONTROL_LINE_IN_FRAMEERROR (1 << 4) + #define CDC_CONTROL_LINE_IN_FRAMEERROR (1 << 4) /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, * to indicate that a parity error has occurred on the virtual serial port. */ - #define CONTROL_LINE_IN_PARITYERROR (1 << 5) + #define CDC_CONTROL_LINE_IN_PARITYERROR (1 << 5) /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host, * to indicate that a data overrun error has occurred on the virtual serial port. */ - #define CONTROL_LINE_IN_OVERRUNERROR (1 << 6) + #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6) /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a * uniform structure but variable sized data payloads, thus cannot be represented accurately by @@ -116,24 +135,26 @@ /** Enum for the possible line encoding formats of a virtual serial port. */ enum CDCDevice_CDC_LineCodingFormats_t { - OneStopBit = 0, /**< Each frame contains one stop bit */ - OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */ - TwoStopBits = 2, /**< Each frame contains two stop bits */ + CDC_LINEENCODING_OneStopBit = 0, /**< Each frame contains one stop bit */ + CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */ + CDC_LINEENCODING_TwoStopBits = 2, /**< Each frame contains two stop bits */ }; /** Enum for the possible line encoding parity settings of a virtual serial port. */ enum CDCDevice_LineCodingParity_t { - Parity_None = 0, /**< No parity bit mode on each frame */ - Parity_Odd = 1, /**< Odd parity bit mode on each frame */ - Parity_Even = 2, /**< Even parity bit mode on each frame */ - Parity_Mark = 3, /**< Mark parity bit mode on each frame */ - Parity_Space = 4, /**< Space parity bit mode on each frame */ + CDC_PARITY_None = 0, /**< No parity bit mode on each frame */ + CDC_PARITY_Odd = 1, /**< Odd parity bit mode on each frame */ + CDC_PARITY_Even = 2, /**< Even parity bit mode on each frame */ + CDC_PARITY_Mark = 3, /**< Mark parity bit mode on each frame */ + CDC_PARITY_Space = 4, /**< Space parity bit mode on each frame */ }; /* 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 { @@ -148,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; + uint8_t ControlLineState; /**< Current control line states, as set by the host */ struct { @@ -168,21 +189,102 @@ void USB_CDC_Event_Stub(void); void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo) ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub); - void EVENT_USB_CDC_ControLineStateChanged(void) ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);; + void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo) + ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub); #endif - void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - bool USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo); + /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library + * \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 a CDC Class configuration and state. + * + * \return Boolean true if the endpoints were sucessfully configured, false otherwise + */ + bool USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo); - void EVENT_USB_CDC_ControLineStateChanged(void); + /** 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 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 a CDC Class configuration and state. + */ + void USB_CDC_USBTask(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) + } + #endif #endif + +/** @} */