777 lines
26 KiB
C
777 lines
26 KiB
C
|
|
#include "sdkconfig.h"
|
|
#if CONFIG_TINYUSB_ENABLED
|
|
#include <stdlib.h>
|
|
#include <stdbool.h>
|
|
|
|
#include "esp_log.h"
|
|
|
|
#include "soc/soc.h"
|
|
#include "soc/efuse_reg.h"
|
|
#include "soc/rtc_cntl_reg.h"
|
|
#include "soc/usb_struct.h"
|
|
#include "soc/usb_reg.h"
|
|
#include "soc/usb_wrap_reg.h"
|
|
#include "soc/usb_wrap_struct.h"
|
|
#include "soc/usb_periph.h"
|
|
#include "soc/periph_defs.h"
|
|
#include "soc/timer_group_struct.h"
|
|
#include "soc/system_reg.h"
|
|
|
|
#include "hal/usb_hal.h"
|
|
#include "hal/gpio_ll.h"
|
|
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/task.h"
|
|
|
|
#include "driver/gpio.h"
|
|
#include "driver/periph_ctrl.h"
|
|
|
|
#include "esp_efuse.h"
|
|
#include "esp_efuse_table.h"
|
|
#include "esp_rom_gpio.h"
|
|
|
|
#include "esp32-hal.h"
|
|
|
|
#include "esp32-hal-tinyusb.h"
|
|
#if CONFIG_IDF_TARGET_ESP32S2
|
|
#include "esp32s2/rom/usb/usb_persist.h"
|
|
#include "esp32s2/rom/usb/usb_dc.h"
|
|
#include "esp32s2/rom/usb/chip_usb_dw_wrapper.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32S3
|
|
#include "hal/usb_serial_jtag_ll.h"
|
|
#include "esp32s3/rom/usb/usb_persist.h"
|
|
#include "esp32s3/rom/usb/usb_dc.h"
|
|
#include "esp32s3/rom/usb/chip_usb_dw_wrapper.h"
|
|
#endif
|
|
|
|
typedef enum{
|
|
TINYUSB_USBDEV_0,
|
|
} tinyusb_usbdev_t;
|
|
|
|
typedef char *tusb_desc_strarray_device_t[USB_STRING_DESCRIPTOR_ARRAY_SIZE];
|
|
|
|
typedef struct {
|
|
bool external_phy;
|
|
} tinyusb_config_t;
|
|
|
|
static void configure_pins(usb_hal_context_t *usb)
|
|
{
|
|
for (const usb_iopin_dsc_t *iopin = usb_periph_iopins; iopin->pin != -1; ++iopin) {
|
|
if ((usb->use_external_phy) || (iopin->ext_phy_only == 0)) {
|
|
esp_rom_gpio_pad_select_gpio(iopin->pin);
|
|
if (iopin->is_output) {
|
|
esp_rom_gpio_connect_out_signal(iopin->pin, iopin->func, false, false);
|
|
} else {
|
|
esp_rom_gpio_connect_in_signal(iopin->pin, iopin->func, false);
|
|
if ((iopin->pin != GPIO_FUNC_IN_LOW) && (iopin->pin != GPIO_FUNC_IN_HIGH)) {
|
|
gpio_ll_input_enable(&GPIO, iopin->pin);
|
|
}
|
|
}
|
|
esp_rom_gpio_pad_unhold(iopin->pin);
|
|
}
|
|
}
|
|
if (!usb->use_external_phy) {
|
|
gpio_set_drive_capability(USBPHY_DM_NUM, GPIO_DRIVE_CAP_3);
|
|
gpio_set_drive_capability(USBPHY_DP_NUM, GPIO_DRIVE_CAP_3);
|
|
}
|
|
}
|
|
|
|
esp_err_t tinyusb_driver_install(const tinyusb_config_t *config)
|
|
{
|
|
usb_hal_context_t hal = {
|
|
.use_external_phy = config->external_phy
|
|
};
|
|
usb_hal_init(&hal);
|
|
configure_pins(&hal);
|
|
if (!tusb_init()) {
|
|
log_e("Can't initialize the TinyUSB stack.");
|
|
return ESP_FAIL;
|
|
}
|
|
return ESP_OK;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
typedef char tusb_str_t[127];
|
|
|
|
static bool WEBUSB_ENABLED = false;
|
|
|
|
static tusb_str_t WEBUSB_URL = "";
|
|
static tusb_str_t USB_DEVICE_PRODUCT = "";
|
|
static tusb_str_t USB_DEVICE_MANUFACTURER = "";
|
|
static tusb_str_t USB_DEVICE_SERIAL = "";
|
|
static tusb_str_t USB_DEVICE_LANGUAGE = "\x09\x04";//English (0x0409)
|
|
|
|
static uint8_t USB_DEVICE_ATTRIBUTES = 0;
|
|
static uint16_t USB_DEVICE_POWER = 0;
|
|
|
|
/*
|
|
* Device Descriptor
|
|
* */
|
|
static tusb_desc_device_t tinyusb_device_descriptor = {
|
|
.bLength = sizeof(tusb_desc_device_t),
|
|
.bDescriptorType = TUSB_DESC_DEVICE,
|
|
.bcdUSB = 0,
|
|
.bDeviceClass = 0,
|
|
.bDeviceSubClass = 0,
|
|
.bDeviceProtocol = 0,
|
|
.bMaxPacketSize0 = CFG_TUD_ENDOINT0_SIZE,
|
|
|
|
.idVendor = 0,
|
|
.idProduct = 0,
|
|
.bcdDevice = 0,
|
|
|
|
.iManufacturer = 0x01,
|
|
.iProduct = 0x02,
|
|
.iSerialNumber = 0x03,
|
|
|
|
.bNumConfigurations = 0x01
|
|
};
|
|
|
|
/*
|
|
* String Descriptors
|
|
* */
|
|
#define MAX_STRING_DESCRIPTORS 20
|
|
static uint32_t tinyusb_string_descriptor_len = 4;
|
|
static char * tinyusb_string_descriptor[MAX_STRING_DESCRIPTORS] = {
|
|
// array of pointer to string descriptors
|
|
USB_DEVICE_LANGUAGE, // 0: is supported language
|
|
USB_DEVICE_MANUFACTURER,// 1: Manufacturer
|
|
USB_DEVICE_PRODUCT, // 2: Product
|
|
USB_DEVICE_SERIAL, // 3: Serials, should use chip ID
|
|
};
|
|
|
|
|
|
/* Microsoft OS 2.0 registry property descriptor
|
|
Per MS requirements https://msdn.microsoft.com/en-us/library/windows/hardware/hh450799(v=vs.85).aspx
|
|
device should create DeviceInterfaceGUIDs. It can be done by driver and
|
|
in case of real PnP solution device should expose MS "Microsoft OS 2.0
|
|
registry property descriptor". Such descriptor can insert any record
|
|
into Windows registry per device/configuration/interface. In our case it
|
|
will insert "DeviceInterfaceGUIDs" multistring property.
|
|
|
|
GUID is freshly generated and should be OK to use.
|
|
|
|
https://developers.google.com/web/fundamentals/native-hardware/build-for-webusb/
|
|
(Section Microsoft OS compatibility descriptors)
|
|
*/
|
|
|
|
#define MS_OS_20_DESC_LEN 0xB2
|
|
|
|
static uint8_t const tinyusb_ms_os_20_descriptor[] =
|
|
{
|
|
// Set header: length, type, windows version, total length
|
|
U16_TO_U8S_LE(0x000A), U16_TO_U8S_LE(MS_OS_20_SET_HEADER_DESCRIPTOR), U32_TO_U8S_LE(0x06030000), U16_TO_U8S_LE(MS_OS_20_DESC_LEN),
|
|
|
|
// Configuration subset header: length, type, configuration index, reserved, configuration total length
|
|
U16_TO_U8S_LE(0x0008), U16_TO_U8S_LE(MS_OS_20_SUBSET_HEADER_CONFIGURATION), 0, 0, U16_TO_U8S_LE(MS_OS_20_DESC_LEN-0x0A),
|
|
|
|
// Function Subset header: length, type, first interface, reserved, subset length
|
|
U16_TO_U8S_LE(0x0008), U16_TO_U8S_LE(MS_OS_20_SUBSET_HEADER_FUNCTION), 0, 0, U16_TO_U8S_LE(MS_OS_20_DESC_LEN-0x0A-0x08),
|
|
|
|
// MS OS 2.0 Compatible ID descriptor: length, type, compatible ID, sub compatible ID
|
|
U16_TO_U8S_LE(0x0014), U16_TO_U8S_LE(MS_OS_20_FEATURE_COMPATBLE_ID), 'W', 'I', 'N', 'U', 'S', 'B', 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // sub-compatible
|
|
|
|
// MS OS 2.0 Registry property descriptor: length, type
|
|
U16_TO_U8S_LE(MS_OS_20_DESC_LEN-0x0A-0x08-0x08-0x14), U16_TO_U8S_LE(MS_OS_20_FEATURE_REG_PROPERTY),
|
|
U16_TO_U8S_LE(0x0007), U16_TO_U8S_LE(0x002A), // wPropertyDataType, wPropertyNameLength and PropertyName "DeviceInterfaceGUIDs\0" in UTF-16
|
|
'D', 0x00, 'e', 0x00, 'v', 0x00, 'i', 0x00, 'c', 0x00, 'e', 0x00, 'I', 0x00, 'n', 0x00, 't', 0x00, 'e', 0x00,
|
|
'r', 0x00, 'f', 0x00, 'a', 0x00, 'c', 0x00, 'e', 0x00, 'G', 0x00, 'U', 0x00, 'I', 0x00, 'D', 0x00, 's', 0x00, 0x00, 0x00,
|
|
U16_TO_U8S_LE(0x0050), // wPropertyDataLength
|
|
//bPropertyData: “{975F44D9-0D08-43FD-8B3E-127CA8AFFF9D}”.
|
|
'{', 0x00, '9', 0x00, '7', 0x00, '5', 0x00, 'F', 0x00, '4', 0x00, '4', 0x00, 'D', 0x00, '9', 0x00, '-', 0x00,
|
|
'0', 0x00, 'D', 0x00, '0', 0x00, '8', 0x00, '-', 0x00, '4', 0x00, '3', 0x00, 'F', 0x00, 'D', 0x00, '-', 0x00,
|
|
'8', 0x00, 'B', 0x00, '3', 0x00, 'E', 0x00, '-', 0x00, '1', 0x00, '2', 0x00, '7', 0x00, 'C', 0x00, 'A', 0x00,
|
|
'8', 0x00, 'A', 0x00, 'F', 0x00, 'F', 0x00, 'F', 0x00, '9', 0x00, 'D', 0x00, '}', 0x00, 0x00, 0x00, 0x00, 0x00
|
|
};
|
|
|
|
TU_VERIFY_STATIC(sizeof(tinyusb_ms_os_20_descriptor) == MS_OS_20_DESC_LEN, "Incorrect size");
|
|
|
|
|
|
/*
|
|
* BOS Descriptor (required for webUSB)
|
|
* */
|
|
#define BOS_TOTAL_LEN (TUD_BOS_DESC_LEN + TUD_BOS_WEBUSB_DESC_LEN + TUD_BOS_MICROSOFT_OS_DESC_LEN)
|
|
|
|
enum {
|
|
VENDOR_REQUEST_WEBUSB = 1,
|
|
VENDOR_REQUEST_MICROSOFT = 2
|
|
};
|
|
|
|
static uint8_t const tinyusb_bos_descriptor[] = {
|
|
// total length, number of device caps
|
|
TUD_BOS_DESCRIPTOR(BOS_TOTAL_LEN, 2),
|
|
|
|
// Vendor Code, iLandingPage
|
|
TUD_BOS_WEBUSB_DESCRIPTOR(VENDOR_REQUEST_WEBUSB, 1),
|
|
|
|
// Microsoft OS 2.0 descriptor
|
|
TUD_BOS_MS_OS_20_DESCRIPTOR(MS_OS_20_DESC_LEN, VENDOR_REQUEST_MICROSOFT)
|
|
};
|
|
|
|
/*
|
|
* URL Descriptor (required for webUSB)
|
|
* */
|
|
typedef struct TU_ATTR_PACKED {
|
|
uint8_t bLength;
|
|
uint8_t bDescriptorType;
|
|
uint8_t bScheme;
|
|
char url[127];
|
|
} tinyusb_desc_webusb_url_t;
|
|
|
|
static tinyusb_desc_webusb_url_t tinyusb_url_descriptor = {
|
|
.bLength = 3,
|
|
.bDescriptorType = 3, // WEBUSB URL type
|
|
.bScheme = 255, // URL Scheme Prefix: 0: "http://", 1: "https://", 255: ""
|
|
.url = ""
|
|
};
|
|
|
|
/*
|
|
* Configuration Descriptor
|
|
* */
|
|
|
|
static tinyusb_descriptor_cb_t tinyusb_loaded_interfaces_callbacks[USB_INTERFACE_MAX];
|
|
static uint32_t tinyusb_loaded_interfaces_mask = 0;
|
|
static uint8_t tinyusb_loaded_interfaces_num = 0;
|
|
static uint16_t tinyusb_config_descriptor_len = 0;
|
|
static uint8_t * tinyusb_config_descriptor = NULL;
|
|
|
|
/*
|
|
* Endpoint Usage Tracking
|
|
* */
|
|
typedef union {
|
|
struct {
|
|
uint32_t in:16;
|
|
uint32_t out:16;
|
|
};
|
|
uint32_t val;
|
|
} tinyusb_endpoints_usage_t;
|
|
|
|
static tinyusb_endpoints_usage_t tinyusb_endpoints;
|
|
|
|
|
|
/*
|
|
* TinyUSB Callbacks
|
|
* */
|
|
|
|
/**
|
|
* @brief Invoked when received GET CONFIGURATION DESCRIPTOR.
|
|
*/
|
|
__attribute__ ((weak)) uint8_t const *tud_descriptor_configuration_cb(uint8_t index)
|
|
{
|
|
//log_d("%u", index);
|
|
return tinyusb_config_descriptor;
|
|
}
|
|
|
|
/**
|
|
* @brief Invoked when received GET DEVICE DESCRIPTOR.
|
|
*/
|
|
__attribute__ ((weak)) uint8_t const *tud_descriptor_device_cb(void)
|
|
{
|
|
//log_d("");
|
|
return (uint8_t const *)&tinyusb_device_descriptor;
|
|
}
|
|
|
|
/**
|
|
* @brief Invoked when received GET STRING DESCRIPTOR request.
|
|
*/
|
|
__attribute__ ((weak)) uint16_t const *tud_descriptor_string_cb(uint8_t index, uint16_t langid)
|
|
{
|
|
//log_d("%u (0x%x)", index, langid);
|
|
static uint16_t _desc_str[127];
|
|
uint8_t chr_count;
|
|
|
|
if (index == 0) {
|
|
memcpy(&_desc_str[1], tinyusb_string_descriptor[0], 2);
|
|
chr_count = 1;
|
|
} else {
|
|
// Convert ASCII string into UTF-16
|
|
if (index >= tinyusb_string_descriptor_len) {
|
|
return NULL;
|
|
}
|
|
const char *str = tinyusb_string_descriptor[index];
|
|
// Cap at max char
|
|
chr_count = strlen(str);
|
|
if (chr_count > 126) {
|
|
chr_count = 126;
|
|
}
|
|
for (uint8_t i = 0; i < chr_count; i++) {
|
|
_desc_str[1 + i] = str[i];
|
|
}
|
|
}
|
|
|
|
// first byte is len, second byte is string type
|
|
_desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2*chr_count + 2);
|
|
|
|
return _desc_str;
|
|
}
|
|
|
|
/**
|
|
* @brief Invoked when received GET BOS DESCRIPTOR request.
|
|
*/
|
|
uint8_t const * tud_descriptor_bos_cb(void)
|
|
{
|
|
//log_v("");
|
|
return tinyusb_bos_descriptor;
|
|
}
|
|
|
|
__attribute__ ((weak)) bool tinyusb_vendor_control_request_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request){ return false; }
|
|
|
|
/**
|
|
* @brief Handle WebUSB and Vendor requests.
|
|
*/
|
|
bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const * request)
|
|
{
|
|
if(WEBUSB_ENABLED && (request->bRequest == VENDOR_REQUEST_WEBUSB
|
|
|| (request->bRequest == VENDOR_REQUEST_MICROSOFT && request->wIndex == 7))){
|
|
// we only care for SETUP stage
|
|
if (stage == CONTROL_STAGE_SETUP) {
|
|
if(request->bRequest == VENDOR_REQUEST_WEBUSB){
|
|
// match vendor request in BOS descriptor
|
|
// Get landing page url
|
|
tinyusb_url_descriptor.bLength = 3 + strlen(WEBUSB_URL);
|
|
snprintf(tinyusb_url_descriptor.url, 127, "%s", WEBUSB_URL);
|
|
return tud_control_xfer(rhport, request, (void*) &tinyusb_url_descriptor, tinyusb_url_descriptor.bLength);
|
|
}
|
|
// Get Microsoft OS 2.0 compatible descriptor
|
|
uint16_t total_len;
|
|
memcpy(&total_len, tinyusb_ms_os_20_descriptor + 8, 2);
|
|
return tud_control_xfer(rhport, request, (void*) tinyusb_ms_os_20_descriptor, total_len);
|
|
}
|
|
return true;
|
|
}
|
|
log_v("rhport: %u, stage: %u, type: 0x%x, request: 0x%x", rhport, stage, request->bmRequestType_bit.type, request->bRequest);
|
|
return tinyusb_vendor_control_request_cb(rhport, stage, request);
|
|
}
|
|
|
|
/*
|
|
* Required Callbacks
|
|
* */
|
|
#if CFG_TUD_HID
|
|
__attribute__ ((weak)) const uint8_t * tud_hid_descriptor_report_cb(uint8_t itf){return NULL;}
|
|
__attribute__ ((weak)) uint16_t tud_hid_get_report_cb(uint8_t itf, uint8_t report_id, hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen){return 0;}
|
|
__attribute__ ((weak)) void tud_hid_set_report_cb(uint8_t itf, uint8_t report_id, hid_report_type_t report_type, const uint8_t * buffer, uint16_t bufsize){}
|
|
#endif
|
|
#if CFG_TUD_MSC
|
|
__attribute__ ((weak)) bool tud_msc_test_unit_ready_cb(uint8_t lun){return false;}
|
|
__attribute__ ((weak)) void tud_msc_inquiry_cb(uint8_t lun, uint8_t vendor_id[8], uint8_t product_id[16], uint8_t product_rev[4]){}
|
|
__attribute__ ((weak)) void tud_msc_capacity_cb(uint8_t lun, uint32_t* block_count, uint16_t* block_size){}
|
|
__attribute__ ((weak)) int32_t tud_msc_read10_cb(uint8_t lun, uint32_t lba, uint32_t offset, void* buffer, uint32_t bufsize){return -1;}
|
|
__attribute__ ((weak)) int32_t tud_msc_write10_cb(uint8_t lun, uint32_t lba, uint32_t offset, uint8_t* buffer, uint32_t bufsize){return -1;}
|
|
__attribute__ ((weak)) int32_t tud_msc_scsi_cb (uint8_t lun, uint8_t const scsi_cmd[16], void* buffer, uint16_t bufsize){return -1;}
|
|
#endif
|
|
|
|
|
|
/*
|
|
* Private API
|
|
* */
|
|
static bool usb_persist_enabled = false;
|
|
static restart_type_t usb_persist_mode = RESTART_NO_PERSIST;
|
|
|
|
#if CONFIG_IDF_TARGET_ESP32S3
|
|
|
|
static void hw_cdc_reset_handler(void *arg) {
|
|
portBASE_TYPE xTaskWoken = 0;
|
|
uint32_t usbjtag_intr_status = usb_serial_jtag_ll_get_intsts_mask();
|
|
usb_serial_jtag_ll_clr_intsts_mask(usbjtag_intr_status);
|
|
|
|
if (usbjtag_intr_status & USB_SERIAL_JTAG_INTR_BUS_RESET) {
|
|
xSemaphoreGiveFromISR((xSemaphoreHandle)arg, &xTaskWoken);
|
|
}
|
|
|
|
if (xTaskWoken == pdTRUE) {
|
|
portYIELD_FROM_ISR();
|
|
}
|
|
}
|
|
|
|
static void usb_switch_to_cdc_jtag(){
|
|
// Disable USB-OTG
|
|
periph_module_reset(PERIPH_USB_MODULE);
|
|
//periph_module_enable(PERIPH_USB_MODULE);
|
|
periph_module_disable(PERIPH_USB_MODULE);
|
|
|
|
// Switch to hardware CDC+JTAG
|
|
CLEAR_PERI_REG_MASK(RTC_CNTL_USB_CONF_REG, (RTC_CNTL_SW_HW_USB_PHY_SEL|RTC_CNTL_SW_USB_PHY_SEL|RTC_CNTL_USB_PAD_ENABLE));
|
|
|
|
// Do not use external PHY
|
|
CLEAR_PERI_REG_MASK(USB_SERIAL_JTAG_CONF0_REG, USB_SERIAL_JTAG_PHY_SEL);
|
|
|
|
// Release GPIO pins from CDC+JTAG
|
|
CLEAR_PERI_REG_MASK(USB_SERIAL_JTAG_CONF0_REG, USB_SERIAL_JTAG_USB_PAD_ENABLE);
|
|
|
|
// Force the host to re-enumerate (BUS_RESET)
|
|
pinMode(USBPHY_DM_NUM, OUTPUT_OPEN_DRAIN);
|
|
pinMode(USBPHY_DP_NUM, OUTPUT_OPEN_DRAIN);
|
|
digitalWrite(USBPHY_DM_NUM, LOW);
|
|
digitalWrite(USBPHY_DP_NUM, LOW);
|
|
|
|
// Initialize CDC+JTAG ISR to listen for BUS_RESET
|
|
usb_serial_jtag_ll_disable_intr_mask(USB_SERIAL_JTAG_LL_INTR_MASK);
|
|
usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_LL_INTR_MASK);
|
|
usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_BUS_RESET);
|
|
intr_handle_t intr_handle = NULL;
|
|
xSemaphoreHandle reset_sem = xSemaphoreCreateBinary();
|
|
if(reset_sem){
|
|
if(esp_intr_alloc(ETS_USB_SERIAL_JTAG_INTR_SOURCE, 0, hw_cdc_reset_handler, reset_sem, &intr_handle) != ESP_OK){
|
|
vSemaphoreDelete(reset_sem);
|
|
reset_sem = NULL;
|
|
log_e("HW USB CDC failed to init interrupts");
|
|
}
|
|
} else {
|
|
log_e("reset_sem init failed");
|
|
}
|
|
|
|
// Connect GPIOs to integrated CDC+JTAG
|
|
SET_PERI_REG_MASK(USB_SERIAL_JTAG_CONF0_REG, USB_SERIAL_JTAG_USB_PAD_ENABLE);
|
|
|
|
// Wait for BUS_RESET to give us back the semaphore
|
|
if(reset_sem){
|
|
if(xSemaphoreTake(reset_sem, 1000 / portTICK_PERIOD_MS) != pdPASS){
|
|
log_e("reset_sem timeout");
|
|
}
|
|
usb_serial_jtag_ll_disable_intr_mask(USB_SERIAL_JTAG_LL_INTR_MASK);
|
|
esp_intr_free(intr_handle);
|
|
vSemaphoreDelete(reset_sem);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
static void IRAM_ATTR usb_persist_shutdown_handler(void)
|
|
{
|
|
if(usb_persist_mode != RESTART_NO_PERSIST){
|
|
if (usb_persist_enabled) {
|
|
usb_dc_prepare_persist();
|
|
}
|
|
if (usb_persist_mode == RESTART_BOOTLOADER) {
|
|
//USB CDC Download
|
|
if (usb_persist_enabled) {
|
|
chip_usb_set_persist_flags(USBDC_PERSIST_ENA);
|
|
#if CONFIG_IDF_TARGET_ESP32S2
|
|
} else {
|
|
periph_module_reset(PERIPH_USB_MODULE);
|
|
periph_module_enable(PERIPH_USB_MODULE);
|
|
#endif
|
|
}
|
|
REG_WRITE(RTC_CNTL_OPTION1_REG, RTC_CNTL_FORCE_DOWNLOAD_BOOT);
|
|
} else if (usb_persist_mode == RESTART_BOOTLOADER_DFU) {
|
|
//DFU Download
|
|
#if CONFIG_IDF_TARGET_ESP32S2
|
|
// Reset USB Core
|
|
USB0.grstctl |= USB_CSFTRST;
|
|
while ((USB0.grstctl & USB_CSFTRST) == USB_CSFTRST){}
|
|
#endif
|
|
chip_usb_set_persist_flags(USBDC_BOOT_DFU);
|
|
REG_WRITE(RTC_CNTL_OPTION1_REG, RTC_CNTL_FORCE_DOWNLOAD_BOOT);
|
|
} else if (usb_persist_enabled) {
|
|
//USB Persist reboot
|
|
chip_usb_set_persist_flags(USBDC_PERSIST_ENA);
|
|
}
|
|
}
|
|
}
|
|
|
|
void usb_persist_restart(restart_type_t mode)
|
|
{
|
|
if (mode < RESTART_TYPE_MAX && esp_register_shutdown_handler(usb_persist_shutdown_handler) == ESP_OK) {
|
|
usb_persist_mode = mode;
|
|
#if CONFIG_IDF_TARGET_ESP32S3
|
|
if (mode == RESTART_BOOTLOADER) {
|
|
usb_switch_to_cdc_jtag();
|
|
}
|
|
#endif
|
|
esp_restart();
|
|
}
|
|
}
|
|
|
|
static bool tinyusb_reserve_in_endpoint(uint8_t endpoint){
|
|
if(endpoint > 6 || (tinyusb_endpoints.in & BIT(endpoint)) != 0){
|
|
return false;
|
|
}
|
|
tinyusb_endpoints.in |= BIT(endpoint);
|
|
return true;
|
|
}
|
|
|
|
static bool tinyusb_reserve_out_endpoint(uint8_t endpoint){
|
|
if(endpoint > 6 || (tinyusb_endpoints.out & BIT(endpoint)) != 0){
|
|
return false;
|
|
}
|
|
tinyusb_endpoints.out |= BIT(endpoint);
|
|
return true;
|
|
}
|
|
|
|
static bool tinyusb_has_available_fifos(void){
|
|
uint8_t max_endpoints = 4, active_endpoints = 0;
|
|
if (tinyusb_loaded_interfaces_mask & BIT(USB_INTERFACE_CDC)) {
|
|
max_endpoints = 5; //CDC endpoint 0x85 is actually not linked to FIFO and not used
|
|
}
|
|
for(uint8_t i=1; i<7; i++){
|
|
if((tinyusb_endpoints.in & BIT(i)) != 0){
|
|
active_endpoints++;
|
|
}
|
|
}
|
|
|
|
return active_endpoints < max_endpoints;
|
|
}
|
|
|
|
static uint16_t tinyusb_load_descriptor(tinyusb_interface_t interface, uint8_t * dst, uint8_t * itf)
|
|
{
|
|
if(tinyusb_loaded_interfaces_callbacks[interface]){
|
|
return tinyusb_loaded_interfaces_callbacks[interface](dst, itf);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static bool tinyusb_load_enabled_interfaces(){
|
|
tinyusb_config_descriptor_len += TUD_CONFIG_DESC_LEN;
|
|
tinyusb_config_descriptor = (uint8_t *)malloc(tinyusb_config_descriptor_len);
|
|
if (tinyusb_config_descriptor == NULL) {
|
|
log_e("Descriptor Malloc Failed");
|
|
return false;
|
|
}
|
|
uint8_t * dst = tinyusb_config_descriptor + TUD_CONFIG_DESC_LEN;
|
|
|
|
for(int i=0; i<USB_INTERFACE_MAX; i++){
|
|
if (tinyusb_loaded_interfaces_mask & (1U << i)) {
|
|
uint16_t len = tinyusb_load_descriptor((tinyusb_interface_t)i, dst, &tinyusb_loaded_interfaces_num);
|
|
if (!len) {
|
|
log_e("Descriptor Load Failed");
|
|
return false;
|
|
} else {
|
|
dst += len;
|
|
}
|
|
}
|
|
}
|
|
uint8_t str_index = tinyusb_add_string_descriptor("TinyUSB Device");
|
|
uint8_t descriptor[TUD_CONFIG_DESC_LEN] = {
|
|
//num configs, interface count, string index, total length, attribute, power in mA
|
|
TUD_CONFIG_DESCRIPTOR(1, tinyusb_loaded_interfaces_num, str_index, tinyusb_config_descriptor_len, USB_DEVICE_ATTRIBUTES, USB_DEVICE_POWER)
|
|
};
|
|
memcpy(tinyusb_config_descriptor, descriptor, TUD_CONFIG_DESC_LEN);
|
|
if ((tinyusb_loaded_interfaces_mask == (BIT(USB_INTERFACE_CDC) | BIT(USB_INTERFACE_DFU))) || (tinyusb_loaded_interfaces_mask == BIT(USB_INTERFACE_CDC))) {
|
|
//usb_persist_enabled = true;
|
|
//log_d("USB Persist enabled");
|
|
}
|
|
log_d("Load Done: if_num: %u, descr_len: %u, if_mask: 0x%x", tinyusb_loaded_interfaces_num, tinyusb_config_descriptor_len, tinyusb_loaded_interfaces_mask);
|
|
return true;
|
|
}
|
|
|
|
static inline char nibble_to_hex_char(uint8_t b)
|
|
{
|
|
if (b < 0xa) {
|
|
return '0' + b;
|
|
} else {
|
|
return 'a' + b - 0xa;
|
|
}
|
|
}
|
|
|
|
static void set_usb_serial_num(void)
|
|
{
|
|
/* Get the MAC address */
|
|
const uint32_t mac0 = REG_GET_FIELD(EFUSE_RD_MAC_SPI_SYS_0_REG, EFUSE_MAC_0);
|
|
const uint32_t mac1 = REG_GET_FIELD(EFUSE_RD_MAC_SPI_SYS_1_REG, EFUSE_MAC_1);
|
|
uint8_t mac_bytes[6];
|
|
memcpy(mac_bytes, &mac0, 4);
|
|
memcpy(mac_bytes + 4, &mac1, 2);
|
|
|
|
/* Convert to UTF16 string */
|
|
uint8_t* srl = (uint8_t*)USB_DEVICE_SERIAL;
|
|
for (int i = 0; i < 6; ++i) {
|
|
uint8_t b = mac_bytes[5 - i]; /* printing from the MSB */
|
|
if (i) {
|
|
*srl++ = ':';
|
|
}
|
|
*srl++ = nibble_to_hex_char(b >> 4);
|
|
*srl++ = nibble_to_hex_char(b & 0xf);
|
|
}
|
|
*srl++ = '\0';
|
|
}
|
|
|
|
static void tinyusb_apply_device_config(tinyusb_device_config_t *config){
|
|
if(config->product_name){
|
|
snprintf(USB_DEVICE_PRODUCT, 126, "%s", config->product_name);
|
|
}
|
|
|
|
if(config->manufacturer_name){
|
|
snprintf(USB_DEVICE_MANUFACTURER, 126, "%s", config->manufacturer_name);
|
|
}
|
|
|
|
if(config->serial_number && config->serial_number[0]){
|
|
snprintf(USB_DEVICE_SERIAL, 126, "%s", config->serial_number);
|
|
} else {
|
|
set_usb_serial_num();
|
|
}
|
|
|
|
if(config->webusb_url){
|
|
snprintf(WEBUSB_URL, 126, "%s", config->webusb_url);
|
|
}
|
|
|
|
// Windows 10 will not recognize the CDC device if WebUSB is enabled and USB Class is not 2 (CDC)
|
|
if(
|
|
(tinyusb_loaded_interfaces_mask & BIT(USB_INTERFACE_CDC))
|
|
&& config->webusb_enabled
|
|
&& (config->usb_class != TUSB_CLASS_CDC)
|
|
){
|
|
config->usb_class = TUSB_CLASS_CDC;
|
|
config->usb_protocol = 0x00;
|
|
}
|
|
|
|
WEBUSB_ENABLED = config->webusb_enabled;
|
|
USB_DEVICE_ATTRIBUTES = config->usb_attributes;
|
|
USB_DEVICE_POWER = config->usb_power_ma;
|
|
|
|
tinyusb_device_descriptor.bcdUSB = config->usb_version;
|
|
tinyusb_device_descriptor.idVendor = config->vid;
|
|
tinyusb_device_descriptor.idProduct = config->pid;
|
|
tinyusb_device_descriptor.bcdDevice = config->fw_version;
|
|
tinyusb_device_descriptor.bDeviceClass = config->usb_class;
|
|
tinyusb_device_descriptor.bDeviceSubClass = config->usb_subclass;
|
|
tinyusb_device_descriptor.bDeviceProtocol = config->usb_protocol;
|
|
}
|
|
|
|
// USB Device Driver task
|
|
// This top level thread processes all usb events and invokes callbacks
|
|
static void usb_device_task(void *param) {
|
|
(void)param;
|
|
while(1) tud_task(); // RTOS forever loop
|
|
}
|
|
|
|
/*
|
|
* PUBLIC API
|
|
* */
|
|
#if ARDUHAL_LOG_LEVEL >= ARDUHAL_LOG_LEVEL_ERROR
|
|
const char *tinyusb_interface_names[USB_INTERFACE_MAX] = {"MSC", "DFU", "HID", "VENDOR", "CDC", "MIDI", "CUSTOM"};
|
|
#endif
|
|
static bool tinyusb_is_initialized = false;
|
|
|
|
esp_err_t tinyusb_enable_interface(tinyusb_interface_t interface, uint16_t descriptor_len, tinyusb_descriptor_cb_t cb)
|
|
{
|
|
if(tinyusb_is_initialized){
|
|
log_e("TinyUSB has already started! Interface %s not enabled", (interface >= USB_INTERFACE_MAX)?"":tinyusb_interface_names[interface]);
|
|
return ESP_FAIL;
|
|
}
|
|
if((interface >= USB_INTERFACE_MAX) || (tinyusb_loaded_interfaces_mask & (1U << interface))){
|
|
log_e("Interface %s invalid or already enabled", (interface >= USB_INTERFACE_MAX)?"":tinyusb_interface_names[interface]);
|
|
return ESP_FAIL;
|
|
}
|
|
if(interface == USB_INTERFACE_CDC){
|
|
if(!tinyusb_reserve_out_endpoint(3) ||!tinyusb_reserve_in_endpoint(4) || !tinyusb_reserve_in_endpoint(5)){
|
|
log_e("CDC Reserve Endpoints Failed");
|
|
return ESP_FAIL;
|
|
}
|
|
}
|
|
tinyusb_loaded_interfaces_mask |= (1U << interface);
|
|
tinyusb_config_descriptor_len += descriptor_len;
|
|
tinyusb_loaded_interfaces_callbacks[interface] = cb;
|
|
log_d("Interface %s enabled", tinyusb_interface_names[interface]);
|
|
return ESP_OK;
|
|
}
|
|
|
|
esp_err_t tinyusb_init(tinyusb_device_config_t *config) {
|
|
if(tinyusb_is_initialized){
|
|
return ESP_OK;
|
|
}
|
|
tinyusb_is_initialized = true;
|
|
|
|
//tinyusb_endpoints.val = 0;
|
|
tinyusb_apply_device_config(config);
|
|
if (!tinyusb_load_enabled_interfaces()) {
|
|
tinyusb_is_initialized = false;
|
|
return ESP_FAIL;
|
|
}
|
|
|
|
bool usb_did_persist = (USB_WRAP.date.val == USBDC_PERSIST_ENA);
|
|
|
|
//if(usb_did_persist && usb_persist_enabled){
|
|
// Enable USB/IO_MUX peripheral reset, if coming from persistent reboot
|
|
REG_CLR_BIT(RTC_CNTL_USB_CONF_REG, RTC_CNTL_IO_MUX_RESET_DISABLE);
|
|
REG_CLR_BIT(RTC_CNTL_USB_CONF_REG, RTC_CNTL_USB_RESET_DISABLE);
|
|
//} else
|
|
if(!usb_did_persist || !usb_persist_enabled){
|
|
// Reset USB module
|
|
periph_module_reset(PERIPH_USB_MODULE);
|
|
periph_module_enable(PERIPH_USB_MODULE);
|
|
}
|
|
|
|
tinyusb_config_t tusb_cfg = {
|
|
.external_phy = false // In the most cases you need to use a `false` value
|
|
};
|
|
esp_err_t err = tinyusb_driver_install(&tusb_cfg);
|
|
if (err != ESP_OK) {
|
|
tinyusb_is_initialized = false;
|
|
return err;
|
|
}
|
|
xTaskCreate(usb_device_task, "usbd", 4096, NULL, configMAX_PRIORITIES - 1, NULL);
|
|
return err;
|
|
}
|
|
|
|
uint8_t tinyusb_add_string_descriptor(const char * str){
|
|
if(str == NULL || tinyusb_string_descriptor_len >= MAX_STRING_DESCRIPTORS){
|
|
return 0;
|
|
}
|
|
uint8_t index = tinyusb_string_descriptor_len;
|
|
tinyusb_string_descriptor[tinyusb_string_descriptor_len++] = (char*)str;
|
|
return index;
|
|
}
|
|
|
|
uint8_t tinyusb_get_free_duplex_endpoint(void){
|
|
if(!tinyusb_has_available_fifos()){
|
|
log_e("No available IN endpoints");
|
|
return 0;
|
|
}
|
|
for(uint8_t i=1; i<7; i++){
|
|
if((tinyusb_endpoints.in & BIT(i)) == 0 && (tinyusb_endpoints.out & BIT(i)) == 0){
|
|
tinyusb_endpoints.in |= BIT(i);
|
|
tinyusb_endpoints.out |= BIT(i);
|
|
return i;
|
|
}
|
|
}
|
|
log_e("No available duplex endpoints");
|
|
return 0;
|
|
}
|
|
|
|
uint8_t tinyusb_get_free_in_endpoint(void){
|
|
if(!tinyusb_has_available_fifos()){
|
|
log_e("No available IN endpoints");
|
|
return 0;
|
|
}
|
|
for(uint8_t i=1; i<7; i++){
|
|
if((tinyusb_endpoints.in & BIT(i)) == 0 && (tinyusb_endpoints.out & BIT(i)) != 0){
|
|
tinyusb_endpoints.in |= BIT(i);
|
|
return i;
|
|
}
|
|
}
|
|
for(uint8_t i=1; i<7; i++){
|
|
if((tinyusb_endpoints.in & BIT(i)) == 0){
|
|
tinyusb_endpoints.in |= BIT(i);
|
|
return i;
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
uint8_t tinyusb_get_free_out_endpoint(void){
|
|
for(uint8_t i=1; i<7; i++){
|
|
if((tinyusb_endpoints.out & BIT(i)) == 0 && (tinyusb_endpoints.in & BIT(i)) != 0){
|
|
tinyusb_endpoints.out |= BIT(i);
|
|
return i;
|
|
}
|
|
}
|
|
for(uint8_t i=1; i<7; i++){
|
|
if((tinyusb_endpoints.out & BIT(i)) == 0){
|
|
tinyusb_endpoints.out |= BIT(i);
|
|
return i;
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
#endif /* CONFIG_TINYUSB_ENABLED */
|