keyboard/lufa/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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  *  This descriptor describes the mouse HID interface's report structure.
  48  */
  49 const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
  50 {
  51         HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  52         HID_RI_USAGE(8, 0x02), /* Mouse */
  53         HID_RI_COLLECTION(8, 0x01), /* Application */
  54             HID_RI_USAGE(8, 0x01), /* Pointer */
  55             HID_RI_COLLECTION(8, 0x00), /* Physical */
  56                 HID_RI_USAGE_PAGE(8, 0x09), /* Button */
  57                 HID_RI_USAGE_MINIMUM(8, 0x01),
  58                 HID_RI_USAGE_MAXIMUM(8, 0x03),
  59                 HID_RI_LOGICAL_MINIMUM(8, 0x00),
  60                 HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  61                 HID_RI_REPORT_COUNT(8, 0x03),
  62                 HID_RI_REPORT_SIZE(8, 0x01),
  63                 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  64                 HID_RI_REPORT_COUNT(8, 0x01),
  65                 HID_RI_REPORT_SIZE(8, 0x05),
  66                 HID_RI_INPUT(8, HID_IOF_CONSTANT),
  67                 HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  68                 HID_RI_USAGE(8, 0x30), /* Usage X */
  69                 HID_RI_USAGE(8, 0x31), /* Usage Y */
  70                 HID_RI_LOGICAL_MINIMUM(8, -1),
  71                 HID_RI_LOGICAL_MAXIMUM(8, 1),
  72                 HID_RI_PHYSICAL_MINIMUM(8, -1),
  73                 HID_RI_PHYSICAL_MAXIMUM(8, 1),
  74                 HID_RI_REPORT_COUNT(8, 0x02),
  75                 HID_RI_REPORT_SIZE(8, 0x08),
  76                 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
  77             HID_RI_END_COLLECTION(0),
  78         HID_RI_END_COLLECTION(0),
  79 };
  80
  81 /** Same as the MouseReport structure, but defines the keyboard HID interface's report structure. */
  82 const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
  83 {
  84         HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
  85         HID_RI_USAGE(8, 0x06), /* Keyboard */
  86         HID_RI_COLLECTION(8, 0x01), /* Application */
  87             HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
  88             HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
  89             HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
  90             HID_RI_LOGICAL_MINIMUM(8, 0x00),
  91             HID_RI_LOGICAL_MAXIMUM(8, 0x01),
  92             HID_RI_REPORT_SIZE(8, 0x01),
  93             HID_RI_REPORT_COUNT(8, 0x08),
  94             HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
  95             HID_RI_REPORT_COUNT(8, 0x01),
  96             HID_RI_REPORT_SIZE(8, 0x08),
  97             HID_RI_INPUT(8, HID_IOF_CONSTANT),
  98             HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
  99             HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
 100             HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
 101             HID_RI_REPORT_COUNT(8, 0x05),
 102             HID_RI_REPORT_SIZE(8, 0x01),
 103             HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
 104             HID_RI_REPORT_COUNT(8, 0x01),
 105             HID_RI_REPORT_SIZE(8, 0x03),
 106             HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
 107             HID_RI_LOGICAL_MINIMUM(8, 0x00),
 108             HID_RI_LOGICAL_MAXIMUM(8, 0x65),
 109             HID_RI_USAGE_PAGE(8, 0x07), /* Keyboard */
 110             HID_RI_USAGE_MINIMUM(8, 0x00), /* Reserved (no event indicated) */
 111             HID_RI_USAGE_MAXIMUM(8, 0x65), /* Keyboard Application */
 112             HID_RI_REPORT_COUNT(8, 0x06),
 113             HID_RI_REPORT_SIZE(8, 0x08),
 114             HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
 115         HID_RI_END_COLLECTION(0),
 116 };
 117
 118 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
 119  *  device characteristics, including the supported USB version, control endpoint size and the
 120  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
 121  *  process begins.
 122  */
 123 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
 124 {
 125         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
 126
 127         .USBSpecification       = VERSION_BCD(01.10),
 128         .Class                  = USB_CSCP_NoDeviceClass,
 129         .SubClass               = USB_CSCP_NoDeviceSubclass,
 130         .Protocol               = USB_CSCP_NoDeviceProtocol,
 131
 132         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 133
 134         .VendorID               = 0x03EB,
 135         .ProductID              = 0x204D,
 136         .ReleaseNumber          = VERSION_BCD(00.01),
 137
 138         .ManufacturerStrIndex   = 0x01,
 139         .ProductStrIndex        = 0x02,
 140         .SerialNumStrIndex      = NO_DESCRIPTOR,
 141
 142         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 143 };
 144
 145 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
 146  *  of the device in one of its supported configurations, including information about any device interfaces
 147  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
 148  *  a configuration so that the host may correctly communicate with the USB device.
 149  */
 150 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 151 {
 152         .Config =
 153                 {
 154                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 155
 156                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 157                         .TotalInterfaces        = 2,
 158
 159                         .ConfigurationNumber    = 1,
 160                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 161
 162                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
 163
 164                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 165                 },
 166
 167         .HID1_KeyboardInterface =
 168                 {
 169                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 170
 171                         .InterfaceNumber        = 0x00,
 172                         .AlternateSetting       = 0x00,
 173
 174                         .TotalEndpoints         = 2,
 175
 176                         .Class                  = HID_CSCP_HIDClass,
 177                         .SubClass               = HID_CSCP_BootSubclass,
 178                         .Protocol               = HID_CSCP_KeyboardBootProtocol,
 179
 180                         .InterfaceStrIndex      = NO_DESCRIPTOR
 181                 },
 182
 183         .HID1_KeyboardHID =
 184                 {
 185                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 186
 187                         .HIDSpec                = VERSION_BCD(01.11),
 188                         .CountryCode            = 0x00,
 189                         .TotalReportDescriptors = 1,
 190                         .HIDReportType          = HID_DTYPE_Report,
 191                         .HIDReportLength        = sizeof(KeyboardReport)
 192                 },
 193
 194         .HID1_ReportINEndpoint =
 195                 {
 196                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 197
 198                         .EndpointAddress        = (ENDPOINT_DIR_IN | KEYBOARD_IN_EPNUM),
 199                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 200                         .EndpointSize           = HID_EPSIZE,
 201                         .PollingIntervalMS      = 0x01
 202                 },
 203
 204         .HID1_ReportOUTEndpoint =
 205                 {
 206                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 207
 208                         .EndpointAddress        = (ENDPOINT_DIR_OUT | KEYBOARD_OUT_EPNUM),
 209                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 210                         .EndpointSize           = HID_EPSIZE,
 211                         .PollingIntervalMS      = 0x01
 212                 },
 213
 214         .HID2_MouseInterface =
 215                 {
 216                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 217
 218                         .InterfaceNumber        = 0x01,
 219                         .AlternateSetting       = 0x00,
 220
 221                         .TotalEndpoints         = 1,
 222
 223                         .Class                  = HID_CSCP_HIDClass,
 224                         .SubClass               = HID_CSCP_BootSubclass,
 225                         .Protocol               = HID_CSCP_MouseBootProtocol,
 226
 227                         .InterfaceStrIndex      = NO_DESCRIPTOR
 228                 },
 229
 230         .HID2_MouseHID =
 231                 {
 232                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 233
 234                         .HIDSpec                = VERSION_BCD(01.11),
 235                         .CountryCode            = 0x00,
 236                         .TotalReportDescriptors = 1,
 237                         .HIDReportType          = HID_DTYPE_Report,
 238                         .HIDReportLength        = sizeof(MouseReport)
 239                 },
 240
 241         .HID2_ReportINEndpoint =
 242                 {
 243                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 244
 245                         .EndpointAddress        = (ENDPOINT_DIR_IN | MOUSE_IN_EPNUM),
 246                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 247                         .EndpointSize           = HID_EPSIZE,
 248                         .PollingIntervalMS      = 0x01
 249                 }
 250 };
 251
 252 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 253  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 254  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 255  */
 256 const USB_Descriptor_String_t PROGMEM LanguageString =
 257 {
 258         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 259
 260         .UnicodeString          = {LANGUAGE_ID_ENG}
 261 };
 262
 263 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 264  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 265  *  Descriptor.
 266  */
 267 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 268 {
 269         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 270
 271         .UnicodeString          = L"Dean Camera"
 272 };
 273
 274 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 275  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 276  *  Descriptor.
 277  */
 278 const USB_Descriptor_String_t PROGMEM ProductString =
 279 {
 280         .Header                 = {.Size = USB_STRING_LEN(28), .Type = DTYPE_String},
 281
 282         .UnicodeString          = L"LUFA Mouse and Keyboard Demo"
 283 };
 284
 285 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 286  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 287  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 288  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 289  *  USB host.
 290  */
 291 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 292                                     const uint8_t wIndex,
 293                                     const void** const DescriptorAddress)
 294 {
 295         const uint8_t  DescriptorType   = (wValue >> 8);
 296         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 297
 298         const void* Address = NULL;
 299         uint16_t    Size    = NO_DESCRIPTOR;
 300
 301         switch (DescriptorType)
 302         {
 303                 case DTYPE_Device:
 304                         Address = &DeviceDescriptor;
 305                         Size    = sizeof(USB_Descriptor_Device_t);
 306                         break;
 307                 case DTYPE_Configuration:
 308                         Address = &ConfigurationDescriptor;
 309                         Size    = sizeof(USB_Descriptor_Configuration_t);
 310                         break;
 311                 case DTYPE_String:
 312                         switch (DescriptorNumber)
 313                         {
 314                                 case 0x00:
 315                                         Address = &LanguageString;
 316                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 317                                         break;
 318                                 case 0x01:
 319                                         Address = &ManufacturerString;
 320                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 321                                         break;
 322                                 case 0x02:
 323                                         Address = &ProductString;
 324                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 325                                         break;
 326                         }
 327
 328                         break;
 329                 case HID_DTYPE_HID:
 330                         if (!(wIndex))
 331                         {
 332                                 Address = &ConfigurationDescriptor.HID1_KeyboardHID;
 333                                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 334                         }
 335                         else
 336                         {
 337                                 Address = &ConfigurationDescriptor.HID2_MouseHID;
 338                                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 339                         }
 340                         break;
 341                 case HID_DTYPE_Report:
 342                         if (!(wIndex))
 343                         {
 344                                 Address = &KeyboardReport;
 345                                 Size    = sizeof(KeyboardReport);
 346                         }
 347                         else
 348                         {
 349                                 Address = &MouseReport;
 350                                 Size    = sizeof(MouseReport);
 351                         }
 352
 353                         break;
 354         }
 355
 356         *DescriptorAddress = Address;
 357         return Size;
 358 }
 359