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