esp-idf/components
Martin Vychodil cd7355007d Merge branch 'bugfix/app_trace_iram' into 'master'
apptrace: move all apptrace related functions to IRAM

Closes IDFGH-7571 and IDFGH-7664

See merge request espressif/esp-idf!18646
2022-06-27 17:46:30 +08:00
..
app_trace apptrace: move all apptrace related functions to IRAM 2022-06-23 16:54:24 +08:00
app_update ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
asio asio: disable concepts support 2022-06-17 16:44:17 +02:00
bootloader bootloader, esp_system: increase static allocation space for esp32s3 2022-06-15 17:57:11 +05:30
bootloader_support G0: Support Xtensa targets for G0-only compilation 2022-06-20 11:34:20 +00:00
bt ble_mesh: stack: Add filter old seq_auth packet menuconfig 2022-06-22 08:08:28 +00: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 tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
driver Merge branch 'bugfix/fix_legacy_pcnt_driver_test_with_freertos_smp' into 'master' 2022-06-23 20:19:08 +08:00
efuse temperature_sensor: Add temperature sensor support for ESP32-C2 2022-06-23 15:36:43 +08:00
esp_adc_cal adc: create common adc hal layer 2022-05-07 19:20:44 +08:00
esp_common Merge branch 'feature/memprot_api_unified_s3_2' into 'master' 2022-06-20 17:34:22 +08:00
esp_eth examples, components: remove C/C++ standard overrides 2022-06-17 16:44:17 +02:00
esp_event examples, components: remove C/C++ standard overrides 2022-06-17 16:44:17 +02:00
esp_gdbstub components: Change copyright in components files 2022-06-17 16:59:56 +02:00
esp_hid freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
esp_http_client esp_http_client/esp_https_ota: Removed errno checks 2022-05-31 15:04:21 +05:30
esp_http_server fix(websocket): Support handler deal with PING and CLOSE frame 2022-06-08 16:16:57 +08:00
esp_https_ota esp_http_client/esp_https_ota: Removed errno checks 2022-05-31 15:04:21 +05:30
esp_https_server docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
esp_hw_support Add regi2c enable/disable reference count 2022-06-23 15:36:44 +08:00
esp_lcd Merge branch 'feature/new_esp_psram_component' into 'master' 2022-06-15 19:16:56 +08:00
esp_local_ctrl protocomm: Added option to enable/disable supported security versions. 2022-06-17 13:16:20 +00:00
esp_netif esp_netif: added support for LwIP bridge 2022-06-14 15:29:44 +02:00
esp_phy fix the bug that some memory leaked in phy after wifi/ble deinit 2022-06-16 20:42:20 +08:00
esp_pm esp_pm: Disable esp_pm when SMP FreeRTOS is enabled 2022-06-15 16:17:59 +08:00
esp_psram psram: fix esp32/esp_psram_impl_quad memcpy out of bounds issue 2022-06-14 15:44:27 +08:00
esp_ringbuf gptimer: added enable/disable functions 2022-05-06 18:18:39 +08:00
esp_rom esp_wifi: fix esp32c2 owe support 2022-06-21 20:58:10 +08:00
esp_serial_slave_link spi: support spi on h2 2022-03-29 11:54:08 +08:00
esp_system esp_system: move MEMPROT related configuration to soc capability header 2022-06-23 10:29:42 +05:30
esp_timer system/sleep: simplify code for time compensation when wakeup from light sleep 2022-06-14 14:49:26 +08:00
esp_wifi Merge branch 'bugfix/fix_esp32c2_owe_support' into 'master' 2022-06-22 15:46:46 +08:00
esp-tls Merge branch 'feature/esp8684_sha' into 'master' 2022-06-23 14:18:49 +08:00
espcoredump Merge branch 'refactor/change_copyright_components' into 'master' 2022-06-20 16:02:12 +08:00
esptool_py Revert "Merge branch 'fix/esptool_esp32c2_minrev' into 'master'" 2022-06-24 11:37:23 +08:00
fatfs Merge branch 'fix/ff_sdmmc_status_check_optional' into 'master' 2022-06-13 14:42:12 +08:00
freertos Merge branch 'feature/update_smp_freertos_porting_notes' into 'master' 2022-06-24 13:33:44 +08:00
hal Merge branch 'esp32h2/enable_ecc_accelerator' into 'master' 2022-06-23 20:06:26 +08:00
heap ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
http_parser docs/en: Add entry for http_parser in copyrights page 2022-01-11 10:26:25 +05:30
idf_test Merge branch 'feature/esp8684_sha' into 'master' 2022-06-23 14:18:49 +08:00
ieee802154 openthread: update OpenThread submodule 2022-06-23 11:33:17 +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 tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
lwip esp_netif: added support for LwIP bridge 2022-06-14 15:29:44 +02:00
mbedtls Merge branch 'feature/freertos-smp-rsa-timeouts' into 'master' 2022-06-23 21:27:36 +08:00
mdns esp-netif: Make dependency on esp-eth optional 2022-06-09 07:55:40 +00:00
mqtt Merge branch 'bugfix/mqtt_host_test' into 'master' 2022-06-13 13:13:00 +08:00
newlib components: Change copyright in components files 2022-06-17 16:59:56 +02:00
nvs_flash Merge branch 'bugfix/nvs_part_ptr_wrong_init' into 'master' 2022-06-23 21:23:39 +08:00
openthread openthread: update OpenThread submodule 2022-06-23 11:33:17 +08:00
partition_table kconfig: move remaining kconfig options out of target component 2022-05-23 17:57:45 +08:00
perfmon ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
protobuf-c protobuf-c: Update submodule to v1.4.0 2022-05-30 09:54:31 +05:30
protocomm WifiProv: Extended support for configuring if link encryption is needed 2022-06-22 10:17:28 +05:30
pthread system: re-enable esp_event, real_time_stats and pthread examples and test for C2 2022-06-23 02:05:46 +00:00
riscv Merge branch 'refactor/remove_g0_dep_on_g1_riscv' into 'master' 2022-06-16 11:53:39 +08:00
sdmmc remove: sdspi_host deprecated api 2022-06-12 20:07:27 +00:00
soc Merge branch 'feature/memprot_settings_to_soc_caps' into 'master' 2022-06-24 18:08:19 +08:00
spi_flash freertos: increase timeout for multi flash test cases 2022-06-20 10:25:39 +00:00
spiffs Merge branch 'feature/esp32c2_configurable_mmu_new' into 'master' 2022-06-10 10:20:49 +08:00
tcp_transport Merge branch 'feature/freertos-smp-adjust-performance-thresholds' into 'master' 2022-06-15 17:23:00 +08:00
tinyusb usb: Clean-up TinyUSB unnecessary code 2022-06-09 10:56:39 +02:00
touch_element docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
ulp system: re-enable esp_event, real_time_stats and pthread examples and test for C2 2022-06-23 02:05:46 +00:00
unity feature (unity): added memory leak check API, integrated it into cxx tests 2022-05-09 11:09:20 +08:00
usb usbh_print_intf_desc prints wrong value for tbInterfaceClass (IDFGH-9000) 2022-05-21 15:54:21 -07:00
vfs ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
wear_levelling MMU: Add configurable mmu page size support on ESP32C2 2022-06-08 19:34:31 +08:00
wifi_provisioning Merge branch 'bugfix/configure_link_encryption_for_charac' into 'master' 2022-06-23 19:46:47 +08:00
wpa_supplicant Merge branch 'feature/sae_sta_h2e' into 'master' 2022-06-20 23:52:08 +08:00
xtensa G0: Support Xtensa targets for G0-only compilation 2022-06-20 11:34:20 +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.