Projects/AVRISP-MKII/AVRISPDescriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 disclaims 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 "AVRISPDescriptors.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 AVRISP_DeviceDescriptor =
  46 {
  47         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  48
  49         .USBSpecification       = VERSION_BCD(1,1,0),
  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               = 0x03EB,
  57         .ProductID              = 0x2104,
  58         .ReleaseNumber          = VERSION_BCD(2,0,0),
  59
  60         .ManufacturerStrIndex   = AVRISP_STRING_ID_Manufacturer,
  61         .ProductStrIndex        = AVRISP_STRING_ID_Product,
  62         .SerialNumStrIndex      = AVRISP_STRING_ID_Serial,
  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 AVRISP_USB_Descriptor_Configuration_t PROGMEM AVRISP_ConfigurationDescriptor =
  73 {
  74         .Config =
  75                 {
  76                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  77
  78                         .TotalConfigurationSize = sizeof(AVRISP_USB_Descriptor_Configuration_t),
  79                         .TotalInterfaces        = 1,
  80
  81                         .ConfigurationNumber    = 1,
  82                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  83
  84                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  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        = INTERFACE_ID_AVRISP,
  94                         .AlternateSetting       = 0,
  95
  96                         .TotalEndpoints         = 2,
  97
  98                         .Class                  = USB_CSCP_VendorSpecificClass,
  99                         .SubClass               = USB_CSCP_NoDeviceSubclass,
 100                         .Protocol               = USB_CSCP_NoDeviceProtocol,
 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        = AVRISP_DATA_IN_EPADDR,
 110                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 111                         .EndpointSize           = 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        = AVRISP_DATA_OUT_EPADDR,
 120                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 121                         .EndpointSize           = 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 AVRISP_LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 131
 132 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 133  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 134  *  Descriptor.
 135  */
 136 const USB_Descriptor_String_t PROGMEM AVRISP_ManufacturerString = USB_STRING_DESCRIPTOR(L"ATMEL");
 137
 138 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 139  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 140  *  Descriptor.
 141  */
 142 const USB_Descriptor_String_t PROGMEM AVRISP_ProductString = USB_STRING_DESCRIPTOR(L"AVRISP mkII");
 143
 144 /** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
 145  *  series of uppercase hexadecimal digits.
 146  */
 147 const USB_Descriptor_String_t PROGMEM AVRISP_SerialString = USB_STRING_DESCRIPTOR(L"000200012345\0"
 148     // Note: Real AVRISP-MKII has the embedded NUL byte, bug in firmware?
 149 );
 150
 151 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 152  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 153  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 154  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 155  *  USB host.
 156  */
 157 uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
 158                               const uint16_t wIndex,
 159                               const void** const DescriptorAddress)
 160 {
 161         const uint8_t  DescriptorType   = (wValue >> 8);
 162         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 163
 164         const void* Address = NULL;
 165         uint16_t    Size    = NO_DESCRIPTOR;
 166
 167         switch (DescriptorType)
 168         {
 169                 case DTYPE_Device:
 170                         Address = &AVRISP_DeviceDescriptor;
 171                         Size    = sizeof(USB_Descriptor_Device_t);
 172                         break;
 173                 case DTYPE_Configuration:
 174                         Address = &AVRISP_ConfigurationDescriptor;
 175                         Size    = sizeof(AVRISP_USB_Descriptor_Configuration_t);
 176                         break;
 177                 case DTYPE_String:
 178                         switch (DescriptorNumber)
 179                         {
 180                                 case AVRISP_STRING_ID_Language:
 181                                         Address = &AVRISP_LanguageString;
 182                                         Size    = pgm_read_byte(&AVRISP_LanguageString.Header.Size);
 183                                         break;
 184                                 case AVRISP_STRING_ID_Manufacturer:
 185                                         Address = &AVRISP_ManufacturerString;
 186                                         Size    = pgm_read_byte(&AVRISP_ManufacturerString.Header.Size);
 187                                         break;
 188                                 case AVRISP_STRING_ID_Product:
 189                                         Address = &AVRISP_ProductString;
 190                                         Size    = pgm_read_byte(&AVRISP_ProductString.Header.Size);
 191                                         break;
 192                                 case AVRISP_STRING_ID_Serial:
 193                                         Address = &AVRISP_SerialString;
 194                                         Size    = AVRISP_SerialString.Header.Size;
 195                                         break;
 196                         }
 197
 198                         break;
 199         }
 200
 201         *DescriptorAddress = Address;
 202         return Size;
 203 }