esp-idf/components
Marius Vikhammer 929a8449bd Merge branch 'feature/usb_host_collective_backport_v5.1' into 'release/v5.1'
USB Host: Collective backport to v5.1

See merge request espressif/esp-idf!28096
2024-03-01 09:28:23 +08:00
..
app_trace fix(gcov): avoid multiple tick hook registration 2024-02-26 14:05:03 +01:00
app_update fix(app_update): fixed undeclared variable 'ret' in esp_ota_ops.c 2024-01-19 14:04:06 +05:30
bootloader Merge branch 'feat/flash_enc_encrypt_app_image_of_size_image_length_v5.1' into 'release/v5.1' 2024-02-28 10:57:45 +08:00
bootloader_support refactor(hal/usb): Rename usb_fsls_phy API to match header/source names 2024-02-28 16:09:52 +08:00
bt Merge branch 'bugfix/ble_update_lib_20240223_v5.1' into 'release/v5.1' 2024-02-28 16:54:19 +08:00
cmock
console fix(console): Fixed linenoise prompt length calculation 2024-01-22 16:22:28 +08:00
cxx
driver Merge branch 'feature/usb_host_collective_backport_v5.1' into 'release/v5.1' 2024-03-01 09:28:23 +08:00
efuse feat(efuse): Adds new efuses for esp32c6 2024-01-26 11:39:16 +08:00
esp_adc fix(tsens): 300us delay in phy cause extra power consumption 2024-02-28 12:36:04 +08:00
esp_app_format fix(ota): additional checks for secure version in anti-rollback case 2024-02-15 15:10:28 +02:00
esp_coex fix(esp_coex): fix circular dependency issue on esp32 2024-02-21 19:15:10 +08:00
esp_common versions: Update version to 5.1.3 2024-02-26 11:09:16 +08:00
esp_eth Merge branch 'feature/mmd_access_v5.1' into 'release/v5.1' 2024-02-29 20:29:57 +08:00
esp_event ci: fix missing linux related .build-test-rules.yml 2023-11-30 09:07:36 +01:00
esp_gdbstub fix(soc): change debug addr range to CPU subsystem range 2024-01-24 12:52:27 +05:30
esp_hid feat(nimble): added HID over Gatt profile support 2023-12-22 11:23:05 +05:30
esp_http_client esp_http_client: Fix reset errno to 0 before call esp_transport_read 2024-02-29 12:00:58 +08:00
esp_http_server feat: ECDSA peripheral while performing http connection with mutual auth 2023-11-17 16:24:10 +05:30
esp_https_ota Merge branch 'bugfix/preencrypted_ota_failed_with_partial_download_v5.1' into 'release/v5.1' 2023-11-29 14:05:39 +08:00
esp_https_server feat: ECDSA peripheral while performing http connection with mutual auth 2023-11-17 16:24:10 +05:30
esp_hw_support Merge branch 'bugfix/esp_intr_free_v5.1' into 'release/v5.1' 2024-02-29 12:44:38 +08:00
esp_lcd fix(rgb_lcd): relax the check for the data line GPIO 2024-02-06 10:35:11 +08:00
esp_local_ctrl
esp_mm fix(cache): no longer use freeze in esp_cache_msync 2023-07-21 17:19:11 +08:00
esp_netif Merge branch 'fix/esp_netif_lock_v5.1' into 'release/v5.1' 2023-12-08 11:18:09 +08:00
esp_netif_stack
esp_partition refactor(esp_partition): Expose function for unloading partitions 2023-11-27 19:50:16 +01:00
esp_phy refactor(usb): Deprecate CONFIG_USB_OTG_SUPPORTED, use SOC_USB_OTG_SUPPORTED instead 2024-02-28 16:09:53 +08:00
esp_pm fix(esp_pm): safely check ccompare validity in DFS update_ccompare 2024-01-19 11:14:28 +08:00
esp_psram fix(wifi): fix psram enabled but initialized fail issue 2023-12-19 19:15:49 +08:00
esp_ringbuf ringbuf: Fix ordering of StaticRingbuffer_t 2023-07-04 21:30:43 +01:00
esp_rom Merge branch 'bugfix/ble_update_lib_20240223_v5.1' into 'release/v5.1' 2024-02-28 16:54:19 +08:00
esp_system Merge branch 'c6_auto_dbias_master_hsq_v5.1' into 'release/v5.1' 2024-02-28 10:49:13 +08:00
esp_timer refactor(esp_timer): Remove duplicate code and move it to a common file 2023-08-22 17:22:24 +08:00
esp_wifi Merge branch 'contrib/github_pr_12867_v5.1' into 'release/v5.1' 2024-02-28 15:32:04 +08:00
esp-tls Merge branch 'fix/wrong_order_of_includes_in_esp_tls_v5.1' into 'release/v5.1' 2023-12-12 13:44:36 +08:00
espcoredump feat(coredump): save isr context to coredump elf file 2023-11-28 18:19:19 +01:00
esptool_py fix(build): fix build failure if CMAKE_EXECUTABLE_SUFFIX is set 2023-11-20 10:49:02 +01:00
fatfs Merge branch 'feature/add_fatfs_sbom_v5.1' into 'release/v5.1' 2023-12-19 16:47:52 +08:00
freertos Merge branch 'bugfix/fix_freertos_system_task_names_v5.1' into 'release/v5.1' 2023-11-14 16:35:25 +08:00
hal feat(usb/host): Calculate FIFO sizes based on USB configuration 2024-02-28 16:09:53 +08:00
heap fix(heap): Patch tlsf_check_pool in ROM heap 2023-12-08 03:19:04 +00:00
http_parser
idf_test Merge branch 'feature/support_adc_calibration_on_h2_v5.1' into 'release/v5.1' 2023-11-17 16:41:00 +08:00
ieee802154 fix(802154): fix pending tx will be delayed issue 2024-02-01 14:16:00 +08:00
json feat(cjson): update submodule to v1.7.17 2024-01-19 14:06:11 +05:30
linux
log cxx: gnu++23 -> gnu++2b for clang compatibility, added docs and test 2023-05-11 17:48:38 +08:00
lwip Fix(lwip):bugfix for change default value for ip ttl 2024-01-24 10:48:57 +08:00
mbedtls Merge branch 'fix/build_failure_when_hardware_gcm_is_disabled_v5.1' into 'release/v5.1' 2024-02-28 10:34:51 +08:00
mqtt change(mqtt): Update submodule to e6afdb 2023-10-02 06:23:35 +00:00
newlib fix(newlib,ci): wrong floating point number handling in tests 2023-11-13 13:51:53 +08:00
nvs_flash ci: fix missing linux related .build-test-rules.yml 2023-11-30 09:07:36 +01:00
openthread Merge branch 'bugfix/bugfix_for_radio_spinel' into 'release/v5.1' 2024-02-05 14:15:15 +08:00
partition_table
perfmon
protobuf-c
protocomm fix(esp_srp): Use @file for file documentation and missing doc 2023-12-19 19:15:49 +08:00
pthread fix(pthread): fixed pthread_condvar linker hook 2023-09-18 12:31:25 +08:00
riscv fix(riscv): supports 1 byte and larger than 64byte range watchpoint setting 2023-11-16 20:40:04 +08:00
sdmmc sdmmc: incrementally increase delay of vTaskDelay 2023-05-19 14:01:43 +02:00
soc Merge branch 'feature/usb_host_collective_backport_v5.1' into 'release/v5.1' 2024-03-01 09:28:23 +08:00
spi_flash Merge branch 'bugfix/fix_wrong_dcache_0_size_issue_on_s2_v5.1' into 'release/v5.1' 2024-02-28 10:43:55 +08:00
spiffs fix(spiffs): SPIFFS print formatter errors out 2023-08-17 11:46:25 +02:00
tcp_transport feat: ECDSA peripheral while performing http connection with mutual auth 2023-11-17 16:24:10 +05:30
touch_element Merge branch 'bugfix/vfs_uart_outof_bounds_read_v5.1' into 'release/v5.1' 2023-07-03 16:13:06 +08:00
ulp Merge branch 'bugfix/rtc_i2c_not_in_od_mode_v5.1' into 'release/v5.1' 2024-02-27 18:16:08 +08:00
unity
usb Merge branch 'feature/usb_host_collective_backport_v5.1' into 'release/v5.1' 2024-03-01 09:28:23 +08:00
vfs fix(vfs): fix uart malloc when locates ISR context in IRAM 2023-12-07 10:43:58 +08:00
wear_levelling
wifi_provisioning fix (wifi_prov): Retry provisioning on WIFI_AUTH_EXPIRE event 2023-11-03 11:50:13 +05:30
wpa_supplicant Merge branch 'bugfix/esp32c2_eap_auth_v5.1' into 'release/v5.1' 2024-02-27 19:59:52 +08:00
xtensa Fix possible conversion errors by using __builtin_ffsll instead of __builtin_ffs 2023-05-11 11:16:45 +08:00
README.md

Core Components

Overview

This document contains details about what the core components are, what they contain, and how they are organized.

Organization

The core components are organized into two groups.

The first group (referred to as G0 from now on) contains hal, xtensa and riscv (referred to as arch components from now on), esp_rom, esp_common, and soc. This group contain information about and low-level access to underlying hardware; or in the case of esp_common, hardware-agnostic code and utilities. These components can depend on each other, but as much as possible have no dependencies outside the group. The reason for this is that, due to the nature of what these components contain, the likelihood is high that a lot of other components will require these. Ideally, then, the dependency relationship only goes one way. This makes it easier for these components, as a group, to be usable in another project. One can conceivably implement a competing SDK to ESP-IDF on top of these components.

The second group (referred to as G1 from now on) sits at a higher level than the first group. This group contains the components esp_hw_support, esp_system, newlib, spi_flash, freertos, log, and heap. Like the first group, circular dependencies within the group are allowed; and being at a higher level, dependency on the first group is allowed. These components represent software mechanisms essential to building other components.

Descriptions

The following is a short description of the components mentioned above.

G0 Components

hal

Contains the hardware abstraction layer and low-level operation implementations for the various peripherals. The low-level functions assign meaningful names to register-level manipulations; the hardware abstraction provide operations one level above this, grouping these low-level functions into routines that achieve a meaningful action or state of the peripheral.

Example:

  • spi_flash_ll_set_address is a low-level function part of the hardware abstraction spi_flash_hal_read_block

arch

Contains low-level architecture operations and definitions, including those for customizations (can be thought of on the same level as the low-level functions of hal). This can also contain files provided by the architecture vendor.

Example:

  • xt_set_exception_handler
  • rv_utils_intr_enable
  • ERI_PERFMON_MAX

esp_common

Contains hardware-agnostic definitions, constants, macros, utilities, 'pure' and/or algorithmic functions that is useable by all other components (that is, barring there being a more appropriate component to put them in).

Example:

  • BIT(nr) and other bit manipulation utilities in the future
  • IDF_DEPRECATED(REASON)
  • ESP_IDF_VERSION_MAJOR

soc

Contains description of the underlying hardware: register structure, addresses, pins, capabilities, etc.

Example:

  • DR_REG_DPORT_BASE
  • SOC_MCPWM_SUPPORTED
  • uart_dev_s

esp_rom

Contains headers, linker scripts, abstraction layer, patches, and other related files to ROM functions.

Example:

  • esp32.rom.eco3.ld
  • rom/aes.h

G1 Components

spi_flash

SPI flash device access implementation.

freertos

FreeRTOS port to targets supported by ESP-IDF.

log

Logging library.

heap

Heap implementation.

newlib

Some functions n the standard library are implemented here, especially those needing other G1 components.

Example:

  • malloc is implemented in terms of the component heap's functions
  • gettimeofday is implemented in terms of system time in esp_system

esp_system

Contains implementation of system services and controls system behavior. The implementations here may take hardware resources and/or decide on a hardware state needed for support of a system service/feature/mechanism. Currently, this encompasses the following, but not limited to:

  • Startup and initialization
  • Panic and debug
  • Reset and reset reason
  • Task and interrupt watchdogs

esp_hw_support

Contains implementations that provide hardware operations, arbitration, or resource sharing, especially those that is used in the system. Unlike esp_system, implementations here do not decide on a hardware state or takes hardware resource, acting merely as facilitator to hardware access. Currently, this encompasses the following, but not limited to:

  • Interrupt allocation
  • Sleep functions
  • Memory functions (external SPIRAM, async memory, etc.)
  • Clock and clock control
  • Random generation
  • CPU utilities
  • MAC settings

esp_hw_support vs esp_system

This section details list some implementations and the reason for placing it in either esp_hw_support or esp_system.

task_wdt.c (esp_system) vs intr_alloc.c (esp_hw_support)

The task watchdog fits the definition of taking and configuring hardware resources (wdt, interrupt) for implementation of a system service/mechanism.

This is in contrast with interrupt allocation that merely facilitates access to the underlying hardware for other implementations - drivers, user code, and even the task watchdog mentioned previously!

crosscore_int.c (esp_system)

The current implementation of crosscore interrupts is tightly coupled with a number of interrupt reasons associated with system services/mechanisms: REASON_YIELD (scheduler), REASON_FREQ_SWITCH (power management) REASON_PRINT_BACKTRACE (panic and debug).

However, if an implementation exists that makes it possible to register an arbitrary interrupt reason - a lower level inter-processor call if you will, then this implementation is a good candidate for esp_hw_support. The current implementation in esp_system can then just register the interrupt reasons mentioned above.

esp_mac.h, esp_chip_info.h, esp_random.h (esp_hw_support)

The functions in these headers used to be in esp_system.h, but have been split-off.

The remaining functions in esp_system.h are those that deal with system behavior, such as esp_register_shutdown_handler, or are proxy for other system components's APIs such as esp_get_free_heap_size.

The functions split-off from esp_system.h are much more hardware manipulation oriented such as: esp_read_mac, esp_random and esp_chip_info.