Demos/Device/ClassDriver/VirtualSerialMouse/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 /* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
  41  * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
  42  * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
  43  * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
  44  * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
  45  * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
  46  * port location).
  47  */
  48 #if (USE_INTERNAL_SERIAL == NO_DESCRIPTOR)
  49         #warning USE_INTERNAL_SERIAL is not available on this AVR - please manually construct a device serial descriptor.
  50 #endif
  51
  52 /** HID class report descriptor. This is a special descriptor constructed with values from the
  53  *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
  54  *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
  55  *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
  56  *  more details on HID report descriptors.
  57  */
  58 USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
  59 {
  60         0x05, 0x01,          /* Usage Page (Generic Desktop)             */
  61         0x09, 0x02,          /* Usage (Mouse)                            */
  62         0xA1, 0x01,          /* Collection (Application)                 */
  63         0x09, 0x01,          /*   Usage (Pointer)                        */
  64         0xA1, 0x00,          /*   Collection (Application)               */
  65         0x95, 0x03,          /*     Report Count (3)                     */
  66         0x75, 0x01,          /*     Report Size (1)                      */
  67         0x05, 0x09,          /*     Usage Page (Button)                  */
  68         0x19, 0x01,          /*     Usage Minimum (Button 1)             */
  69         0x29, 0x03,          /*     Usage Maximum (Button 3)             */
  70         0x15, 0x00,          /*     Logical Minimum (0)                  */
  71         0x25, 0x01,          /*     Logical Maximum (1)                  */
  72         0x81, 0x02,          /*     Input (Data, Variable, Absolute)     */
  73         0x95, 0x01,          /*     Report Count (1)                     */
  74         0x75, 0x05,          /*     Report Size (5)                      */
  75         0x81, 0x01,          /*     Input (Constant)                     */
  76         0x75, 0x08,          /*     Report Size (8)                      */
  77         0x95, 0x02,          /*     Report Count (2)                     */
  78         0x05, 0x01,          /*     Usage Page (Generic Desktop Control) */
  79         0x09, 0x30,          /*     Usage X                              */
  80         0x09, 0x31,          /*     Usage Y                              */
  81         0x15, 0x81,          /*     Logical Minimum (-127)               */
  82         0x25, 0x7F,          /*     Logical Maximum (127)                */
  83         0x81, 0x06,          /*     Input (Data, Variable, Relative)     */
  84         0xC0,                /*   End Collection                         */
  85         0xC0                 /* End Collection                           */
  86 };
  87
  88 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  89  *  device characteristics, including the supported USB version, control endpoint size and the
  90  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  91  *  process begins.
  92  */
  93 USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  94 {
  95         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  96
  97         .USBSpecification       = VERSION_BCD(01.10),
  98         .Class                  = 0xEF,
  99         .SubClass               = 0x02,
 100         .Protocol               = 0x01,
 101
 102         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 103
 104         .VendorID               = 0x03EB,
 105         .ProductID              = 0x2062,
 106         .ReleaseNumber          = 0x0000,
 107
 108         .ManufacturerStrIndex   = 0x01,
 109         .ProductStrIndex        = 0x02,
 110         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
 111
 112         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 113 };
 114
 115 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
 116  *  of the device in one of its supported configurations, including information about any device interfaces
 117  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
 118  *  a configuration so that the host may correctly communicate with the USB device.
 119  */
 120 USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 121 {
 122         .Config =
 123                 {
 124                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 125
 126                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 127                         .TotalInterfaces        = 3,
 128
 129                         .ConfigurationNumber    = 1,
 130                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
 131
 132                         .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
 133
 134                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 135                 },
 136
 137         .CDC_IAD =
 138                 {
 139                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
 140
 141                         .FirstInterfaceIndex    = 0,
 142                         .TotalInterfaces        = 2,
 143
 144                         .Class                  = 0x02,
 145                         .SubClass               = 0x02,
 146                         .Protocol               = 0x01,
 147
 148                         .IADStrIndex            = NO_DESCRIPTOR
 149                 },
 150
 151         .CDC_CCI_Interface =
 152                 {
 153                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 154
 155                         .InterfaceNumber        = 0,
 156                         .AlternateSetting       = 0,
 157
 158                         .TotalEndpoints         = 1,
 159
 160                         .Class                  = 0x02,
 161                         .SubClass               = 0x02,
 162                         .Protocol               = 0x01,
 163
 164                         .InterfaceStrIndex      = NO_DESCRIPTOR
 165                 },
 166
 167         .CDC_Functional_IntHeader =
 168                 {
 169                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 170                         .SubType                = 0x00,
 171
 172                         .Data                   = {0x01, 0x10}
 173                 },
 174
 175         .CDC_Functional_AbstractControlManagement =
 176                 {
 177                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), .Type = 0x24},
 178                         .SubType                = 0x02,
 179
 180                         .Data                   = {0x06}
 181                 },
 182
 183         .CDC_Functional_Union =
 184                 {
 185                         .Header                 = {.Size = sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), .Type = 0x24},
 186                         .SubType                = 0x06,
 187
 188                         .Data                   = {0x00, 0x01}
 189                 },
 190
 191         .CDC_NotificationEndpoint =
 192                 {
 193                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 194
 195                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
 196                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 197                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 198                         .PollingIntervalMS      = 0xFF
 199                 },
 200
 201         .CDC_DCI_Interface =
 202                 {
 203                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 204
 205                         .InterfaceNumber        = 1,
 206                         .AlternateSetting       = 0,
 207
 208                         .TotalEndpoints         = 2,
 209
 210                         .Class                  = 0x0A,
 211                         .SubClass               = 0x00,
 212                         .Protocol               = 0x00,
 213
 214                         .InterfaceStrIndex      = NO_DESCRIPTOR
 215                 },
 216
 217         .CDC_DataOutEndpoint =
 218                 {
 219                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 220
 221                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
 222                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 223                         .EndpointSize           = CDC_TXRX_EPSIZE,
 224                         .PollingIntervalMS      = 0x00
 225                 },
 226
 227         .CDC_DataInEndpoint =
 228                 {
 229                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 230
 231                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
 232                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 233                         .EndpointSize           = CDC_TXRX_EPSIZE,
 234                         .PollingIntervalMS      = 0x00
 235                 },
 236
 237         .HID_Interface =
 238                 {
 239                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 240
 241                         .InterfaceNumber        = 2,
 242                         .AlternateSetting       = 0,
 243
 244                         .TotalEndpoints         = 1,
 245
 246                         .Class                  = 0x03,
 247                         .SubClass               = 0x01,
 248                         .Protocol               = HID_BOOT_MOUSE_PROTOCOL,
 249
 250                         .InterfaceStrIndex      = NO_DESCRIPTOR
 251                 },
 252
 253         .HID_MouseHID =
 254                 {
 255                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = DTYPE_HID},
 256
 257                         .HIDSpec                = VERSION_BCD(01.11),
 258                         .CountryCode            = 0x00,
 259                         .TotalReportDescriptors = 1,
 260                         .HIDReportType          = DTYPE_Report,
 261                         .HIDReportLength        = sizeof(MouseReport)
 262                 },
 263
 264         .HID_ReportINEndpoint =
 265                 {
 266                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 267
 268                         .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_EPNUM),
 269                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 270                         .EndpointSize           = MOUSE_EPSIZE,
 271                         .PollingIntervalMS      = 0x0A
 272                 }
 273 };
 274
 275 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 276  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 277  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 278  */
 279 USB_Descriptor_String_t PROGMEM LanguageString =
 280 {
 281         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 282
 283         .UnicodeString          = {LANGUAGE_ID_ENG}
 284 };
 285
 286 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 287  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 288  *  Descriptor.
 289  */
 290 USB_Descriptor_String_t PROGMEM ManufacturerString =
 291 {
 292         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 293
 294         .UnicodeString          = L"Dean Camera"
 295 };
 296
 297 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 298  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 299  *  Descriptor.
 300  */
 301 USB_Descriptor_String_t PROGMEM ProductString =
 302 {
 303         .Header                 = {.Size = USB_STRING_LEN(23), .Type = DTYPE_String},
 304
 305         .UnicodeString          = L"LUFA CDC and Mouse Demo"
 306 };
 307
 308 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 309  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 310  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 311  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 312  *  USB host.
 313  */
 314 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 315                                     const uint8_t wIndex,
 316                                     const void** const DescriptorAddress)
 317 {
 318         const uint8_t  DescriptorType   = (wValue >> 8);
 319         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 320
 321         const void* Address = NULL;
 322         uint16_t    Size    = NO_DESCRIPTOR;
 323
 324         switch (DescriptorType)
 325         {
 326                 case DTYPE_Device:
 327                         Address = &DeviceDescriptor;
 328                         Size    = sizeof(USB_Descriptor_Device_t);
 329                         break;
 330                 case DTYPE_Configuration:
 331                         Address = &ConfigurationDescriptor;
 332                         Size    = sizeof(USB_Descriptor_Configuration_t);
 333                         break;
 334                 case DTYPE_String:
 335                         switch (DescriptorNumber)
 336                         {
 337                                 case 0x00:
 338                                         Address = &LanguageString;
 339                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 340                                         break;
 341                                 case 0x01:
 342                                         Address = &ManufacturerString;
 343                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 344                                         break;
 345                                 case 0x02:
 346                                         Address = &ProductString;
 347                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 348                                         break;
 349                         }
 350
 351                         break;
 352                 case DTYPE_HID:
 353                         Address = &ConfigurationDescriptor.HID_MouseHID;
 354                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 355                         break;
 356                 case DTYPE_Report:
 357                         Address = &MouseReport;
 358                         Size    = sizeof(MouseReport);
 359                         break;
 360         }
 361
 362         *DescriptorAddress = Address;
 363         return Size;
 364 }