Demos/Device/LowLevel/MassStorage/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 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 /* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
  41  * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
  42  * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
  43  * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
  44  * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
  45  * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
  46  * port location).
  47  */
  48 #if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
  49         #warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
  50 #endif
  51
  52 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  53  *  device characteristics, including the supported USB version, control endpoint size and the
  54  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  55  *  process begins.
  56  */
  57 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  58 {
  59         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  60
  61         .USBSpecification       = VERSION_BCD(01.10),
  62         .Class                  = USB_CSCP_NoDeviceClass,
  63         .SubClass               = USB_CSCP_NoDeviceSubclass,
  64         .Protocol               = USB_CSCP_NoDeviceProtocol,
  65
  66         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  67
  68         .VendorID               = 0x03EB,
  69         .ProductID              = 0x2045,
  70         .ReleaseNumber          = VERSION_BCD(00.01),
  71
  72         .ManufacturerStrIndex   = 0x01,
  73         .ProductStrIndex        = 0x02,
  74         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  75
  76         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  77 };
  78
  79 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  80  *  of the device in one of its supported configurations, including information about any device interfaces
  81  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  82  *  a configuration so that the host may correctly communicate with the USB device.
  83  */
  84 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  85 {
  86         .Config =
  87                 {
  88                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  89
  90                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  91                         .TotalInterfaces        = 1,
  92
  93                         .ConfigurationNumber    = 1,
  94                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  95
  96                         .ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
  97
  98                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  99                 },
 100
 101         .MS_Interface =
 102                 {
 103                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 104
 105                         .InterfaceNumber        = 0,
 106                         .AlternateSetting       = 0,
 107
 108                         .TotalEndpoints         = 2,
 109
 110                         .Class                  = MS_CSCP_MassStorageClass,
 111                         .SubClass               = MS_CSCP_SCSITransparentSubclass,
 112                         .Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
 113
 114                         .InterfaceStrIndex      = NO_DESCRIPTOR
 115                 },
 116
 117         .MS_DataInEndpoint =
 118                 {
 119                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 120
 121                         .EndpointAddress        = (ENDPOINT_DIR_IN | MASS_STORAGE_IN_EPNUM),
 122                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 123                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 124                         .PollingIntervalMS      = 0x01
 125                 },
 126
 127         .MS_DataOutEndpoint =
 128                 {
 129                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 130
 131                         .EndpointAddress        = (ENDPOINT_DIR_OUT | MASS_STORAGE_OUT_EPNUM),
 132                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 133                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 134                         .PollingIntervalMS      = 0x01
 135                 }
 136 };
 137
 138 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 139  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 140  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 141  */
 142 const USB_Descriptor_String_t PROGMEM LanguageString =
 143 {
 144         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 145
 146         .UnicodeString          = {LANGUAGE_ID_ENG}
 147 };
 148
 149 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 150  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 151  *  Descriptor.
 152  */
 153 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 154 {
 155         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 156
 157         .UnicodeString          = L"Dean Camera"
 158 };
 159
 160 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 161  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 162  *  Descriptor.
 163  */
 164 const USB_Descriptor_String_t PROGMEM ProductString =
 165 {
 166         .Header                 = {.Size = USB_STRING_LEN(22), .Type = DTYPE_String},
 167
 168         .UnicodeString          = L"LUFA Mass Storage Demo"
 169 };
 170
 171 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 172  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 173  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 174  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 175  *  USB host.
 176  */
 177 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 178                                     const uint8_t wIndex,
 179                                     const void** const DescriptorAddress)
 180 {
 181         const uint8_t  DescriptorType   = (wValue >> 8);
 182         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 183
 184         const void* Address = NULL;
 185         uint16_t    Size    = NO_DESCRIPTOR;
 186
 187         switch (DescriptorType)
 188         {
 189                 case DTYPE_Device:
 190                         Address = &DeviceDescriptor;
 191                         Size    = sizeof(USB_Descriptor_Device_t);
 192                         break;
 193                 case DTYPE_Configuration:
 194                         Address = &ConfigurationDescriptor;
 195                         Size    = sizeof(USB_Descriptor_Configuration_t);
 196                         break;
 197                 case DTYPE_String:
 198                         switch (DescriptorNumber)
 199                         {
 200                                 case 0x00:
 201                                         Address = &LanguageString;
 202                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 203                                         break;
 204                                 case 0x01:
 205                                         Address = &ManufacturerString;
 206                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 207                                         break;
 208                                 case 0x02:
 209                                         Address = &ProductString;
 210                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 211                                         break;
 212                         }
 213
 214                         break;
 215         }
 216
 217         *DescriptorAddress = Address;
 218         return Size;
 219 }
 220