Demos/Device/ClassDriver/Keyboard/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 disclaims 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 const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
  47 {
  48         /* Use the HID class driver's standard Keyboard report.
  49          *   Max simultaneous keys: 6
  50          */
  51         HID_DESCRIPTOR_KEYBOARD(6)
  52 };
  53
  54 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  55  *  device characteristics, including the supported USB version, control endpoint size and the
  56  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  57  *  process begins.
  58  */
  59 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  60 {
  61         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  62
  63         .USBSpecification       = VERSION_BCD(1,1,0),
  64         .Class                  = USB_CSCP_NoDeviceClass,
  65         .SubClass               = USB_CSCP_NoDeviceSubclass,
  66         .Protocol               = USB_CSCP_NoDeviceProtocol,
  67
  68         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  69
  70         .VendorID               = 0x03EB,
  71         .ProductID              = 0x2042,
  72         .ReleaseNumber          = VERSION_BCD(0,0,1),
  73
  74         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  75         .ProductStrIndex        = STRING_ID_Product,
  76         .SerialNumStrIndex      = NO_DESCRIPTOR,
  77
  78         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  79 };
  80
  81 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  82  *  of the device in one of its supported configurations, including information about any device interfaces
  83  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  84  *  a configuration so that the host may correctly communicate with the USB device.
  85  */
  86 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  87 {
  88         .Config =
  89                 {
  90                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  91
  92                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  93                         .TotalInterfaces        = 1,
  94
  95                         .ConfigurationNumber    = 1,
  96                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  97
  98                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  99
 100                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 101                 },
 102
 103         .HID_Interface =
 104                 {
 105                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 106
 107                         .InterfaceNumber        = INTERFACE_ID_Keyboard,
 108                         .AlternateSetting       = 0x00,
 109
 110                         .TotalEndpoints         = 1,
 111
 112                         .Class                  = HID_CSCP_HIDClass,
 113                         .SubClass               = HID_CSCP_BootSubclass,
 114                         .Protocol               = HID_CSCP_KeyboardBootProtocol,
 115
 116                         .InterfaceStrIndex      = NO_DESCRIPTOR
 117                 },
 118
 119         .HID_KeyboardHID =
 120                 {
 121                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 122
 123                         .HIDSpec                = VERSION_BCD(1,1,1),
 124                         .CountryCode            = 0x00,
 125                         .TotalReportDescriptors = 1,
 126                         .HIDReportType          = HID_DTYPE_Report,
 127                         .HIDReportLength        = sizeof(KeyboardReport)
 128                 },
 129
 130         .HID_ReportINEndpoint =
 131                 {
 132                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 133
 134                         .EndpointAddress        = KEYBOARD_EPADDR,
 135                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 136                         .EndpointSize           = KEYBOARD_EPSIZE,
 137                         .PollingIntervalMS      = 0x05
 138                 },
 139 };
 140
 141 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 142  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 143  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 144  */
 145 const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 146
 147 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 148  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 149  *  Descriptor.
 150  */
 151 const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera");
 152
 153 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 154  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 155  *  Descriptor.
 156  */
 157 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Keyboard Demo");
 158
 159 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 160  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 161  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 162  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 163  *  USB host.
 164  */
 165 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 166                                     const uint8_t wIndex,
 167                                     const void** const DescriptorAddress)
 168 {
 169         const uint8_t  DescriptorType   = (wValue >> 8);
 170         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 171
 172         const void* Address = NULL;
 173         uint16_t    Size    = NO_DESCRIPTOR;
 174
 175         switch (DescriptorType)
 176         {
 177                 case DTYPE_Device:
 178                         Address = &DeviceDescriptor;
 179                         Size    = sizeof(USB_Descriptor_Device_t);
 180                         break;
 181                 case DTYPE_Configuration:
 182                         Address = &ConfigurationDescriptor;
 183                         Size    = sizeof(USB_Descriptor_Configuration_t);
 184                         break;
 185                 case DTYPE_String:
 186                         switch (DescriptorNumber)
 187                         {
 188                                 case STRING_ID_Language:
 189                                         Address = &LanguageString;
 190                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 191                                         break;
 192                                 case STRING_ID_Manufacturer:
 193                                         Address = &ManufacturerString;
 194                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 195                                         break;
 196                                 case STRING_ID_Product:
 197                                         Address = &ProductString;
 198                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 199                                         break;
 200                         }
 201
 202                         break;
 203                 case HID_DTYPE_HID:
 204                         Address = &ConfigurationDescriptor.HID_KeyboardHID;
 205                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 206                         break;
 207                 case HID_DTYPE_Report:
 208                         Address = &KeyboardReport;
 209                         Size    = sizeof(KeyboardReport);
 210                         break;
 211         }
 212
 213         *DescriptorAddress = Address;
 214         return Size;
 215 }
 216