CDC.h 11.2 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 14, 2009 31 32 /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver  Dean Camera committed Jun 04, 2009 33 34  * * \section Module Description  Dean Camera committed Jun 14, 2009 35  * Device Mode USB Class driver framework interface, for the CDC USB Class driver.  Dean Camera committed Jun 04, 2009 36 37 38 39  * * @{ */  Dean Camera committed Jun 14, 2009 40 41 #ifndef _CDC_CLASS_DEVICE_H_ #define _CDC_CLASS_DEVICE_H_  Dean Camera committed Jun 01, 2009 42 43 44  /* Includes: */ #include "../../USB.h"  Dean Camera committed Jun 14, 2009 45  #include "../Common/CDC.h"  Dean Camera committed Jun 01, 2009 46 47 48  #include  Dean Camera committed Jun 04, 2009 49 50 51 52 53  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 15, 2009 54  /* Public Interface - May be used in end-application: */  Dean Camera committed Jun 18, 2009 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73  /* Type Defines: */ /** Configuration information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */ 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 */ } USB_ClassInfo_CDC_Device_Config_t; /** Current State information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */ typedef struct {  Dean Camera committed Jun 20, 2009 74 75 76 77 78 79 80 81 82  struct { uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_* * masks. */ uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_* * masks. */ } ControlLineStates;  Dean Camera committed Jun 18, 2009 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116  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_Device_State_t; /** 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. This stores each CDC interface's configuration and state information. */ typedef struct { const USB_ClassInfo_CDC_Device_Config_t Config; /**< Config data for the USB class interface within * the device. All elements in this section * must be set or the interface will fail * to enumerate and operate correctly. */ USB_ClassInfo_CDC_Device_State_t State; /**< State data for the USB class interface within * the device. All elements in this section * may be set to initial values, but may * also be ignored to default to sane values when * the interface is enumerated. */ } USB_ClassInfo_CDC_Device_t;  Dean Camera committed Jun 15, 2009 117 118 119 120 121 122 123 124 125  /* Function Prototypes: */ /** 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 */  Dean Camera committed Jun 18, 2009 126  bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 04, 2009 127   Dean Camera committed Jun 15, 2009 128 129 130 131 132  /** 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. */  Dean Camera committed Jun 18, 2009 133  void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 04, 2009 134   Dean Camera committed Jun 15, 2009 135 136 137 138 139  /** 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. */  Dean Camera committed Jun 18, 2009 140  void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 01, 2009 141   Dean Camera committed Jun 15, 2009 142 143 144 145 146 147 148  /** 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. */  Dean Camera committed Jun 18, 2009 149  void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 15, 2009 150 151 152 153  /** 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  Dean Camera committed Jun 20, 2009 154 155  * are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as * a mask of CDC_CONTROL_LINE_OUT_* masks.  Dean Camera committed Jun 15, 2009 156 157 158  * * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. */  Dean Camera committed Jun 18, 2009 159  void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 01, 2009 160   Dean Camera committed Jun 15, 2009 161 162 163 164 165 166 167  /** 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 18, 2009 168  void CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, char* Data, uint16_t Length);  Dean Camera committed Jun 15, 2009 169 170 171 172 173 174 175  /** 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 18, 2009 176  void CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, uint8_t Data);  Dean Camera committed Jun 15, 2009 177 178 179 180 181 182 183  /** 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 18, 2009 184  uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 15, 2009 185 186 187 188 189 190 191 192 193  /** 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 18, 2009 194  uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 15, 2009 195   Dean Camera committed Jun 20, 2009 196 197 198 199  /** 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. This should be called each time the CDC class driver's * ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.  Dean Camera committed Jun 15, 2009 200 201 202  * * \param CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. */  Dean Camera committed Jun 20, 2009 203  void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);  Dean Camera committed Jun 04, 2009 204   Dean Camera committed Jun 15, 2009 205 206 207 208 209  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Function Prototypes: */ #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C) void CDC_Device_Event_Stub(void);  Dean Camera committed Jun 18, 2009 210  void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)  Dean Camera committed Jun 15, 2009 211  ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);  Dean Camera committed Jun 18, 2009 212  void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)  Dean Camera committed Jun 15, 2009 213 214 215 216 217  ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub); #endif #endif  Dean Camera committed Jun 04, 2009 218 219 220 221  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Jun 01, 2009 222 223  #endif  Dean Camera committed Jun 04, 2009 224 225  /** @} */