Demos/Device/ClassDriver/VirtualSerialMassStorage/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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
  41 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  42  *  device characteristics, including the supported USB version, control endpoint size and the
  43  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  44  *  process begins.
  45  */
  46 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  47 {
  48         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  49
  50         .USBSpecification       = VERSION_BCD(01.10),
  51         .Class                  = USB_CSCP_IADDeviceClass,
  52         .SubClass               = USB_CSCP_IADDeviceSubclass,
  53         .Protocol               = USB_CSCP_IADDeviceProtocol,
  54
  55         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  56
  57         .VendorID               = 0x03EB,
  58         .ProductID              = 0x2068,
  59         .ReleaseNumber          = VERSION_BCD(00.01),
  60
  61         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  62         .ProductStrIndex        = STRING_ID_Product,
  63         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  64
  65         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  66 };
  67
  68 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  69  *  of the device in one of its supported configurations, including information about any device interfaces
  70  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  71  *  a configuration so that the host may correctly communicate with the USB device.
  72  */
  73 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  74 {
  75         .Config =
  76                 {
  77                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  78
  79                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  80                         .TotalInterfaces        = 3,
  81
  82                         .ConfigurationNumber    = 1,
  83                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  84
  85                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  86
  87                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  88                 },
  89
  90         .CDC_IAD =
  91                 {
  92                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
  93
  94                         .FirstInterfaceIndex    = INTERFACE_ID_CDC_CCI,
  95                         .TotalInterfaces        = 2,
  96
  97                         .Class                  = CDC_CSCP_CDCClass,
  98                         .SubClass               = CDC_CSCP_ACMSubclass,
  99                         .Protocol               = CDC_CSCP_ATCommandProtocol,
 100
 101                         .IADStrIndex            = NO_DESCRIPTOR
 102                 },
 103
 104         .CDC_CCI_Interface =
 105                 {
 106                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 107
 108                         .InterfaceNumber        = INTERFACE_ID_CDC_CCI,
 109                         .AlternateSetting       = 0,
 110
 111                         .TotalEndpoints         = 1,
 112
 113                         .Class                  = CDC_CSCP_CDCClass,
 114                         .SubClass               = CDC_CSCP_ACMSubclass,
 115                         .Protocol               = CDC_CSCP_ATCommandProtocol,
 116
 117                         .InterfaceStrIndex      = NO_DESCRIPTOR
 118                 },
 119
 120         .CDC_Functional_Header =
 121                 {
 122                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
 123                         .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
 124
 125                         .CDCSpecification       = VERSION_BCD(01.10),
 126                 },
 127
 128         .CDC_Functional_ACM =
 129                 {
 130                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
 131                         .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
 132
 133                         .Capabilities           = 0x06,
 134                 },
 135
 136         .CDC_Functional_Union =
 137                 {
 138                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
 139                         .Subtype                = CDC_DSUBTYPE_CSInterface_Union,
 140
 141                         .MasterInterfaceNumber  = INTERFACE_ID_CDC_CCI,
 142                         .SlaveInterfaceNumber   = INTERFACE_ID_CDC_DCI,
 143                 },
 144
 145         .CDC_NotificationEndpoint =
 146                 {
 147                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 148
 149                         .EndpointAddress        = CDC_NOTIFICATION_EPADDR,
 150                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 151                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 152                         .PollingIntervalMS      = 0xFF
 153                 },
 154
 155         .CDC_DCI_Interface =
 156                 {
 157                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 158
 159                         .InterfaceNumber        = INTERFACE_ID_CDC_DCI,
 160                         .AlternateSetting       = 0,
 161
 162                         .TotalEndpoints         = 2,
 163
 164                         .Class                  = CDC_CSCP_CDCDataClass,
 165                         .SubClass               = CDC_CSCP_NoDataSubclass,
 166                         .Protocol               = CDC_CSCP_NoDataProtocol,
 167
 168                         .InterfaceStrIndex      = NO_DESCRIPTOR
 169                 },
 170
 171         .CDC_DataOutEndpoint =
 172                 {
 173                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 174
 175                         .EndpointAddress        = CDC_RX_EPADDR,
 176                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 177                         .EndpointSize           = CDC_TXRX_EPSIZE,
 178                         .PollingIntervalMS      = 0x05
 179                 },
 180
 181         .CDC_DataInEndpoint =
 182                 {
 183                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 184
 185                         .EndpointAddress        = CDC_TX_EPADDR,
 186                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 187                         .EndpointSize           = CDC_TXRX_EPSIZE,
 188                         .PollingIntervalMS      = 0x05
 189                 },
 190
 191         .MS_Interface =
 192                 {
 193                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 194
 195                         .InterfaceNumber        = INTERFACE_ID_MassStorage,
 196                         .AlternateSetting       = 0,
 197
 198                         .TotalEndpoints         = 2,
 199
 200                         .Class                  = MS_CSCP_MassStorageClass,
 201                         .SubClass               = MS_CSCP_SCSITransparentSubclass,
 202                         .Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
 203
 204                         .InterfaceStrIndex      = NO_DESCRIPTOR
 205                 },
 206
 207         .MS_DataInEndpoint =
 208                 {
 209                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 210
 211                         .EndpointAddress        = MASS_STORAGE_IN_EPADDR,
 212                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 213                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 214                         .PollingIntervalMS      = 0x05
 215                 },
 216
 217         .MS_DataOutEndpoint =
 218                 {
 219                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 220
 221                         .EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
 222                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 223                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 224                         .PollingIntervalMS      = 0x05
 225                 }
 226 };
 227
 228 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 229  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 230  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 231  */
 232 const USB_Descriptor_String_t PROGMEM LanguageString =
 233 {
 234         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 235
 236         .UnicodeString          = {LANGUAGE_ID_ENG}
 237 };
 238
 239 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 240  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 241  *  Descriptor.
 242  */
 243 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 244 {
 245         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 246
 247         .UnicodeString          = L"Dean Camera"
 248 };
 249
 250 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 251  *  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 ProductString =
 255 {
 256         .Header                 = {.Size = USB_STRING_LEN(30), .Type = DTYPE_String},
 257
 258         .UnicodeString          = L"LUFA CDC and Mass Storage Demo"
 259 };
 260
 261 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 262  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 263  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 264  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 265  *  USB host.
 266  */
 267 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 268                                     const uint8_t wIndex,
 269                                     const void** const DescriptorAddress)
 270 {
 271         const uint8_t  DescriptorType   = (wValue >> 8);
 272         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 273
 274         const void* Address = NULL;
 275         uint16_t    Size    = NO_DESCRIPTOR;
 276
 277         switch (DescriptorType)
 278         {
 279                 case DTYPE_Device:
 280                         Address = &DeviceDescriptor;
 281                         Size    = sizeof(USB_Descriptor_Device_t);
 282                         break;
 283                 case DTYPE_Configuration:
 284                         Address = &ConfigurationDescriptor;
 285                         Size    = sizeof(USB_Descriptor_Configuration_t);
 286                         break;
 287                 case DTYPE_String:
 288                         switch (DescriptorNumber)
 289                         {
 290                                 case STRING_ID_Language:
 291                                         Address = &LanguageString;
 292                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 293                                         break;
 294                                 case STRING_ID_Manufacturer:
 295                                         Address = &ManufacturerString;
 296                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 297                                         break;
 298                                 case STRING_ID_Product:
 299                                         Address = &ProductString;
 300                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 301                                         break;
 302                         }
 303
 304                         break;
 305         }
 306
 307         *DescriptorAddress = Address;
 308         return Size;
 309 }
 310