Demos/Device/MassStorage/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 /** 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 USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  46 {
  47         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  48
  49         .USBSpecification       = VERSION_BCD(01.10),
  50         .Class                  = 0x00,
  51         .SubClass               = 0x00,
  52         .Protocol               = 0x00,
  53
  54         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  55
  56         .VendorID               = 0x03EB,
  57         .ProductID              = 0x2045,
  58         .ReleaseNumber          = 0x0000,
  59
  60         .ManufacturerStrIndex   = 0x01,
  61         .ProductStrIndex        = 0x02,
  62         .SerialNumStrIndex      = 0x03,
  63
  64         .NumberOfConfigurations = 1
  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 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        = 1,
  80
  81                         .ConfigurationNumber    = 1,
  82                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  83
  84                         .ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
  85
  86                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  87                 },
  88
  89         .Interface =
  90                 {
  91                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  92
  93                         .InterfaceNumber        = 0,
  94                         .AlternateSetting       = 0,
  95
  96                         .TotalEndpoints         = 2,
  97
  98                         .Class                  = 0x08,
  99                         .SubClass               = 0x06,
 100                         .Protocol               = 0x50,
 101
 102                         .InterfaceStrIndex      = NO_DESCRIPTOR
 103                 },
 104
 105         .DataInEndpoint =
 106                 {
 107                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 108
 109                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MASS_STORAGE_IN_EPNUM),
 110                         .Attributes             = EP_TYPE_BULK,
 111                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 112                         .PollingIntervalMS      = 0x00
 113                 },
 114
 115         .DataOutEndpoint =
 116                 {
 117                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 118
 119                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | MASS_STORAGE_OUT_EPNUM),
 120                         .Attributes             = EP_TYPE_BULK,
 121                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 122                         .PollingIntervalMS      = 0x00
 123                 }
 124 };
 125
 126 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 127  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 128  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 129  */
 130 USB_Descriptor_String_t PROGMEM LanguageString =
 131 {
 132         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 133
 134         .UnicodeString          = {LANGUAGE_ID_ENG}
 135 };
 136
 137 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 138  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 139  *  Descriptor.
 140  */
 141 USB_Descriptor_String_t PROGMEM ManufacturerString =
 142 {
 143         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 144
 145         .UnicodeString          = L"Dean Camera"
 146 };
 147
 148 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 149  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 150  *  Descriptor.
 151  */
 152 USB_Descriptor_String_t PROGMEM ProductString =
 153 {
 154         .Header                 = {.Size = USB_STRING_LEN(22), .Type = DTYPE_String},
 155
 156         .UnicodeString          = L"LUFA Mass Storage Demo"
 157 };
 158
 159 /** Serial number descriptor string. This is a Unicode string containing a string of HEX characters at least 12
 160  *  digits in length to uniquely identify a device when concatenated with the device's Vendor and Product IDs. By
 161  *  using the unique serial number string to identify a device, the device drivers do not need to be reinstalled
 162  *  each time the device is inserted into a different USB port on the same system. <b>This should be unique between
 163  *  devices, or conflicts will occur if two devices sharing the same serial number are inserted into the same system
 164  *  at the same time.</b>
 165  */
 166 USB_Descriptor_String_t PROGMEM SerialNumberString =
 167 {
 168         .Header                 = {.Size = USB_STRING_LEN(12), .Type = DTYPE_String},
 169
 170         .UnicodeString          = L"000000000000"
 171 };
 172
 173 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 174  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 175  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 176  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 177  *  USB host.
 178  */
 179 uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 180 {
 181         const uint8_t  DescriptorType   = (wValue >> 8);
 182         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 183
 184         void*    Address = NULL;
 185         uint16_t Size    = NO_DESCRIPTOR;
 186
 187         switch (DescriptorType)
 188         {
 189                 case DTYPE_Device:
 190                         Address = DESCRIPTOR_ADDRESS(DeviceDescriptor);
 191                         Size    = sizeof(USB_Descriptor_Device_t);
 192                         break;
 193                 case DTYPE_Configuration:
 194                         Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor);
 195                         Size    = sizeof(USB_Descriptor_Configuration_t);
 196                         break;
 197                 case DTYPE_String:
 198                         switch (DescriptorNumber)
 199                         {
 200                                 case 0x00:
 201                                         Address = DESCRIPTOR_ADDRESS(LanguageString);
 202                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 203                                         break;
 204                                 case 0x01:
 205                                         Address = DESCRIPTOR_ADDRESS(ManufacturerString);
 206                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 207                                         break;
 208                                 case 0x02:
 209                                         Address = DESCRIPTOR_ADDRESS(ProductString);
 210                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 211                                         break;
 212                                 case 0x03:
 213                                         Address = DESCRIPTOR_ADDRESS(SerialNumberString);
 214                                         Size    = pgm_read_byte(&SerialNumberString.Header.Size);
 215                                         break;
 216                         }
 217
 218                         break;
 219         }
 220
 221         *DescriptorAddress = Address;
 222         return Size;
 223 }