Chapter 2. API Reference
• CONFIG_USB_DEBUG_LEVEL (CONFIG_TINYUSB_DEBUG_LEVEL)
• CONFIG_USB_DESC_BCDDEVICE (CONFIG_TINYUSB_DESC_BCD_DEVICE)
• CONFIG_USB_DESC_CDC_STRING (CONFIG_TINYUSB_DESC_CDC_STRING)
• CONFIG_USB_DESC_CUSTOM_PID (CONFIG_TINYUSB_DESC_CUSTOM_PID)
• CONFIG_USB_DESC_CUSTOM_VID (CONFIG_TINYUSB_DESC_CUSTOM_VID)
• CONFIG_USB_DESC_HID_STRING (CONFIG_TINYUSB_DESC_HID_STRING)
• CONFIG_USB_DESC_MANUFACTURER_STRING (CONFIG_TINYUSB_DESC_MANUFACTURER_STRING)
• CONFIG_USB_DESC_MSC_STRING (CONFIG_TINYUSB_DESC_MSC_STRING)
• CONFIG_USB_DESC_PRODUCT_STRING (CONFIG_TINYUSB_DESC_PRODUCT_STRING)
• CONFIG_USB_DESC_SERIAL_STRING (CONFIG_TINYUSB_DESC_SERIAL_STRING)
• CONFIG_USB_DESC_USE_DEFAULT_PID (CONFIG_TINYUSB_DESC_USE_DEFAULT_PID)
• CONFIG_USB_DESC_USE_ESPRESSIF_VID (CONFIG_TINYUSB_DESC_USE_ESPRESSIF_VID)
• CONFIG_USB_DO_NOT_CREATE_TASK (CONFIG_TINYUSB_NO_DEFAULT_TASK)
• CONFIG_USB_ENABLED (CONFIG_TINYUSB)
• CONFIG_USB_MSC_BUFSIZE (CONFIG_TINYUSB_MSC_BUFSIZE)
• CONFIG_USB_MSC_ENABLED (CONFIG_TINYUSB_MSC_ENABLED)
• CONFIG_USB_TASK_PRIORITY (CONFIG_TINYUSB_TASK_PRIORITY)
• CONFIG_USE_ONLY_LWIP_SELECT (CONFIG_LWIP_USE_ONLY_LWIP_SELECT)
• CONFIG_WARN_WRITE_STRINGS (CONFIG_COMPILER_WARN_WRITE_STRINGS)
2.8.7 Customisations
Because IDF builds by default with Warning On Undefined Variables, when the Kconfig tool generates Makefiles (the
auto.conf file) its behaviour has been customised. In normal Kconfig, a variable which is set to“no”is undefined.
In IDF’s version of Kconfig, this variable is defined in the Makefile but has an empty value.
(Note that ifdef and ifndef can still be used in Makefiles, because they test if a variable is defined and has a
non-empty value.)
When generating header files for C & C++, the behaviour is not customised - so #ifdef can be used to test if a
boolean config item is set or not.
2.9 Error Codes Reference
This section lists various error code constants defined in ESP-IDF.
For general information about error codes in ESP-IDF, see Error Handling.
ESP_FAIL (-1): Generic esp_err_t code indicating failure
ESP_OK (0): esp_err_t value indicating success (no error)
ESP_ERR_NO_MEM (0x101): Out of memory
ESP_ERR_INVALID_ARG (0x102): Invalid argument
ESP_ERR_INVALID_STATE (0x103): Invalid state
ESP_ERR_INVALID_SIZE (0x104): Invalid size
ESP_ERR_NOT_FOUND (0x105): Requested resource not found
ESP_ERR_NOT_SUPPORTED (0x106): Operation or feature not supported
ESP_ERR_TIMEOUT (0x107): Operation timed out
ESP_ERR_INVALID_RESPONSE (0x108): Received response was invalid
ESP_ERR_INVALID_CRC (0x109): CRC or checksum was invalid
ESP_ERR_INVALID_VERSION (0x10a): Version was invalid
ESP_ERR_INVALID_MAC (0x10b): MAC address was invalid
Espressif Systems 1242
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General