LUFA/CodeTemplates/DeviceTemplate/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 /** Device descriptor structure. This descriptor describes the overall device
  41  *  characteristics, including the supported USB version, control endpoint size
  42  *  and the number of device configurations. The descriptor is read out by the
  43  *  USB host when the enumeration process begins.
  44  */
  45 const USB_Descriptor_Device_t DeviceDescriptor =
  46 {
  47         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  48
  49         .USBSpecification       = VERSION_BCD(2,0,0),
  50         .Class                  = USB_CSCP_NoDeviceClass,
  51         .SubClass               = USB_CSCP_NoDeviceSubclass,
  52         .Protocol               = USB_CSCP_NoDeviceProtocol,
  53
  54         .Endpoint0Size          = 64,
  55
  56         .VendorID               = 0x0000,
  57         .ProductID              = 0x0000,
  58         .ReleaseNumber          = VERSION_BCD(0,0,2),
  59
  60         .ManufacturerStrIndex   = 0x01,
  61         .ProductStrIndex        = 0x02,
  62         .SerialNumStrIndex      = NO_DESCRIPTOR,
  63
  64         .NumberOfConfigurations = 1
  65 };
  66
  67 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  68  *  of the device in one of its supported configurations, including information about any device interfaces
  69  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  70  *  a configuration so that the host may correctly communicate with the USB device.
  71  */
  72 const USB_Descriptor_Configuration_t ConfigurationDescriptor =
  73 {
  74         .Config =
  75                 {
  76                         .Header                   = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  77
  78                         .TotalConfigurationSize   = sizeof(USB_Descriptor_Configuration_t),
  79                         .TotalInterfaces          = 0,
  80
  81                         .ConfigurationNumber      = 1,
  82                         .ConfigurationStrIndex    = NO_DESCRIPTOR,
  83
  84                         .ConfigAttributes         = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  85
  86                         .MaxPowerConsumption      = USB_CONFIG_POWER_MA(100)
  87                 },
  88 };
  89
  90 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
  91  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
  92  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
  93  */
  94 const USB_Descriptor_String_t LanguageString =
  95 {
  96         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
  97
  98         .UnicodeString          = {LANGUAGE_ID_ENG}
  99 };
 100
 101 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 102  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 103  *  Descriptor.
 104  */
 105 const USB_Descriptor_String_t ManufacturerString =
 106 {
 107         .Header                 = {.Size = USB_STRING_LEN(14), .Type = DTYPE_String},
 108
 109         .UnicodeString          = L"Your Name Here"
 110 };
 111
 112 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 113  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 114  *  Descriptor.
 115  */
 116 const USB_Descriptor_String_t ProductString =
 117 {
 118         .Header                 = {.Size = USB_STRING_LEN(15), .Type = DTYPE_String},
 119
 120         .UnicodeString          = L"LUFA USB Device"
 121 };
 122
 123 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 124  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 125  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 126  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 127  *  USB host.
 128  */
 129 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 130                                     const uint8_t wIndex,
 131                                     const void** const DescriptorAddress
 132                                                                         #if defined(HAS_MULTIPLE_DESCRIPTOR_ADDRESS_SPACES)
 133                                                                         , uint8_t* const DescriptorMemorySpace
 134                                                                         #endif
 135                                                                         )
 136 {
 137         const uint8_t  DescriptorType   = (wValue >> 8);
 138         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 139
 140         const void* Address = NULL;
 141         uint16_t    Size    = NO_DESCRIPTOR;
 142
 143         switch (DescriptorType)
 144         {
 145                 case DTYPE_Device:
 146                         Address = &DeviceDescriptor;
 147                         Size    = sizeof(USB_Descriptor_Device_t);
 148                         break;
 149                 case DTYPE_Configuration:
 150                         Address = &ConfigurationDescriptor;
 151                         Size    = sizeof(USB_Descriptor_Configuration_t);
 152                         break;
 153                 case DTYPE_String:
 154                         switch (DescriptorNumber)
 155                         {
 156                                 case 0x00:
 157                                         Address = &LanguageString;
 158                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 159                                         break;
 160                                 case 0x01:
 161                                         Address = &ManufacturerString;
 162                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 163                                         break;
 164                                 case 0x02:
 165                                         Address = &ProductString;
 166                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 167                                         break;
 168                         }
 169
 170                         break;
 171         }
 172
 173         #if defined(HAS_MULTIPLE_DESCRIPTOR_ADDRESS_SPACES)
 174         *DescriptorMemorySpace = MEMSPACE_RAM;
 175         #endif
 176
 177         *DescriptorAddress = Address;
 178         return Size;
 179 }
 180