Projects/AVRISP-MKII/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 /** 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 const 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                  = USB_CSCP_VendorSpecificClass,
  51         .SubClass               = USB_CSCP_NoDeviceSubclass,
  52         .Protocol               = USB_CSCP_NoDeviceProtocol,
  53
  54         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  55
  56         .VendorID               = CPU_TO_LE16(0x03EB),
  57         .ProductID              = CPU_TO_LE16(0x2104),
  58         .ReleaseNumber          = VERSION_BCD(02.00),
  59
  60         .ManufacturerStrIndex   = 0x01,
  61         .ProductStrIndex        = 0x02,
  62         .SerialNumStrIndex      = 0x03,
  63
  64         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  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 const 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 = CPU_TO_LE16(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         .AVRISP_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                  = USB_CSCP_VendorSpecificClass,
  99                         .SubClass               = 0x00,
 100                         .Protocol               = 0x00,
 101
 102                         .InterfaceStrIndex      = NO_DESCRIPTOR
 103                 },
 104
 105         .AVRISP_DataInEndpoint =
 106                 {
 107                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 108
 109                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | AVRISP_DATA_IN_EPNUM),
 110                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 111                         .EndpointSize           = CPU_TO_LE16(AVRISP_DATA_EPSIZE),
 112                         .PollingIntervalMS      = 0x0A
 113                 },
 114
 115         .AVRISP_DataOutEndpoint =
 116                 {
 117                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 118
 119                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | AVRISP_DATA_OUT_EPNUM),
 120                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 121                         .EndpointSize           = CPU_TO_LE16(AVRISP_DATA_EPSIZE),
 122                         .PollingIntervalMS      = 0x0A
 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 const 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 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 142 {
 143         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 144
 145         .UnicodeString          = {CPU_TO_LE16('D'),
 146                                    CPU_TO_LE16('e'),
 147                                    CPU_TO_LE16('a'),
 148                                    CPU_TO_LE16('n'),
 149                                    CPU_TO_LE16(' '),
 150                                    CPU_TO_LE16('C'),
 151                                    CPU_TO_LE16('a'),
 152                                    CPU_TO_LE16('m'),
 153                                    CPU_TO_LE16('e'),
 154                                    CPU_TO_LE16('r'),
 155                                    CPU_TO_LE16('a')}
 156 };
 157
 158 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 159  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 160  *  Descriptor.
 161  */
 162 const USB_Descriptor_String_t PROGMEM ProductString =
 163 {
 164         .Header                 = {.Size = USB_STRING_LEN(22), .Type = DTYPE_String},
 165
 166         .UnicodeString          = {CPU_TO_LE16('L'),
 167                                    CPU_TO_LE16('U'),
 168                                    CPU_TO_LE16('F'),
 169                                    CPU_TO_LE16('A'),
 170                                    CPU_TO_LE16(' '),
 171                                    CPU_TO_LE16('A'),
 172                                    CPU_TO_LE16('V'),
 173                                    CPU_TO_LE16('R'),
 174                                    CPU_TO_LE16('I'),
 175                                    CPU_TO_LE16('S'),
 176                                    CPU_TO_LE16('P'),
 177                                    CPU_TO_LE16(' '),
 178                                    CPU_TO_LE16('M'),
 179                                    CPU_TO_LE16('k'),
 180                                    CPU_TO_LE16('I'),
 181                                    CPU_TO_LE16('I'),
 182                                    CPU_TO_LE16(' '),
 183                                    CPU_TO_LE16('C'),
 184                                    CPU_TO_LE16('l'),
 185                                    CPU_TO_LE16('o'),
 186                                    CPU_TO_LE16('n'),
 187                                    CPU_TO_LE16('e')}
 188 };
 189
 190 /** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
 191  *  series of uppercase hexadecimal digits.
 192  */
 193 const USB_Descriptor_String_t PROGMEM SerialString =
 194 {
 195         .Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
 196
 197         .UnicodeString          = {CPU_TO_LE16('0'),
 198                                    CPU_TO_LE16('0'),
 199                                    CPU_TO_LE16('0'),
 200                                    CPU_TO_LE16('0'),
 201                                    CPU_TO_LE16('A'),
 202                                    CPU_TO_LE16('0'),
 203                                    CPU_TO_LE16('0'),
 204                                    CPU_TO_LE16('1'),
 205                                    CPU_TO_LE16('2'),
 206                                    CPU_TO_LE16('8'),
 207                                    CPU_TO_LE16('2'),
 208                                    CPU_TO_LE16('5'),
 209                                    CPU_TO_LE16('5')}
 210 };
 211
 212 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 213  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 214  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 215  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 216  *  USB host.
 217  */
 218 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 219                                     const uint8_t wIndex,
 220                                     const void** const DescriptorAddress)
 221 {
 222         const uint8_t  DescriptorType   = (wValue >> 8);
 223         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 224
 225         const void* Address = NULL;
 226         uint16_t    Size    = NO_DESCRIPTOR;
 227
 228         switch (DescriptorType)
 229         {
 230                 case DTYPE_Device:
 231                         Address = &DeviceDescriptor;
 232                         Size    = sizeof(USB_Descriptor_Device_t);
 233                         break;
 234                 case DTYPE_Configuration:
 235                         Address = &ConfigurationDescriptor;
 236                         Size    = sizeof(USB_Descriptor_Configuration_t);
 237                         break;
 238                 case DTYPE_String:
 239                         switch (DescriptorNumber)
 240                         {
 241                                 case 0x00:
 242                                         Address = &LanguageString;
 243                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 244                                         break;
 245                                 case 0x01:
 246                                         Address = &ManufacturerString;
 247                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 248                                         break;
 249                                 case 0x02:
 250                                         Address = &ProductString;
 251                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 252                                         break;
 253                                 case 0x03:
 254                                         Address = &SerialString;
 255                                         Size    = pgm_read_byte(&SerialString.Header.Size);
 256                                         break;
 257                         }
 258
 259                         break;
 260         }
 261
 262         *DescriptorAddress = Address;
 263         return Size;
 264 }
 265