Demos/Device/LowLevel/CDC/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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                  = 0x02,
  63         .SubClass               = 0x00,
  64         .Protocol               = 0x00,
  65
  66         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  67
  68         .VendorID               = 0x03EB,
  69         .ProductID              = 0x2044,
  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        = 2,
  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         .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                  = 0x02,
 111                         .SubClass               = 0x02,
 112                         .Protocol               = 0x01,
 113
 114                         .InterfaceStrIndex      = NO_DESCRIPTOR
 115                 },
 116
 117         .CDC_Functional_IntHeader =
 118                 {
 119                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 120                         .SubType                = 0x00,
 121
 122                         .Data                   = {0x01, 0x10}
 123                 },
 124
 125         .CDC_Functional_CallManagement =
 126                 {
 127                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 128                         .SubType                = 0x01,
 129
 130                         .Data                   = {0x03, 0x01}
 131                 },
 132
 133         .CDC_Functional_AbstractControlManagement =
 134                 {
 135                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 136                         .SubType                = 0x02,
 137
 138                         .Data                   = {0x06}
 139                 },
 140
 141         .CDC_Functional_Union =
 142                 {
 143                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 144                         .SubType                = 0x06,
 145
 146                         .Data                   = {0x00, 0x01}
 147                 },
 148
 149         .ManagementEndpoint =
 150                 {
 151                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 152
 153                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
 154                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 155                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 156                         .PollingIntervalMS      = 0xFF
 157                 },
 158
 159         .DCI_Interface =
 160                 {
 161                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 162
 163                         .InterfaceNumber        = 1,
 164                         .AlternateSetting       = 0,
 165
 166                         .TotalEndpoints         = 2,
 167
 168                         .Class                  = 0x0A,
 169                         .SubClass               = 0x00,
 170                         .Protocol               = 0x00,
 171
 172                         .InterfaceStrIndex      = NO_DESCRIPTOR
 173                 },
 174
 175         .DataOutEndpoint =
 176                 {
 177                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 178
 179                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
 180                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 181                         .EndpointSize           = CDC_TXRX_EPSIZE,
 182                         .PollingIntervalMS      = 0x00
 183                 },
 184
 185         .DataInEndpoint =
 186                 {
 187                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 188
 189                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
 190                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 191                         .EndpointSize           = CDC_TXRX_EPSIZE,
 192                         .PollingIntervalMS      = 0x00
 193                 }
 194 };
 195
 196 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 197  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 198  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 199  */
 200 USB_Descriptor_String_t PROGMEM LanguageString =
 201 {
 202         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 203
 204         .UnicodeString          = {LANGUAGE_ID_ENG}
 205 };
 206
 207 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 208  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 209  *  Descriptor.
 210  */
 211 USB_Descriptor_String_t PROGMEM ManufacturerString =
 212 {
 213         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 214
 215         .UnicodeString          = L"Dean Camera"
 216 };
 217
 218 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 219  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 220  *  Descriptor.
 221  */
 222 USB_Descriptor_String_t PROGMEM ProductString =
 223 {
 224         .Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
 225
 226         .UnicodeString          = L"LUFA CDC Demo"
 227 };
 228
 229 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 230  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 231  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 232  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 233  *  USB host.
 234  */
 235 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 236 {
 237         const uint8_t  DescriptorType   = (wValue >> 8);
 238         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 239
 240         void*          Address = NULL;
 241         uint16_t       Size    = NO_DESCRIPTOR;
 242
 243         switch (DescriptorType)
 244         {
 245                 case DTYPE_Device:
 246                         Address = (void*)&DeviceDescriptor;
 247                         Size    = sizeof(USB_Descriptor_Device_t);
 248                         break;
 249                 case DTYPE_Configuration:
 250                         Address = (void*)&ConfigurationDescriptor;
 251                         Size    = sizeof(USB_Descriptor_Configuration_t);
 252                         break;
 253                 case DTYPE_String:
 254                         switch (DescriptorNumber)
 255                         {
 256                                 case 0x00:
 257                                         Address = (void*)&LanguageString;
 258                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 259                                         break;
 260                                 case 0x01:
 261                                         Address = (void*)&ManufacturerString;
 262                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 263                                         break;
 264                                 case 0x02:
 265                                         Address = (void*)&ProductString;
 266                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 267                                         break;
 268                         }
 269
 270                         break;
 271         }
 272
 273         *DescriptorAddress = Address;
 274         return Size;
 275 }