Descriptors.c

Go to the documentation of this file.

/*
 * @brief USB Device Descriptors, for library use when in USB device mode. Descriptors are special
 *        computer-readable structures which the host requests upon device enumeration, to determine
 *        the device's capabilities and functions
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * Copyright(C) Dean Camera, 2011, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#include "Descriptors.h"

/* On some devices, there is a factory set internal serial number which can be automatically sent to the host as
 * the device's serial number when the Device Descriptor's .SerialNumStrIndex entry is set to USE_INTERNAL_SERIAL.
 * This allows the host to track a device across insertions on different ports, allowing them to retain allocated
 * resources like COM port numbers and drivers. On demos using this feature, give a warning on unsupported devices
 * so that the user can supply their own serial number descriptor instead or remove the USE_INTERNAL_SERIAL value
 * from the Device Descriptor (forcing the host to generate a serial number for each device from the VID, PID and
 * port location).
 */

/*****************************************************************************
 * Private types/enumerations/variables
 ****************************************************************************/

/*****************************************************************************
 * Public types/enumerations/variables
 ****************************************************************************/

USB_Descriptor_Device_t DeviceDescriptor = {
 .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},

 .USBSpecification       = VERSION_BCD(01.10),
 .Class                  = CDC_CSCP_CDCClass,
 .SubClass               = CDC_CSCP_NoSpecificSubclass,
 .Protocol               = CDC_CSCP_NoSpecificProtocol,

 .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,

 .VendorID               = 0x1fc9, /* NXP */
 .ProductID              = 0x2047,
 .ReleaseNumber          = VERSION_BCD(00.01),

 .ManufacturerStrIndex   = 0x01,
 .ProductStrIndex        = 0x02,
 .SerialNumStrIndex      = USE_INTERNAL_SERIAL,

 .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
};

USB_Descriptor_Configuration_t ConfigurationDescriptor = {
 .Config = {
  .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},

  .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t) - 1,  // termination byte not included in size
  .TotalInterfaces        = 2,

  .ConfigurationNumber    = 1,
  .ConfigurationStrIndex  = NO_DESCRIPTOR,

  .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),

  .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 },

 .CDC_CCI_Interface = {
  .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

  .InterfaceNumber        = 0,
  .AlternateSetting       = 0,

  .TotalEndpoints         = 1,

  .Class                  = CDC_CSCP_CDCClass,
  .SubClass               = CDC_CSCP_ACMSubclass,
  .Protocol               = CDC_CSCP_ATCommandProtocol,

  .InterfaceStrIndex      = NO_DESCRIPTOR
 },

 .CDC_Functional_Header = {
  .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
  .Subtype                = CDC_DSUBTYPE_CSInterface_Header,

  .CDCSpecification       = VERSION_BCD(01.10),
 },

 .CDC_Functional_ACM = {
  .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
  .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,

  .Capabilities           = 0x06,
 },

 .CDC_Functional_Union = {
  .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
  .Subtype                = CDC_DSUBTYPE_CSInterface_Union,

  .MasterInterfaceNumber  = 0,
  .SlaveInterfaceNumber   = 1,
 },

 .CDC_NotificationEndpoint = {
  .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

  //   .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
  .EndpointAddress        = (ENDPOINT_DIR_IN | CDC_NOTIFICATION_EPNUM),
  .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
  .PollingIntervalMS      = 0xFF
 },

 .CDC_DCI_Interface = {
  .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},

  .InterfaceNumber        = 1,
  .AlternateSetting       = 0,

  .TotalEndpoints         = 2,

  .Class                  = CDC_CSCP_CDCDataClass,
  .SubClass               = CDC_CSCP_NoDataSubclass,
  .Protocol               = CDC_CSCP_NoDataProtocol,

  .InterfaceStrIndex      = NO_DESCRIPTOR
 },

 .CDC_DataOutEndpoint = {
  .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

  //   .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
  .EndpointAddress        = (ENDPOINT_DIR_OUT | CDC_RX_EPNUM),
  .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  .EndpointSize           = CDC_TXRX_EPSIZE,
  .PollingIntervalMS      = 0x01
 },

 .CDC_DataInEndpoint = {
  .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},

  //   .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
  .EndpointAddress        = (ENDPOINT_DIR_IN | CDC_TX_EPNUM),
  .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
  .EndpointSize           = CDC_TXRX_EPSIZE,
  .PollingIntervalMS      = 0x01
 },
 .CDC_Termination = 0x00
};

uint8_t LanguageString[] = {
 USB_STRING_LEN(1),
 DTYPE_String,
 WBVAL(LANGUAGE_ID_ENG),
};
USB_Descriptor_String_t *LanguageStringPtr = (USB_Descriptor_String_t *) LanguageString;

uint8_t ManufacturerString[] = {
 USB_STRING_LEN(3),
 DTYPE_String,
 WBVAL('N'),
 WBVAL('X'),
 WBVAL('P'),
};
USB_Descriptor_String_t *ManufacturerStringPtr = (USB_Descriptor_String_t *) ManufacturerString;

uint8_t ProductString[] = {
 USB_STRING_LEN(29),
 DTYPE_String,
 WBVAL('L'),
 WBVAL('P'),
 WBVAL('C'),
 WBVAL('U'),
 WBVAL('S'),
 WBVAL('B'),
 WBVAL('l'),
 WBVAL('i'),
 WBVAL('b'),
 WBVAL(' '),
 WBVAL('V'),
 WBVAL('i'),
 WBVAL('r'),
 WBVAL('t'),
 WBVAL('u'),
 WBVAL('a'),
 WBVAL('l'),
 WBVAL(' '),
 WBVAL('S'),
 WBVAL('e'),
 WBVAL('r'),
 WBVAL('i'),
 WBVAL('a'),
 WBVAL('l'),
 WBVAL(' '),
 WBVAL('D'),
 WBVAL('e'),
 WBVAL('m'),
 WBVAL('o'),
};
USB_Descriptor_String_t *ProductStringPtr = (USB_Descriptor_String_t *) ProductString;

/*****************************************************************************
 * Private functions
 ****************************************************************************/

/*****************************************************************************
 * Public functions
 ****************************************************************************/

uint16_t CALLBACK_USB_GetDescriptor(uint8_t corenum,
         const uint16_t wValue,
         const uint8_t wIndex,
         const void * *const DescriptorAddress)
{
 const uint8_t  DescriptorType   = (wValue >> 8);
 const uint8_t  DescriptorNumber = (wValue & 0xFF);

 const void *Address = NULL;
 uint16_t    Size    = NO_DESCRIPTOR;

 switch (DescriptorType) {
 case DTYPE_Device:
  Address = &DeviceDescriptor;
  Size    = sizeof(USB_Descriptor_Device_t);
  break;

 case DTYPE_Configuration:
  Address = &ConfigurationDescriptor;
  Size    = sizeof(USB_Descriptor_Configuration_t);
  break;

 case DTYPE_String:
  switch (DescriptorNumber) {
  case 0x00:
   Address = LanguageStringPtr;
   Size    = pgm_read_byte(&LanguageStringPtr->Header.Size);
   break;

  case 0x01:
   Address = ManufacturerStringPtr;
   Size    = pgm_read_byte(&ManufacturerStringPtr->Header.Size);
   break;

  case 0x02:
   Address = ProductStringPtr;
   Size    = pgm_read_byte(&ProductStringPtr->Header.Size);
   break;
  }

  break;
 }

 *DescriptorAddress = Address;
 return Size;
}