esp-idf/components
2023-03-27 06:42:08 +00:00
..
app_trace app_trace: fix fwrite/fread return value 2023-03-17 00:15:07 +08:00
app_update bootloader_support: Adds API to detect Factory reset has happened 2023-03-22 02:21:54 +08:00
bootloader bootloader_support: Adds API to detect Factory reset has happened 2023-03-22 02:21:54 +08:00
bootloader_support bootloader_support: Adds API to detect Factory reset has happened 2023-03-22 02:21:54 +08:00
bt Merge branch 'bugfix/warning_cur_len' into 'master' 2023-03-24 19:09:50 +08:00
cmock
console console: Fix and re-enable no-format warnings 2023-03-06 14:12:31 +01:00
cxx ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
driver spi_slave: add multi board test case for spi slave hd append mode 2023-03-21 11:30:17 +08:00
efuse efuse: Enable and adjust some efuse tests for H2 chip 2023-03-24 17:21:32 +00:00
esp_adc gptimer: fix race condition between start and stop 2023-03-10 23:27:29 +08:00
esp_app_format esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_coex coex: support esp32h2 coex lib 2023-03-16 17:23:43 +08:00
esp_common esp_common: restore test_attr test scope for psram 2023-03-01 11:04:22 +08:00
esp_eth esp_eth: allowed DM9051 to receive multicast packets 2023-03-14 13:59:27 +00:00
esp_event esp_event: fix and re-enable no-format warnings 2023-03-12 21:40:47 +01:00
esp_gdbstub wdt: refactor wdt codes to use unified type 2023-02-15 12:08:55 +08:00
esp_hid fix HID Host bug when handling the two consecutive connection request 2023-03-09 14:25:25 +08:00
esp_http_client Merge branch 'contrib/github_pr_10715' into 'master' 2023-03-21 14:07:31 +08:00
esp_http_server ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
esp_https_ota esp_http(s)_server: remove "Wno-format" cflag and fix formatting errors 2022-12-21 14:14:04 +05:30
esp_https_server esp_https_server: Add dependency on MBEDTLS_TLS_SERVER config 2022-12-16 10:30:41 +05:30
esp_hw_support Merge branch 'feat/merge_nuttx_patch' into 'master' 2023-03-21 20:48:21 +08:00
esp_lcd ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
esp_local_ctrl esp_local_ctrl: Fix header inclusion 2023-01-12 16:16:45 +05:30
esp_mm MMU: Fix stale data being read on memory mapped instruction page 2023-03-24 18:59:57 +08:00
esp_netif lwip/esp_napt: Added api to enable/disable napt based on esp_netif. 2023-03-23 20:38:03 +11:00
esp_netif_stack esp-netif: Support non-lwip mode, add test 2022-12-14 14:12:50 +00:00
esp_partition host_test: 2023-03-08 05:06:30 +00:00
esp_phy Remove -Wno-format in esp_phy, esp_wifi, wpa_supplicant components 2023-03-27 06:42:08 +00:00
esp_pm ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
esp_psram gpio: support runtime preserve 2023-03-17 11:59:49 +08:00
esp_ringbuf esp_ringbuf: Clarify behavior when sending items of 0 size 2023-02-28 23:56:45 +08:00
esp_rom mbedtls: Add port layer for ECDSA peripheral 2023-03-24 10:43:40 +05:30
esp_system Merge branch 'featue/factory_reset_state' into 'master' 2023-03-24 21:32:30 +08:00
esp_timer esp_timer: Adds AFFINITY options for task and ISR 2023-03-02 20:08:02 +08:00
esp_wifi Remove -Wno-format in esp_phy, esp_wifi, wpa_supplicant components 2023-03-27 06:42:08 +00:00
esp-tls Merge branch 'contrib/github_pr_10967' into 'master' 2023-03-24 18:02:31 +08:00
espcoredump esp32h2: add build test 2023-01-17 10:29:04 +08:00
esptool_py spi_flash: Allow clock frequency up to 64M, and make it default on ESP32H2 2023-03-10 11:39:53 +08:00
fatfs fatfs: fstat - enable setting a custom preferred block size 2023-03-08 09:09:47 +01:00
freertos freertos: Uncrustify FreeRTOSConfig files 2023-03-22 16:32:29 +08:00
hal h2/clk_gate: Clear reset signal of ECDSA peripheral before enabling SHA, RSA or ECC 2023-03-24 10:43:48 +05:30
heap heap: Wrap the function hook feature under a configuration 2023-03-23 04:50:49 +00:00
http_parser
idf_test esp32h2: Add support for ECC hardware accelerator 2023-03-13 16:39:46 +05:30
ieee802154 openthread_port: support CSL on esp32c6 2023-03-20 10:24:28 +08:00
json
linux esp_http_client: remove dependency of esp_stubs from esp_http_client. Add esp_event stubs in linux component 2023-03-15 11:48:11 +05:30
log log: Fix function name in OS-independent implementation 2023-03-16 01:50:21 +08:00
lwip lwip: Remove AFL based fuzzer tests 2023-03-20 17:47:23 +00:00
mbedtls mbedtls: Add port layer for ECDSA peripheral 2023-03-24 10:43:40 +05:30
mqtt esp32h2: add build test 2023-01-17 10:29:04 +08:00
newlib newlib: Put atomic function in IRAM 2023-03-24 11:18:55 +08:00
nvs_flash ci(nvs_flash): Increase timeout of nvs_page_test 2023-02-13 12:35:52 +08:00
openthread openthread_port: support CSL on esp32c6 2023-03-20 10:24:28 +08:00
partition_table partition_table: add tests for checking secure boot part size 2023-02-08 03:23:46 +00:00
perfmon
protobuf-c
protocomm Merge branch 'ci/driver_single_board' into 'master' 2023-03-13 09:25:42 +08:00
pthread pthread: Implemented POSIX unnamed semaphore 2023-03-21 10:23:58 +08:00
riscv esp32c6: Fix incorrect PMP configuration 2023-03-09 11:37:29 +05:30
sdmmc sdmmc: also set card->real_freq_khz for probing frequency 2023-03-23 23:28:54 +01:00
soc Merge branch 'feature/add_power_control_soc_cap' into 'master' 2023-03-24 17:43:37 +08:00
spi_flash MMU: Fix stale data being read on memory mapped instruction page 2023-03-24 18:59:57 +08:00
spiffs Storage: ESP Partition extended options for the SPI Flash emulation 2023-03-03 23:57:34 +00:00
tcp_transport [ws_transport] - Added esp_transport_ws_get_upgrade_request_status API 2023-02-16 12:19:40 +00:00
touch_element TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
ulp ulp-fsm: fixed potential sleep tests failures 2023-03-22 11:39:33 +08:00
unity gpio: Refactor pytest_gpio to separate cases with labels, and update to use new IdfDut class in pytest_embedded_idf 2022-12-20 15:28:33 +08:00
usb usb_host: add recovering interval after SetAddress(). Possibility to change constant delay value via menuconfig. 2023-03-09 08:11:05 +01:00
vfs Merge branch 'bugfix/usb_serial_driver_block' into 'master' 2023-02-24 10:22:08 +08:00
wear_levelling freertos(IDF): Remove usage of xPortGetFreeHeapSize() outside FreeRTOS 2023-03-07 02:02:28 +08:00
wifi_provisioning lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
wpa_supplicant Remove -Wno-format in esp_phy, esp_wifi, wpa_supplicant components 2023-03-27 06:42:08 +00:00
xtensa Merge branch 'bugfix/support_coredump_stack_xtensa' into 'master' 2022-12-19 18:02:15 +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.