Demos/Device/ClassDriver/Joystick/Descriptors.c

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