Bootloaders/TeensyHID/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 /** 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 USB_Descriptor_HIDReport_Datatype_t HIDReport[] =
  47 {
  48         0x06, 0x9c, 0xff,        /* Usage Page (Vendor Defined)                     */
  49         0x09, TEENSY_USAGEPAGE,  /* Usage (Vendor Defined)                          */
  50         0xa1, 0x01,              /* Collection (Vendor Defined)                     */
  51         0x0a, 0x19, 0x00,        /*   Usage (Vendor Defined)                        */
  52         0x75, 0x08,              /*   Report Size (8)                               */
  53 #if (SPM_PAGESIZE == 128)    /*   Report Count (SPM_PAGESIZE + 2)               */
  54         0x95, (SPM_PAGESIZE + 2),
  55 #else
  56         0x96, ((SPM_PAGESIZE + 2) & 0xFF), ((SPM_PAGESIZE + 2) >> 8),
  57 #endif
  58         0x15, 0x00,              /*   Logical Minimum (0)                           */
  59         0x25, 0xff,              /*   Logical Maximum (255)                         */
  60         0x91, 0x02,              /*   Output (Data, Variable, Absolute)             */
  61         0xc0                     /* End Collection                                  */
  62 };
  63
  64 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  65  *  device characteristics, including the supported USB version, control endpoint size and the
  66  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  67  *  process begins.
  68  */
  69 USB_Descriptor_Device_t DeviceDescriptor =
  70 {
  71         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  72
  73         .USBSpecification       = VERSION_BCD(01.10),
  74         .Class                  = 0x00,
  75         .SubClass               = 0x00,
  76         .Protocol               = 0x00,
  77
  78         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  79
  80         .VendorID               = 0x16C0,
  81         .ProductID              = 0x0478,
  82         .ReleaseNumber          = 0x0120,
  83
  84         .ManufacturerStrIndex   = NO_DESCRIPTOR,
  85         .ProductStrIndex        = NO_DESCRIPTOR,
  86         .SerialNumStrIndex      = NO_DESCRIPTOR,
  87
  88         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  89 };
  90
  91 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  92  *  of the device in one of its supported configurations, including information about any device interfaces
  93  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  94  *  a configuration so that the host may correctly communicate with the USB device.
  95  */
  96 USB_Descriptor_Configuration_t ConfigurationDescriptor =
  97 {
  98         .Config =
  99                 {
 100                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 101
 102                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 103                         .TotalInterfaces        = 1,
 104
 105                         .ConfigurationNumber    = 1,
 106                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 107
 108                         .ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
 109
 110                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 111                 },
 112
 113         .HID_Interface =
 114                 {
 115                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 116
 117                         .InterfaceNumber        = 0x00,
 118                         .AlternateSetting       = 0x00,
 119
 120                         .TotalEndpoints         = 1,
 121
 122                         .Class                  = 0x03,
 123                         .SubClass               = 0x00,
 124                         .Protocol               = 0x00,
 125
 126                         .InterfaceStrIndex      = NO_DESCRIPTOR
 127                 },
 128
 129         .HID_VendorHID =
 130                 {
 131                         .Header                 = {.Size = sizeof(USB_Descriptor_HID_t), .Type = DTYPE_HID},
 132
 133                         .HIDSpec                = VERSION_BCD(01.11),
 134                         .CountryCode            = 0x00,
 135                         .TotalHIDDescriptors    = 1,
 136                         .HIDReportType          = DTYPE_Report,
 137                         .HIDReportLength        = sizeof(HIDReport)
 138                 },
 139
 140         .HID_ReportINEndpoint =
 141                 {
 142                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 143
 144                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | HID_EPNUM),
 145                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 146                         .EndpointSize           = HID_EPSIZE,
 147                         .PollingIntervalMS      = 0x40
 148                 },
 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 CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 158 {
 159         const uint8_t DescriptorType = (wValue >> 8);
 160
 161         void*    Address = NULL;
 162         uint16_t Size    = NO_DESCRIPTOR;
 163
 164         /* If/Else If chain compiles slightly smaller than a switch case */
 165
 166         if (DescriptorType == DTYPE_Device)
 167         {
 168                 Address = (void*)&DeviceDescriptor;
 169                 Size    = sizeof(USB_Descriptor_Device_t);
 170         }
 171         else if (DescriptorType == DTYPE_Configuration)
 172         {
 173                 Address = (void*)&ConfigurationDescriptor;
 174                 Size    = sizeof(USB_Descriptor_Configuration_t);
 175         }
 176         else if (DescriptorType == DTYPE_HID)
 177         {
 178                 Address = (void*)&ConfigurationDescriptor.HID_VendorHID;
 179                 Size    = sizeof(USB_Descriptor_HID_t);
 180         }
 181         else
 182         {
 183                 Address = (void*)&HIDReport;
 184                 Size    = sizeof(HIDReport);
 185         }
 186
 187         *DescriptorAddress = Address;
 188         return Size;
 189 }