esp-idf/components
2023-09-08 21:37:33 +08:00
..
app_trace feat(gcov): make gcov dump task size configurable 2023-08-22 01:07:42 +02:00
app_update change(ci): add todo to p4 build test enable 2023-08-24 12:51:19 +08:00
bootloader change(bootloader): added address check in bootloader.ld 2023-08-09 19:33:26 +08:00
bootloader_support Merge branch 'change/delete_not_used_mmu_macros' into 'master' 2023-09-06 11:59:03 +08:00
bt feat(ble_mesh): Bluetooth Mesh folder and file misc updates 2023-09-08 21:37:33 +08:00
cmock
console feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
cxx feat(newlib): Implement getentropy() function 2023-08-08 18:06:58 +03:00
driver Merge branch 'bugfix/i2c_probe_continue' into 'master' 2023-09-06 17:23:48 +08:00
efuse feat(ecdsa): add ECDSA peripheral support for esp32p4 2023-09-06 11:07:37 +05:30
esp_adc feat(adc): added an API to flush the continuous driver pool 2023-08-31 03:52:28 +00:00
esp_app_format feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
esp_bootloader_format esp_bootloader_format: Adds bootloader description structure to read bootloader version from app 2023-05-10 21:39:52 +08:00
esp_coex feat(external coex): add set tx line flag api 2023-07-12 19:24:29 +08:00
esp_common feat(psram): esp32p4 psram device driver support 2023-08-28 14:14:58 +08:00
esp_eth Merge branch 'feature/eth_iram_optimization' into 'master' 2023-09-07 00:35:56 +08:00
esp_event fix(esp_event): made #include <stdint.h> explicit 2023-08-09 16:17:06 +08:00
esp_gdbstub fix(gdb): removed wrongly added esp32p4 files 2023-08-31 03:52:47 +00:00
esp_hid fix(bqb): Changed HID related copyright automatically 2023-09-01 01:54:29 +00:00
esp_http_client fix(http_client): Set common tcp config to both TCP and SSL transport 2023-09-07 08:33:44 +02:00
esp_http_server feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
esp_https_ota fix(component-esp_https_ota): Fix wrong debug print for ota upgrade size 2023-08-18 11:35:54 +05:30
esp_https_server
esp_hw_support Merge branch 'feature/ble_lib_update_h2_c6' into 'master' 2023-09-07 10:25:08 +08:00
esp_lcd Merge branch 'feature/esplcd_replace_periph_func_with_atomic' into 'master' 2023-09-07 01:59:04 +08:00
esp_local_ctrl
esp_mm change(soc): added SOC_ prefix to mmu defs 2023-09-05 15:47:26 +08:00
esp_netif feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
esp_netif_stack
esp_partition Merge branch 'feature/storage_host_test_nvs_flash2' into 'master' 2023-08-28 20:20:16 +08:00
esp_phy bugfix(esp_phy): fix using wrong macro 2023-08-29 18:28:29 +08:00
esp_pm feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
esp_psram change(soc): added SOC_ prefix to mmu defs 2023-09-05 15:47:26 +08:00
esp_ringbuf ci(qemu): temporarily allow qemu tests to fail 2023-07-13 11:16:38 +08:00
esp_rom change(soc): added SOC_ prefix to mmu defs 2023-09-05 15:47:26 +08:00
esp_system Merge branch 'change/delete_not_used_mmu_macros' into 'master' 2023-09-06 11:59:03 +08:00
esp_timer feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
esp_wifi fix(wifi): Fix sta connecting with wpa security in enterprise mode 2023-09-06 06:00:48 +00:00
esp-tls feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
espcoredump refactor(freertos): Remove option for Task Snapshot 2023-08-28 20:11:27 +08:00
esptool_py kconfig: introduced CONFIG_IDF_ENV_BRINGUP for new chip bringup usage 2023-06-26 03:30:23 +00:00
fatfs Merge branch 'fix/fatfs_ff_volumes_warning' into 'master' 2023-08-28 18:20:38 +08:00
freertos Merge branch 'feature/freertos_add_sbom_file' into 'master' 2023-09-08 18:21:46 +08:00
hal Merge branch 'bugfix/flash_pe_usr_interval' into 'master' 2023-09-08 15:24:25 +08:00
heap feat(psram): esp32p4 psram device driver support 2023-08-28 14:14:58 +08:00
http_parser
idf_test feat(esp32p4): introduced new target esp32p4, supported hello_world 2023-08-09 19:33:25 +08:00
ieee802154 Merge branch 'bugfix/fix_ieee802154_test_issue' into 'master' 2023-08-29 15:11:05 +08:00
json feat: Update cJSON version to v1.7.16 2023-07-28 16:45:00 +05:30
linux lwip/linux: Add lwip support for networking component under linux 2023-05-05 05:03:39 +00:00
log log: Add master log option 2023-05-18 18:35:19 +08:00
lwip feat(wifi): optimize esp32c6 iperf performance 2023-09-04 14:34:54 +08:00
mbedtls feat(mbedtls): Integrate the ecdsa export public key feature in mbedtls 2023-09-06 11:07:40 +05:30
mqtt feat(mqtt): Updates submodule to 05b3476 2023-09-04 15:33:34 +02:00
newlib feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
nvs_flash feature(nvs_flash) : added support iteration over namespace by index - review changes 2023-08-29 16:05:02 +02:00
nvs_sec_provider fix(nvs_sec_provider): Fix memory leakage reported by coverity 2023-07-03 14:26:49 +05:30
openthread Merge branch 'feature/add_mesh_local_prefix_config' into 'master' 2023-09-05 12:16:19 +08:00
partition_table feat(example/storage/littlefs): add LittleFS demo example 2023-07-21 11:08:01 +02:00
perfmon
protobuf-c
protocomm feat(bt/bluedroid): Add new version of API for Bluedroid host stack initialization 2023-08-31 12:28:38 +00:00
pthread feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
riscv fix(interrupts): Cleanup pending tags in the code base regarding interrupt vectors 2023-09-01 17:18:39 +08:00
sdmmc feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
soc Merge branch 'esp32p4/add_ecdsa_support' into 'master' 2023-09-08 11:20:36 +08:00
spi_flash ci(spi_flash): Add flash test for 26MHZ XTAL on ESP32C2 2023-09-07 17:37:01 +08:00
spiffs Merge branch 'feature/storage_host_test_nvs_flash2' into 'master' 2023-08-28 20:20:16 +08:00
tcp_transport feat(ci): Enable p4 example, test_apps and unit tests CI build 2023-08-24 12:51:19 +08:00
touch_element touch_element: fix unintended integer division 2023-06-19 11:04:53 +08:00
ulp Merge branch 'bugfix/ulp_riscv_reg_ops_header_inclusion' into 'master' 2023-08-29 11:15:26 +08:00
unity
usb Merge branch 'bugfix/usb/host/urb_compliance_verification_add' into 'master' 2023-08-03 16:20:49 +08:00
vfs Merge branch 'bugfix/fix-compile-error-on-64bit-linux' into 'master' 2023-08-27 22:59:15 +08:00
wear_levelling fix(Storage/Wear Levelling): Fixed too few arguments in ESP_LOGV macro (WL_Flash::config) 2023-06-26 17:40:44 +02:00
wifi_provisioning fix (wifi_prov): Retry provisioning on WIFI_AUTH_EXPIRE event 2023-07-03 11:28:04 +05:30
wpa_supplicant Merge branch 'bugfix/reduce_bss_logging' into 'master' 2023-08-28 13:44:38 +08:00
xtensa Xtensa: fix a bug that altered CPU registers in FPU exception handlers 2023-07-04 02:45:56 +00: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.