Demos/OTG/TestApp/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          = 8,
  55
  56         .VendorID               = 0x03EB,
  57         .ProductID              = 0x2040,
  58         .ReleaseNumber          = 0x0000,
  59
  60         .ManufacturerStrIndex   = 0x01,
  61         .ProductStrIndex        = 0x02,
  62         .SerialNumStrIndex      = NO_DESCRIPTOR,
  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_Header_t)
  79                                                    + sizeof(USB_Descriptor_Interface_t)           ),
  80
  81                         .TotalInterfaces        = 1,
  82
  83                         .ConfigurationNumber    = 1,
  84                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  85
  86                         .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
  87
  88                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  89                 },
  90
  91         .Interface =
  92                 {
  93                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  94
  95                         .InterfaceNumber        = 1,
  96                         .AlternateSetting       = 0,
  97
  98                         .TotalEndpoints         = 0,
  99
 100                         .Class                  = 0xFF,
 101                         .SubClass               = 0x00,
 102                         .Protocol               = 0x00,
 103
 104                         .InterfaceStrIndex      = NO_DESCRIPTOR
 105                 },
 106 };
 107
 108 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 109  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 110  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 111  */
 112 USB_Descriptor_String_t PROGMEM LanguageString =
 113 {
 114         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 115
 116         .UnicodeString          = {LANGUAGE_ID_ENG}
 117 };
 118
 119 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 120  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 121  *  Descriptor.
 122  */
 123 USB_Descriptor_String_t PROGMEM ManufacturerString =
 124 {
 125         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 126
 127         .UnicodeString          = L"Dean Camera"
 128 };
 129
 130 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 131  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 132  *  Descriptor.
 133  */
 134 USB_Descriptor_String_t PROGMEM ProductString =
 135 {
 136         .Header                 = {.Size = USB_STRING_LEN(9), .Type = DTYPE_String},
 137
 138         .UnicodeString          = L"LUFA Demo"
 139 };
 140
 141 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 142  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 143  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 144  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 145  *  USB host.
 146  */
 147 uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 148 {
 149         const uint8_t  DescriptorType   = (wValue >> 8);
 150         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 151
 152         void*    Address = NULL;
 153         uint16_t Size    = NO_DESCRIPTOR;
 154
 155         switch (DescriptorType)
 156         {
 157                 case DTYPE_Device:
 158                         Address = DESCRIPTOR_ADDRESS(DeviceDescriptor);
 159                         Size    = sizeof(USB_Descriptor_Device_t);
 160                         break;
 161                 case DTYPE_Configuration:
 162                         Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor);
 163                         Size    = sizeof(USB_Descriptor_Configuration_t);
 164                         break;
 165                 case DTYPE_String:
 166                         switch (DescriptorNumber)
 167                         {
 168                                 case 0x00:
 169                                         Address = DESCRIPTOR_ADDRESS(LanguageString);
 170                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 171                                         break;
 172                                 case 0x01:
 173                                         Address = DESCRIPTOR_ADDRESS(ManufacturerString);
 174                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 175                                         break;
 176                                 case 0x02:
 177                                         Address = DESCRIPTOR_ADDRESS(ProductString);
 178                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 179                                         break;
 180                         }
 181
 182                         break;
 183         }
 184
 185         *DescriptorAddress = Address;
 186         return Size;
 187 }