Projects/Webserver/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2019.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2019  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(2,0,0),
  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              = 0x2069,
  59         .ReleaseNumber          = VERSION_BCD(0,0,2),
  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,
  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_VendorSpecificProtocol,
 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_VendorSpecificProtocol,
 116
 117                         .InterfaceStrIndex      = NO_DESCRIPTOR
 118                 },
 119
 120         .CDC_Functional_Header =
 121                 {
 122                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = CDC_DTYPE_CSInterface},
 123                         .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
 124
 125                         .CDCSpecification       = VERSION_BCD(1,1,0),
 126                 },
 127
 128         .CDC_Functional_ACM =
 129                 {
 130                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = CDC_DTYPE_CSInterface},
 131                         .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
 132
 133                         .Capabilities           = 0x00,
 134                 },
 135
 136         .CDC_Functional_Union =
 137                 {
 138                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = CDC_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         .RNDIS_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         .RNDIS_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 = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 233
 234 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 235  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 236  *  Descriptor.
 237  */
 238 const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
 239
 240 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 241  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 242  *  Descriptor.
 243  */
 244 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Webserver");
 245
 246 /** Microsoft OS Compatibility string descriptor. This is a special string descriptor that Microsoft based OS hosts
 247  *  will query at string descriptor ID 0xEE on initial enumeration, to test if the device supports the Microsoft OS
 248  *  Compatibility descriptor extensions (used to give the host additional information on the device's general class
 249  *  compatibility for driver-less installation).
 250  */
 251 const USB_Descriptor_String_t PROGMEM MSConpatibilityString = USB_STRING_DESCRIPTOR_ARRAY('M','S','F','T','1','0','0', VENDOR_REQUEST_ID_MS_COMPAT);
 252
 253 /** Microsoft OS Compatibility 1.0 descriptor. This is a special descriptor returned by the device on vendor request
 254  *  from the host, giving the OS additional compatibility information. This allows the host to automatically install
 255  *  the appropriate driver for various devices which share a common USB class (in this case RNDIS, which uses the
 256  *  CDC-ACM class usually used by virtual to serial adapters).
 257  */
 258 const USB_Descriptor_MSCompatibility_t PROGMEM MSCompatibilityDescriptor =
 259         {
 260                 .dwLength                   = sizeof(USB_Descriptor_MSCompatibility_t),
 261                 .bcdVersion                 = VERSION_BCD(1,0,0),
 262                 .wIndex                     = 4,
 263                 .bCount                     = 1,
 264                 .bReserved                  = { 0 },
 265                 .bFirstInterfaceNumber      = INTERFACE_ID_CDC_CCI,
 266                 .bReserved2                 = 1, // Must always be 1 according to spec
 267                 .compatibleID               = "RNDIS",
 268                 .subCompatibleID            = "5162001",
 269                 .bReserved3                 = { 0 },
 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 uint16_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 STRING_ID_Language:
 302                                         Address = &LanguageString;
 303                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 304                                         break;
 305                                 case STRING_ID_Manufacturer:
 306                                         Address = &ManufacturerString;
 307                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 308                                         break;
 309                                 case STRING_ID_Product:
 310                                         Address = &ProductString;
 311                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 312                                         break;
 313                                 case STRING_ID_MS_Compat:
 314                                         Address = &MSConpatibilityString;
 315                                         Size    = pgm_read_byte(&MSConpatibilityString.Header.Size);
 316                                         break;
 317                         }
 318
 319                         break;
 320         }
 321
 322         *DescriptorAddress = Address;
 323         return Size;
 324 }
 325
 326 /** Sends the special Microsoft OS Compatibility Descriptor to the host PC, if
 327  *  the host is requesting it.
 328  */
 329 void CheckIfMSCompatibilityDescriptorRequest(void)
 330 {
 331         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))
 332         {
 333                 if (USB_ControlRequest.bRequest == VENDOR_REQUEST_ID_MS_COMPAT)
 334                 {
 335                         Endpoint_ClearSETUP();
 336
 337                         /* Write the OS compatibility descriptor to the control endpoint */
 338                         Endpoint_Write_Control_PStream_LE(&MSCompatibilityDescriptor, sizeof(MSCompatibilityDescriptor));
 339                         Endpoint_ClearOUT();
 340                 }
 341         }
 342 }