esp-idf/components
Jiang Jiang Jian be06a6f5ff Merge branch 'bugfix/fix_softap_coex_start_issue' into 'master'
fix(wifi): fix softap coex start issue, no wifi request if wifi is not used at idle

See merge request espressif/esp-idf!29772
2024-03-21 21:22:54 +08:00
..
app_trace feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
app_update ci(test_apps): limit dependencies for misc test_apps 2024-02-18 16:01:58 +08:00
bootloader feat(esp32c5mp): add temporary esp-rom 2024-03-14 15:09:22 +08:00
bootloader_support Merge branch 'refactor/usb_fsls_phy_hal' into 'master' 2024-03-20 06:07:29 +08:00
bt fix(nimble): Added support for deleting the oldest bonded device across reboot 2024-03-19 22:26:22 +05:30
cmock
console Merge branch 'fix/add_libbsd_string_h' into 'master' 2024-03-21 10:11:25 +08:00
cxx feat(cxx): get rid of _Unwind_SetEnableExceptionFdeSorting 2024-03-15 12:36:00 +04:00
driver feat(spi_master): rebase dma sct mode support, rename APIs, use malloc conf_buffer 2024-03-20 16:06:43 +08:00
efuse feat(esp32c61): new chip add rom and efuse support 2024-03-15 15:16:14 +08:00
esp-tls Merge branch 'fix/add_libbsd_string_h' into 'master' 2024-03-21 10:11:25 +08:00
esp_adc ci(adc): ignore adc restart test fail 2024-03-14 11:14:46 +08:00
esp_app_format feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
esp_bootloader_format feat(esp_system): allow .bss to spill over into L2MEM above 0x4ff40000 2024-02-28 19:41:25 +04:00
esp_coex feat(coex): support to scan long time on channel, fix coexist sync issue 2024-03-13 10:54:41 +08:00
esp_common Merge branch 'fix/add_libbsd_string_h' into 'master' 2024-03-21 10:11:25 +08:00
esp_driver_ana_cmpr feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
esp_driver_cam bugfix(csi): fix wrong cache invalidate location 2024-03-18 14:54:25 +08:00
esp_driver_dac
esp_driver_gpio Merge branch 'feature/optimize_chips_active_power' into 'master' 2024-03-14 12:08:33 +08:00
esp_driver_gptimer feat(gptimer): basic driver support on esp32c5 2024-02-19 10:27:18 +08:00
esp_driver_i2c fix(i2c_master): Fix issue that i2c clock got wrong after reset, 2024-03-21 13:13:53 +08:00
esp_driver_i2s feat(i2s): support more mclk_multiples 2024-03-06 10:22:27 +08:00
esp_driver_jpeg fix(jpeg_decoder): Improve apis for better align strategy and provide buffer size parameter 2024-03-18 18:32:22 +08:00
esp_driver_ledc ci: enable lightsleep related tests 2024-03-10 10:51:28 +08:00
esp_driver_mcpwm feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
esp_driver_parlio change(parlio_tx): plenty of driver clean up 2024-03-15 18:02:44 +08:00
esp_driver_pcnt
esp_driver_rmt docs(rmt): clarification on memory and isr lantency 2024-03-14 14:23:12 +08:00
esp_driver_sdio feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
esp_driver_sdm
esp_driver_sdmmc
esp_driver_sdspi
esp_driver_spi feat(spi_master): rebase dma sct mode support, rename APIs, use malloc conf_buffer 2024-03-20 16:06:43 +08:00
esp_driver_tsens Update temp_sensor.rst documentation to match example (GitHub PR) 2024-03-06 10:11:40 +08:00
esp_driver_uart fix(uart): Fix mismatch wakeup rising edges required with the threshold configured 2024-03-15 16:58:33 +08:00
esp_driver_usb_serial_jtag refactor(hal/usb): Remove usb_fsls_phy_ll.h 2024-03-18 19:23:43 +08:00
esp_eth Merge branch 'feature/emac_intr_prio' into 'master' 2024-03-19 21:09:30 +08:00
esp_event docs(esp_event): Fixed mistake in API docs 2024-03-11 11:06:18 +08:00
esp_gdbstub feat(gdbstub): fix access to PSRAM for esp32p4 2024-03-12 18:10:32 +04:00
esp_hid refactor(esp_hid): Create one common event loop 2024-03-14 11:34:13 +01:00
esp_http_client ci(test_apps): limit dependencies for misc test_apps 2024-02-18 16:01:58 +08:00
esp_http_server refactor(linux): Unified libbsd handling 2024-03-08 12:26:54 +08:00
esp_https_ota fix(esp_https_ota): fix incorrectly reference of API esp_https_ota_get_img_desc() 2024-02-05 13:55:42 +05:30
esp_https_server fix(mbedtls/aes-gcm): Fix null pointer derefernce coverity reports 2024-03-12 12:36:00 +05:30
esp_hw_support Merge branch 'refactor/usb_fsls_phy_hal' into 'master' 2024-03-20 06:07:29 +08:00
esp_lcd fix(esp_lcd): Flush rgb lcd PSRAM framebuffers after allocation 2024-03-01 18:05:22 +08:00
esp_local_ctrl refactor(protocomm): Make the protocomm `proto-c` headers public 2024-02-28 14:35:04 +05:30
esp_mm feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
esp_netif feat(esp_eth): added option to configure interrupt priority 2024-03-07 10:30:32 +01:00
esp_netif_stack
esp_partition refactor(linux): Unified libbsd handling 2024-03-08 12:26:54 +08:00
esp_phy Merge branch 'fix/bbpll_usb_link_error' into 'master' 2024-03-07 19:43:01 +08:00
esp_pm feat(esp_hw_support): support esp32p4 sleep cpu retention 2024-03-15 18:13:25 +08:00
esp_psram Merge branch 'refactor/decouple-psram-init-from-essp-system' into 'master' 2024-03-12 21:01:59 +08:00
esp_ringbuf change(esp_ringbuf): Format pytest_esp_ringbuf.py 2024-03-15 11:22:00 +01:00
esp_rom feat(esp32c61): new chip add system and esp_timer support 2024-03-21 11:31:15 +08:00
esp_system Merge branch 'feature/esp32p4-coredump-support' into 'master' 2024-03-21 21:12:25 +08:00
esp_timer feat(esp32c61): new chip add system and esp_timer support 2024-03-21 11:31:15 +08:00
esp_vfs_console fix(esp_vfs_console): add esp_vfs_console component 2024-03-11 10:18:10 +01:00
esp_wifi Merge branch 'bugfix/fix_softap_coex_start_issue' into 'master' 2024-03-21 21:22:54 +08:00
espcoredump feat(all): Use PRIx macro in all logs 2024-03-12 11:15:53 +02:00
esptool_py feat(esp32c5): add esp32c5 mp target 2024-03-01 10:13:45 +08:00
fatfs Merge branch 'fix/wl_fatfsgen_safe_mode' into 'master' 2024-03-19 16:19:24 +08:00
freertos feat(esp32c61): new chip add system and esp_timer support 2024-03-21 11:31:15 +08:00
hal Merge branch 'feature/esp32p4-coredump-support' into 'master' 2024-03-21 21:12:25 +08:00
heap feat(esp_system): allow .data to spill over into L2MEM above 0x4ff40000 2024-03-21 15:36:39 +04:00
http_parser
idf_test fix(spi): test_apps mv idf_perform_test to esp_driver_spi domain 2024-03-07 18:16:27 +08:00
ieee802154 Merge branch 'bugfix/fix_tx_pending_issue' into 'master' 2024-02-05 10:16:51 +08:00
json
linux refactor(linux): Unified libbsd handling 2024-03-08 12:26:54 +08:00
log feat(log): Added PRIuSIZE printf formatter macro 2024-03-20 16:41:22 +08:00
lwip refactor(linux): Unified libbsd handling 2024-03-08 12:26:54 +08:00
mbedtls Merge branch 'esp32p4/add_aes_support' into 'master' 2024-03-15 11:43:22 +08:00
mqtt ci: update protocol/ethernet pytest markers 2024-02-01 22:47:18 +08:00
newlib feat(newlib): get rid of dirent.h in favor of toolchain 2024-03-15 12:36:00 +04:00
nvs_flash Merge branch 'fix/add_libbsd_string_h' into 'master' 2024-03-21 10:11:25 +08:00
nvs_sec_provider
openthread fix(openthread): using atomic variable for buffer count 2024-03-04 15:06:46 +08:00
partition_table fix: Fixed KConfig files that were not succesfully checked 2024-02-02 14:13:45 +01:00
perfmon
protobuf-c
protocomm refactor(protocomm): Make the protocomm `proto-c` headers public 2024-02-28 14:35:04 +05:30
pthread refactor(core): reformat newlib and pthread with astyle 2024-02-27 10:00:06 +08:00
riscv feat(system): esp32p4: support hw stack guard 2024-03-21 14:30:21 +04:00
sdmmc fix(sdmmc): extend the maximum number of retries of ACMD41 2024-02-28 09:33:24 +01:00
soc Merge branch 'feature/esp32p4-coredump-support' into 'master' 2024-03-21 21:12:25 +08:00
spi_flash Merge branch 'bugfix/flash_mxic_chip' into 'master' 2024-03-12 18:35:38 +08:00
spiffs Merge branch 'contrib/github_pr_12800' into 'master' 2024-02-20 15:21:47 +08:00
tcp_transport fix(mbedtls/aes-gcm): Fix null pointer derefernce coverity reports 2024-03-12 12:36:00 +05:30
touch_element ci(test_apps): limit dependencies for misc test_apps 2024-02-18 16:01:58 +08:00
ulp feat(ulp-riscv): Add convenience print function that supports different widths 2024-03-19 09:41:05 +01:00
unity refactor(tools): Tidy up core component files copyright ignore 2024-01-22 18:07:35 +08:00
usb refactor(hal/usb): Refactor usb_wrap_ll.h 2024-03-18 19:23:44 +08:00
vfs Merge branch 'feature/update-toolchain-to-esp-13.2.0_20240305' into 'master' 2024-03-18 16:58:39 +08:00
wear_levelling Merge branch 'contrib/github_pr_12800' into 'master' 2024-02-20 15:21:47 +08:00
wifi_provisioning refactor(protocomm): Make the protocomm `proto-c` headers public 2024-02-28 14:35:04 +05:30
wpa_supplicant fix(wpa_supplicant): Add bugfixes related to ciphersuites in wifi enterprise 2024-03-20 09:33:52 +05:30
xtensa
README.md

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) 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.