lib/lufa/Demos/Device/ClassDriver/Mouse/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 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(1,1,0),
  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               = 0x03EB,
  76         .ProductID              = 0x2041,
  77         .ReleaseNumber          = VERSION_BCD(0,0,1),
  78
  79         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  80         .ProductStrIndex        = STRING_ID_Product,
  81         .SerialNumStrIndex      = NO_DESCRIPTOR,
  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 = sizeof(USB_Descriptor_Configuration_t),
  98                         .TotalInterfaces        = 1,
  99
 100                         .ConfigurationNumber    = 1,
 101                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 102
 103                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | 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        = INTERFACE_ID_Mouse,
 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(1,1,1),
 129                         .CountryCode            = 0x00,
 130                         .TotalReportDescriptors = 1,
 131                         .HIDReportType          = HID_DTYPE_Report,
 132                         .HIDReportLength        = sizeof(MouseReport)
 133                 },
 134
 135         .HID_ReportINEndpoint =
 136                 {
 137                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 138
 139                         .EndpointAddress        = MOUSE_EPADDR,
 140                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 141                         .EndpointSize           = MOUSE_EPSIZE,
 142                         .PollingIntervalMS      = 0x05
 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 = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 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 = USB_STRING_DESCRIPTOR(L"Dean Camera");
 157
 158 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 159  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 160  *  Descriptor.
 161  */
 162 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Mouse Demo");
 163
 164 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 165  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 166  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 167  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 168  *  USB host.
 169  */
 170 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 171                                     const uint16_t wIndex,
 172                                     const void** const DescriptorAddress)
 173 {
 174         const uint8_t  DescriptorType   = (wValue >> 8);
 175         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 176
 177         const void* Address = NULL;
 178         uint16_t    Size    = NO_DESCRIPTOR;
 179
 180         switch (DescriptorType)
 181         {
 182                 case DTYPE_Device:
 183                         Address = &DeviceDescriptor;
 184                         Size    = sizeof(USB_Descriptor_Device_t);
 185                         break;
 186                 case DTYPE_Configuration:
 187                         Address = &ConfigurationDescriptor;
 188                         Size    = sizeof(USB_Descriptor_Configuration_t);
 189                         break;
 190                 case DTYPE_String:
 191                         switch (DescriptorNumber)
 192                         {
 193                                 case STRING_ID_Language:
 194                                         Address = &LanguageString;
 195                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 196                                         break;
 197                                 case STRING_ID_Manufacturer:
 198                                         Address = &ManufacturerString;
 199                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 200                                         break;
 201                                 case STRING_ID_Product:
 202                                         Address = &ProductString;
 203                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 204                                         break;
 205                         }
 206
 207                         break;
 208                 case HID_DTYPE_HID:
 209                         Address = &ConfigurationDescriptor.HID_MouseHID;
 210                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 211                         break;
 212                 case HID_DTYPE_Report:
 213                         Address = &MouseReport;
 214                         Size    = sizeof(MouseReport);
 215                         break;
 216         }
 217
 218         *DescriptorAddress = Address;
 219         return Size;
 220 }
 221