Demos/Device/Incomplete/TestAndMeasurement/Descriptors.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2010  Peter Lawrence (majbthrd [at] gmail [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaims all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
  35  *  computer-readable structures which the host requests upon device enumeration, to determine
  36  *  the device's capabilities and functions.
  37  */
  38
  39 #include "Descriptors.h"
  40
  41
  42 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  43  *  device characteristics, including the supported USB version, control endpoint size and the
  44  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  45  *  process begins.
  46  */
  47 const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  48 {
  49         .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  50
  51         .USBSpecification       = VERSION_BCD(1,1,0),
  52         .Class                  = 0x00,
  53         .SubClass               = 0x00,
  54         .Protocol               = 0x00,
  55
  56         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  57
  58         .VendorID               = 0x03EB,
  59         .ProductID              = 0x2065,
  60         .ReleaseNumber          = VERSION_BCD(0,0,1),
  61
  62         .ManufacturerStrIndex   = STRING_ID_Manufacturer,
  63         .ProductStrIndex        = STRING_ID_Product,
  64         .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
  65
  66         .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  67 };
  68
  69 /** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  70  *  of the device in one of its supported configurations, including information about any device interfaces
  71  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  72  *  a configuration so that the host may correctly communicate with the USB device.
  73  */
  74 const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  75 {
  76         .Config =
  77                 {
  78                         .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  79
  80                         .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  81                         .TotalInterfaces        = 1,
  82
  83                         .ConfigurationNumber    = 1,
  84                         .ConfigurationStrIndex  = NO_DESCRIPTOR,
  85
  86                         .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
  87
  88                         .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
  89                 },
  90
  91         .TM_Interface =
  92                 {
  93                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  94
  95                         .InterfaceNumber        = INTERFACE_ID_TestAndMeasurement,
  96                         .AlternateSetting       = 0x00,
  97
  98                         .TotalEndpoints         = 3,
  99
 100                         .Class                  = 0xFE,
 101                         .SubClass               = 0x03,
 102                         .Protocol               = 0x01,
 103
 104                         .InterfaceStrIndex      = NO_DESCRIPTOR
 105                 },
 106
 107         .TM_DataOutEndpoint =
 108                 {
 109                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 110
 111                         .EndpointAddress        = TMC_OUT_EPADDR,
 112                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 113                         .EndpointSize           = TMC_IO_EPSIZE,
 114                         .PollingIntervalMS      = 0x05
 115                 },
 116
 117         .TM_DataInEndpoint =
 118                 {
 119                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 120
 121                         .EndpointAddress        = TMC_IN_EPADDR,
 122                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 123                         .EndpointSize           = TMC_IO_EPSIZE,
 124                         .PollingIntervalMS      = 0x05
 125                 },
 126
 127         .TM_NotificationEndpoint =
 128                 {
 129                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 130
 131                         .EndpointAddress        = TMC_NOTIFICATION_EPADDR,
 132                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 133                         .EndpointSize           = TMC_NOTIFICATION_EPSIZE,
 134                         .PollingIntervalMS      = 0xFF
 135                 }
 136 };
 137
 138 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 139  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 140  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 141  */
 142 const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);
 143
 144 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 145  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 146  *  Descriptor.
 147  */
 148 const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"LUFA Library");
 149
 150 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 151  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 152  *  Descriptor.
 153  */
 154 const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA TMC Demo");
 155
 156 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 157  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 158  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 159  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 160  *  USB host.
 161  */
 162 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 163                                     const uint16_t wIndex,
 164                                     const void** const DescriptorAddress)
 165 {
 166         const uint8_t  DescriptorType   = (wValue >> 8);
 167         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 168
 169         const void* Address = NULL;
 170         uint16_t    Size    = NO_DESCRIPTOR;
 171
 172         switch (DescriptorType)
 173         {
 174                 case DTYPE_Device:
 175                         Address = &DeviceDescriptor;
 176                         Size    = sizeof(USB_Descriptor_Device_t);
 177                         break;
 178                 case DTYPE_Configuration:
 179                         Address = &ConfigurationDescriptor;
 180                         Size    = sizeof(USB_Descriptor_Configuration_t);
 181                         break;
 182                 case DTYPE_String:
 183                         switch (DescriptorNumber)
 184                         {
 185                                 case STRING_ID_Language:
 186                                         Address = &LanguageString;
 187                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 188                                         break;
 189                                 case STRING_ID_Manufacturer:
 190                                         Address = &ManufacturerString;
 191                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 192                                         break;
 193                                 case STRING_ID_Product:
 194                                         Address = &ProductString;
 195                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 196                                         break;
 197                         }
 198
 199                         break;
 200         }
 201
 202         *DescriptorAddress = Address;
 203         return Size;
 204 }
 205