lib/lufa/Bootloaders/DFU/Descriptors.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 "Descriptors.h"
  39 #include "Keyboard.h"
  40
  41 #ifndef MANUFACTURER
  42     #define MANUFACTURER QMK
  43 #endif
  44 #ifndef PRODUCT
  45     #define PRODUCT Keyboard
  46 #endif
  47
  48 /** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
  49  *  device characteristics, including the supported USB version, control endpoint size and the
  50  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  51  *  process begins.
  52  */
  53 const USB_Descriptor_Device_t DeviceDescriptor =
  54 {
  55         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  56
  57         .USBSpecification       = VERSION_BCD(1,1,0),
  58         .Class                  = USB_CSCP_NoDeviceClass,
  59         .SubClass               = USB_CSCP_NoDeviceSubclass,
  60         .Protocol               = USB_CSCP_NoDeviceProtocol,
  61
  62         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  63
  64         .VendorID               = 0x03EB,
  65         .ProductID              = PRODUCT_ID_CODE,
  66         .ReleaseNumber          = VERSION_BCD(0,0,0),
  67
  68         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  69         .ProductStrIndex        = STRING_ID_Product,
  70         .SerialNumStrIndex      = NO_DESCRIPTOR,
  71
  72         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  73 };
  74
  75 /** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
  76  *  of the device in one of its supported configurations, including information about any device interfaces
  77  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  78  *  a configuration so that the host may correctly communicate with the USB device.
  79  */
  80 const USB_Descriptor_Configuration_t ConfigurationDescriptor =
  81 {
  82         .Config =
  83                 {
  84                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  85
  86                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  87                         .TotalInterfaces        = 1,
  88
  89                         .ConfigurationNumber    = 1,
  90                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  91
  92                         .ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
  93
  94                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  95                 },
  96
  97         .DFU_Interface =
  98                 {
  99                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 100
 101                         .InterfaceNumber        = INTERFACE_ID_DFU,
 102                         .AlternateSetting       = 0,
 103
 104                         .TotalEndpoints         = 0,
 105
 106                         .Class                  = 0xFE,
 107                         .SubClass               = 0x01,
 108                         .Protocol               = 0x02,
 109
 110                         .InterfaceStrIndex      = NO_DESCRIPTOR
 111                 },
 112
 113         .DFU_Functional =
 114                 {
 115                         .Header                 = {.Size = sizeof(USB_Descriptor_DFU_Functional_t), .Type = DTYPE_DFUFunctional},
 116
 117                         .Attributes             = (ATTR_CAN_UPLOAD | ATTR_CAN_DOWNLOAD),
 118
 119                         .DetachTimeout          = 0x0000,
 120                         .TransferSize           = 0x0C00,
 121
 122                         .DFUSpecification       = VERSION_BCD(1,1,0)
 123                 }
 124 };
 125
 126 /** Language descriptor structure. This descriptor, located in SRAM 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 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 ManufacturerString = USB_STRING_DESCRIPTOR(LSTR(MANUFACTURER));
 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 ProductString = USB_STRING_DESCRIPTOR(LSTR(PRODUCT));
 143
 144 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 145  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 146  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 147  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 148  *  USB host.
 149  */
 150 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 151                                     const uint16_t wIndex,
 152                                     const void** const DescriptorAddress)
 153 {
 154         const uint8_t  DescriptorType   = (wValue >> 8);
 155         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 156
 157         const void* Address = NULL;
 158         uint16_t    Size    = NO_DESCRIPTOR;
 159
 160         switch (DescriptorType)
 161         {
 162                 case DTYPE_Device:
 163                         Address = &DeviceDescriptor;
 164                         Size    = sizeof(USB_Descriptor_Device_t);
 165                         break;
 166                 case DTYPE_Configuration:
 167                         Address = &ConfigurationDescriptor;
 168                         Size    = sizeof(USB_Descriptor_Configuration_t);
 169                         break;
 170                 case DTYPE_String:
 171                         if (DescriptorNumber == STRING_ID_Language)
 172                         {
 173                                 Address = &LanguageString;
 174                                 Size    = LanguageString.Header.Size;
 175                         }
 176                         else if (DescriptorNumber == STRING_ID_Manufacturer)
 177                         {
 178                                 Address = &ManufacturerString;
 179                                 Size    = ManufacturerString.Header.Size;
 180                         }
 181                         else if (DescriptorNumber == STRING_ID_Product)
 182                         {
 183                                 Address = &ProductString;
 184                                 Size    = ProductString.Header.Size;
 185                         }
 186
 187                         break;
 188         }
 189
 190         *DescriptorAddress = Address;
 191         return Size;
 192 }
 193