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