CDC.h 14.1 KB
 Dean Camera committed Jun 01, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */  Dean Camera committed Jun 04, 2009 31 32 33 34 35 36 37 38 39 40 41 42 43 44 /** \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. * * @{ */  Dean Camera committed Jun 01, 2009 45 46 47 48 49 50 51 52 #ifndef _CDC_CLASS_H_ #define _CDC_CLASS_H_ /* Includes: */ #include "../../USB.h" #include  Dean Camera committed Jun 04, 2009 53 54 55 56 57  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 01, 2009 58 59  /* Macros: */ /** CDC Class specific request to get the current virtual serial port configuration settings. */  Dean Camera committed Jun 04, 2009 60  #define REQ_GetLineEncoding 0x21  Dean Camera committed Jun 01, 2009 61 62  /** CDC Class specific request to set the current virtual serial port configuration settings. */  Dean Camera committed Jun 04, 2009 63  #define REQ_SetLineEncoding 0x20  Dean Camera committed Jun 01, 2009 64 65  /** CDC Class specific request to set the current virtual serial port handshake line states. */  Dean Camera committed Jun 04, 2009 66  #define REQ_SetControlLineState 0x22  Dean Camera committed Jun 01, 2009 67 68 69 70 71  /** 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. */  Dean Camera committed Jun 04, 2009 72  #define NOTIF_SerialState 0x20  Dean Camera committed Jun 01, 2009 73 74 75 76  /** 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. */  Dean Camera committed Jun 04, 2009 77  #define CDC_CONTROL_LINE_OUT_DTR (1 << 0)  Dean Camera committed Jun 01, 2009 78 79 80 81  /** 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. */  Dean Camera committed Jun 04, 2009 82  #define CDC_CONTROL_LINE_OUT_RTS (1 << 1)  Dean Camera committed Jun 01, 2009 83 84 85 86  /** 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. */  Dean Camera committed Jun 04, 2009 87  #define CDC_CONTROL_LINE_IN_DCD (1 << 0)  Dean Camera committed Jun 01, 2009 88 89 90 91  /** 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. */  Dean Camera committed Jun 04, 2009 92  #define CDC_CONTROL_LINE_IN_DSR (1 << 1)  Dean Camera committed Jun 01, 2009 93 94 95 96  /** 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. */  Dean Camera committed Jun 04, 2009 97  #define CDC_CONTROL_LINE_IN_BREAK (1 << 2)  Dean Camera committed Jun 01, 2009 98 99 100 101  /** 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. */  Dean Camera committed Jun 04, 2009 102  #define CDC_CONTROL_LINE_IN_RING (1 << 3)  Dean Camera committed Jun 01, 2009 103 104 105 106  /** 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. */  Dean Camera committed Jun 04, 2009 107  #define CDC_CONTROL_LINE_IN_FRAMEERROR (1 << 4)  Dean Camera committed Jun 01, 2009 108 109 110 111  /** 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. */  Dean Camera committed Jun 04, 2009 112  #define CDC_CONTROL_LINE_IN_PARITYERROR (1 << 5)  Dean Camera committed Jun 01, 2009 113 114 115 116  /** 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. */  Dean Camera committed Jun 04, 2009 117  #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)  Dean Camera committed Jun 01, 2009 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137  /** 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 * a single typedef struct. A macro is used instead so that functional descriptors can be created * easily by specifying the size of the payload. This allows sizeof() to work correctly. * * \param DataSize Size in bytes of the CDC functional descriptor's data payload */ #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize) \ struct \ { \ USB_Descriptor_Header_t Header; \ uint8_t SubType; \ uint8_t Data[DataSize]; \ } /* Enums: */ /** Enum for the possible line encoding formats of a virtual serial port. */ enum CDCDevice_CDC_LineCodingFormats_t {  Dean Camera committed Jun 04, 2009 138 139 140  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 */  Dean Camera committed Jun 01, 2009 141 142 143 144 145  }; /** Enum for the possible line encoding parity settings of a virtual serial port. */ enum CDCDevice_LineCodingParity_t {  Dean Camera committed Jun 04, 2009 146 147 148 149 150  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 */  Dean Camera committed Jun 01, 2009 151 152 153  }; /* Type Defines: */  Dean Camera committed Jun 08, 2009 154 155 156 157  /** 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.  Dean Camera committed Jun 01, 2009 158 159 160 161 162 163 164 165 166 167 168 169 170 171  */ typedef struct { uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */ uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */ uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */ uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint */ 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 */  Dean Camera committed Jun 05, 2009 172  uint8_t ControlLineState; /**< Current control line states, as set by the host */  Dean Camera committed Jun 01, 2009 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191  struct { uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */ uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the * CDCDevice_CDC_LineCodingFormats_t enum */ uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the * CDCDevice_LineCodingParity_t enum */ uint8_t DataBits; /**< Bits of data per character of the virtual serial port */ } LineEncoding; } USB_ClassInfo_CDC_t; /* Function Prototypes: */ #if defined(INCLUDE_FROM_CDC_CLASS_C) void USB_CDC_Event_Stub(void); void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo) ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);  Dean Camera committed Jun 04, 2009 192 193  void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo) ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);  Dean Camera committed Jun 01, 2009 194 195  #endif  Dean Camera committed Jun 04, 2009 196 197 198 199  /** 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. *  Dean Camera committed Jun 05, 2009 200  * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.  Dean Camera committed Jun 04, 2009 201 202 203 204 205 206 207 208  * * \return Boolean true if the endpoints were sucessfully configured, false otherwise */ bool USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo); /** 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. *  Dean Camera committed Jun 05, 2009 209  * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.  Dean Camera committed Jun 04, 2009 210 211 212 213 214 215  */ 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(). *  Dean Camera committed Jun 05, 2009 216  * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.  Dean Camera committed Jun 04, 2009 217 218  */ void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);  Dean Camera committed Jun 01, 2009 219   Dean Camera committed Jun 05, 2009 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237  /** 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);  Dean Camera committed Jun 01, 2009 238   Dean Camera committed Jun 08, 2009 239 240 241 242 243 244 245  /** 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 */  Dean Camera committed Jun 01, 2009 246  void USB_CDC_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);  Dean Camera committed Jun 08, 2009 247 248 249 250 251 252 253  /** 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 */  Dean Camera committed Jun 01, 2009 254  void USB_CDC_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);  Dean Camera committed Jun 08, 2009 255 256 257 258 259 260 261  /** 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 */  Dean Camera committed Jun 01, 2009 262  uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);  Dean Camera committed Jun 08, 2009 263 264 265 266 267 268 269 270 271  /** 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 */  Dean Camera committed Jun 01, 2009 272  uint8_t USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);  Dean Camera committed Jun 08, 2009 273 274 275 276 277 278 279 280  /** 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 */  Dean Camera committed Jun 05, 2009 281  void USB_CDC_SendSerialLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);  Dean Camera committed Jun 04, 2009 282 283 284 285 286  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Jun 01, 2009 287 288  #endif  Dean Camera committed Jun 04, 2009 289 290  /** @} */