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