esp-idf/components
2024-02-04 16:28:57 +08:00
..
app_trace Merge branch 'feature/app_trace_component_test_app' into 'master' 2023-10-20 21:45:05 +08:00
app_update fix(app_update): fixed undeclared variable 'ret' in esp_ota_ops.c 2023-12-22 12:30:57 +05:30
bootloader fix(nvs_flash): Remove the forceful selection of NVS_ENCRYPTION with flash encryption 2023-12-21 19:22:56 +05:30
bootloader_support Merge branch 'feature/misc_core_build_tests_p4_v5.2' into 'release/v5.2' 2023-12-04 12:16:58 +08:00
bt feat(bt/bluedroid): Make the max number of bond device to be configurable 2024-02-04 16:28:57 +08:00
cmock
console refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
cxx refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
driver fix(i2s): multi_dev test update to use non_boot_ctrl gpio 2024-01-25 16:44:58 +08:00
efuse docs: add ECDSA peripheral chapter for H2/P4 2023-11-17 07:13:53 +00:00
esp_adc Merge branch 'bugfix/fix_adc_continuous_do_not_rst_apb_clk_v5.2' into 'release/v5.2' 2023-12-07 15:11:26 +08:00
esp_app_format refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
esp_bootloader_format refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
esp_coex fix(esp_coex): Fixed potential BLE scan request ifs timer error bug 2024-01-18 22:36:59 +08:00
esp_common fix(docs): fixed doxygen warnings in few headers 2023-12-19 13:12:28 +05:30
esp_eth refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
esp_event fix(ci): change build-test-rules files folder 2023-09-20 19:17:06 +08:00
esp_gdbstub change(xtensa): Deprecate ".../xtensa_context.h" include path 2023-12-05 18:04:52 +08:00
esp_hid feat(nimble): added HID over Gatt profile support 2023-12-20 09:58:26 +05:30
esp_http_client fix(esp_http_client): Fix esp_http_client async mode 2023-11-30 12:04:31 +05:30
esp_http_server feat: ECDSA peripheral while performing http connection with mutual auth 2023-09-08 12:22:41 +05:30
esp_https_ota fix(esp_https_ota): fix return code of esp_https_ota_finish API 2023-11-22 17:09:47 +05:30
esp_https_server docs(build): add header include path and component require to api reference 2023-10-07 11:47:45 +08:00
esp_hw_support Merge branch 'bugfix/recalib_bbpll_before_tuning_v5.2' into 'release/v5.2' 2024-01-17 21:30:10 +08:00
esp_lcd fix(i80_lcd): enhance the check of a valid data phase 2023-11-28 09:57:02 +08:00
esp_local_ctrl refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
esp_mm refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
esp_netif fix(dhcp server):dhcp server can not restore address pool 2023-12-07 15:18:45 +08:00
esp_netif_stack
esp_partition refactor(esp_partition): Expose function for unloading partitions 2023-11-27 19:49:59 +01:00
esp_phy fix(esp_phy): fix esp32h2 wakeup i2c fail 2024-01-17 18:48:48 +08:00
esp_pm fix(esp_pm): safely check ccompare validity in DFS update_ccompare 2024-01-19 11:12:22 +08:00
esp_psram fix(wifi): fix psram enabled but initialized fail issue 2023-12-08 13:08:55 +00:00
esp_ringbuf fix(esp_ringbuffer): Enable build on Linix 2023-10-24 11:30:03 +02:00
esp_rom Merge branch 'bugfix/fix_establish_two_sco_fail_v5.2' into 'release/v5.2' 2023-12-25 20:34:09 +08:00
esp_system fix(rtc): fixed bbpll not calibrated from bootloader issue 2024-01-05 10:24:49 +08:00
esp_timer refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
esp_wifi fix(wifi): fix the crash and malloc fail issue 2024-01-17 16:57:44 +08:00
esp-tls fix(esp-tls): Add headers in esp_tls_errors.h header file 2023-12-06 10:19:41 +05:30
espcoredump feat(coredump): save twdt panic output to coredump elf file 2023-12-07 15:21:24 +01:00
esptool_py fix(build): fix build failure if CMAKE_EXECUTABLE_SUFFIX is set 2023-11-20 10:48:47 +01:00
fatfs Merge branch 'feature/add_fatfs_sbom_v5.2' into 'release/v5.2' 2023-12-05 12:03:17 +08:00
freertos change(xtensa): Deprecate ".../xtensa_context.h" include path 2023-12-05 18:04:52 +08:00
hal Merge branch 'fix/esp32h2_rssi_positive_issue_5.2' into 'release/v5.2' 2024-01-11 14:14:29 +08:00
heap fix(heap): Update the heap memory layout on esp32p4 target 2023-12-06 04:48:00 +00:00
http_parser feat(http_parser): Add sbom manifest file 2023-09-25 16:09:32 +05:30
idf_test feat(adc_cali): Add ADC calibration support for ESP32H2 2023-11-06 10:57:36 +08:00
ieee802154 fix(ieee802154): fix the issue of not receiving packets when RSSI is positive in esp32h2 2024-01-04 15:13:49 +08:00
json feat(cjson): update submodule to v1.7.17 2024-01-09 12:12:39 +05:30
linux
log fix(ci): change build-test-rules files folder 2023-09-20 19:17:06 +08:00
lwip Fix(lwip):bugfix for change default value for ip ttl 2024-01-17 16:37:57 +08:00
mbedtls mbedtls: Fix enable dynamic mbedtls will occur heap corruption when server support TLS renegotiation 2024-01-08 14:23:32 +08:00
mqtt change(mqtt): Update submodule to e6afdb 2023-09-25 08:14:02 +02:00
newlib fix(newlib,ci): wrong floating point number handling in tests 2023-11-16 02:57:41 +00:00
nvs_flash fix(nvs_flash): Remove the forceful selection of NVS_ENCRYPTION with flash encryption 2023-12-21 19:22:56 +05:30
nvs_sec_provider refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
openthread fix(openthread): update lib to set raw pcb ttl value 2024-01-02 17:05:16 +08:00
partition_table feat(partition_table): Add read-only partition flag and functionality 2023-10-11 00:01:05 +02:00
perfmon refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
protobuf-c
protocomm fix(esp_srp): Use @file for file documentation and missing doc 2023-12-19 13:12:11 +05:30
pthread feat(pthread): added pthread_condattr* stubs to avoid linker errors 2023-09-26 12:17:38 +08:00
riscv fix(riscv): supports 1 byte and larger than 64byte range watchpoint setting 2023-11-16 20:23:57 +08:00
sdmmc refactor: Remove -Wno-format from storage related components 2023-10-22 17:56:41 +00:00
soc fix(nimble): Added periodic_adv_enh soc_caps for c2, h2 2023-12-26 10:09:12 +05:30
spi_flash Merge branch 'feature/hello_world_linux' into 'master' 2023-10-25 10:22:49 +08:00
spiffs feat(partition_table): Add read-only partition flag and functionality 2023-10-11 00:01:05 +02:00
tcp_transport fix(esp-tls): Use TLS 1.2 and TLS 1.3 simultaneously 2023-10-23 16:23:10 +05:30
touch_element refactor(linux): excluded all non-Linux components from build 2023-10-16 17:06:54 +08:00
ulp feat(ulp): add api to get lp_cpu wakeup cause and clear wakeup source at startup 2023-12-27 19:12:16 +08:00
unity refactor(unity): improved unity task deletion function 2023-09-18 17:48:26 +08:00
usb fix(usb/host): remove bInterval verification during pipe opening for INTR and ISOC EPs 2023-12-05 16:44:53 +01:00
vfs fix(vfs): add MALLOC_CAP_8BIT for vfs select 2023-12-07 10:46:01 +08:00
wear_levelling refactor: Remove -Wno-format from storage related components 2023-10-22 17:56:41 +00:00
wifi_provisioning feat(bt/bluedroid): Added mode to use BlueDroid host only without Bluetooth Controller 2023-11-02 11:10:24 +08:00
wpa_supplicant fix(wpa_supplicant): Move concurrent wps and dpp check to before creating task 2023-12-05 18:57:33 +05:30
xtensa change(xtensa): Deprecate ".../xtensa_timer.h" include path 2023-12-05 18:04:52 +08:00
README.md docs(components-readme): Fix Organization section 2023-08-16 14:26:11 +02:00

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.