Projects/Incomplete/StandaloneProgrammer/Descriptors.c

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