Projects/Magstripe/Descriptors.c

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