esp-idf/components
Jiang Jiang Jian 446ec3a899
Some checks failed
docker / docker (push) Has been cancelled
Merge branch 'feature/ipc_noblocking_call_v5.1' into 'release/v5.1'
feat(ipc): Adds a new no blocking IPC call (v5.1)

See merge request espressif/esp-idf!28443
2024-08-15 22:29:51 +08:00
..
app_trace feat(ipc): Adds a new no blocking IPC call 2024-08-07 15:13:11 +03:00
app_update fix(app_update): fixed undeclared variable 'ret' in esp_ota_ops.c 2024-01-19 14:04:06 +05:30
bootloader doc(spi_flash): hide unsupported optional features 2024-03-12 10:48:08 +08:00
bootloader_support fix(bootloader_support): Fix encrypt image instead of the partition feature not being enabled 2024-08-06 13:45:35 +05:30
bt fix(bt): Fix heap corruption in the call of esp_bt_mem_release on ESP32 2024-08-14 19:00:15 +08:00
cmock
console fix(console): USB Serial JTAG freezes when input received before init 2024-07-01 09:37:00 +02:00
cxx
driver fix(rmt): power up memory block 2024-07-17 13:53:35 +08:00
efuse feat(efuse): Add flash&psram efuses for S3 2024-02-21 09:36:49 +02:00
esp_adc Merge branch 'bugfix/workaround_reset_eof_counter_c3_v5.1' into 'release/v5.1' 2024-03-14 10:44:23 +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(coex): Fixed coexist scheme phase index overflow issue 2024-07-23 17:46:24 +08:00
esp_common fix: add ESP_ERR_NOT_ALLOWED error code to esp_err.h 2024-05-14 19:34:37 +08:00
esp_eth Merge branch 'bugfix/eth_l2_test_conn_wait_tmo_v5.1' into 'release/v5.1' 2024-05-27 18:25:37 +08:00
esp_event docs(esp_event): Fixed mistake in API docs 2024-03-12 10:33:10 +08:00
esp_gdbstub fix(soc): change debug addr range to CPU subsystem range 2024-01-24 12:52:27 +05:30
esp_hid fix(esp_hid): Loose the check of input report length to be more compatible 2024-08-09 15:55:06 +08:00
esp_http_client fix: fixed allocating if_name in client context multiple times 2024-07-07 21:21:00 +08:00
esp_http_server fix: Add warning to enable LWIP_NETIF_LOOPBACK to use control socket API 2024-05-20 10:46:45 +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 fix(esp_hw_support): wait eFuse controller idle after sleep wakeup 2024-07-08 14:17:28 +08:00
esp_lcd fix(lcd): build errors with deprecated lcd types in cpp 2024-06-24 14:06:20 +08:00
esp_local_ctrl refactor(protocomm): Make the protocomm proto-c headers public 2024-03-01 10:26:42 +05:30
esp_mm fix(esp_mm): for existing mmap region, consider new offset for virtual addr 2024-07-15 12:42:45 +08:00
esp_netif fix(esp_netif): Prevent running esp_netif_sntp_init() multiple times 2024-05-29 17:22:29 +08:00
esp_netif_stack
esp_partition feat(example/storage/littlefs): add LittleFS demo example 2024-03-12 20:58:14 +08:00
esp_phy fix(phy): add phy calibration data check when mode is not none calibration 2024-07-01 15:22:40 +08:00
esp_pm fix(esp_pm): configure timer wakeup source with auto light-sleep congiguration 2024-08-06 11:06:00 +08:00
esp_psram feat(psram): support APS3204L 2024-07-29 11:43:33 +08:00
esp_ringbuf
esp_rom Merge branch 'bugfix/fix_ble_channel_map_update_v5.1' into 'release/v5.1' 2024-08-14 10:50:08 +08:00
esp_system feat(ipc): Adds a new no blocking IPC call 2024-08-07 15:13:11 +03:00
esp_timer Merge branch 'bugfix/esp_timer_test_fail_v5.1' into 'release/v5.1' 2024-06-03 10:24:42 +08:00
esp_wifi fix(wifi): Avoid internal retries for offchannel FTM Requests 2024-08-14 18:33:54 +05:30
esp-tls fix(esp_tls): Fixed client key parsing for ECC key 2024-07-02 09:30:39 +08:00
espcoredump fix(coredump): fix array out of the bounds error 2024-07-09 22:10:45 +02:00
esptool_py spi_flash: fixed issue that enabling HPM-DC by default may cause app unable to restart 2024-03-12 10:48:08 +08:00
fatfs fix(vfs): FATFS mount immediately after format if mount failed 2024-07-26 17:54:51 +02:00
freertos test(freertos): Fixed flaky scheduling time test 2024-08-14 09:33:29 +02:00
hal Merge branch 'bugfix/rmt_memory_power_up_v5.1' into 'release/v5.1' 2024-07-18 15:13:41 +08:00
heap fix(heap): Tracing of all heap_caps API 2024-06-25 11:59:24 +02: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(ieee802154): refacted the next operation logic for multiple events 2024-07-31 16:40:09 +08:00
json feat(cjson): update submodule to v1.7.18 2024-05-22 13:34:54 +05:30
linux
log Merge branch 'bugfix/log_wrap_around_cache_generation_counter_v5.1' into 'release/v5.1' 2024-06-04 11:31:12 +08:00
lwip fix(lwip): Fixed compilation error referencing undefined POSIX interface API 2024-06-14 13:13:39 +10:00
mbedtls fix(hal): correct the power up sequence for MPI/ECC peripherals in ESP32-C5 2024-07-03 11:50:10 +05:30
mqtt change(mqtt): Update esp-mqtt submodule 2024-06-04 15:13:54 +08:00
newlib feat(newlib): add test case for printf float 2024-08-12 09:59:13 +08:00
nvs_flash fix(tests): correct the flash write length for NVS encrypted test 2024-05-02 16:54:13 +05:30
openthread fix(openthread): make ot task queue sending non-permanent blocking 2024-08-06 14:10:55 +08:00
partition_table feat(example/storage/littlefs): add LittleFS demo example 2024-03-12 20:58:14 +08:00
perfmon
protobuf-c
protocomm Merge branch 'refactor/protocomm_public_hdr_v5.1' into 'release/v5.1' 2024-03-01 21:42:08 +08:00
pthread fix(pthread): Remove TLS pointer/deletion callback from correct thread 2024-07-02 13:33:20 +08:00
riscv fix(riscv): supports 1 byte and larger than 64byte range watchpoint setting 2023-11-16 20:40:04 +08:00
sdmmc fix(sdmmc): extend the maximum number of retries of ACMD41 2024-03-14 13:49:23 +08:00
soc fix(esp_hw_support): clear reserved interrupts that are not applicable for each target 2024-06-03 11:09:45 +08:00
spi_flash feat(CI): Add targets into manifest file for esp_flash_stress test 2024-08-07 15:13:17 +03:00
spiffs fix: PRI inttypes error due to C++ invalid suffix on literal in SPIFFS 2024-06-30 23:32:04 +02:00
tcp_transport fix(esp-tls): Use TLS 1.2 and TLS 1.3 simultaneously 2024-05-02 16:57:50 +05:30
touch_element
ulp fix(lp-i2c): Fixed the generation of spurious I2C start with lp-i2c 2024-07-12 17:29:35 +02:00
unity
usb fix(usb/host): Fix occasional ISOC scheduler skipping transfers 2024-07-12 08:18:45 +02:00
vfs Merge branch 'docs/update_esp_vfs_notes_v5.1' into 'release/v5.1' 2024-07-01 10:21:41 +08:00
wear_levelling
wifi_provisioning fix(wifi): fix esp_wifi_scan_start memory leakage issue 2024-03-11 10:49:18 +08:00
wpa_supplicant fix(esp_wifi): Handle PMKID mismatch or absence in OWE 2024-07-25 08:33:42 +05:30
xtensa
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.