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         .IAD1 =
 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_CallManagement =
 140                 {
 141                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 142                         .SubType                = 0x01,
 143
 144                         .Data                   = {0x03, 0x01}
 145                 },
 146
 147         .CDC1_Functional_AbstractControlManagement =
 148                 {
 149                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 150                         .SubType                = 0x02,
 151
 152                         .Data                   = {0x06}
 153                 },
 154
 155         .CDC1_Functional_Union =
 156                 {
 157                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 158                         .SubType                = 0x06,
 159
 160                         .Data                   = {0x00, 0x01}
 161                 },
 162
 163         .CDC1_ManagementEndpoint =
 164                 {
 165                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 166
 167                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC1_NOTIFICATION_EPNUM),
 168                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 169                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 170                         .PollingIntervalMS      = 0xFF
 171                 },
 172
 173         .CDC1_DCI_Interface =
 174                 {
 175                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 176
 177                         .InterfaceNumber        = 1,
 178                         .AlternateSetting       = 0,
 179
 180                         .TotalEndpoints         = 2,
 181
 182                         .Class                  = 0x0A,
 183                         .SubClass               = 0x00,
 184                         .Protocol               = 0x00,
 185
 186                         .InterfaceStrIndex      = NO_DESCRIPTOR
 187                 },
 188
 189         .CDC1_DataOutEndpoint =
 190                 {
 191                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 192
 193                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC1_RX_EPNUM),
 194                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 195                         .EndpointSize           = CDC_TXRX_EPSIZE,
 196                         .PollingIntervalMS      = 0x00
 197                 },
 198
 199         .CDC1_DataInEndpoint =
 200                 {
 201                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 202
 203                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC1_TX_EPNUM),
 204                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 205                         .EndpointSize           = CDC_TXRX_EPSIZE,
 206                         .PollingIntervalMS      = 0x00
 207                 },
 208
 209         .IAD2 =
 210                 {
 211                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
 212
 213                         .FirstInterfaceIndex    = 2,
 214                         .TotalInterfaces        = 2,
 215
 216                         .Class                  = 0x02,
 217                         .SubClass               = 0x02,
 218                         .Protocol               = 0x01,
 219
 220                         .IADStrIndex            = NO_DESCRIPTOR
 221                 },
 222
 223         .CDC2_CCI_Interface =
 224                 {
 225                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 226
 227                         .InterfaceNumber        = 2,
 228                         .AlternateSetting       = 0,
 229
 230                         .TotalEndpoints         = 1,
 231
 232                         .Class                  = 0x02,
 233                         .SubClass               = 0x02,
 234                         .Protocol               = 0x01,
 235
 236                         .InterfaceStrIndex      = NO_DESCRIPTOR
 237                 },
 238
 239         .CDC2_Functional_IntHeader =
 240                 {
 241                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 242                         .SubType                = 0x00,
 243
 244                         .Data                   = {0x01, 0x10}
 245                 },
 246
 247         .CDC2_Functional_CallManagement =
 248                 {
 249                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 250                         .SubType                = 0x01,
 251
 252                         .Data                   = {0x03, 0x03}
 253                 },
 254
 255         .CDC2_Functional_AbstractControlManagement =
 256                 {
 257                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 258                         .SubType                = 0x02,
 259
 260                         .Data                   = {0x06}
 261                 },
 262
 263         .CDC2_Functional_Union =
 264                 {
 265                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 266                         .SubType                = 0x06,
 267
 268                         .Data                   = {0x02, 0x03}
 269                 },
 270
 271         .CDC2_ManagementEndpoint =
 272                 {
 273                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 274
 275                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC2_NOTIFICATION_EPNUM),
 276                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 277                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 278                         .PollingIntervalMS      = 0xFF
 279                 },
 280
 281         .CDC2_DCI_Interface =
 282                 {
 283                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 284
 285                         .InterfaceNumber        = 3,
 286                         .AlternateSetting       = 0,
 287
 288                         .TotalEndpoints         = 2,
 289
 290                         .Class                  = 0x0A,
 291                         .SubClass               = 0x00,
 292                         .Protocol               = 0x00,
 293
 294                         .InterfaceStrIndex      = NO_DESCRIPTOR
 295                 },
 296
 297         .CDC2_DataOutEndpoint =
 298                 {
 299                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 300
 301                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC2_RX_EPNUM),
 302                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 303                         .EndpointSize           = CDC_TXRX_EPSIZE,
 304                         .PollingIntervalMS      = 0x00
 305                 },
 306
 307         .CDC2_DataInEndpoint =
 308                 {
 309                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 310
 311                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC2_TX_EPNUM),
 312                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 313                         .EndpointSize           = CDC_TXRX_EPSIZE,
 314                         .PollingIntervalMS      = 0x00
 315                 }
 316 };
 317
 318 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 319  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 320  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 321  */
 322 USB_Descriptor_String_t PROGMEM LanguageString =
 323 {
 324         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 325
 326         .UnicodeString          = {LANGUAGE_ID_ENG}
 327 };
 328
 329 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 330  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 331  *  Descriptor.
 332  */
 333 USB_Descriptor_String_t PROGMEM ManufacturerString =
 334 {
 335         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 336
 337         .UnicodeString          = L"Dean Camera"
 338 };
 339
 340 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 341  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 342  *  Descriptor.
 343  */
 344 USB_Descriptor_String_t PROGMEM ProductString =
 345 {
 346         .Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
 347
 348         .UnicodeString          = L"LUFA Dual CDC Demo"
 349 };
 350
 351 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 352  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 353  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 354  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 355  *  USB host.
 356  */
 357 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 358 {
 359         const uint8_t  DescriptorType   = (wValue >> 8);
 360         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 361
 362         void*    Address = NULL;
 363         uint16_t Size    = NO_DESCRIPTOR;
 364
 365         switch (DescriptorType)
 366         {
 367                 case DTYPE_Device:
 368                         Address = (void*)&DeviceDescriptor;
 369                         Size    = sizeof(USB_Descriptor_Device_t);
 370                         break;
 371                 case DTYPE_Configuration:
 372                         Address = (void*)&ConfigurationDescriptor;
 373                         Size    = sizeof(USB_Descriptor_Configuration_t);
 374                         break;
 375                 case DTYPE_String:
 376                         switch (DescriptorNumber)
 377                         {
 378                                 case 0x00:
 379                                         Address = (void*)&LanguageString;
 380                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 381                                         break;
 382                                 case 0x01:
 383                                         Address = (void*)&ManufacturerString;
 384                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 385                                         break;
 386                                 case 0x02:
 387                                         Address = (void*)&ProductString;
 388                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 389                                         break;
 390                         }
 391
 392                         break;
 393         }
 394
 395         *DescriptorAddress = Address;
 396         return Size;
 397 }