Projects/Magstripe/Descriptors.c

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