esp-idf/components
Jiang Jiang Jian 51f6091761 Merge branch 'bugfix/fix_wifi_pm_state' into 'master'
esp_wifi: fix no null data after WiFi waking up.

Closes IDFGH-7070

See merge request espressif/esp-idf!18141
2022-05-18 17:42:31 +08:00
..
app_trace uart: add default source clock for all targets 2022-05-09 11:26:30 +08:00
app_update docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
asio mbedtls: Remove certs.c and certs.h from port directory 2022-03-15 17:16:07 +05:30
bootloader esp32c2: Support Secure Boot V2 based on ECDSA scheme 2022-05-11 18:00:03 +05:30
bootloader_support esp32c2: Remove assert check on len for SHA calculation 2022-05-11 18:00:07 +05:30
bt components/bt: disable Bluetooth PLL track function for ESP32-C3/ESP32-S3 as it introduced coexistence issues 2022-05-17 20:00:23 +08:00
cmock Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
console console: allow use apb clock for uart to achieve high baud rate 2022-05-09 11:26:30 +08:00
cxx feature (unity): added memory leak check API, integrated it into cxx tests 2022-05-09 11:09:20 +08:00
driver docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
efuse esp32c2: Support Secure Boot V2 based on ECDSA scheme 2022-05-11 18:00:03 +05:30
esp32 Merge branch 'toos/add_s3_ut_based_on_quad_octal_psram' into 'master' 2022-05-16 09:57:21 +08:00
esp32c2 soc: moved kconfig options out of the target component. 2022-04-21 12:09:43 +08:00
esp32c3 soc: moved kconfig options out of the target component. 2022-04-21 12:09:43 +08:00
esp32h2 soc: moved kconfig options out of the target component. 2022-04-21 12:09:43 +08:00
esp32s2 Merge branch 'toos/add_s3_ut_based_on_quad_octal_psram' into 'master' 2022-05-16 09:57:21 +08:00
esp32s3 Kconfig: remove misleading psram name IS25WP032 in the Kconfig option 2022-05-06 22:56:53 +08:00
esp_adc_cal adc: create common adc hal layer 2022-05-07 19:20:44 +08:00
esp_common esp_common: rename EXT_RAM_ATTR to EXT_RAM_BSS_ATTR to make it clearer 2022-04-19 19:48:00 +08:00
esp_eth docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
esp_event gptimer: added enable/disable functions 2022-05-06 18:18:39 +08:00
esp_gdbstub Merge branch 'feature/gdbstub_rt_multicore' into 'master' 2022-03-17 19:59:29 +08:00
esp_hid freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
esp_http_client build system: remove lwip from common requirements 2022-05-02 20:47:17 +02:00
esp_http_server esp_http_server: Remove http_server.h Header file 2022-05-13 16:00:17 +05:30
esp_https_ota Check FW version at start of ota for encrypted binary 2022-03-23 11:09:48 +05:30
esp_https_server docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
esp_hw_support Merge branch 'bugfix/fix_memory_miss_bug_esp32c3_esp32s3' into 'master' 2022-05-18 12:05:08 +08:00
esp_lcd docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
esp_local_ctrl Updated coding style and added error logs 2022-05-11 08:58:01 +00:00
esp_netif docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
esp_phy esp_phy: support esp32h2beta2 phy build 2022-05-16 10:50:44 +00:00
esp_pm esp_system: Add arbitrary user feature to TWDT 2022-05-13 18:01:28 +08:00
esp_ringbuf gptimer: added enable/disable functions 2022-05-06 18:18:39 +08:00
esp_rom esp_wifi: fix no null data after WiFi waking up. 2022-05-17 21:45:55 +08:00
esp_serial_slave_link spi: support spi on h2 2022-03-29 11:54:08 +08:00
esp_system Merge branch 'feature/task_watchdog_freeertos_smp' into 'master' 2022-05-17 15:13:43 +08:00
esp_timer global: add dependency on esp_timer component and include esp_timer.h 2022-04-25 18:39:23 +02:00
esp_wifi esp_wifi: fix no null data after WiFi waking up. 2022-05-17 21:45:55 +08:00
esp-tls esp_tls.h: Clean up included header files. 2022-05-11 07:09:34 +00:00
espcoredump tools: add GDB v11.1 as a tool 2022-04-25 11:21:48 +07:00
esptool_py esp32c2: Support Secure Boot V2 based on ECDSA scheme 2022-05-11 18:00:03 +05:30
fatfs Added FATFS partition parser 2022-05-16 14:32:17 +02:00
freertos esp_system: Add arbitrary user feature to TWDT 2022-05-13 18:01:28 +08:00
hal Merge branch 'bugfix/fix_cannot_lslp_again_after_ulp_wakeup' into 'master' 2022-05-13 22:25:23 +08:00
heap heap: use ROM implementation for heap tlsf on esp32c2 2022-05-12 05:18:57 +00:00
http_parser docs/en: Add entry for http_parser in copyrights page 2022-01-11 10:26:25 +05:30
idf_test test_rsa.c: remove 'use_blinding' variable. 2022-04-20 01:07:01 +00:00
ieee802154 openthread: support build esp32h2beta1 & esp32h2beta2 on master 2022-05-11 16:32:19 +08:00
json Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
linux linux: add dummy sys/lock.h implementation (single threaded only) 2022-01-24 18:51:40 +01:00
log log: support ESP_LOG_BUFFER* functions for Linux target 2022-04-11 13:29:01 +02:00
lwip lwip: Update AFL host test mock 2022-04-29 15:11:44 +08:00
mbedtls esp_system: Update task watchdog unit tests and example 2022-05-13 18:01:28 +08:00
mdns soc: moved kconfig options out of the target component. 2022-04-21 12:09:43 +08:00
mqtt mqtt: Fix incorrect reads on error; Update ping processing 2022-05-16 20:23:26 +02:00
newlib newlib: implement __atomic_load/__atomic_store functions 2022-05-11 17:00:14 +03:00
nvs_flash Merge branch 'bugfix/nvs_coverity_issues' into 'master' 2022-01-29 21:52:18 +00:00
openthread openthread: support build esp32h2beta1 & esp32h2beta2 on master 2022-05-11 16:32:19 +08:00
partition_table Merge branch 'esp32c2/support_secure_boot' into 'master' 2022-05-13 19:46:22 +08:00
perfmon perfmon: add SDPX headers 2022-02-07 08:02:13 +00:00
protobuf-c Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
protocomm docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
pthread global: add dependency on esp_timer component and include esp_timer.h 2022-04-25 18:39:23 +02:00
riscv semihosting: version 2 2022-05-05 09:12:42 +00:00
sdmmc Add high speed mode switch validation check for MMC. 2022-04-28 15:23:21 +02:00
soc Merge branch 'bugfix/fix_memory_miss_bug_esp32c3_esp32s3' into 'master' 2022-05-18 12:05:08 +08:00
spi_flash Kconfig: add depends 2022-05-06 15:26:43 +08:00
spiffs spiffs: add esp_spiffs_gc function to force garbage collection 2022-04-11 11:19:10 +02:00
tcp_transport esp_tls.h: Clean up included header files. 2022-05-11 07:09:34 +00:00
tinyusb tinyusb: Allow dynamic configuration descriptor 2022-03-21 18:34:25 +01:00
touch_element docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
ulp Merge branch 'bugfix/fix_cannot_lslp_again_after_ulp_wakeup' into 'master' 2022-05-13 22:25:23 +08:00
unity feature (unity): added memory leak check API, integrated it into cxx tests 2022-05-09 11:09:20 +08:00
usb docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
vfs Merge branch 'bugfix/vfs_sock_select_race' into 'master' 2022-05-17 15:28:48 +08:00
wear_levelling esp_hw_support/esp_system: Re-evaluate header inclusions and include directories 2022-03-07 11:18:08 +05:30
wifi_provisioning feat(wifi_provisioning): Optimize memory for wifi scan ap number 2022-05-13 13:58:34 +08:00
wpa_supplicant esp_wifi: Add APIs to check BTM and RRM support of connected AP 2022-05-16 15:57:59 +05:30
xtensa semihosting: drop absolute path support 2022-05-05 09:12:42 +00:00
README.md esp_hw_support/esp_system: Re-evaluate header inclusions and include directories 2022-03-07 11:18:08 +05:30

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
  • riscv_global_interrupts_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.