esp-idf/components
morris a15830bcfc Merge branch 'bugfix/correct_default_apb_frequency' into 'master'
soc: fix wrong APB_CLK_FREQ value on esp32c6

Closes IDF-6343

See merge request espressif/esp-idf!22080
2023-01-30 17:12:55 +08:00
..
app_trace sys_view: upgrade to version 3.42 2023-01-27 22:22:33 +07:00
app_update esp32h2: add build test 2023-01-17 10:29:04 +08:00
bootloader esp32h2 memory: update esp32h2 memory layout 2023-01-06 05:30:24 +00:00
bootloader_support Merge branch 'fix/malloc_cap_exec_on_esp32c6' into 'master' 2023-01-26 17:45:23 +08:00
bt Merge branch 'bugfix/coex_enable_disable_not_in_pairs' into 'master' 2023-01-18 17:01:02 +08:00
cmock
console esp32h2: add build test 2023-01-17 10:29:04 +08:00
cxx cxx: fixed stack smash test case failing due to changed output 2022-12-13 11:15:01 +08:00
driver soc: fix wrong APB_CLK_FREQ value on esp32c6 2023-01-28 06:33:23 +00:00
efuse esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_adc esp_adc: added an all-in-one API to get calibrated voltage 2023-01-18 16:38:18 +08:00
esp_app_format esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_common esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_eth esp_eth: fixed copyright for W5500 2023-01-19 07:56:22 +00:00
esp_event Merge branch 'contrib/github_pr_10509' into 'master' 2023-01-29 17:04:04 +08:00
esp_gdbstub ESP32H2: Introduce new chip target esp32h2, hello_world example supported 2022-12-29 12:29:14 +08:00
esp_hid optimize HID Host disconnection procedure 2022-11-15 15:15:50 +08:00
esp_http_client esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_http_server esp32h2: add build test 2023-01-17 10:29:04 +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 esp32h2: add support for SHA peripheral 2023-01-30 10:08:58 +05:30
esp_lcd esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_local_ctrl esp_local_ctrl: Fix header inclusion 2023-01-12 16:16:45 +05:30
esp_netif Merge branch 'lwip/restrict_dhcp_server_client_together' into 'master' 2023-01-27 22:36:30 +08:00
esp_netif_stack esp-netif: Support non-lwip mode, add test 2022-12-14 14:12:50 +00:00
esp_partition Merge branch 'bugfix/linux_build_errors' into 'master' 2023-01-20 14:46:36 +08:00
esp_phy esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_pm esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_psram mspi: move timing tuning to esp_hw_support 2023-01-06 14:41:20 +08:00
esp_ringbuf esp_ringbuf: migrated esp_ringbuf component tests to pytest framework 2022-10-11 11:31:04 +02:00
esp_rom Merge branch 'bugfix/remove_undefined_rom_funcs' into 'master' 2023-01-29 11:47:39 +08:00
esp_system wdt: add support for WDTs on C6 2023-01-19 12:58:26 +08:00
esp_timer esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_wifi esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp-tls esp32h2: add build test 2023-01-17 10:29:04 +08:00
espcoredump esp32h2: add build test 2023-01-17 10:29:04 +08:00
esptool_py esptool_py: Adds funcs to read eFuses from Cmake during a build stage 2023-01-04 00:30:38 +08:00
fatfs esp32h2: add build test 2023-01-17 10:29:04 +08:00
freertos fix(linux): fix build errors and warnings, remove ignore file 2023-01-18 09:24:28 +08:00
hal Merge branch 'bugfix/correct_default_apb_frequency' into 'master' 2023-01-30 17:12:55 +08:00
heap Merge branch 'fix/malloc_cap_exec_on_esp32c6' into 'master' 2023-01-26 17:45:23 +08:00
http_parser
idf_test spi_master: update spi performance test resulte for C6 2023-01-18 10:41:43 +08:00
ieee802154 ieee802154: add multipan api 2023-01-09 15:06:01 +08:00
json
linux linux: Add esp_linux_helper.h header file 2023-01-04 11:17:18 +05:30
log Merge branch 'bugfix/linux_target_gen_partition_table' into 'master' 2023-01-18 11:57:08 +08:00
lwip Merge branch 'bugfix/lwip_core_locking' into 'master' 2023-01-18 20:31:25 +08:00
mbedtls mbedtls: fix null pointer dereference of variable iv_off 2023-01-24 12:20:00 +05:30
mqtt esp32h2: add build test 2023-01-17 10:29:04 +08:00
newlib esp32h2: add build test 2023-01-17 10:29:04 +08:00
nvs_flash Merge branch 'bugfix/linux_build_errors' into 'master' 2023-01-20 14:46:36 +08:00
openthread Merge branch 'bugfix/lwip_core_locking' into 'master' 2023-01-18 20:31:25 +08:00
partition_table build system: generate the partition table by default for linux target 2023-01-13 08:14:56 +01:00
perfmon perfmon: fix xtensa_perfmon build target 2022-09-01 12:28:00 +08:00
protobuf-c protobuf-c: Update submodule to v1.4.1 2022-09-29 15:35:19 +05:30
protocomm protocomm: Fix Kconfig dependency on wifi_provisioning component config 2023-01-20 11:01:01 +05:30
pthread esp32h2: add build test 2023-01-17 10:29:04 +08:00
riscv Merge branch 'bugfix/fix_gnu_asm_struct' into 'master' 2022-12-07 20:21:31 +08:00
sdmmc esp32h2: add build test 2023-01-17 10:29:04 +08:00
soc Merge branch 'bugfix/correct_default_apb_frequency' into 'master' 2023-01-30 17:12:55 +08:00
spi_flash esp32h2: add build test 2023-01-17 10:29:04 +08:00
spiffs Merge branch 'bugfix/linux_build_errors' into 'master' 2023-01-20 14:46:36 +08:00
tcp_transport tcp_transport: Update tcp_transport to support linux build 2023-01-04 11:17:29 +05:30
touch_element build: Adds support for universal Clang toolchain 2022-11-23 13:25:16 +03:00
ulp ulp-riscv: add more wakeup test cases 2023-01-17 16:41:48 +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: Fix incorrect bmRequestType direction flag in USB Host Library 2022-12-06 18:10:45 +08:00
vfs soc: fix wrong APB_CLK_FREQ value on esp32c6 2023-01-28 06:33:23 +00:00
wear_levelling Storage: Partition APIs moved to the new component 'esp_partition' 2022-11-02 21:54:45 +01:00
wifi_provisioning Clean up wifi provisioning in the esp_event thread 2023-01-27 15:39:08 +05:30
wpa_supplicant Merge branch 'bugfix/update_wps_api_documentation' into 'master' 2023-01-25 18:52:51 +08:00
xtensa Merge branch 'bugfix/support_coredump_stack_xtensa' into 'master' 2022-12-19 18:02:15 +08:00
README.md riscv: Remove redundant riscv_interrupts.h header 2022-09-16 16:45:43 +08: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 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.