Demos/Device/LowLevel/Keyboard/Descriptors.c

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