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