esp-idf/components
morris 9080a7ac7c Merge branch 'bugfix/fix_legacy_adc_continuous_driver_dma_descriptor_not_internal_issue_v5.1' into 'release/v5.1'
adc: fixed legacy adc continuous driver dma descriptor not in internal ram issue (v5.1)

See merge request espressif/esp-idf!25508
2023-08-25 10:38:09 +08:00
..
app_trace heap: Add a configuration that places all the heap component and related functionalities in flash when enabled 2023-04-25 01:12:10 +00:00
app_update fix(app_update): Fix CI test_switch_ota by increasing deepsleep 2023-08-22 16:10:49 +08:00
bootloader esp_rom: add common ROM API to update CPU tick rate 2023-06-01 10:57:13 +08:00
bootloader_support fix(secure_ota): secure app verification issue without padding bytes 2023-08-14 03:29:44 +00:00
bt Merge branch 'bugfix/fix_current_issue_after_ble_init_5.1' into 'release/v5.1' 2023-08-25 10:25:11 +08:00
cmock
console console: Fix building issue when serial JTAG is set 2023-05-16 04:37:09 +00:00
cxx ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
driver Merge branch 'bugfix/fix_legacy_adc_continuous_driver_dma_descriptor_not_internal_issue_v5.1' into 'release/v5.1' 2023-08-25 10:38:09 +08:00
efuse adc_calib: support calibration v2 on esp32c6 2023-07-06 10:36:29 +08:00
esp_adc adc: added adc filter exhausted allocation test 2023-08-23 19:41:15 +08:00
esp_app_format
esp_coex feat(external coex): add set tx line flag api 2023-07-13 10:37:53 +08:00
esp_common versions: Update version to 5.1.1 2023-08-21 14:24:40 +05:50
esp_eth Merge branch 'contrib/github_pr_11337_v5.1' into 'release/v5.1' 2023-07-05 19:34:10 +08:00
esp_event Merge branch 'bugfix/fix-esp-even-compile-error-v5.1' into 'release/v5.1' 2023-07-11 17:08:38 +08:00
esp_gdbstub esp_gdbstub: refactor code 2023-04-28 12:38:26 +08:00
esp_hid esp_hid: fixed ble hid battery level setting 2023-06-16 11:01:40 +08:00
esp_http_client Merge branch 'contrib/github_pr_10715' into 'master' 2023-03-21 14:07:31 +08:00
esp_http_server esp_http_server: Update to support build for Linux 2023-03-31 16:42:05 +05:30
esp_https_ota esp_https_ota: Set user configurable ota authorization retries 2023-03-29 17:29:31 +05:30
esp_https_server
esp_hw_support Merge branch 'ci/fix_test_switch_ota_v5.1' into 'release/v5.1' 2023-08-24 12:16:51 +08:00
esp_lcd fix(i80_lcd): reset cs gpio on exit 2023-08-14 02:30:54 +00:00
esp_local_ctrl
esp_mm fix(cache): no longer use freeze in esp_cache_msync 2023-07-21 17:19:11 +08:00
esp_netif fix(wifi): Fix default wifi-netif creation to assert if no event loop 2023-08-14 09:16:29 +02:00
esp_netif_stack
esp_partition support SPI_FLASH_ENABLE_COUNTERS feature on esp_flash driver and rename the functions to esp_flash_xx 2023-04-06 11:40:40 +08:00
esp_phy fix(esp_hw_support): manage i2c_ana_mst clock witch modem clock driver 2023-08-04 12:04:40 +08:00
esp_pm refactor(esp_timer): Remove duplicate code and move it to a common file 2023-08-22 17:22:24 +08:00
esp_psram spiram: Support configure CLK onto the same pin as flash for ESP32-D0WD 2023-08-03 15:44:22 +08:00
esp_ringbuf ringbuf: Fix ordering of StaticRingbuffer_t 2023-07-04 21:30:43 +01:00
esp_rom Merge branch 'bugfix/v5.1_ble_issues_bugfix_c2' into 'release/v5.1' 2023-08-24 14:13:39 +08:00
esp_system remove(pm/deep_sleep): enable CI test for esp32h2 deepsleep 2023-08-03 16:46:55 +08:00
esp_timer refactor(esp_timer): Remove duplicate code and move it to a common file 2023-08-22 17:22:24 +08:00
esp_wifi Merge branch 'bugfix/netif_default_sta_init_v5.1' into 'release/v5.1' 2023-08-23 19:57:06 +08:00
esp-tls fix(esp-tls): fix pointer cast and condition for CONFIG_ATECC608A_TCUSTOM 2023-08-23 15:49:56 +05:30
espcoredump Optionally disable logs in espcoredump component 2023-06-29 11:50:48 +05:30
esptool_py system-hardware/efuse: fixed efuse summary description containing ; breaking efuse-summary 2023-05-30 14:07:50 +08:00
fatfs Merge branch 'contrib/github_pr_10532_v5.1' into 'release/v5.1' 2023-05-20 07:35:38 +08:00
freertos freertos: add a unit test for FPU context switch 2023-07-11 15:55:40 +08:00
hal Merge branch 'feature/usb_host_restrict_ahb_errata_workaround_to_esp32s2_eco0_v5.1' into 'release/v5.1' 2023-08-24 10:12:48 +08:00
heap heap: remove exclusion of esp32h2 as a target for no/light/comprehensive_poisoning tests 2023-07-04 11:08:59 +08:00
http_parser
idf_test adc_cali: supported channel compensation of adc calibration on esp32c6 2023-07-05 12:48:11 +08:00
ieee802154 fix(ieee802154): fix ieee802154 sleep state 2023-07-21 11:03:23 +00: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 cxx: gnu++23 -> gnu++2b for clang compatibility, added docs and test 2023-05-11 17:48:38 +08:00
lwip fix: Added check to ensure safe restart of dhcp fine timer 2023-08-24 00:51:36 +10:00
mbedtls Merge branch 'feature/update_mbedtls_v5.1' into 'release/v5.1' 2023-08-23 18:17:20 +08:00
mqtt ci: Migrateunit test for mqtt test to unit test app 2023-03-24 10:32:43 +01:00
newlib ci: misc fixes for newlib test app 2023-05-11 09:27:09 +08:00
nvs_flash ci(nvs_flash): Increase timeout of nvs_page_test 2023-02-13 12:35:52 +08:00
openthread feat(thread): update openthread lib 2023-08-01 14:59:07 +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 wifi_prov: Exposed events for secure session establishment 2023-08-22 15:21:48 +05:30
pthread pthread: Implemented POSIX unnamed semaphore 2023-03-21 10:23:58 +08:00
riscv bugfix: fix pmp retention and add pma retention 2023-05-19 13:51:20 +08:00
sdmmc sdmmc: incrementally increase delay of vTaskDelay 2023-05-19 14:01:43 +02:00
soc Merge branch 'feature/periodic_adv_enhancement_v5.1' into 'release/v5.1' 2023-08-24 17:14:43 +08:00
spi_flash cache: refactor cache_utils into cache_hal instade 2023-07-31 14:52:03 +08:00
spiffs build-system: replace ADDITIONAL_MAKE_CLEAN_FILES with ADDITIONAL_CLEAN_FILES 2023-05-10 09:53:55 +08:00
tcp_transport ci: Migrate unit test for tcp_transport to unit test app 2023-06-14 16:01:00 +02:00
touch_element Merge branch 'bugfix/vfs_uart_outof_bounds_read_v5.1' into 'release/v5.1' 2023-07-03 16:13:06 +08:00
ulp refactor(adc): maintain s_adc_tsen_enabled in adc driver 2023-07-12 16:35:51 +08:00
unity
usb usb_host: Fix coverity issues with hcd_install() 2023-08-24 12:01:50 +08:00
vfs Merge branch 'contrib/github_pr_10987_v5.1' into 'release/v5.1' 2023-07-05 19:32:32 +08:00
wear_levelling freertos(IDF): Remove usage of xPortGetFreeHeapSize() outside FreeRTOS 2023-03-07 02:02:28 +08:00
wifi_provisioning wifi_prov: Fix build issue when building only for sec1 or sec2 2023-08-22 15:21:48 +05:30
wpa_supplicant Merge branch 'fix/wifi_wps_pbc_overlap_v5.1' into 'release/v5.1' 2023-08-23 19:54:50 +08:00
xtensa Fix possible conversion errors by using __builtin_ffsll instead of __builtin_ffs 2023-05-11 11:16:45 +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.