Demos/Device/ClassDriver/VirtualSerialMassStorage/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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              = 0x2068,
  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        = 3,
  92
  93                         .ConfigurationNumber    = 1,
  94                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  95
  96                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  97
  98                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  99                 },
 100
 101         .CDC_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         .CDC_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         .CDC_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         .CDC_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         .CDC_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         .CDC_NotificationEndpoint =
 157                 {
 158                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 159
 160                         .EndpointAddress        = (ENDPOINT_DIR_IN | CDC_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         .CDC_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         .CDC_DataOutEndpoint =
 183                 {
 184                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 185
 186                         .EndpointAddress        = (ENDPOINT_DIR_OUT | CDC_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         .CDC_DataInEndpoint =
 193                 {
 194                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 195
 196                         .EndpointAddress        = (ENDPOINT_DIR_IN | CDC_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         .MS_Interface =
 203                 {
 204                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 205
 206                         .InterfaceNumber        = 2,
 207                         .AlternateSetting       = 0,
 208
 209                         .TotalEndpoints         = 2,
 210
 211                         .Class                  = MS_CSCP_MassStorageClass,
 212                         .SubClass               = MS_CSCP_SCSITransparentSubclass,
 213                         .Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
 214
 215                         .InterfaceStrIndex      = NO_DESCRIPTOR
 216                 },
 217
 218         .MS_DataInEndpoint =
 219                 {
 220                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 221
 222                         .EndpointAddress        = (ENDPOINT_DIR_IN | MASS_STORAGE_IN_EPNUM),
 223                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 224                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 225                         .PollingIntervalMS      = 0x01
 226                 },
 227
 228         .MS_DataOutEndpoint =
 229                 {
 230                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 231
 232                         .EndpointAddress        = (ENDPOINT_DIR_OUT | MASS_STORAGE_OUT_EPNUM),
 233                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 234                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 235                         .PollingIntervalMS      = 0x01
 236                 }
 237 };
 238
 239 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 240  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 241  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 242  */
 243 const USB_Descriptor_String_t PROGMEM LanguageString =
 244 {
 245         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 246
 247         .UnicodeString          = {LANGUAGE_ID_ENG}
 248 };
 249
 250 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 251  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 252  *  Descriptor.
 253  */
 254 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 255 {
 256         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 257
 258         .UnicodeString          = L"Dean Camera"
 259 };
 260
 261 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 262  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 263  *  Descriptor.
 264  */
 265 const USB_Descriptor_String_t PROGMEM ProductString =
 266 {
 267         .Header                 = {.Size = USB_STRING_LEN(30), .Type = DTYPE_String},
 268
 269         .UnicodeString          = L"LUFA CDC and Mass Storage Demo"
 270 };
 271
 272 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 273  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 274  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 275  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 276  *  USB host.
 277  */
 278 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 279                                     const uint8_t wIndex,
 280                                     const void** const DescriptorAddress)
 281 {
 282         const uint8_t  DescriptorType   = (wValue >> 8);
 283         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 284
 285         const void* Address = NULL;
 286         uint16_t    Size    = NO_DESCRIPTOR;
 287
 288         switch (DescriptorType)
 289         {
 290                 case DTYPE_Device:
 291                         Address = &DeviceDescriptor;
 292                         Size    = sizeof(USB_Descriptor_Device_t);
 293                         break;
 294                 case DTYPE_Configuration:
 295                         Address = &ConfigurationDescriptor;
 296                         Size    = sizeof(USB_Descriptor_Configuration_t);
 297                         break;
 298                 case DTYPE_String:
 299                         switch (DescriptorNumber)
 300                         {
 301                                 case 0x00:
 302                                         Address = &LanguageString;
 303                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 304                                         break;
 305                                 case 0x01:
 306                                         Address = &ManufacturerString;
 307                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 308                                         break;
 309                                 case 0x02:
 310                                         Address = &ProductString;
 311                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 312                                         break;
 313                         }
 314
 315                         break;
 316         }
 317
 318         *DescriptorAddress = Address;
 319         return Size;
 320 }
 321