Demos/Device/ClassDriver/Joystick/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 PROGMEM JoystickReport[] =
  47 {
  48         /* Use the HID class driver's standard Joystick report.
  49          *   Min X/Y/Z Axis values: -100
  50          *   Max X/Y/Z Axis values:  100
  51          *   Min physical X/Y/Z Axis values (used to determine resolution): -1
  52          *   Max physical X/Y/Z Axis values (used to determine resolution):  1
  53          *   Buttons: 2
  54          */
  55         HID_DESCRIPTOR_JOYSTICK(-100, 100, -1, 1, 2)
  56 };
  57
  58 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  59  *  device characteristics, including the supported USB version, control endpoint size and the
  60  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  61  *  process begins.
  62  */
  63 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  64 {
  65         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  66
  67         .USBSpecification       = VERSION_BCD(1,1,0),
  68         .Class                  = USB_CSCP_NoDeviceClass,
  69         .SubClass               = USB_CSCP_NoDeviceSubclass,
  70         .Protocol               = USB_CSCP_NoDeviceProtocol,
  71
  72         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  73
  74         .VendorID               = 0x03EB,
  75         .ProductID              = 0x2043,
  76         .ReleaseNumber          = VERSION_BCD(0,0,1),
  77
  78         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  79         .ProductStrIndex        = STRING_ID_Product,
  80         .SerialNumStrIndex      = NO_DESCRIPTOR,
  81
  82         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  83 };
  84
  85 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  86  *  of the device in one of its supported configurations, including information about any device interfaces
  87  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  88  *  a configuration so that the host may correctly communicate with the USB device.
  89  */
  90 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  91 {
  92         .Config =
  93                 {
  94                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  95
  96                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  97                         .TotalInterfaces        = 1,
  98
  99                         .ConfigurationNumber    = 1,
 100                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 101
 102                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
 103
 104                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 105                 },
 106
 107         .HID_Interface =
 108                 {
 109                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 110
 111                         .InterfaceNumber        = INTERFACE_ID_Joystick,
 112                         .AlternateSetting       = 0x00,
 113
 114                         .TotalEndpoints         = 1,
 115
 116                         .Class                  = HID_CSCP_HIDClass,
 117                         .SubClass               = HID_CSCP_NonBootSubclass,
 118                         .Protocol               = HID_CSCP_NonBootProtocol,
 119
 120                         .InterfaceStrIndex      = NO_DESCRIPTOR
 121                 },
 122
 123         .HID_JoystickHID =
 124                 {
 125                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 126
 127                         .HIDSpec                = VERSION_BCD(1,1,1),
 128                         .CountryCode            = 0x00,
 129                         .TotalReportDescriptors = 1,
 130                         .HIDReportType          = HID_DTYPE_Report,
 131                         .HIDReportLength        = sizeof(JoystickReport)
 132                 },
 133
 134         .HID_ReportINEndpoint =
 135                 {
 136                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 137
 138                         .EndpointAddress        = JOYSTICK_EPADDR,
 139                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 140                         .EndpointSize           = JOYSTICK_EPSIZE,
 141                         .PollingIntervalMS      = 0x05
 142                 }
 143 };
 144
 145 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 146  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 147  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 148  */
 149 const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 150
 151 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 152  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 153  *  Descriptor.
 154  */
 155 const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera");
 156
 157 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 158  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 159  *  Descriptor.
 160  */
 161 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Joystick Demo");
 162
 163 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 164  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 165  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 166  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 167  *  USB host.
 168  */
 169 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 170                                     const uint16_t wIndex,
 171                                     const void** const DescriptorAddress)
 172 {
 173         const uint8_t  DescriptorType   = (wValue >> 8);
 174         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 175
 176         const void* Address = NULL;
 177         uint16_t    Size    = NO_DESCRIPTOR;
 178
 179         switch (DescriptorType)
 180         {
 181                 case DTYPE_Device:
 182                         Address = &DeviceDescriptor;
 183                         Size    = sizeof(USB_Descriptor_Device_t);
 184                         break;
 185                 case DTYPE_Configuration:
 186                         Address = &ConfigurationDescriptor;
 187                         Size    = sizeof(USB_Descriptor_Configuration_t);
 188                         break;
 189                 case DTYPE_String:
 190                         switch (DescriptorNumber)
 191                         {
 192                                 case STRING_ID_Language:
 193                                         Address = &LanguageString;
 194                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 195                                         break;
 196                                 case STRING_ID_Manufacturer:
 197                                         Address = &ManufacturerString;
 198                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 199                                         break;
 200                                 case STRING_ID_Product:
 201                                         Address = &ProductString;
 202                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 203                                         break;
 204                         }
 205
 206                         break;
 207                 case HID_DTYPE_HID:
 208                         Address = &ConfigurationDescriptor.HID_JoystickHID;
 209                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 210                         break;
 211                 case HID_DTYPE_Report:
 212                         Address = &JoystickReport;
 213                         Size    = sizeof(JoystickReport);
 214                         break;
 215         }
 216
 217         *DescriptorAddress = Address;
 218         return Size;
 219 }
 220