usb_descriptors.h File Reference

#include "tusb.h"
#include "tinyusb_types.h"

Include dependency graph for usb_descriptors.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	_PID_MAP(itf, n)

Variables
tusb_desc_device_t	descriptor_tinyusb
tusb_desc_strarray_device_t	descriptor_str_tinyusb
const tusb_desc_device_t	descriptor_dev_kconfig
tusb_desc_strarray_device_t	descriptor_str_kconfig
const uint8_t	descriptor_cfg_kconfig []

Macro Definition Documentation

_PID_MAP

#define _PID_MAP	(		itf,
			n )

Value:

((CFG_TUD_##itf) << (n))

Definition at line 16 of file usb_descriptors.h.

Variable Documentation

descriptor_cfg_kconfig

const uint8_t descriptor_cfg_kconfig[]

extern

Definition at line 166 of file usb_descriptors.c.

                                       {
    // Configuration number, interface count, string index, total length, attribute, power in mA
    TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, TUSB_DESC_TOTAL_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100),
 
#if CFG_TUD_CDC
    // Interface number, string index, EP notification address and size, EP data address (out, in) and size.
    TUD_CDC_DESCRIPTOR(ITF_NUM_CDC, 4, 0x80 | EPNUM_0_CDC_NOTIF, 8, EPNUM_0_CDC, 0x80 | EPNUM_0_CDC, CFG_TUD_CDC_EP_BUFSIZE),
#endif
 
#if CFG_TUD_CDC > 1
    // Interface number, string index, EP notification address and size, EP data address (out, in) and size.
    TUD_CDC_DESCRIPTOR(ITF_NUM_CDC1, 4, 0x80 | EPNUM_1_CDC_NOTIF, 8, EPNUM_1_CDC, 0x80 | EPNUM_1_CDC, CFG_TUD_CDC_EP_BUFSIZE),
#endif
 
#if CFG_TUD_MSC
    // Interface number, string index, EP Out & EP In address, EP size
    TUD_MSC_DESCRIPTOR(ITF_NUM_MSC, 5, EPNUM_MSC, 0x80 | EPNUM_MSC, 64), // highspeed 512
#endif
};

Referenced by tinyusb_driver_install().

descriptor_dev_kconfig

const tusb_desc_device_t descriptor_dev_kconfig

extern

Definition at line 61 of file usb_descriptors.c.

                                                {
    .bLength = sizeof(descriptor_dev_kconfig),
    .bDescriptorType = TUSB_DESC_DEVICE,
    .bcdUSB = 0x0200,
 
#if CFG_TUD_CDC
    // Use Interface Association Descriptor (IAD) for CDC
    // As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
    .bDeviceClass = TUSB_CLASS_MISC,
    .bDeviceSubClass = MISC_SUBCLASS_COMMON,
    .bDeviceProtocol = MISC_PROTOCOL_IAD,
#else
    .bDeviceClass = 0x00,
    .bDeviceSubClass = 0x00,
    .bDeviceProtocol = 0x00,
#endif
 
    .bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE,
 
#if CONFIG_TINYUSB_DESC_USE_ESPRESSIF_VID
    .idVendor = USB_ESPRESSIF_VID,
#else
    .idVendor = CONFIG_TINYUSB_DESC_CUSTOM_VID,
#endif
 
#if CONFIG_TINYUSB_DESC_USE_DEFAULT_PID
    .idProduct = USB_TUSB_PID,
#else
    .idProduct = CONFIG_TINYUSB_DESC_CUSTOM_PID,
#endif
 
    .bcdDevice = CONFIG_TINYUSB_DESC_BCD_DEVICE,
 
    .iManufacturer = 0x01,
    .iProduct = 0x02,
    .iSerialNumber = 0x03,
 
    .bNumConfigurations = 0x01
};

Referenced by tinyusb_driver_install().

descriptor_str_kconfig

tusb_desc_strarray_device_t descriptor_str_kconfig

extern

Definition at line 101 of file usb_descriptors.c.

                                                   {
    // array of pointer to string descriptors
    (char[]){0x09, 0x04},                // 0: is supported language is English (0x0409)
    CONFIG_TINYUSB_DESC_MANUFACTURER_STRING, // 1: Manufacturer
    CONFIG_TINYUSB_DESC_PRODUCT_STRING,      // 2: Product
    CONFIG_TINYUSB_DESC_SERIAL_STRING,       // 3: Serials, should use chip ID
 
#if CONFIG_TINYUSB_CDC_ENABLED
    CONFIG_TINYUSB_DESC_CDC_STRING,          // 4: CDC Interface
#else
    "",
#endif
 
#if CONFIG_TINYUSB_MSC_ENABLED
    CONFIG_TINYUSB_DESC_MSC_STRING,          // 5: MSC Interface
#else
    "",
#endif
 
};

Referenced by tinyusb_driver_install().

descriptor_str_tinyusb

tusb_desc_strarray_device_t descriptor_str_tinyusb

extern

Definition at line 51 of file usb_descriptors.c.

                                                   {
    // array of pointer to string descriptors
    (char[]){0x09, 0x04}, // 0: is supported language is English (0x0409)
    "TinyUSB",            // 1: Manufacturer
    "TinyUSB Device",     // 2: Product
    "123456",             // 3: Serials, should use chip ID
};

descriptor_tinyusb

tusb_desc_device_t descriptor_tinyusb

extern

Definition at line 21 of file usb_descriptors.c.

                                      {
    .bLength = sizeof(descriptor_tinyusb),
    .bDescriptorType = TUSB_DESC_DEVICE,
    .bcdUSB = 0x0200,
 
#if CFG_TUD_CDC
    // Use Interface Association Descriptor (IAD) for CDC
    // As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
    .bDeviceClass = TUSB_CLASS_MISC,
    .bDeviceSubClass = MISC_SUBCLASS_COMMON,
    .bDeviceProtocol = MISC_PROTOCOL_IAD,
#else
    .bDeviceClass = 0x00,
    .bDeviceSubClass = 0x00,
    .bDeviceProtocol = 0x00,
#endif
 
    .bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE,
 
    .idVendor = 0xCafe,
    .idProduct = USB_TUSB_PID,
    .bcdDevice = 0x0100,
 
    .iManufacturer = 0x01,
    .iProduct = 0x02,
    .iSerialNumber = 0x03,
 
    .bNumConfigurations = 0x01
};