tinyusb.h File Reference

#include <stdbool.h>
#include "esp_err.h"
#include "tusb.h"
#include "tusb_option.h"
#include "tusb_config.h"
#include "tinyusb_types.h"

Include dependency graph for tinyusb.h:

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

Go to the source code of this file.

Data Structures
struct	tinyusb_config_t
	Configuration structure of the TinyUSB core. More...

Functions
esp_err_t	tinyusb_driver_install (const tinyusb_config_t *config)
	This is an all-in-one helper function, including:

Function Documentation

tinyusb_driver_install()

esp_err_t tinyusb_driver_install

(

const tinyusb_config_t *

config

)

This is an all-in-one helper function, including:

1. USB device driver initialization
2. Descriptors preparation
3. TinyUSB stack initialization
4. Creates and start a task to handle usb events

Note

Don't change Custom descriptor, but if it has to be done, Suggest to define as follows in order to match the Interface Association Descriptor (IAD): bDeviceClass = TUSB_CLASS_MISC, bDeviceSubClass = MISC_SUBCLASS_COMMON,

Parameters

config

tinyusb stack specific configuration

Return values

ESP_ERR_INVALID_ARG	Install driver and tinyusb stack failed because of invalid argument
ESP_FAIL	Install driver and tinyusb stack failed because of internal error
ESP_OK	Install driver and tinyusb stack successfully

Definition at line 32 of file tinyusb.c.

{
    const tusb_desc_device_t *dev_descriptor;
    const char **string_descriptor;
    const uint8_t *cfg_descriptor;
    ESP_RETURN_ON_FALSE(config, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
 
    // Configure USB PHY
    usb_phy_config_t phy_conf = {
        .controller = USB_PHY_CTRL_OTG,
        .otg_mode = USB_OTG_MODE_DEVICE,
    };
 
    // External PHY IOs config
    usb_phy_ext_io_conf_t ext_io_conf = {
        .vp_io_num = USBPHY_VP_NUM,
        .vm_io_num = USBPHY_VM_NUM,
        .rcv_io_num = USBPHY_RCV_NUM,
        .oen_io_num = USBPHY_OEN_NUM,
        .vpo_io_num = USBPHY_VPO_NUM,
        .vmo_io_num = USBPHY_VMO_NUM,
    };
    if (config->external_phy) {
        phy_conf.target = USB_PHY_TARGET_EXT;
        phy_conf.ext_io_conf = &ext_io_conf;
    } else {
        phy_conf.target = USB_PHY_TARGET_INT;
    }
 
    // OTG IOs config
    const usb_phy_otg_io_conf_t otg_io_conf = USB_PHY_SELF_POWERED_DEVICE(config->vbus_monitor_io);
    if (config->self_powered) {
        phy_conf.otg_io_conf = &otg_io_conf;
    }
    ESP_RETURN_ON_ERROR(usb_new_phy(&phy_conf, &phy_hdl), TAG, "Install USB PHY failed");
 
    if (config->configuration_descriptor) {
        cfg_descriptor = config->configuration_descriptor;
    } else {
#if (CONFIG_TINYUSB_HID_COUNT > 0 || CONFIG_TINYUSB_MIDI_COUNT > 0)
        // For HID device, configuration descriptor must be provided
        ESP_RETURN_ON_FALSE(config->configuration_descriptor, ESP_ERR_INVALID_ARG, TAG, "Configuration descriptor must be provided for this device");
#else
        cfg_descriptor = descriptor_cfg_kconfig;
        ESP_LOGW(TAG, "The device's configuration descriptor is not provided by user, using default.");
#endif
    }
 
    if (config->string_descriptor) {
        string_descriptor = config->string_descriptor;
    } else {
        string_descriptor = descriptor_str_kconfig;
        ESP_LOGW(TAG, "The device's string descriptor is not provided by user, using default.");
    }
 
    if (config->device_descriptor) {
        dev_descriptor = config->device_descriptor;
    } else {
        dev_descriptor = &descriptor_dev_kconfig;
        ESP_LOGW(TAG, "The device's device descriptor is not provided by user, using default.");
    }
 
    tusb_set_descriptor(dev_descriptor, string_descriptor, cfg_descriptor);
 
    ESP_RETURN_ON_FALSE(tusb_init(), ESP_FAIL, TAG, "Init TinyUSB stack failed");
#if !CONFIG_TINYUSB_NO_DEFAULT_TASK
    ESP_RETURN_ON_ERROR(tusb_run_task(), TAG, "Run TinyUSB task failed");
#endif
    ESP_LOGI(TAG, "TinyUSB Driver installed");
    return ESP_OK;
}

References tinyusb_config_t::configuration_descriptor, descriptor_cfg_kconfig, descriptor_dev_kconfig, descriptor_str_kconfig, tinyusb_config_t::device_descriptor, ESP_OK, ESP_RETURN_ON_ERROR, tinyusb_config_t::external_phy, phy_hdl, tinyusb_config_t::self_powered, tinyusb_config_t::string_descriptor, TAG, tusb_run_task(), tusb_set_descriptor(), USBPHY_OEN_NUM, USBPHY_RCV_NUM, USBPHY_VM_NUM, USBPHY_VMO_NUM, USBPHY_VP_NUM, USBPHY_VPO_NUM, and tinyusb_config_t::vbus_monitor_io.

Referenced by app_main().

Here is the call graph for this function:

Here is the caller graph for this function: