esp-idf/components
Jiang Jiang Jian 146a5c4de4 Merge branch 'feature/sae_softAP' into 'master'
esp_wifi: WPA3-SAE support for softAP

Closes IDFGH-4771

See merge request espressif/esp-idf!15690
2023-02-28 12:25:05 +08:00
..
app_trace gcov: use original libgcov.a with redefined symbols 2023-02-22 05:33:03 +00:00
app_update Merge branch 'esp32c6/ecdsa_secure_boot_support' into 'master' 2023-02-15 16:03:35 +08:00
bootloader efuse: Add support for esp32h2 2023-02-21 08:18:14 +00:00
bootloader_support Merge branch 'feature/adds_more_efuse_logs' into 'master' 2023-02-22 19:25:58 +08:00
bt bt: add coexistence internal API declarations and clean up some unused coexistence hooks 2023-02-26 06:58:18 +00:00
cmock
console ci: update idf-core related tests for C6 2023-02-13 13:01:57 +08:00
cxx TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
driver usb_serial_jtag: Improve the code for the issue of usb cdc device unable to work during sleep 2023-02-27 12:10:49 +08:00
efuse Merge branch 'feature/adds_more_efuse_logs' into 'master' 2023-02-22 19:25:58 +08:00
esp-tls esp-tls: Fix build issue when esp-tls server session tickets have been enabled. 2023-02-24 04:45:23 +00:00
esp_adc adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp_app_format
esp_coex feature: separate coex lib from wifi lib, support esp32c6 internal coex 2023-02-26 06:58:18 +00:00
esp_common regdma: add regdma link operation api support 2023-02-15 11:46:36 +08:00
esp_eth TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
esp_event esp_event: fix gcc-12 compile errors 2023-02-22 05:33:03 +00:00
esp_gdbstub wdt: refactor wdt codes to use unified type 2023-02-15 12:08:55 +08:00
esp_hid esp_hid: fix gcc-12 compile errors 2023-02-22 05:33:03 +00:00
esp_http_client http_client: fixed looping caused when disable_auto_redirect enabled 2023-02-23 14:11:58 +05:30
esp_http_server TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
esp_https_ota
esp_https_server
esp_hw_support Merge branch 'bugfix/revert_rtc_clock_bbpll_power_on_with_usb' into 'master' 2023-02-27 23:18:54 +08:00
esp_lcd rmt: fix rmt buffer allocation issue 2023-02-14 14:05:12 +08:00
esp_local_ctrl
esp_mm esp_mm: shared and non-shared mapping 2023-02-17 13:04:55 +08:00
esp_netif esp_netif: fix test_app_vfs_l2tap stack overflow 2023-02-22 05:33:03 +00:00
esp_netif_stack
esp_partition flash_mmap: migrate to use esp_mmap driver 2023-02-07 20:23:52 +08:00
esp_phy feature: separate coex lib from wifi lib, support esp32c6 internal coex 2023-02-26 06:58:18 +00:00
esp_pm refactor: power management component use unified esp_pm_config_t 2023-02-23 11:36:07 +08:00
esp_psram TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
esp_ringbuf ci: update idf-core related tests for C6 2023-02-13 13:01:57 +08:00
esp_rom esp_wifi: support adapter of all chips for new coex lib 2023-02-26 06:58:18 +00:00
esp_system Merge branch 'bugfix/revert_rtc_clock_bbpll_power_on_with_usb' into 'master' 2023-02-27 23:18:54 +08:00
esp_timer esp32h2(ci): enable target test 2023-02-15 10:20:43 +08:00
esp_wifi esp_wifi: WPA3-SAE support for softAP 2023-02-28 12:25:05 +08:00
espcoredump
esptool_py feat(idf_monitor): move idf_monitor to separate repo 2023-02-03 11:20:15 +01:00
fatfs fatfs: deprecate esp_vfs_fat_sdmmc_unmount 2023-02-16 14:17:51 +08:00
freertos freertos: Fix stream buffer send-receive test 2023-02-23 12:52:28 +08:00
hal Merge branch 'bugfix/revert_rtc_clock_bbpll_power_on_with_usb' into 'master' 2023-02-27 23:18:54 +08:00
heap heap: fix gcc-12 compile errors 2023-02-22 05:33:03 +00:00
http_parser
idf_test esp_adc: support h2 oneshot mode and continuous mode 2023-02-23 11:48:31 +08:00
ieee802154 ieee802154: update i154 lib to fix the bug of esp32c6 2023-01-30 15:30:59 +08:00
json
linux
log Merge branch 'bugfix/linux_target_gen_partition_table' into 'master' 2023-01-18 11:57:08 +08:00
lwip lwip:optimization dhcp coarse timer 2023-02-08 16:29:28 +08:00
mbedtls mbedtls: Add test config with `CONFIG_COMPILER_OPTIMIZATION_PERF` 2023-02-21 18:45:25 +05:30
mqtt
newlib newlib: implement 8/16-bit atomic operations for riscv 2023-02-22 05:33:03 +00:00
nvs_flash ci(nvs_flash): Increase timeout of nvs_page_test 2023-02-13 12:35:52 +08:00
openthread feature: add ram loadable app support 2023-02-01 17:57:22 +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 protocomm: fix gcc-12 compile errors 2023-02-22 05:33:03 +00:00
pthread TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
riscv cpu retention: software cpu retention support for esp32c6 2023-01-31 22:12:54 +08:00
sdmmc
soc Merge branch 'bugfix/revert_rtc_clock_bbpll_power_on_with_usb' into 'master' 2023-02-27 23:18:54 +08:00
spi_flash cache: support h2 and c6 cache error 2023-02-24 16:16:46 +08:00
spiffs Merge branch 'bugfix/linux_build_errors' into 'master' 2023-01-20 14:46:36 +08:00
tcp_transport [ws_transport] - Added `esp_transport_ws_get_upgrade_request_status` API 2023-02-16 12:19:40 +00:00
touch_element TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
ulp ulp: Added APIs to handle ULP signal ISRs for the main CPU 2023-02-24 07:25:39 +00:00
unity
usb usb_host: Fix interface descriptor parsing 2023-02-10 15:49:11 +01:00
vfs Merge branch 'bugfix/usb_serial_driver_block' into 'master' 2023-02-24 10:22:08 +08:00
wear_levelling
wifi_provisioning Clean up wifi provisioning in the esp_event thread 2023-01-27 15:39:08 +05:30
wpa_supplicant esp_wifi: WPA3-SAE support for softAP 2023-02-28 12:25:05 +08:00
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 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.