Demos/Device/ClassDriver/MassStorageKeyboard/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   Copyright 2010  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaim all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
  35  *  computer-readable structures which the host requests upon device enumeration, to determine
  36  *  the device's capabilities and functions.
  37  */
  38
  39 #include "Descriptors.h"
  40
  41 /* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
  42  * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
  43  * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
  44  * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
  45  * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
  46  * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
  47  * port location).
  48  */
  49 #if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
  50         #warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
  51 #endif
  52
  53 /** HID class report descriptor. This is a special descriptor constructed with values from the
  54  *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
  55  *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
  56  *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
  57  *  more details on HID report descriptors.
  58  */
  59 const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
  60 {
  61         /* Use the HID class driver's standard Keyboard report.
  62          *   Max simultaneous keys: 6
  63          */
  64         HID_DESCRIPTOR_KEYBOARD(6)
  65 };
  66
  67 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  68  *  device characteristics, including the supported USB version, control endpoint size and the
  69  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  70  *  process begins.
  71  */
  72 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  73 {
  74         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  75
  76         .USBSpecification       = VERSION_BCD(01.10),
  77         .Class                  = USB_CSCP_NoDeviceClass,
  78         .SubClass               = USB_CSCP_NoDeviceSubclass,
  79         .Protocol               = USB_CSCP_NoDeviceProtocol,
  80
  81         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  82
  83         .VendorID               = 0x03EB,
  84         .ProductID              = 0x2061,
  85         .ReleaseNumber          = VERSION_BCD(00.01),
  86
  87         .ManufacturerStrIndex   = 0x01,
  88         .ProductStrIndex        = 0x02,
  89         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  90
  91         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  92 };
  93
  94 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  95  *  of the device in one of its supported configurations, including information about any device interfaces
  96  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  97  *  a configuration so that the host may correctly communicate with the USB device.
  98  */
  99 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 100 {
 101         .Config =
 102                 {
 103                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 104
 105                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 106                         .TotalInterfaces        = 2,
 107
 108                         .ConfigurationNumber    = 1,
 109                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 110
 111                         .ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
 112
 113                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 114                 },
 115
 116         .MS_Interface =
 117                 {
 118                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 119
 120                         .InterfaceNumber        = 0,
 121                         .AlternateSetting       = 0,
 122
 123                         .TotalEndpoints         = 2,
 124
 125                         .Class                  = MS_CSCP_MassStorageClass,
 126                         .SubClass               = MS_CSCP_SCSITransparentSubclass,
 127                         .Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
 128
 129                         .InterfaceStrIndex      = NO_DESCRIPTOR
 130                 },
 131
 132         .MS_DataInEndpoint =
 133                 {
 134                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 135
 136                         .EndpointAddress        = MASS_STORAGE_IN_EPADDR,
 137                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 138                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 139                         .PollingIntervalMS      = 0x05
 140                 },
 141
 142         .MS_DataOutEndpoint =
 143                 {
 144                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 145
 146                         .EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
 147                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 148                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 149                         .PollingIntervalMS      = 0x05
 150                 },
 151
 152         .HID_KeyboardInterface =
 153                 {
 154                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 155
 156                         .InterfaceNumber        = 1,
 157                         .AlternateSetting       = 0,
 158
 159                         .TotalEndpoints         = 1,
 160
 161                         .Class                  = HID_CSCP_HIDClass,
 162                         .SubClass               = HID_CSCP_BootSubclass,
 163                         .Protocol               = HID_CSCP_KeyboardBootProtocol,
 164
 165                         .InterfaceStrIndex      = NO_DESCRIPTOR
 166                 },
 167
 168         .HID_KeyboardHID =
 169                 {
 170                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 171
 172                         .HIDSpec                = VERSION_BCD(01.11),
 173                         .CountryCode            = 0x00,
 174                         .TotalReportDescriptors = 1,
 175                         .HIDReportType          = HID_DTYPE_Report,
 176                         .HIDReportLength        = sizeof(KeyboardReport)
 177                 },
 178
 179         .HID_ReportINEndpoint =
 180                 {
 181                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 182
 183                         .EndpointAddress        = KEYBOARD_EPADDR,
 184                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 185                         .EndpointSize           = KEYBOARD_EPSIZE,
 186                         .PollingIntervalMS      = 0x05
 187                 },
 188 };
 189
 190 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 191  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 192  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 193  */
 194 const USB_Descriptor_String_t PROGMEM LanguageString =
 195 {
 196         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 197
 198         .UnicodeString          = {LANGUAGE_ID_ENG}
 199 };
 200
 201 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 202  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 203  *  Descriptor.
 204  */
 205 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 206 {
 207         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 208
 209         .UnicodeString          = L"Dean Camera"
 210 };
 211
 212 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 213  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 214  *  Descriptor.
 215  */
 216 const USB_Descriptor_String_t PROGMEM ProductString =
 217 {
 218         .Header                 = {.Size = USB_STRING_LEN(35), .Type = DTYPE_String},
 219
 220         .UnicodeString          = L"LUFA Mass Storage and Keyboard Demo"
 221 };
 222
 223 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 224  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 225  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 226  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 227  *  USB host.
 228  */
 229 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 230                                     const uint8_t wIndex,
 231                                     const void** const DescriptorAddress)
 232 {
 233         const uint8_t  DescriptorType   = (wValue >> 8);
 234         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 235
 236         const void* Address = NULL;
 237         uint16_t    Size    = NO_DESCRIPTOR;
 238
 239         switch (DescriptorType)
 240         {
 241                 case DTYPE_Device:
 242                         Address = &DeviceDescriptor;
 243                         Size    = sizeof(USB_Descriptor_Device_t);
 244                         break;
 245                 case DTYPE_Configuration:
 246                         Address = &ConfigurationDescriptor;
 247                         Size    = sizeof(USB_Descriptor_Configuration_t);
 248                         break;
 249                 case DTYPE_String:
 250                         switch (DescriptorNumber)
 251                         {
 252                                 case 0x00:
 253                                         Address = &LanguageString;
 254                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 255                                         break;
 256                                 case 0x01:
 257                                         Address = &ManufacturerString;
 258                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 259                                         break;
 260                                 case 0x02:
 261                                         Address = &ProductString;
 262                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 263                                         break;
 264                         }
 265
 266                         break;
 267                 case HID_DTYPE_HID:
 268                         Address = &ConfigurationDescriptor.HID_KeyboardHID;
 269                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 270                         break;
 271                 case HID_DTYPE_Report:
 272                         Address = &KeyboardReport;
 273                         Size    = sizeof(KeyboardReport);
 274                         break;
 275         }
 276
 277         *DescriptorAddress = Address;
 278         return Size;
 279 }
 280