Demos/Device/ClassDriver/DualVirtualSerial/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 "Descriptors.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 USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  58 {
  59         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  60
  61         .USBSpecification       = VERSION_BCD(01.10),
  62         .Class                  = 0xEF,
  63         .SubClass               = 0x02,
  64         .Protocol               = 0x01,
  65
  66         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  67
  68         .VendorID               = 0x03EB,
  69         .ProductID              = 0x204E,
  70         .ReleaseNumber          = 0x0000,
  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 USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  85 {
  86         .Config =
  87                 {
  88                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  89
  90                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  91                         .TotalInterfaces        = 4,
  92
  93                         .ConfigurationNumber    = 1,
  94                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  95
  96                         .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
  97
  98                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  99                 },
 100
 101         .CDC1_IAD =
 102                 {
 103                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
 104
 105                         .FirstInterfaceIndex    = 0,
 106                         .TotalInterfaces        = 2,
 107
 108                         .Class                  = 0x02,
 109                         .SubClass               = 0x02,
 110                         .Protocol               = 0x01,
 111
 112                         .IADStrIndex            = NO_DESCRIPTOR
 113                 },
 114
 115         .CDC1_CCI_Interface =
 116                 {
 117                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 118
 119                         .InterfaceNumber        = 0,
 120                         .AlternateSetting       = 0,
 121
 122                         .TotalEndpoints         = 1,
 123
 124                         .Class                  = 0x02,
 125                         .SubClass               = 0x02,
 126                         .Protocol               = 0x01,
 127
 128                         .InterfaceStrIndex      = NO_DESCRIPTOR
 129                 },
 130
 131         .CDC1_Functional_IntHeader =
 132                 {
 133                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 134                         .SubType                = 0x00,
 135
 136                         .Data                   = {0x01, 0x10}
 137                 },
 138
 139         .CDC1_Functional_AbstractControlManagement =
 140                 {
 141                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 142                         .SubType                = 0x02,
 143
 144                         .Data                   = {0x06}
 145                 },
 146
 147         .CDC1_Functional_Union =
 148                 {
 149                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 150                         .SubType                = 0x06,
 151
 152                         .Data                   = {0x00, 0x01}
 153                 },
 154
 155         .CDC1_ManagementEndpoint =
 156                 {
 157                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 158
 159                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC1_NOTIFICATION_EPNUM),
 160                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 161                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 162                         .PollingIntervalMS      = 0xFF
 163                 },
 164
 165         .CDC1_DCI_Interface =
 166                 {
 167                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 168
 169                         .InterfaceNumber        = 1,
 170                         .AlternateSetting       = 0,
 171
 172                         .TotalEndpoints         = 2,
 173
 174                         .Class                  = 0x0A,
 175                         .SubClass               = 0x00,
 176                         .Protocol               = 0x00,
 177
 178                         .InterfaceStrIndex      = NO_DESCRIPTOR
 179                 },
 180
 181         .CDC1_DataOutEndpoint =
 182                 {
 183                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 184
 185                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC1_RX_EPNUM),
 186                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 187                         .EndpointSize           = CDC_TXRX_EPSIZE,
 188                         .PollingIntervalMS      = 0x00
 189                 },
 190
 191         .CDC1_DataInEndpoint =
 192                 {
 193                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 194
 195                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC1_TX_EPNUM),
 196                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 197                         .EndpointSize           = CDC_TXRX_EPSIZE,
 198                         .PollingIntervalMS      = 0x00
 199                 },
 200
 201         .CDC2_IAD =
 202                 {
 203                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
 204
 205                         .FirstInterfaceIndex    = 2,
 206                         .TotalInterfaces        = 2,
 207
 208                         .Class                  = 0x02,
 209                         .SubClass               = 0x02,
 210                         .Protocol               = 0x01,
 211
 212                         .IADStrIndex            = NO_DESCRIPTOR
 213                 },
 214
 215         .CDC2_CCI_Interface =
 216                 {
 217                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 218
 219                         .InterfaceNumber        = 2,
 220                         .AlternateSetting       = 0,
 221
 222                         .TotalEndpoints         = 1,
 223
 224                         .Class                  = 0x02,
 225                         .SubClass               = 0x02,
 226                         .Protocol               = 0x01,
 227
 228                         .InterfaceStrIndex      = NO_DESCRIPTOR
 229                 },
 230
 231         .CDC2_Functional_IntHeader =
 232                 {
 233                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 234                         .SubType                = 0x00,
 235
 236                         .Data                   = {0x01, 0x10}
 237                 },
 238
 239         .CDC2_Functional_AbstractControlManagement =
 240                 {
 241                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 242                         .SubType                = 0x02,
 243
 244                         .Data                   = {0x06}
 245                 },
 246
 247         .CDC2_Functional_Union =
 248                 {
 249                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 250                         .SubType                = 0x06,
 251
 252                         .Data                   = {0x02, 0x03}
 253                 },
 254
 255         .CDC2_ManagementEndpoint =
 256                 {
 257                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 258
 259                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC2_NOTIFICATION_EPNUM),
 260                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 261                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 262                         .PollingIntervalMS      = 0xFF
 263                 },
 264
 265         .CDC2_DCI_Interface =
 266                 {
 267                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 268
 269                         .InterfaceNumber        = 3,
 270                         .AlternateSetting       = 0,
 271
 272                         .TotalEndpoints         = 2,
 273
 274                         .Class                  = 0x0A,
 275                         .SubClass               = 0x00,
 276                         .Protocol               = 0x00,
 277
 278                         .InterfaceStrIndex      = NO_DESCRIPTOR
 279                 },
 280
 281         .CDC2_DataOutEndpoint =
 282                 {
 283                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 284
 285                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC2_RX_EPNUM),
 286                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 287                         .EndpointSize           = CDC_TXRX_EPSIZE,
 288                         .PollingIntervalMS      = 0x00
 289                 },
 290
 291         .CDC2_DataInEndpoint =
 292                 {
 293                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 294
 295                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC2_TX_EPNUM),
 296                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 297                         .EndpointSize           = CDC_TXRX_EPSIZE,
 298                         .PollingIntervalMS      = 0x00
 299                 }
 300 };
 301
 302 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 303  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 304  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 305  */
 306 USB_Descriptor_String_t PROGMEM LanguageString =
 307 {
 308         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 309
 310         .UnicodeString          = {LANGUAGE_ID_ENG}
 311 };
 312
 313 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 314  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 315  *  Descriptor.
 316  */
 317 USB_Descriptor_String_t PROGMEM ManufacturerString =
 318 {
 319         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 320
 321         .UnicodeString          = L"Dean Camera"
 322 };
 323
 324 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 325  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 326  *  Descriptor.
 327  */
 328 USB_Descriptor_String_t PROGMEM ProductString =
 329 {
 330         .Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
 331
 332         .UnicodeString          = L"LUFA Dual CDC Demo"
 333 };
 334
 335 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 336  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 337  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 338  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 339  *  USB host.
 340  */
 341 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 342                                     const uint8_t wIndex,
 343                                     const void** const DescriptorAddress)
 344 {
 345         const uint8_t  DescriptorType   = (wValue >> 8);
 346         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 347
 348         const void* Address = NULL;
 349         uint16_t    Size    = NO_DESCRIPTOR;
 350
 351         switch (DescriptorType)
 352         {
 353                 case DTYPE_Device:
 354                         Address = &DeviceDescriptor;
 355                         Size    = sizeof(USB_Descriptor_Device_t);
 356                         break;
 357                 case DTYPE_Configuration:
 358                         Address = &ConfigurationDescriptor;
 359                         Size    = sizeof(USB_Descriptor_Configuration_t);
 360                         break;
 361                 case DTYPE_String:
 362                         switch (DescriptorNumber)
 363                         {
 364                                 case 0x00:
 365                                         Address = &LanguageString;
 366                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 367                                         break;
 368                                 case 0x01:
 369                                         Address = &ManufacturerString;
 370                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 371                                         break;
 372                                 case 0x02:
 373                                         Address = &ProductString;
 374                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 375                                         break;
 376                         }
 377
 378                         break;
 379         }
 380
 381         *DescriptorAddress = Address;
 382         return Size;
 383 }