Bootloaders/CDC/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 SRAM 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 DeviceDescriptor =
  46 {
  47         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  48
  49         .USBSpecification       = VERSION_BCD(01.10),
  50         .Class                  = 0x02,
  51         .SubClass               = 0x00,
  52         .Protocol               = 0x00,
  53
  54         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  55
  56         .VendorID               = 0x03EB,
  57         .ProductID              = 0x204A,
  58         .ReleaseNumber          = 0x0000,
  59
  60         .ManufacturerStrIndex   = NO_DESCRIPTOR,
  61         .ProductStrIndex        = 0x01,
  62         .SerialNumStrIndex      = NO_DESCRIPTOR,
  63
  64         .NumberOfConfigurations = 1
  65 };
  66
  67 /** Configuration descriptor structure. This descriptor, located in SRAM 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 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        = 2,
  80
  81                         .ConfigurationNumber    = 1,
  82                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  83
  84                         .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
  85
  86                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  87                 },
  88
  89         .CCI_Interface =
  90                 {
  91                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  92
  93                         .InterfaceNumber        = 0,
  94                         .AlternateSetting       = 0,
  95
  96                         .TotalEndpoints         = 1,
  97
  98                         .Class                  = 0x02,
  99                         .SubClass               = 0x02,
 100                         .Protocol               = 0x01,
 101
 102                         .InterfaceStrIndex      = NO_DESCRIPTOR
 103                 },
 104
 105         .CDC_Functional_IntHeader =
 106                 {
 107                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 108                         .SubType                = 0x00,
 109
 110                         .Data                   = {0x10, 0x01}
 111                 },
 112
 113         .CDC_Functional_CallManagement =
 114                 {
 115                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 116                         .SubType                = 0x01,
 117
 118                         .Data                   = {0x03, 0x01}
 119                 },
 120
 121         .CDC_Functional_AbstractControlManagement =
 122                 {
 123                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 124                         .SubType                = 0x02,
 125
 126                         .Data                   = {0x06}
 127                 },
 128
 129         .CDC_Functional_Union =
 130                 {
 131                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 132                         .SubType                = 0x06,
 133
 134                         .Data                   = {0x00, 0x01}
 135                 },
 136
 137         .ManagementEndpoint =
 138                 {
 139                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 140
 141                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
 142                         .Attributes             = EP_TYPE_INTERRUPT,
 143                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 144                         .PollingIntervalMS      = 0x02
 145                 },
 146
 147         .DCI_Interface =
 148                 {
 149                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 150
 151                         .InterfaceNumber        = 1,
 152                         .AlternateSetting       = 0,
 153
 154                         .TotalEndpoints         = 2,
 155
 156                         .Class                  = 0x0A,
 157                         .SubClass               = 0x00,
 158                         .Protocol               = 0x00,
 159
 160                         .InterfaceStrIndex      = NO_DESCRIPTOR
 161                 },
 162
 163         .DataOutEndpoint =
 164                 {
 165                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 166
 167                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
 168                         .Attributes             = EP_TYPE_BULK,
 169                         .EndpointSize           = CDC_TXRX_EPSIZE,
 170                         .PollingIntervalMS      = 0x00
 171                 },
 172
 173         .DataInEndpoint =
 174                 {
 175                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 176
 177                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
 178                         .Attributes             = EP_TYPE_BULK,
 179                         .EndpointSize           = CDC_TXRX_EPSIZE,
 180                         .PollingIntervalMS      = 0x00
 181                 }
 182 };
 183
 184 /** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests
 185  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 186  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 187  */
 188 USB_Descriptor_String_t LanguageString =
 189 {
 190         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 191
 192         .UnicodeString          = {LANGUAGE_ID_ENG}
 193 };
 194
 195 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 196  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 197  *  Descriptor.
 198  */
 199 USB_Descriptor_String_t ProductString =
 200 {
 201         .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
 202
 203         .UnicodeString          = L"AVR CDC Bootloader"
 204 };
 205
 206 /** This function is called by the library when in device mode, and must be overridden (see LUFA library "USB Descriptors"
 207  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 208  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 209  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 210  *  USB host.
 211  */
 212 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 213 {
 214         const uint8_t  DescriptorType   = (wValue >> 8);
 215         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 216
 217         void*    Address = NULL;
 218         uint16_t Size    = NO_DESCRIPTOR;
 219
 220         switch (DescriptorType)
 221         {
 222                 case DTYPE_Device:
 223                         Address = (void*)&DeviceDescriptor;
 224                         Size    = sizeof(USB_Descriptor_Device_t);
 225                         break;
 226                 case DTYPE_Configuration:
 227                         Address = (void*)&ConfigurationDescriptor;
 228                         Size    = sizeof(USB_Descriptor_Configuration_t);
 229                         break;
 230                 case DTYPE_String:
 231                         if (!(DescriptorNumber))
 232                         {
 233                                 Address = (void*)&LanguageString;
 234                                 Size    = LanguageString.Header.Size;
 235                         }
 236                         else
 237                         {
 238                                 Address = (void*)&ProductString;
 239                                 Size    = ProductString.Header.Size;
 240                         }
 241
 242                         break;
 243         }
 244
 245         *DescriptorAddress = Address;
 246         return Size;
 247 }