CDC.h 7.26 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 {  74 75 76 77  bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the * 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 82  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 */ uint16_t NotificationPipeSize; /**< Size in bytes of the CDC interface's IN notification endpoint, 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 Jul 16, 2009 112  enum  Dean Camera committed Jun 18, 2009 113 114  { CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */  Dean Camera committed Jul 27, 2009 115 116 117  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 Jun 18, 2009 118  } CDCHost_EnumerationFailure_ErrorCodes_t;  Dean Camera committed Jun 15, 2009 119   Dean Camera committed Jun 15, 2009 120  /* Function Prototypes: */  Dean Camera committed Jun 18, 2009 121  void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);  Dean Camera committed Jul 27, 2009 122 123 124  uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength, uint8_t* DeviceConfigDescriptor);  Dean Camera committed Jul 27, 2009 125 126 127 128 129 130 131  uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo); uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo); void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length); void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data); uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo); uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);  Dean Camera committed Jun 15, 2009 132 133 134 135  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */  Dean Camera committed Jun 19, 2009 136 137 138 139 140 141 142 143 144 145  #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) #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)  Dean Camera committed Jun 15, 2009 146 147 148  /* Function Prototypes: */ #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)  Dean Camera committed Aug 11, 2009 149 150 151  void CDC_Host_Event_Stub(void); void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_WEAK ATTR_ALIAS(CDC_Host_Event_Stub);  Dean Camera committed Jun 15, 2009 152 153 154  static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor); static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor); static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);  Dean Camera committed Jul 27, 2009 155  #endif  Dean Camera committed Jun 15, 2009 156 157  #endif  Dean Camera committed Jun 14, 2009 158 159 160 161 162 163 164 165  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */