Demos/Device/ClassDriver/RNDISEthernet/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  41  *  device characteristics, including the supported USB version, control endpoint size and the
  42  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  43  *  process begins.
  44  */
  45 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  46 {
  47         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  48
  49         .USBSpecification       = VERSION_BCD(2,0,0),
  50         .Class                  = CDC_CSCP_CDCClass,
  51         .SubClass               = CDC_CSCP_NoSpecificSubclass,
  52         .Protocol               = CDC_CSCP_NoSpecificProtocol,
  53
  54         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  55
  56         .VendorID               = 0x03EB,
  57         .ProductID              = 0x204C,
  58         .ReleaseNumber          = VERSION_BCD(0,0,2),
  59
  60         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  61         .ProductStrIndex        = STRING_ID_Product,
  62         .SerialNumStrIndex      = NO_DESCRIPTOR,
  63
  64         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  65 };
  66
  67 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  68  *  of the device in one of its supported configurations, including information about any device interfaces
  69  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  70  *  a configuration so that the host may correctly communicate with the USB device.
  71  */
  72 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  73 {
  74         .Config =
  75                 {
  76                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  77
  78                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  79                         .TotalInterfaces        = 2,
  80
  81                         .ConfigurationNumber    = 1,
  82                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  83
  84                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  85
  86                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  87                 },
  88
  89         .CDC_CCI_Interface =
  90                 {
  91                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  92
  93                         .InterfaceNumber        = INTERFACE_ID_CDC_CCI,
  94                         .AlternateSetting       = 0,
  95
  96                         .TotalEndpoints         = 1,
  97
  98                         .Class                  = CDC_CSCP_CDCClass,
  99                         .SubClass               = CDC_CSCP_ACMSubclass,
 100                         .Protocol               = CDC_CSCP_VendorSpecificProtocol,
 101
 102                         .InterfaceStrIndex      = NO_DESCRIPTOR
 103                 },
 104
 105         .CDC_Functional_Header =
 106                 {
 107                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = CDC_DTYPE_CSInterface},
 108                         .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
 109
 110                         .CDCSpecification       = VERSION_BCD(1,1,0),
 111                 },
 112
 113         .CDC_Functional_ACM =
 114                 {
 115                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = CDC_DTYPE_CSInterface},
 116                         .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
 117
 118                         .Capabilities           = 0x00,
 119                 },
 120
 121         .CDC_Functional_Union =
 122                 {
 123                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = CDC_DTYPE_CSInterface},
 124                         .Subtype                = CDC_DSUBTYPE_CSInterface_Union,
 125
 126                         .MasterInterfaceNumber  = INTERFACE_ID_CDC_CCI,
 127                         .SlaveInterfaceNumber   = INTERFACE_ID_CDC_DCI,
 128                 },
 129
 130         .CDC_NotificationEndpoint =
 131                 {
 132                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 133
 134                         .EndpointAddress        = CDC_NOTIFICATION_EPADDR,
 135                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 136                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 137                         .PollingIntervalMS      = 0xFF
 138                 },
 139
 140         .CDC_DCI_Interface =
 141                 {
 142                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 143
 144                         .InterfaceNumber        = INTERFACE_ID_CDC_DCI,
 145                         .AlternateSetting       = 0,
 146
 147                         .TotalEndpoints         = 2,
 148
 149                         .Class                  = CDC_CSCP_CDCDataClass,
 150                         .SubClass               = CDC_CSCP_NoDataSubclass,
 151                         .Protocol               = CDC_CSCP_NoDataProtocol,
 152
 153                         .InterfaceStrIndex      = NO_DESCRIPTOR
 154                 },
 155
 156         .RNDIS_DataOutEndpoint =
 157                 {
 158                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 159
 160                         .EndpointAddress        = CDC_RX_EPADDR,
 161                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 162                         .EndpointSize           = CDC_TXRX_EPSIZE,
 163                         .PollingIntervalMS      = 0x05
 164                 },
 165
 166         .RNDIS_DataInEndpoint =
 167                 {
 168                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 169
 170                         .EndpointAddress        = CDC_TX_EPADDR,
 171                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 172                         .EndpointSize           = CDC_TXRX_EPSIZE,
 173                         .PollingIntervalMS      = 0x05
 174                 }
 175 };
 176
 177 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 178  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 179  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 180  */
 181 const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 182
 183 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 184  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 185  *  Descriptor.
 186  */
 187 const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
 188
 189 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 190  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 191  *  Descriptor.
 192  */
 193 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA RNDIS CDC Demo");
 194
 195 /** Microsoft OS Compatibility string descriptor. This is a special string descriptor that Microsoft based OS hosts
 196  *  will query at string descriptor ID 0xEE on initial enumeration, to test if the device supports the Microsoft OS
 197  *  Compatibility descriptor extensions (used to give the host additional information on the device's general class
 198  *  compatibility for driver-less installation).
 199  */
 200 const USB_Descriptor_String_t PROGMEM MSConpatibilityString = USB_STRING_DESCRIPTOR_ARRAY('M','S','F','T','1','0','0', VENDOR_REQUEST_ID_MS_COMPAT);
 201
 202 /** Microsoft OS Compatibility 1.0 descriptor. This is a special descriptor returned by the device on vendor request
 203  *  from the host, giving the OS additional compatibility information. This allows the host to automatically install
 204  *  the appropriate driver for various devices which share a common USB class (in this case RNDIS, which uses the
 205  *  CDC-ACM class usually used by virtual to serial adapters).
 206  */
 207 const USB_Descriptor_MSCompatibility_t PROGMEM MSCompatibilityDescriptor =
 208         {
 209                 .dwLength                   = sizeof(USB_Descriptor_MSCompatibility_t),
 210                 .bcdVersion                 = VERSION_BCD(1,0,0),
 211                 .wIndex                     = 4,
 212                 .bCount                     = 1,
 213                 .bReserved                  = { 0 },
 214                 .bFirstInterfaceNumber      = INTERFACE_ID_CDC_CCI,
 215                 .bReserved2                 = 1, // Must always be 1 according to spec
 216                 .compatibleID               = "RNDIS",
 217                 .subCompatibleID            = "5162001",
 218                 .bReserved3                 = { 0 },
 219         };
 220
 221 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 222  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 223  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 224  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 225  *  USB host.
 226  */
 227 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 228                                     const uint16_t wIndex,
 229                                     const void** const DescriptorAddress)
 230 {
 231         const uint8_t  DescriptorType   = (wValue >> 8);
 232         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 233
 234         const void* Address = NULL;
 235         uint16_t    Size    = NO_DESCRIPTOR;
 236
 237         switch (DescriptorType)
 238         {
 239                 case DTYPE_Device:
 240                         Address = &DeviceDescriptor;
 241                         Size    = sizeof(USB_Descriptor_Device_t);
 242                         break;
 243                 case DTYPE_Configuration:
 244                         Address = &ConfigurationDescriptor;
 245                         Size    = sizeof(USB_Descriptor_Configuration_t);
 246                         break;
 247                 case DTYPE_String:
 248                         switch (DescriptorNumber)
 249                         {
 250                                 case STRING_ID_Language:
 251                                         Address = &LanguageString;
 252                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 253                                         break;
 254                                 case STRING_ID_Manufacturer:
 255                                         Address = &ManufacturerString;
 256                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 257                                         break;
 258                                 case STRING_ID_Product:
 259                                         Address = &ProductString;
 260                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 261                                         break;
 262                                 case STRING_ID_MS_Compat:
 263                                         Address = &MSConpatibilityString;
 264                                         Size    = pgm_read_byte(&MSConpatibilityString.Header.Size);
 265                                         break;
 266                         }
 267
 268                         break;
 269         }
 270
 271         *DescriptorAddress = Address;
 272         return Size;
 273 }
 274
 275 /** Sends the special Microsoft OS Compatibility Descriptor to the host PC, if
 276  *  the host is requesting it.
 277  */
 278 void CheckIfMSCompatibilityDescriptorRequest(void)
 279 {
 280         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))
 281         {
 282                 if (USB_ControlRequest.bRequest == VENDOR_REQUEST_ID_MS_COMPAT)
 283                 {
 284                         Endpoint_ClearSETUP();
 285
 286                         /* Write the OS compatibility descriptor to the control endpoint */
 287                         Endpoint_Write_Control_PStream_LE(&MSCompatibilityDescriptor, sizeof(MSCompatibilityDescriptor));
 288                         Endpoint_ClearOUT();
 289                 }
 290         }
 291 }