Projects/SerialToLCD/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   Copyright 2012  Simon Foster (simon.foster [at] inbox [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 disclaim 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(01.10),
  52         .Class                  = CDC_CSCP_CDCClass,
  53         .SubClass               = CDC_CSCP_NoSpecificSubclass,
  54         .Protocol               = CDC_CSCP_NoSpecificProtocol,
  55
  56         .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
  57
  58         .VendorID               = 0x03EB,
  59         .ProductID              = 0x204B,
  60         .ReleaseNumber          = VERSION_BCD(00.01),
  61
  62         .ManufacturerStrIndex   = 0x01,
  63         .ProductStrIndex        = 0x02,
  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        = 2,
  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         .CDC_CCI_Interface =
  92                 {
  93                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  94
  95                         .InterfaceNumber        = 0,
  96                         .AlternateSetting       = 0,
  97
  98                         .TotalEndpoints         = 1,
  99
 100                         .Class                  = CDC_CSCP_CDCClass,
 101                         .SubClass               = CDC_CSCP_ACMSubclass,
 102                         .Protocol               = CDC_CSCP_ATCommandProtocol,
 103
 104                         .InterfaceStrIndex      = NO_DESCRIPTOR
 105                 },
 106
 107         .CDC_Functional_Header =
 108                 {
 109                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
 110                         .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
 111
 112                         .CDCSpecification       = VERSION_BCD(01.10),
 113                 },
 114
 115         .CDC_Functional_ACM =
 116                 {
 117                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
 118                         .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
 119
 120                         .Capabilities           = 0x06,
 121                 },
 122
 123         .CDC_Functional_Union =
 124                 {
 125                         .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
 126                         .Subtype                = CDC_DSUBTYPE_CSInterface_Union,
 127
 128                         .MasterInterfaceNumber  = 0,
 129                         .SlaveInterfaceNumber   = 1,
 130                 },
 131
 132         .CDC_NotificationEndpoint =
 133                 {
 134                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 135
 136                         .EndpointAddress        = CDC_NOTIFICATION_EPADDR,
 137                         .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 138                         .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
 139                         .PollingIntervalMS      = 0xFF
 140                 },
 141
 142         .CDC_DCI_Interface =
 143                 {
 144                         .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 145
 146                         .InterfaceNumber        = 1,
 147                         .AlternateSetting       = 0,
 148
 149                         .TotalEndpoints         = 2,
 150
 151                         .Class                  = CDC_CSCP_CDCDataClass,
 152                         .SubClass               = CDC_CSCP_NoDataSubclass,
 153                         .Protocol               = CDC_CSCP_NoDataProtocol,
 154
 155                         .InterfaceStrIndex      = NO_DESCRIPTOR
 156                 },
 157
 158         .CDC_DataOutEndpoint =
 159                 {
 160                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 161
 162                         .EndpointAddress        = CDC_RX_EPADDR,
 163                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 164                         .EndpointSize           = CDC_TXRX_EPSIZE,
 165                         .PollingIntervalMS      = 0x05
 166                 },
 167
 168         .CDC_DataInEndpoint =
 169                 {
 170                         .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 171
 172                         .EndpointAddress        = CDC_TX_EPADDR,
 173                         .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 174                         .EndpointSize           = CDC_TXRX_EPSIZE,
 175                         .PollingIntervalMS      = 0x05
 176                 }
 177 };
 178
 179 /** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
 180  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
 181  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
 182  */
 183 const USB_Descriptor_String_t PROGMEM LanguageString =
 184 {
 185         .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 186
 187         .UnicodeString          = {LANGUAGE_ID_ENG}
 188 };
 189
 190 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
 191  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 192  *  Descriptor.
 193  */
 194 const USB_Descriptor_String_t PROGMEM ManufacturerString =
 195 {
 196         .Header                 = {.Size = USB_STRING_LEN(12), .Type = DTYPE_String},
 197
 198         .UnicodeString          = L"Simon Foster"
 199 };
 200
 201 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
 202  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
 203  *  Descriptor.
 204  */
 205 const USB_Descriptor_String_t PROGMEM ProductString =
 206 {
 207         .Header                 = {.Size = USB_STRING_LEN(19), .Type = DTYPE_String},
 208
 209         .UnicodeString          = L"USB-HD44780 Adapter"
 210 };
 211
 212 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 213  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 214  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 215  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 216  *  USB host.
 217  */
 218 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 219                                     const uint8_t wIndex,
 220                                     const void** const DescriptorAddress)
 221 {
 222         const uint8_t  DescriptorType   = (wValue >> 8);
 223         const uint8_t  DescriptorNumber = (wValue & 0xFF);
 224
 225         const void* Address = NULL;
 226         uint16_t    Size    = NO_DESCRIPTOR;
 227
 228         switch (DescriptorType)
 229         {
 230                 case DTYPE_Device:
 231                         Address = &DeviceDescriptor;
 232                         Size    = sizeof(USB_Descriptor_Device_t);
 233                         break;
 234                 case DTYPE_Configuration:
 235                         Address = &ConfigurationDescriptor;
 236                         Size    = sizeof(USB_Descriptor_Configuration_t);
 237                         break;
 238                 case DTYPE_String:
 239                         switch (DescriptorNumber)
 240                         {
 241                                 case 0x00:
 242                                         Address = &LanguageString;
 243                                         Size    = pgm_read_byte(&LanguageString.Header.Size);
 244                                         break;
 245                                 case 0x01:
 246                                         Address = &ManufacturerString;
 247                                         Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 248                                         break;
 249                                 case 0x02:
 250                                         Address = &ProductString;
 251                                         Size    = pgm_read_byte(&ProductString.Header.Size);
 252                                         break;
 253                         }
 254
 255                         break;
 256         }
 257
 258         *DescriptorAddress = Address;
 259         return Size;
 260 }
 261