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