esp-idf/components
Jiang Jiang Jian db50b1ac63 Merge branch 'bugfix/support_cert_test' into 'master'
All chip support cert_test

Closes WIFI-5432, IDFGH-12197, and IDFHG-10756

See merge request espressif/esp-idf!27977
2024-09-14 16:44:21 +08:00
..
app_trace feat(sysview): add sbom manifest file 2024-09-04 18:38:01 +03:00
app_update fix(build): fix calloc warnings 2024-09-08 13:53:52 +07:00
bootloader fix(bootloader): Update pin range for factory reset and app test 2024-09-06 07:18:46 +02:00
bootloader_support Merge branch 'feature/esp32c61_update_efuses' into 'master' 2024-09-12 01:20:20 +08:00
bt fix(bt/bluedroid): Fixed some bugs in AVRCP 2024-09-13 17:58:49 +08:00
cmock
console fix(uart): make custom console uart pins same to the default console uart pins 2024-09-02 15:24:29 +08:00
cxx ci: replace pytest function 2024-07-23 14:07:31 +08:00
driver feat(esp_hw_support): add clk tree source gate management api 2024-09-11 10:53:01 +08:00
efuse feat(efuse): Updates efuse table for esp32c61 2024-09-10 14:16:29 +03:00
esp_adc Merge branch 'feature/optimize_esp32p4_active_power_eco1' into 'master' 2024-09-11 23:15:29 +08:00
esp_app_format feat(bootloader): support to check efuse block revision 2024-08-26 10:02:31 +08:00
esp_bootloader_format ci: replace pytest function 2024-07-23 14:07:31 +08:00
esp_coex feat(coex): support GPIO debug 2024-09-10 10:40:15 +08:00
esp_common fix(esp_system): fix GCC 14 analyzer warnings 2024-09-08 13:53:52 +07:00
esp_driver_ana_cmpr ci(ana_cmpr): enable the ana_cmpr target tests on P4 2024-07-19 16:53:25 +08:00
esp_driver_cam fix(csi): fixed csi bridge clock closed by csi host driver issue 2024-09-13 17:00:07 +08:00
esp_driver_dac fix(driver_dac): fix GCC 14 analyzer warnings 2024-09-08 13:53:52 +07:00
esp_driver_gpio refactor(gpio): public some IO configuration functions 2024-09-11 18:07:46 +08:00
esp_driver_gptimer Merge branch 'feature/optimize_esp32p4_active_power_eco1' into 'master' 2024-09-11 23:15:29 +08:00
esp_driver_i2c fix(i2c): Fix possible error state in clear the bus, 2024-09-06 14:28:26 +08:00
esp_driver_i2s fix: fix minor issues in isp and i2s 2024-09-02 14:07:05 +08:00
esp_driver_isp feat(esp_hw_support): add clk tree source gate management api 2024-09-11 10:53:01 +08:00
esp_driver_jpeg feat(ci): check LL functions not read write register by half word 2024-06-18 14:58:41 +08:00
esp_driver_ledc Merge branch 'feature/gpio_add_direction' into 'master' 2024-09-12 18:20:11 +08:00
esp_driver_mcpwm feat(esp_hw_support): add clk tree source gate management api 2024-09-11 10:53:01 +08:00
esp_driver_parlio feat(esp_hw_support): add clk tree source gate management api 2024-09-11 10:53:01 +08:00
esp_driver_pcnt refactor(gpio): public some IO configuration functions 2024-09-11 18:07:46 +08:00
esp_driver_ppa fix(ppa): fix insufficient writeback/invalidate data length 2024-07-09 16:06:42 +08:00
esp_driver_rmt feat(esp_hw_support): add clk tree source gate management api 2024-09-11 10:53:01 +08:00
esp_driver_sdio feat(ci): check LL functions not read write register by half word 2024-06-18 14:58:41 +08:00
esp_driver_sdm refactor(sdm): add check and error info to the clock division 2024-09-13 14:13:20 +08:00
esp_driver_sdmmc feat(esp_hw_support): add clk tree source gate management api 2024-09-11 10:53:01 +08:00
esp_driver_sdspi fix(mspi): fixed mspi clock wrong on ram loadable app on c61, enable tests on c5 c61 2024-09-10 11:12:03 +08:00
esp_driver_spi change(esp_driver_spi): increase SPI_PER_TRANS_POLLING peformance tolerance 2024-09-11 10:53:45 +08:00
esp_driver_touch_sens ci(touch_sensor): enable the touch sensor target tests on P4 2024-07-19 16:53:35 +08:00
esp_driver_tsens feature(temperature_sensor): Add temperature sensor support on esp32c5 2024-08-13 11:55:39 +08:00
esp_driver_uart Merge branch 'feature/optimize_esp32p4_active_power_eco1' into 'master' 2024-09-11 23:15:29 +08:00
esp_driver_usb_serial_jtag test(usb_serial): Add a test for printf/rom_printf after driver is installed 2024-08-23 14:59:57 +08:00
esp_eth docs(esp_eth): added warning to not use ESP32 as ETH CLK source with WiFi 2024-08-27 20:01:23 +08:00
esp_event ci(qemu): remove allowed to fail attribute from qemu tests 2024-07-26 15:36:32 +08:00
esp_gdbstub
esp_hid fix(esp_hid): Fixed protocol mode mapping bug 2024-08-30 15:37:14 +08:00
esp_http_client feat(esp_http_client): Added http method REPORT 2024-07-23 16:43:33 +05:30
esp_http_server fix(esp_http_server): fix GCC 14 analyzer warnings 2024-09-08 13:53:52 +07:00
esp_https_ota
esp_https_server
esp_hw_support Merge branch 'contrib/github_pr_14469' into 'master' 2024-09-14 15:34:41 +08:00
esp_lcd refactor(mipi_dsi): remove unused LL functions 2024-09-13 12:24:12 +08:00
esp_local_ctrl feat(build): add COMPILER_STATIC_ANALYZER option 2024-06-18 14:25:37 +08:00
esp_mm fix(system): fixed warnings related to ununsed var if asserts disabled 2024-08-26 10:25:04 +08:00
esp_netif Merge branch 'feat/lwip_2.2.0' into 'master' 2024-09-13 15:38:23 +08:00
esp_netif_stack
esp_partition fix(build): fix calloc warnings 2024-09-08 13:53:52 +07:00
esp_phy fix(phy): esp32s2 and esph2 support rf cert_test 2024-09-14 10:37:14 +08:00
esp_pm Merge branch 'feature/optimize_esp32p4_active_power_eco1' into 'master' 2024-09-11 23:15:29 +08:00
esp_psram fix(linker): fixed extern linker symbol type from int to char 2024-09-14 11:11:55 +08:00
esp_ringbuf Merge branch 'bugfix/esp_ringbuf_32_bit_alignment' into 'master' 2024-08-27 15:46:28 +08:00
esp_rom Merge branch 'feature/c6_misc_core' into 'master' 2024-09-12 09:46:30 +08:00
esp_security Merge branch 'fix/ds_tries_acquiring_mpi_lock_twice' into 'master' 2024-09-12 12:18:22 +08:00
esp_system fix(linker): fixed extern linker symbol type from int to char 2024-09-14 11:11:55 +08:00
esp_timer feat(esp_timer): Updates systimer and esp_timer 2024-09-12 14:26:37 +08:00
esp_vfs_console fix(storage/vfs): always register /dev/null on startup 2024-05-28 07:55:37 +02:00
esp_wifi Merge branch 'ci/enable_esp32c5_target_test' into 'master' 2024-09-13 20:17:58 +08:00
esp-tls fix(esp-tls): Reduce parameter check for esp_tls_conn_read 2024-08-23 12:08:42 +05:30
espcoredump test(coredump): enable esp32c5 coredump tests 2024-08-30 13:17:44 +03:00
esptool_py fix(esptool_py): Check the size of the bootloader + signature block 2024-09-12 15:38:18 +08:00
fatfs fix(build): fix calloc warnings 2024-09-08 13:53:52 +07:00
freertos Merge branch 'fix/freertos_sim_nonblock_select' into 'master' 2024-09-12 16:57:58 +08:00
hal Merge branch 'feature/esp32c61_esp_timer_systimer' into 'master' 2024-09-14 16:08:40 +08:00
heap feat(system): remove references to RTC mem on C61 2024-09-04 11:16:36 +08:00
http_parser
idf_test feat(esp_timer): Updates systimer and esp_timer 2024-09-12 14:26:37 +08:00
ieee802154 fix(802.15.4): fix oob issue for pending table 2024-08-28 17:36:44 +08:00
json
linux refactor(linux): deprecated esp_linux_helper.h 2024-07-30 16:41:28 +02:00
log fix: fix various errors in Kconfig files 2024-07-17 11:33:22 +02:00
lwip Merge branch 'feat/thread_dns_ext_resolve' into 'master' 2024-09-13 15:45:25 +08:00
mbedtls feat(mbedtls): support rom mbedtls threading layer 2024-09-06 19:27:57 +08:00
mqtt change(mqtt): Update esp_mqtt submodule 2024-06-17 13:06:35 +08:00
newlib Merge branch 'feature/c6_misc_core' into 'master' 2024-09-12 09:46:30 +08:00
nvs_flash feat(nvs): Test nvs_partition_gen.py and nvs_check.py with pytest 2024-08-30 16:21:42 +02:00
nvs_sec_provider fix(nvs_sec_provider): Added check for nvs_keys partition 2024-09-10 12:12:02 +08:00
openthread Merge branch 'feat/thread_dns_ext_resolve' into 'master' 2024-09-13 15:45:25 +08:00
partition_table feat: add config option under partition menu to support large size ota 2024-07-12 14:49:16 +05:30
perfmon
protobuf-c
protocomm fix(nimble): Add notify characteristic flag support 2024-09-05 16:16:08 +05:30
pthread fix(pthread): fix GCC 14 analyzer warnings 2024-09-08 13:53:52 +07:00
riscv Merge branch 'refactor/supplement_plic_intr_rv_util_apis' into 'master' 2024-09-12 15:28:24 +08:00
rt feat(rt/posix): Added FreeRTOS-Plus-POSIX message queues implementation 2024-07-11 21:08:01 +02:00
sdmmc docs(sdmmc): update information about eMMC support 2024-09-10 09:14:54 +02:00
soc Merge branch 'feature/esp32c61_esp_timer_systimer' into 'master' 2024-09-14 16:08:40 +08:00
spi_flash fix(linker): fixed extern linker symbol type from int to char 2024-09-14 11:11:55 +08:00
spiffs fix(build): fix calloc warnings 2024-09-08 13:53:52 +07:00
tcp_transport ci: replace pytest function 2024-07-23 14:07:31 +08:00
touch_element ci: replace pytest function 2024-07-23 14:07:31 +08:00
ulp Merge branch 'feature/optimize_esp32p4_active_power_eco1' into 'master' 2024-09-11 23:15:29 +08:00
unity Merge branch 'feat/unity_runner_print_stage_number' into 'master' 2024-07-31 17:15:24 +08:00
usb Merge branch 'refactor/usb_host_ext_hub_cleanup' into 'master' 2024-09-12 16:01:36 +08:00
vfs fix(vfs): fix nullfs open syscall 2024-08-09 16:05:52 +07:00
wear_levelling ci: replace pytest function 2024-07-23 14:07:31 +08:00
wifi_provisioning fix(nimble): Add notify characteristic flag support 2024-09-05 16:16:08 +05:30
wpa_supplicant fix(esp_wifi): Remove duplicate declaration of function 2024-09-11 10:03:38 +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) includes hal, arch (where arch is either riscv or xtensa depending on the chip), esp_rom, esp_common, and soc. This group contains information about and provides low-level access to the underlying hardware. In the case of esp_common, it contains hardware-agnostic code and utilities. These components may have dependencies on each other within the group, but outside dependencies should be minimized. The reason for this approach is that these components are fundamental, and many other components may require them. Ideally, the dependency relationship only goes one way, making it easier for this group to be usable in other projects.

The second group (referred to as G1) operates at a higher level than the first group. G1 includes the components esp_hw_support, esp_system, newlib, spi_flash, freertos, log, and heap. Like the first group, circular dependencies within this group are allowed, and these components can have dependencies on the first group. G1 components represent essential software mechanisms for 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_mm

Memory management. Currently, this encompasses:

  • Memory mapping for MMU supported memories
  • Memory synchronisation via Cache
  • Utils such as APIs to convert between virtual address and physical address

esp_psram

Contains implementation of PSRAM services

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.