Bootloaders/HID/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
  40 /** HID class report descriptor. This is a special descriptor constructed with values from the
  41  *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
  42  *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
  43  *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
  44  *  more details on HID report descriptors.
  45  */
  46 const USB_Descriptor_HIDReport_Datatype_t HIDReport[] =
  47 {
  48         HID_RI_USAGE_PAGE(16, 0xFFDC), /* Vendor Page 0xDC */
  49         HID_RI_USAGE(8, 0xFB), /* Vendor Usage 0xFB */
  50         HID_RI_COLLECTION(8, 0x01), /* Vendor Usage 1 */
  51                 HID_RI_USAGE(8, 0x02), /* Vendor Usage 2 */
  52                 HID_RI_LOGICAL_MINIMUM(8, 0x00),
  53                 HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
  54                 HID_RI_REPORT_SIZE(8, 0x08),
  55                 HID_RI_REPORT_COUNT(16, (sizeof(uint16_t) + SPM_PAGESIZE)),
  56                 HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  57         HID_RI_END_COLLECTION(0),
  58 };
  59
  60 /** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
  61  *  device characteristics, including the supported USB version, control endpoint size and the
  62  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  63  *  process begins.
  64  */
  65 const USB_Descriptor_Device_t DeviceDescriptor =
  66 {
  67         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  68
  69         .USBSpecification       = VERSION_BCD(1,1,0),
  70         .Class                  = USB_CSCP_NoDeviceClass,
  71         .SubClass               = USB_CSCP_NoDeviceSubclass,
  72         .Protocol               = USB_CSCP_NoDeviceProtocol,
  73
  74         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  75
  76         .VendorID               = 0x03EB,
  77         .ProductID              = 0x2067,
  78         .ReleaseNumber          = VERSION_BCD(0,0,1),
  79
  80         .ManufacturerStrIndex   = NO_DESCRIPTOR,
  81         .ProductStrIndex        = NO_DESCRIPTOR,
  82         .SerialNumStrIndex      = NO_DESCRIPTOR,
  83
  84         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  85 };
  86
  87 /** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
  88  *  of the device in one of its supported configurations, including information about any device interfaces
  89  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  90  *  a configuration so that the host may correctly communicate with the USB device.
  91  */
  92 const USB_Descriptor_Configuration_t ConfigurationDescriptor =
  93 {
  94         .Config =
  95                 {
  96                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  97
  98                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  99                         .TotalInterfaces        = 1,
 100
 101                         .ConfigurationNumber    = 1,
 102                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 103
 104                         .ConfigAttributes       = USB_CONFIG_ATTR_RESERVED,
 105
 106                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 107                 },
 108
 109         .HID_Interface =
 110                 {
 111                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 112
 113                         .InterfaceNumber        = INTERFACE_ID_GenericHID,
 114                         .AlternateSetting       = 0x00,
 115
 116                         .TotalEndpoints         = 1,
 117
 118                         .Class                  = HID_CSCP_HIDClass,
 119                         .SubClass               = HID_CSCP_NonBootSubclass,
 120                         .Protocol               = HID_CSCP_NonBootProtocol,
 121
 122                         .InterfaceStrIndex      = NO_DESCRIPTOR
 123                 },
 124
 125         .HID_VendorHID =
 126                 {
 127                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 128
 129                         .HIDSpec                = VERSION_BCD(1,1,1),
 130                         .CountryCode            = 0x00,
 131                         .TotalReportDescriptors = 1,
 132                         .HIDReportType          = HID_DTYPE_Report,
 133                         .HIDReportLength        = sizeof(HIDReport)
 134                 },
 135
 136         .HID_ReportINEndpoint =
 137                 {
 138                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 139
 140                         .EndpointAddress        = HID_IN_EPADDR,
 141                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 142                         .EndpointSize           = HID_IN_EPSIZE,
 143                         .PollingIntervalMS      = 0x05
 144                 },
 145 };
 146
 147 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 148  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 149  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 150  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 151  *  USB host.
 152  */
 153 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 154                                     const uint16_t wIndex,
 155                                     const void** const DescriptorAddress)
 156 {
 157         const uint8_t DescriptorType   = (wValue >> 8);
 158
 159         const void* Address = NULL;
 160         uint16_t    Size    = NO_DESCRIPTOR;
 161
 162         /* If/Else If chain compiles slightly smaller than a switch case */
 163         if (DescriptorType == DTYPE_Device)
 164         {
 165                 Address = &DeviceDescriptor;
 166                 Size    = sizeof(USB_Descriptor_Device_t);
 167         }
 168         else if (DescriptorType == DTYPE_Configuration)
 169         {
 170                 Address = &ConfigurationDescriptor;
 171                 Size    = sizeof(USB_Descriptor_Configuration_t);
 172         }
 173         else if (DescriptorType == HID_DTYPE_HID)
 174         {
 175                 Address = &ConfigurationDescriptor.HID_VendorHID;
 176                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 177         }
 178         else if (DescriptorType == HID_DTYPE_Report)
 179         {
 180                 Address = &HIDReport;
 181                 Size    = sizeof(HIDReport);
 182         }
 183
 184         *DescriptorAddress = Address;
 185         return Size;
 186 }
 187