esp-idf/components
Jiang Jiang Jian 9c4b89c6d2 Merge branch 'bugfix/fix_no_sleep_null_data_after_data_sent_v5.1' into 'release/v5.1'
fix(pm): fix no sleep null after data sent (e7243f1f)

See merge request espressif/esp-idf!28290
2024-01-10 11:20:56 +08:00
..
app_trace fix(app_trace): fix host file write API return value 2023-10-11 15:23:56 +04:00
app_update fix(app_update): avoid erasing an extra sector than the actual required size 2023-12-07 10:08:08 +00:00
bootloader Merge branch 'bugfix/fix_condition_to_verify_when_no_SB_v5.1' into 'release/v5.1' 2023-09-27 17:20:50 +08:00
bootloader_support bugfix(spi_flash): Fix build error when octal flash is enabled, 2023-12-22 14:11:28 +08:00
bt fix(bt/bludroid): Increase BTU task stack size 2024-01-08 11:36:07 +08:00
cmock
console console: minor fixes 2023-11-21 17:33:29 +01:00
cxx ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
driver change(uart): improved the internal logic of uart_read_bytes 2024-01-02 20:21:39 +08:00
efuse docs: add ECDSA peripheral chapter for H2/P4 2023-11-20 16:13:35 +05:30
esp_adc Merge branch 'bugfix/fix_adc_continuous_do_not_rst_apb_clk_v5.1' into 'release/v5.1' 2023-12-07 21:27:05 +08:00
esp_app_format
esp_coex fix(coex): 802.15.4 coex break notification 2023-12-21 15:17:58 +08:00
esp_common fix(wpa_supplicant): Add support for a dpp authentication timeout 2024-01-03 13:46:41 +05:30
esp_eth feat(esp_eth): abstraction of SPI driver for SPI Ethernet modules 2023-12-13 10:44:23 +01:00
esp_event ci: fix missing linux related .build-test-rules.yml 2023-11-30 09:07:36 +01:00
esp_gdbstub esp_gdbstub: refactor code 2023-04-28 12:38:26 +08:00
esp_hid feat(nimble): added HID over Gatt profile support 2023-12-22 11:23:05 +05:30
esp_http_client fix(esp_http_client): Fix esp_http_client async mode 2023-12-07 06:47:37 +00:00
esp_http_server feat: ECDSA peripheral while performing http connection with mutual auth 2023-11-17 16:24:10 +05:30
esp_https_ota Merge branch 'bugfix/preencrypted_ota_failed_with_partial_download_v5.1' into 'release/v5.1' 2023-11-29 14:05:39 +08:00
esp_https_server feat: ECDSA peripheral while performing http connection with mutual auth 2023-11-17 16:24:10 +05:30
esp_hw_support feat(soc): Increase max supported version of C3 to 1.99 2024-01-03 18:02:49 +08:00
esp_lcd feat(spi_lcd): control DC level for cmd, param, color phase separately 2024-01-03 17:25:01 +08: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 Merge branch 'fix/esp_netif_lock_v5.1' into 'release/v5.1' 2023-12-08 11:18:09 +08:00
esp_netif_stack
esp_partition refactor(esp_partition): Expose function for unloading partitions 2023-11-27 19:50:16 +01:00
esp_phy fix(ieee802154): fix the issue of not receiving packets when RSSI is positive in esp32h2 2024-01-04 15:09:42 +08:00
esp_pm fix(esp_pm): fix psram access faild after pd_cpu wakeup 2023-11-16 03:20:27 +00:00
esp_psram fix(wifi): fix psram enabled but initialized fail issue 2023-12-19 19:15:49 +08:00
esp_ringbuf ringbuf: Fix ordering of StaticRingbuffer_t 2023-07-04 21:30:43 +01:00
esp_rom Merge branch 'feat/support_esp32c3_v1.1_wifi_v5.1' into 'release/v5.1' 2023-12-28 16:56:49 +08:00
esp_system change(wifi): update esp_coexist_internal.h and esp_modem_wrapper.h 2023-12-19 19:15:49 +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 fix(pm): fix no sleep null after data sent (e7243f1f) 2024-01-05 10:38:11 +08:00
esp-tls Merge branch 'fix/wrong_order_of_includes_in_esp_tls_v5.1' into 'release/v5.1' 2023-12-12 13:44:36 +08:00
espcoredump feat(coredump): save isr context to coredump elf file 2023-11-28 18:19:19 +01:00
esptool_py fix(build): fix build failure if CMAKE_EXECUTABLE_SUFFIX is set 2023-11-20 10:49:02 +01:00
fatfs Merge branch 'feature/add_fatfs_sbom_v5.1' into 'release/v5.1' 2023-12-19 16:47:52 +08:00
freertos Merge branch 'bugfix/fix_freertos_system_task_names_v5.1' into 'release/v5.1' 2023-11-14 16:35:25 +08:00
hal fix(ieee802154): fix the issue of not receiving packets when RSSI is positive in esp32h2 2024-01-04 15:09:42 +08:00
heap fix(heap): Patch tlsf_check_pool in ROM heap 2023-12-08 03:19:04 +00:00
http_parser
idf_test Merge branch 'feature/support_adc_calibration_on_h2_v5.1' into 'release/v5.1' 2023-11-17 16:41:00 +08:00
ieee802154 fix(ieee802154): fix the issue of not receiving packets when RSSI is positive in esp32h2 2024-01-04 15:09:42 +08:00
json feat: Update cJSON version to v1.7.16 2023-08-24 04:14:08 +00:00
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 optimize(lwip):when psram is enable the number of ooseq is not limited 2023-12-15 14:11:38 +08:00
mbedtls mbedtls: define MBEDTLS_SSL_CID_TLS1_3_PAD_GRANULARITY for CID padding 2024-01-02 11:22:10 +05:30
mqtt change(mqtt): Update submodule to e6afdb 2023-10-02 06:23:35 +00:00
newlib fix(newlib,ci): wrong floating point number handling in tests 2023-11-13 13:51:53 +08:00
nvs_flash ci: fix missing linux related .build-test-rules.yml 2023-11-30 09:07:36 +01:00
openthread fix(openthread): update lib to set raw pcb ttl value 2024-01-02 16:56:52 +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 fix(esp_srp): Use @file for file documentation and missing doc 2023-12-19 19:15:49 +08:00
pthread fix(pthread): fixed pthread_condvar linker hook 2023-09-18 12:31:25 +08:00
riscv fix(riscv): supports 1 byte and larger than 64byte range watchpoint setting 2023-11-16 20:40:04 +08:00
sdmmc sdmmc: incrementally increase delay of vTaskDelay 2023-05-19 14:01:43 +02:00
soc fix(nimble): Added periodic_adv_enh soc_caps for c2, h2 2023-12-27 15:03:17 +05:30
spi_flash fix(ota): Fixed OTA fail on octal flash with 32MB memory, 2023-11-06 10:49:06 +08:00
spiffs fix(spiffs): SPIFFS print formatter errors out 2023-08-17 11:46:25 +02:00
tcp_transport feat: ECDSA peripheral while performing http connection with mutual auth 2023-11-17 16:24:10 +05:30
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 feat(ulp): add api to get lp_cpu wakeup cause and clear wakeup source at startup 2023-12-28 13:31:55 +08:00
unity
usb fix(usb/host): remove bInterval verification during pipe opening for INTR and ISOC EPs 2023-11-28 22:00:54 +01:00
vfs fix(vfs): fix uart malloc when locates ISR context in IRAM 2023-12-07 10:43:58 +08:00
wear_levelling freertos(IDF): Remove usage of xPortGetFreeHeapSize() outside FreeRTOS 2023-03-07 02:02:28 +08:00
wifi_provisioning fix (wifi_prov): Retry provisioning on WIFI_AUTH_EXPIRE event 2023-11-03 11:50:13 +05:30
wpa_supplicant fix(wpa_supplicant): Move concurrent wps and dpp check to before creating task 2024-01-03 13:46:41 +05:30
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.