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