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