CDC.h 12.6 KB
 Dean Camera committed Jun 14, 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 31 32 33 /* 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. */ /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver *  Dean Camera committed Jul 14, 2009 34 35 36 37  * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/CDC.c *  Dean Camera committed Jun 14, 2009 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55  * \section Module Description * Host Mode USB Class driver framework interface, for the CDC USB Class driver. * * @{ */ #ifndef __CDC_CLASS_HOST_H__ #define __CDC_CLASS_HOST_H__ /* Includes: */ #include "../../USB.h" #include "../Common/CDC.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 15, 2009 56  /* Public Interface - May be used in end-application: */  57  /* Type Defines: */  Dean Camera committed Jun 19, 2009 58 59 60 61 62 63  /** Class state structure. An instance of this structure should be made 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 {  64 65 66 67 68 69 70 71 72 73  const struct { uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */ uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */ uint8_t NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */ } 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. */ struct {  Dean Camera committed Sep 02, 2009 74  bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid  Dean Camera committed Nov 04, 2009 75  * after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the  Dean Camera committed Sep 02, 2009 76 77  * Configured state */  Dean Camera committed Aug 11, 2009 78 79  uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */  80 81  uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */ uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe */  Dean Camera committed Aug 30, 2009 82  uint16_t NotificationPipeSize; /**< Size in bytes of the CDC interface's IN notification pipe, if used */  Dean Camera committed Jun 19, 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  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; 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; } 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. */  Dean Camera committed Jun 15, 2009 109  } USB_ClassInfo_CDC_Host_t;  Dean Camera committed Jun 18, 2009 110 111  /* Enums: */  Dean Camera committed Aug 11, 2009 112  /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */  Dean Camera committed Aug 27, 2009 113  enum CDCHost_EnumerationFailure_ErrorCodes_t  Dean Camera committed Jun 18, 2009 114 115  { CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */  Dean Camera committed Jul 27, 2009 116 117 118  CDC_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */ CDC_ENUMERROR_NoCDCInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */ CDC_ENUMERROR_EndpointsNotFound = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */  Dean Camera committed Aug 27, 2009 119  };  Dean Camera committed Jun 15, 2009 120   Dean Camera committed Jun 15, 2009 121  /* Function Prototypes: */  Dean Camera committed Aug 11, 2009 122 123 124  /** General management task for a given CDC host 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 Aug 26, 2009 125  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state  Dean Camera committed Aug 11, 2009 126  */  Dean Camera committed Sep 21, 2009 127  void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Aug 11, 2009 128 129 130 131 132 133 134  /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration * Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's * state values and configures the pipes required to communicate with the interface if it is found within the device. * This should be called once after the stack has enumerated the attached device, while the host state machine is in * the Addressed state. *  Dean Camera committed Aug 26, 2009 135  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state  Dean Camera committed Sep 21, 2009 136  * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor  Dean Camera committed Aug 11, 2009 137  * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor  Dean Camera committed Aug 27, 2009 138  *  Dean Camera committed Aug 30, 2009 139  * \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum  Dean Camera committed Aug 11, 2009 140  */  Dean Camera committed Sep 21, 2009 141  uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,  Dean Camera committed Aug 26, 2009 142  uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);  Dean Camera committed Jul 27, 2009 143   Dean Camera committed Aug 11, 2009 144 145 146  /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding * values of the interface have been changed to push the new settings to the USB device. *  Dean Camera committed Aug 26, 2009 147  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Sep 17, 2009 148 149  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum  Dean Camera committed Aug 11, 2009 150  */  Dean Camera committed Sep 21, 2009 151  uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Aug 11, 2009 152 153 154 155 156 157  /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial * control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second * notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated * to push the new states to the USB device. *  Dean Camera committed Aug 26, 2009 158  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Sep 17, 2009 159 160  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum  Dean Camera committed Aug 11, 2009 161  */  Dean Camera committed Sep 21, 2009 162  uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Jul 27, 2009 163   Dean Camera committed Aug 11, 2009 164 165 166  /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the * string is discarded. *  Dean Camera committed Aug 26, 2009 167  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Aug 11, 2009 168 169  * \param[in] Data Pointer to the string to send to the device * \param[in] Length Size in bytes of the string to send to the device  Dean Camera committed Aug 31, 2009 170 171  * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum  Dean Camera committed Aug 11, 2009 172  */  Dean Camera committed Sep 21, 2009 173  uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1, 2);  Dean Camera committed Aug 11, 2009 174 175 176 177  /** Sends a given byte to the attached USB device, if connected. If a host is not connected when the function is called, the * byte is discarded. *  Dean Camera committed Aug 26, 2009 178  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Aug 11, 2009 179  * \param[in] Data Byte of data to send to the device  Dean Camera committed Aug 31, 2009 180 181  * * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum  Dean Camera committed Aug 11, 2009 182  */  Dean Camera committed Sep 21, 2009 183  uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Aug 11, 2009 184 185 186  /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. *  Dean Camera committed Aug 26, 2009 187  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Aug 11, 2009 188 189 190  * * \return Total number of buffered bytes received from the device */  Dean Camera committed Sep 21, 2009 191  uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Aug 11, 2009 192 193  /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function  Dean Camera committed Sep 02, 2009 194  * returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data  Dean Camera committed Aug 11, 2009 195 196  * underflow occurs. *  Dean Camera committed Aug 26, 2009 197  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Aug 11, 2009 198 199 200  * * \return Next received byte from the device, or 0 if no data received */  Dean Camera committed Sep 21, 2009 201  uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Aug 11, 2009 202 203 204 205 206 207 208  /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies * the host of a control line state change (containing the virtual serial control line states, such as DCD) 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 ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as * a mask of CDC_CONTROL_LINE_IN_* masks. *  Dean Camera committed Aug 26, 2009 209  * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state  Dean Camera committed Aug 11, 2009 210  */  Dean Camera committed Sep 21, 2009 211  void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Jun 15, 2009 212 213 214 215  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */  Dean Camera committed Jun 19, 2009 216 217 218 219 220 221 222 223 224  #define CDC_CONTROL_CLASS 0x02 #define CDC_CONTROL_SUBCLASS 0x02 #define CDC_CONTROL_PROTOCOL 0x01 #define CDC_DATA_CLASS 0x0A #define CDC_DATA_SUBCLASS 0x00 #define CDC_DATA_PROTOCOL 0x00 #define CDC_FOUND_DATAPIPE_IN (1 << 0) #define CDC_FOUND_DATAPIPE_OUT (1 << 1)  Dean Camera committed Aug 30, 2009 225  #define CDC_FOUND_NOTIFICATION_IN (1 << 2)  Dean Camera committed Jun 15, 2009 226 227 228  /* Function Prototypes: */ #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)  Dean Camera committed Aug 11, 2009 229  void CDC_Host_Event_Stub(void);  Dean Camera committed Nov 03, 2009 230  void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)  Dean Camera committed Aug 26, 2009 231  ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);  Dean Camera committed Nov 03, 2009 232 233 234  static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor);  Dean Camera committed Jul 27, 2009 235  #endif  Dean Camera committed Jun 15, 2009 236 237  #endif  Dean Camera committed Jun 14, 2009 238 239 240 241 242 243 244 245  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */