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