Projects/TempDataLogger/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
  41 /** HID class report descriptor. This is a special descriptor constructed with values from the
  42  *  USBIF HID class specification to describe the reports and capabilities of the HID device. This
  43  *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding)
  44  *  the device will send, and what it may be sent back from the host. Refer to the HID specification for
  45  *  more details on HID report descriptors.
  46  */
  47 const USB_Descriptor_HIDReport_Datatype_t PROGMEM GenericReport[] =
  48 {
  49         /* Use the HID class driver's standard Vendor HID report.
  50          *  Vendor Usage Page: 1
  51          *  Vendor Collection Usage: 1
  52          *  Vendor Report IN Usage: 2
  53          *  Vendor Report OUT Usage: 3
  54          *  Vendor Report Size: GENERIC_REPORT_SIZE
  55          */
  56         HID_DESCRIPTOR_VENDOR(0x00, 0x01, 0x02, 0x03, GENERIC_REPORT_SIZE)
  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(01.10),
  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              = 0x2063,
  77         .ReleaseNumber          = VERSION_BCD(00.01),
  78
  79         .ManufacturerStrIndex   = 0x01,
  80         .ProductStrIndex        = 0x02,
  81         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  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        = 2,
  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         .MS_Interface =
 109                 {
 110                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 111
 112                         .InterfaceNumber        = 0,
 113                         .AlternateSetting       = 0,
 114
 115                         .TotalEndpoints         = 2,
 116
 117                         .Class                  = MS_CSCP_MassStorageClass,
 118                         .SubClass               = MS_CSCP_SCSITransparentSubclass,
 119                         .Protocol               = MS_CSCP_BulkOnlyTransportProtocol,
 120
 121                         .InterfaceStrIndex      = NO_DESCRIPTOR
 122                 },
 123
 124         .MS_DataInEndpoint =
 125                 {
 126                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 127
 128                         .EndpointAddress        = MASS_STORAGE_IN_EPADDR,
 129                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 130                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 131                         .PollingIntervalMS      = 0x05
 132                 },
 133
 134         .MS_DataOutEndpoint =
 135                 {
 136                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 137
 138                         .EndpointAddress        = MASS_STORAGE_OUT_EPADDR,
 139                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 140                         .EndpointSize           = MASS_STORAGE_IO_EPSIZE,
 141                         .PollingIntervalMS      = 0x05
 142                 },
 143
 144         .HID_Interface =
 145                 {
 146                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 147
 148                         .InterfaceNumber        = 1,
 149                         .AlternateSetting       = 0,
 150
 151                         .TotalEndpoints         = 1,
 152
 153                         .Class                  = HID_CSCP_HIDClass,
 154                         .SubClass               = HID_CSCP_NonBootSubclass,
 155                         .Protocol               = HID_CSCP_NonBootProtocol,
 156
 157                         .InterfaceStrIndex      = NO_DESCRIPTOR
 158                 },
 159
 160         .HID_GenericHID =
 161                 {
 162                         .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 163
 164                         .HIDSpec                = VERSION_BCD(01.11),
 165                         .CountryCode            = 0x00,
 166                         .TotalReportDescriptors = 1,
 167                         .HIDReportType          = HID_DTYPE_Report,
 168                         .HIDReportLength        = sizeof(GenericReport)
 169                 },
 170
 171         .HID_ReportINEndpoint =
 172                 {
 173                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 174
 175                         .EndpointAddress        = GENERIC_IN_EPADDR,
 176                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 177                         .EndpointSize           = GENERIC_EPSIZE,
 178                         .PollingIntervalMS      = 0x05
 179                 },
 180 };
 181
 182 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 183  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 184  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 185  */
 186 const USB_Descriptor_String_t PROGMEM LanguageString =
 187 {
 188         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 189
 190         .UnicodeString          = {LANGUAGE_ID_ENG}
 191 };
 192
 193 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 194  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 195  *  Descriptor.
 196  */
 197 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 198 {
 199         .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 200
 201         .UnicodeString          = L"Dean Camera"
 202 };
 203
 204 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 205  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 206  *  Descriptor.
 207  */
 208 const USB_Descriptor_String_t PROGMEM ProductString =
 209 {
 210         .Header                 = {.Size = USB_STRING_LEN(22), .Type = DTYPE_String},
 211
 212         .UnicodeString          = L"Temperature Datalogger"
 213 };
 214
 215 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 216  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 217  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 218  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 219  *  USB host.
 220  */
 221 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 222                                     const uint8_t wIndex,
 223                                     const void** const DescriptorAddress)
 224 {
 225         const uint8_t  DescriptorType   = (wValue >> 8);
 226         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 227
 228         const void* Address = NULL;
 229         uint16_t    Size    = NO_DESCRIPTOR;
 230
 231         switch (DescriptorType)
 232         {
 233                 case DTYPE_Device:
 234                         Address = &DeviceDescriptor;
 235                         Size    = sizeof(USB_Descriptor_Device_t);
 236                         break;
 237                 case DTYPE_Configuration:
 238                         Address = &ConfigurationDescriptor;
 239                         Size    = sizeof(USB_Descriptor_Configuration_t);
 240                         break;
 241                 case DTYPE_String:
 242                         switch (DescriptorNumber)
 243                         {
 244                                 case 0x00:
 245                                         Address = &LanguageString;
 246                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 247                                         break;
 248                                 case 0x01:
 249                                         Address = &ManufacturerString;
 250                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 251                                         break;
 252                                 case 0x02:
 253                                         Address = &ProductString;
 254                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 255                                         break;
 256                         }
 257
 258                         break;
 259                 case HID_DTYPE_HID:
 260                         Address = &ConfigurationDescriptor.HID_GenericHID;
 261                         Size    = sizeof(USB_HID_Descriptor_HID_t);
 262                         break;
 263                 case HID_DTYPE_Report:
 264                         Address = &GenericReport;
 265                         Size    = sizeof(GenericReport);
 266                         break;
 267         }
 268
 269         *DescriptorAddress = Address;
 270         return Size;
 271 }
 272