Projects/XPLAINBridge/USARTDescriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
  34  *  computer-readable structures which the host requests upon device enumeration, to determine
  35  *  the device's capabilities and functions.
  36  */
  37
  38 #include "USARTDescriptors.h"
  39
  40 /* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
  41  * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
  42  * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
  43  * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
  44  * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
  45  * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
  46  * port location).
  47  */
  48 #if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
  49         #warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
  50 #endif
  51
  52 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  53  *  device characteristics, including the supported USB version, control endpoint size and the
  54  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  55  *  process begins.
  56  */
  57 const USB_Descriptor_Device_t PROGMEM USART_DeviceDescriptor =
  58 {
  59         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  60
  61         .USBSpecification       = VERSION_BCD(01.10),
  62         .Class                  = CDC_CSCP_CDCClass,
  63         .SubClass               = CDC_CSCP_NoSpecificSubclass,
  64         .Protocol               = CDC_CSCP_NoSpecificProtocol,
  65
  66         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  67
  68         .VendorID               = 0x03EB,
  69         .ProductID              = 0x204B,
  70         .ReleaseNumber          = VERSION_BCD(00.01),
  71
  72         .ManufacturerStrIndex   = 0x01,
  73         .ProductStrIndex        = 0x02,
  74         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  75
  76         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  77 };
  78
  79 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  80  *  of the device in one of its supported configurations, including information about any device interfaces
  81  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  82  *  a configuration so that the host may correctly communicate with the USB device.
  83  */
  84 const USART_USB_Descriptor_Configuration_t PROGMEM USART_ConfigurationDescriptor =
  85 {
  86         .Config =
  87                 {
  88                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  89
  90                         .TotalConfigurationSize = sizeof(USART_USB_Descriptor_Configuration_t),
  91                         .TotalInterfaces        = 2,
  92
  93                         .ConfigurationNumber    = 1,
  94                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  95
  96                         .ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
  97
  98                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  99                 },
 100
 101         .CDC_CCI_Interface =
 102                 {
 103                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 104
 105                         .InterfaceNumber        = 0,
 106                         .AlternateSetting       = 0,
 107
 108                         .TotalEndpoints         = 1,
 109
 110                         .Class                  = CDC_CSCP_CDCClass,
 111                         .SubClass               = CDC_CSCP_ACMSubclass,
 112                         .Protocol               = CDC_CSCP_ATCommandProtocol,
 113
 114                         .InterfaceStrIndex      = NO_DESCRIPTOR
 115                 },
 116
 117         .CDC_Functional_Header =
 118                 {
 119                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
 120                         .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
 121
 122                         .CDCSpecification       = VERSION_BCD(01.10),
 123                 },
 124
 125         .CDC_Functional_ACM =
 126                 {
 127                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
 128                         .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
 129
 130                         .Capabilities           = 0x06,
 131                 },
 132
 133         .CDC_Functional_Union =
 134                 {
 135                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
 136                         .Subtype                = CDC_DSUBTYPE_CSInterface_Union,
 137
 138                         .MasterInterfaceNumber  = 0,
 139                         .SlaveInterfaceNumber   = 1,
 140                 },
 141
 142         .CDC_NotificationEndpoint =
 143                 {
 144                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 145
 146                         .EndpointAddress        = (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM),
 147                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 148                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 149                         .PollingIntervalMS      = 0xFF
 150                 },
 151
 152         .CDC_DCI_Interface =
 153                 {
 154                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 155
 156                         .InterfaceNumber        = 1,
 157                         .AlternateSetting       = 0,
 158
 159                         .TotalEndpoints         = 2,
 160
 161                         .Class                  = CDC_CSCP_CDCDataClass,
 162                         .SubClass               = CDC_CSCP_NoDataSubclass,
 163                         .Protocol               = CDC_CSCP_NoDataProtocol,
 164
 165                         .InterfaceStrIndex      = NO_DESCRIPTOR
 166                 },
 167
 168         .CDC_DataOutEndpoint =
 169                 {
 170                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 171
 172                         .EndpointAddress        = (ENDPOINT_DIR_OUT | CDC_RX_EPNUM),
 173                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 174                         .EndpointSize           = CDC_TXRX_EPSIZE,
 175                         .PollingIntervalMS      = 0x01
 176                 },
 177
 178         .CDC_DataInEndpoint =
 179                 {
 180                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 181
 182                         .EndpointAddress        = (ENDPOINT_DIR_IN | CDC_TX_EPNUM),
 183                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 184                         .EndpointSize           = CDC_TXRX_EPSIZE,
 185                         .PollingIntervalMS      = 0x01
 186                 }
 187 };
 188
 189 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 190  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 191  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 192  */
 193 const USB_Descriptor_String_t PROGMEM USART_LanguageString =
 194 {
 195         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 196
 197         .UnicodeString          = {LANGUAGE_ID_ENG}
 198 };
 199
 200 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 201  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 202  *  Descriptor.
 203  */
 204 const USB_Descriptor_String_t PROGMEM USART_ManufacturerString =
 205 {
 206         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 207
 208         .UnicodeString          = L"Dean Camera"
 209 };
 210
 211 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 212  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 213  *  Descriptor.
 214  */
 215 const USB_Descriptor_String_t PROGMEM USART_ProductString =
 216 {
 217         .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
 218
 219         .UnicodeString          = L"LUFA XPLAIN Bridge"
 220 };
 221
 222 /** Descriptor retrieval function for the USART Bridge descriptors. This function is in turn called by the GetDescriptor
 223  *  callback function in the main source file, to retrieve the device's descriptors when in USART bridge mode.
 224  */
 225 uint16_t USART_GetDescriptor(const uint16_t wValue,
 226                              const uint8_t wIndex,
 227                              const void** const DescriptorAddress)
 228 {
 229         const uint8_t  DescriptorType   = (wValue >> 8);
 230         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 231
 232         const void* Address = NULL;
 233         uint16_t    Size    = NO_DESCRIPTOR;
 234
 235         switch (DescriptorType)
 236         {
 237                 case DTYPE_Device:
 238                         Address = &USART_DeviceDescriptor;
 239                         Size    = sizeof(USB_Descriptor_Device_t);
 240                         break;
 241                 case DTYPE_Configuration:
 242                         Address = &USART_ConfigurationDescriptor;
 243                         Size    = sizeof(USART_USB_Descriptor_Configuration_t);
 244                         break;
 245                 case DTYPE_String:
 246                         switch (DescriptorNumber)
 247                         {
 248                                 case 0x00:
 249                                         Address = &USART_LanguageString;
 250                                         Size    = pgm_read_byte(&USART_LanguageString.Header.Size);
 251                                         break;
 252                                 case 0x01:
 253                                         Address = &USART_ManufacturerString;
 254                                         Size    = pgm_read_byte(&USART_ManufacturerString.Header.Size);
 255                                         break;
 256                                 case 0x02:
 257                                         Address = &USART_ProductString;
 258                                         Size    = pgm_read_byte(&USART_ProductString.Header.Size);
 259                                         break;
 260                         }
 261
 262                         break;
 263         }
 264
 265         *DescriptorAddress = Address;
 266         return Size;
 267 }
 268