Projects/MediaController/Descriptors.c

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