Demos/Device/ClassDriver/Joystick/Descriptors.c

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