Demos/Device/LowLevel/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   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaim all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
  35  *  computer-readable structures which the host requests upon device enumeration, to determine
  36  *  the device's capabilities and functions.
  37  */
  38
  39 #include "Descriptors.h"
  40
  41 /** HID class report descriptor. This is a special descriptor constructed with values from the
  42  *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
  43  *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
  44  *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
  45  *  more details on HID report descriptors.
  46  */
  47 USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
  48 {
  49         HID_RI_USAGE_PAGE(8),                0x01, /* Generic Desktop */
  50         HID_RI_USAGE(8),                     0x06, /* Keyboard */
  51         HID_RI_COLLECTION(8),                0x01, /* Application */
  52             HID_RI_USAGE_PAGE(8),            0x07, /* Key Codes */
  53             HID_RI_USAGE_MINIMUM(8),         0xE0, /* Keyboard Left Control */
  54             HID_RI_USAGE_MAXIMUM(8),         0xE7, /* Keyboard Right GUI */
  55             HID_RI_LOGICAL_MINIMUM(8),       0,
  56             HID_RI_LOGICAL_MAXIMUM(8),       1,
  57             HID_RI_REPORT_SIZE(8),           1,
  58             HID_RI_REPORT_COUNT(8),          8,
  59             HID_RI_INPUT(8),                 (HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  60
  61             HID_RI_REPORT_COUNT(8),          1,
  62             HID_RI_REPORT_SIZE(8),           8,
  63             HID_RI_INPUT(8),                 HID_IOF_CONSTANT,
  64
  65             HID_RI_USAGE_PAGE(8),            0x08, /* LEDs */
  66             HID_RI_USAGE_MINIMUM(8),         0x01, /* Num Lock */
  67             HID_RI_USAGE_MAXIMUM(8),         0x05, /* Kana */
  68             HID_RI_REPORT_COUNT(8),          5,
  69             HID_RI_REPORT_SIZE(8),           1,
  70             HID_RI_OUTPUT(8),                (HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  71             HID_RI_REPORT_COUNT(8),          1,
  72             HID_RI_REPORT_SIZE(8),           3,
  73             HID_RI_OUTPUT(8),                HID_IOF_CONSTANT,
  74
  75             HID_RI_LOGICAL_MINIMUM(8),       0x00,
  76             HID_RI_LOGICAL_MAXIMUM(8),       0x65,
  77             HID_RI_USAGE_PAGE(8),            0x07, /* Keyboard */
  78             HID_RI_USAGE_MINIMUM(8),         0x00, /* Reserved (no event indicated) */
  79             HID_RI_USAGE_MAXIMUM(8),         0x65, /* Keyboard Application */
  80             HID_RI_REPORT_COUNT(8),          6,
  81             HID_RI_REPORT_SIZE(8),           8,
  82             HID_RI_INPUT(8),                 (HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
  83         HID_RI_END_COLLECTION(0),
  84 };
  85
  86 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  87  *  device characteristics, including the supported USB version, control endpoint size and the
  88  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  89  *  process begins.
  90  */
  91 USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  92 {
  93         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  94
  95         .USBSpecification       = VERSION_BCD(01.10),
  96         .Class                  = USB_CSCP_NoDeviceClass,
  97         .SubClass               = USB_CSCP_NoDeviceSubclass,
  98         .Protocol               = USB_CSCP_NoDeviceProtocol,
  99
 100         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 101
 102         .VendorID               = 0x03EB,
 103         .ProductID              = 0x2042,
 104         .ReleaseNumber          = VERSION_BCD(00.01),
 105
 106         .ManufacturerStrIndex   = 0x01,
 107         .ProductStrIndex        = 0x02,
 108         .SerialNumStrIndex      = NO_DESCRIPTOR,
 109
 110         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 111 };
 112
 113 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
 114  *  of the device in one of its supported configurations, including information about any device interfaces
 115  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
 116  *  a configuration so that the host may correctly communicate with the USB device.
 117  */
 118 USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 119 {
 120         .Config =
 121                 {
 122                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 123
 124                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 125                         .TotalInterfaces        = 1,
 126
 127                         .ConfigurationNumber    = 1,
 128                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 129
 130                         .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
 131
 132                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 133                 },
 134
 135         .HID_Interface =
 136                 {
 137                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 138
 139                         .InterfaceNumber        = 0x00,
 140                         .AlternateSetting       = 0x00,
 141
 142                         .TotalEndpoints         = 2,
 143
 144                         .Class                  = HID_CSCP_HIDClass,
 145                         .SubClass               = HID_CSCP_BootSubclass,
 146                         .Protocol               = HID_CSCP_KeyboardBootProtocol,
 147
 148                         .InterfaceStrIndex      = NO_DESCRIPTOR
 149                 },
 150
 151         .HID_KeyboardHID =
 152                 {
 153                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 154
 155                         .HIDSpec                = VERSION_BCD(01.11),
 156                         .CountryCode            = 0x00,
 157                         .TotalReportDescriptors = 1,
 158                         .HIDReportType          = HID_DTYPE_Report,
 159                         .HIDReportLength        = sizeof(KeyboardReport)
 160                 },
 161
 162         .HID_ReportINEndpoint =
 163                 {
 164                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 165
 166                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_IN_EPNUM),
 167                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 168                         .EndpointSize           = KEYBOARD_EPSIZE,
 169                         .PollingIntervalMS      = 0x01
 170                 },
 171
 172         .HID_ReportOUTEndpoint =
 173                 {
 174                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 175
 176                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_OUT_EPNUM),
 177                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 178                         .EndpointSize           = KEYBOARD_EPSIZE,
 179                         .PollingIntervalMS      = 0x01
 180                 }
 181 };
 182
 183 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 184  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 185  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 186  */
 187 USB_Descriptor_String_t PROGMEM LanguageString =
 188 {
 189         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 190
 191         .UnicodeString          = {LANGUAGE_ID_ENG}
 192 };
 193
 194 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 195  *  form, 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 ManufacturerString =
 199 {
 200         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 201
 202         .UnicodeString          = L"Dean Camera"
 203 };
 204
 205 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 206  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 207  *  Descriptor.
 208  */
 209 USB_Descriptor_String_t PROGMEM ProductString =
 210 {
 211         .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
 212
 213         .UnicodeString          = L"LUFA Keyboard Demo"
 214 };
 215
 216 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 217  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 218  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 219  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 220  *  USB host.
 221  */
 222 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 223                                     const uint8_t wIndex,
 224                                     const void** const DescriptorAddress)
 225 {
 226         const uint8_t  DescriptorType   = (wValue >> 8);
 227         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 228
 229         const void* Address = NULL;
 230         uint16_t    Size    = NO_DESCRIPTOR;
 231
 232         switch (DescriptorType)
 233         {
 234                 case DTYPE_Device:
 235                         Address = &DeviceDescriptor;
 236                         Size    = sizeof(USB_Descriptor_Device_t);
 237                         break;
 238                 case DTYPE_Configuration:
 239                         Address = &ConfigurationDescriptor;
 240                         Size    = sizeof(USB_Descriptor_Configuration_t);
 241                         break;
 242                 case DTYPE_String:
 243                         switch (DescriptorNumber)
 244                         {
 245                                 case 0x00:
 246                                         Address = &LanguageString;
 247                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 248                                         break;
 249                                 case 0x01:
 250                                         Address = &ManufacturerString;
 251                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 252                                         break;
 253                                 case 0x02:
 254                                         Address = &ProductString;
 255                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 256                                         break;
 257                         }
 258
 259                         break;
 260                 case HID_DTYPE_HID:
 261                         Address = &ConfigurationDescriptor.HID_KeyboardHID;
 262                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 263                         break;
 264                 case HID_DTYPE_Report:
 265                         Address = &KeyboardReport;
 266                         Size    = sizeof(KeyboardReport);
 267                         break;
 268         }
 269
 270         *DescriptorAddress = Address;
 271         return Size;
 272 }
 273