descriptors_control.c File Reference

#include <string.h>
#include "esp_log.h"
#include "descriptors_control.h"

Include dependency graph for descriptors_control.c:

Go to the source code of this file.

Macros
#define	MAX_DESC_BUF_SIZE   32

Functions
uint8_t const *	tud_descriptor_device_cb (void)
	Invoked when received GET DEVICE DESCRIPTOR. Application returns pointer to descriptor.
uint8_t const *	tud_descriptor_configuration_cb (uint8_t index)
	Invoked when received GET CONFIGURATION DESCRIPTOR. Descriptor contents must exist long enough for transfer to complete.
uint16_t const *	tud_descriptor_string_cb (uint8_t index, uint16_t langid)
void	tusb_set_descriptor (const tusb_desc_device_t *dev_desc, const char **str_desc, const uint8_t *cfg_desc)
tusb_desc_device_t *	tusb_get_active_desc (void)
char **	tusb_get_active_str_desc (void)
void	tusb_clear_descriptor (void)

Variables
static const char *	TAG = "tusb_desc"
static tusb_desc_device_t	s_device_descriptor
static const uint8_t *	s_configuration_descriptor
static char *	s_str_descriptor [USB_STRING_DESCRIPTOR_ARRAY_SIZE]
static uint16_t	_desc_str [32]

Macro Definition Documentation

MAX_DESC_BUF_SIZE

#define MAX_DESC_BUF_SIZE   32

Definition at line 15 of file descriptors_control.c.

Referenced by tud_descriptor_string_cb().

Function Documentation

tud_descriptor_configuration_cb()

uint8_t const * tud_descriptor_configuration_cb

(

uint8_t

index

)

Invoked when received GET CONFIGURATION DESCRIPTOR. Descriptor contents must exist long enough for transfer to complete.

Parameters

index

Returns

uint8_t const* Application return pointer to descriptor

Definition at line 39 of file descriptors_control.c.

{
    (void)index; // for multiple configurations
    return s_configuration_descriptor;
}

References s_configuration_descriptor.

tud_descriptor_device_cb()

uint8_t const * tud_descriptor_device_cb

(

void

)

Invoked when received GET DEVICE DESCRIPTOR. Application returns pointer to descriptor.

Returns

uint8_t const*

Definition at line 27 of file descriptors_control.c.

{
    return (uint8_t const *)&s_device_descriptor;
}

References s_device_descriptor.

tud_descriptor_string_cb()

uint16_t const * tud_descriptor_string_cb	(	uint8_t	index,
		uint16_t	langid )

Definition at line 49 of file descriptors_control.c.

{
    (void) langid;
 
    uint8_t chr_count;
 
    if ( index == 0) {
        memcpy(&_desc_str[1], s_str_descriptor[0], 2);
        chr_count = 1;
    } else {
        // Convert ASCII string into UTF-16
 
        if ( index >= sizeof(s_str_descriptor) / sizeof(s_str_descriptor[0]) ) {
            ESP_LOGE(TAG, "String index (%u) is out of bounds, check your string descriptor", index);
            return NULL;
        }
 
        if (s_str_descriptor[index] == NULL) {
            ESP_LOGE(TAG, "String index (%u) points to NULL, check your string descriptor", index);
            return NULL;
        }
 
        const char *str = s_str_descriptor[index];
 
        // Cap at max char
        chr_count = strlen(str);
        if ( chr_count > MAX_DESC_BUF_SIZE - 1 ) {
            chr_count = MAX_DESC_BUF_SIZE - 1;
        }
 
        for (uint8_t i = 0; i < chr_count; i++) {
            _desc_str[1 + i] = str[i];
        }
    }
 
    // first byte is length (including header), second byte is string type
    _desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2 * chr_count + 2);
 
    return _desc_str;
}

References _desc_str, MAX_DESC_BUF_SIZE, s_str_descriptor, and TAG.

tusb_clear_descriptor()

void tusb_clear_descriptor

(

void

)

Definition at line 146 of file descriptors_control.c.

{
    memset(&s_device_descriptor, 0, sizeof(s_device_descriptor));
    memset(&s_str_descriptor, 0, sizeof(s_str_descriptor));
}

References s_device_descriptor, and s_str_descriptor.

tusb_get_active_desc()

tusb_desc_device_t * tusb_get_active_desc

(

void

)

Definition at line 136 of file descriptors_control.c.

{
    return &s_device_descriptor;
}

References s_device_descriptor.

tusb_get_active_str_desc()

char ** tusb_get_active_str_desc

(

void

)

Definition at line 141 of file descriptors_control.c.

{
    return s_str_descriptor;
}

References s_str_descriptor.

tusb_set_descriptor()

void tusb_set_descriptor	(	const tusb_desc_device_t *	dev_desc,
		const char **	str_desc,
		const uint8_t *	cfg_desc )

Definition at line 94 of file descriptors_control.c.

{
    ESP_LOGI(TAG, "\n"
             "┌─────────────────────────────────┐\n"
             "│  USB Device Descriptor Summary  │\n"
             "├───────────────────┬─────────────┤\n"
             "│bDeviceClass       │ %-4u        │\n"
             "├───────────────────┼─────────────┤\n"
             "│bDeviceSubClass    │ %-4u        │\n"
             "├───────────────────┼─────────────┤\n"
             "│bDeviceProtocol    │ %-4u        │\n"
             "├───────────────────┼─────────────┤\n"
             "│bMaxPacketSize0    │ %-4u        │\n"
             "├───────────────────┼─────────────┤\n"
             "│idVendor           │ %-#10x  │\n"
             "├───────────────────┼─────────────┤\n"
             "│idProduct          │ %-#10x  │\n"
             "├───────────────────┼─────────────┤\n"
             "│bcdDevice          │ %-#10x  │\n"
             "├───────────────────┼─────────────┤\n"
             "│iManufacturer      │ %-#10x  │\n"
             "├───────────────────┼─────────────┤\n"
             "│iProduct           │ %-#10x  │\n"
             "├───────────────────┼─────────────┤\n"
             "│iSerialNumber      │ %-#10x  │\n"
             "├───────────────────┼─────────────┤\n"
             "│bNumConfigurations │ %-#10x  │\n"
             "└───────────────────┴─────────────┘",
             dev_desc->bDeviceClass, dev_desc->bDeviceSubClass,
             dev_desc->bDeviceProtocol, dev_desc->bMaxPacketSize0,
             dev_desc->idVendor, dev_desc->idProduct, dev_desc->bcdDevice,
             dev_desc->iManufacturer, dev_desc->iProduct, dev_desc->iSerialNumber,
             dev_desc->bNumConfigurations);
    s_device_descriptor = *dev_desc;
    s_configuration_descriptor = cfg_desc;
 
    if (str_desc != NULL) {
        memcpy(s_str_descriptor, str_desc,
               sizeof(s_str_descriptor[0])*USB_STRING_DESCRIPTOR_ARRAY_SIZE);
    }
}

References s_configuration_descriptor, s_device_descriptor, s_str_descriptor, TAG, and USB_STRING_DESCRIPTOR_ARRAY_SIZE.

Referenced by tinyusb_driver_install().

Here is the caller graph for this function:

Variable Documentation

_desc_str

uint16_t _desc_str[32]

static

Definition at line 45 of file descriptors_control.c.

Referenced by tud_descriptor_string_cb().

s_configuration_descriptor

const uint8_t* s_configuration_descriptor

static

Definition at line 13 of file descriptors_control.c.

Referenced by tud_descriptor_configuration_cb(), and tusb_set_descriptor().

s_device_descriptor

tusb_desc_device_t s_device_descriptor

static

Definition at line 12 of file descriptors_control.c.

Referenced by tud_descriptor_device_cb(), tusb_clear_descriptor(), tusb_get_active_desc(), and tusb_set_descriptor().

s_str_descriptor

char* s_str_descriptor[USB_STRING_DESCRIPTOR_ARRAY_SIZE]

static

Definition at line 14 of file descriptors_control.c.

Referenced by tud_descriptor_string_cb(), tusb_clear_descriptor(), tusb_get_active_str_desc(), and tusb_set_descriptor().

TAG

const char* TAG = "tusb_desc"

static

Definition at line 11 of file descriptors_control.c.