esp-idf/components
morris 2bc721739c Merge branch 'bugfix/i2s_tdm_multi_dev_on_h2_v5.1' into 'release/v5.1'
i2s: fixed tdm multi dev test on h2 (v5.1)

See merge request espressif/esp-idf!23475
2023-04-27 13:20:03 +08:00
..
app_trace app_trace: fix fwrite/fread return value 2023-03-17 00:15:07 +08:00
app_update esp32h4: checked all the corner stuffs of the removal 2023-04-26 18:53:12 +08:00
bootloader esp32h4: removed esp32h4 related files 2023-04-26 18:53:12 +08:00
bootloader_support esp32h4: checked all the corner stuffs of the removal 2023-04-26 18:53:12 +08:00
bt Merge branch 'bugfix/fix_duplicate_scan_cycle_refresh_not_accurate_v5.1' into 'release/v5.1' 2023-04-27 10:02:17 +08:00
cmock
console bug(idf_monitor): fix color on windows with hints 2023-04-21 14:42:26 +02:00
cxx ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
driver Merge branch 'bugfix/i2s_tdm_multi_dev_on_h2_v5.1' into 'release/v5.1' 2023-04-27 13:20:03 +08:00
efuse esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
esp_adc esp32h4: removed esp32h4 related files 2023-04-26 18:53:12 +08:00
esp_app_format esp32h2: add build test 2023-01-17 10:29:04 +08:00
esp_coex esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
esp_common esp_common: restore test_attr test scope for psram 2023-03-01 11:04:22 +08:00
esp_eth ci: remove redundent ci configs for chip support and network components 2023-04-26 17:29:51 +08:00
esp_event esp_event: fix and re-enable no-format warnings 2023-03-12 21:40:47 +01:00
esp_gdbstub wdt: refactor wdt codes to use unified type 2023-02-15 12:08:55 +08:00
esp_hid fix HID Host bug when handling the two consecutive connection request 2023-03-09 14:25:25 +08:00
esp_http_client Merge branch 'contrib/github_pr_10715' into 'master' 2023-03-21 14:07:31 +08:00
esp_http_server esp_http_server: Update to support build for Linux 2023-03-31 16:42:05 +05:30
esp_https_ota esp_https_ota: Set user configurable ota authorization retries 2023-03-29 17:29:31 +05:30
esp_https_server
esp_hw_support Merge branch 'bugfix/fix_wrong_frame_ptr_after_wake_restore_backportv5.1' into 'release/v5.1' 2023-04-27 10:45:04 +08:00
esp_lcd Merge branch 'bugfix/spi_lcd_max_trans_size_v5.1' into 'release/v5.1' 2023-04-24 10:31:51 +08:00
esp_local_ctrl esp_local_ctrl: Fix header inclusion 2023-01-12 16:16:45 +05:30
esp_mm Merge branch 'ci/chip_support_network_invalid_kconfig_v5.1' into 'release/v5.1' 2023-04-27 11:10:54 +08:00
esp_netif lwip/esp_napt: Added api to enable/disable napt based on esp_netif. 2023-03-23 20:38:03 +11:00
esp_netif_stack
esp_partition support SPI_FLASH_ENABLE_COUNTERS feature on esp_flash driver and rename the functions to esp_flash_xx 2023-04-06 11:40:40 +08:00
esp_phy esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
esp_pm Merge branch 'bugfix/fix_wrong_frame_ptr_after_wake_restore_backportv5.1' into 'release/v5.1' 2023-04-27 10:45:04 +08:00
esp_psram himem: Fixed incorrect out_ptr when calling esp_himem_map range_offset non-zero 2023-04-05 01:29:34 +08:00
esp_ringbuf esp_ringbuf: Added functions to linker.lf file which can be placed in Flash 2023-04-03 08:57:56 +02:00
esp_rom esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
esp_system esp32h4: checked all the corner stuffs of the removal 2023-04-26 18:53:12 +08:00
esp_timer esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
esp_wifi esp32h4: checked all the corner stuffs of the removal 2023-04-26 18:53:12 +08:00
esp-tls Merge branch 'bugfix/esp_tls_coverity_warning' into 'master' 2023-03-31 15:22:58 +08:00
espcoredump esp32h2: add build test 2023-01-17 10:29:04 +08:00
esptool_py esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
fatfs fatfs: fstat - enable setting a custom preferred block size 2023-03-08 09:09:47 +01:00
freertos esp32h4: checked all the corner stuffs of the removal 2023-04-26 18:53:12 +08:00
hal esp32h4: remove esp32h4 target from peripherals 2023-04-26 18:53:10 +08:00
heap esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
http_parser
idf_test esp32h4: removed esp32h4 related files 2023-04-26 18:53:12 +08:00
ieee802154 Merge branch 'support/backport_154_related_feature' into 'release/v5.1' 2023-04-27 11:57:47 +08:00
json
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 log: Fix function name in OS-independent implementation 2023-03-16 01:50:21 +08:00
lwip lwip: Remove AFL based fuzzer tests 2023-03-20 17:47:23 +00:00
mbedtls esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
mqtt ci: Migrateunit test for mqtt test to unit test app 2023-03-24 10:32:43 +01:00
newlib esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
nvs_flash ci(nvs_flash): Increase timeout of nvs_page_test 2023-02-13 12:35:52 +08:00
openthread Merge branch 'support/backport_154_related_feature' into 'release/v5.1' 2023-04-27 11:57:47 +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 Merge branch 'ci/driver_single_board' into 'master' 2023-03-13 09:25:42 +08:00
pthread pthread: Implemented POSIX unnamed semaphore 2023-03-21 10:23:58 +08:00
riscv esp_pm: check sleep retention frame integrity in ci UT 2023-04-26 17:36:46 +08:00
sdmmc sdmmc: keep clock enabled for the duration of ACMD41 2023-03-27 14:09:02 +02:00
soc Merge branch 'refactor/remove_esp32h4_target_v5.1' into 'release/v5.1' 2023-04-27 09:37:51 +08:00
spi_flash Merge branch 'ci/chip_support_network_invalid_kconfig_v5.1' into 'release/v5.1' 2023-04-27 11:10:54 +08:00
spiffs spiffs: test is using configurable build dir 2023-03-31 15:07:07 +08:00
tcp_transport [tcp_transport] - Adds Socks4 proxy transport 2023-03-27 14:46:40 +02: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-riscv-i2c: Updated ULP RISC-V I2C driver to abort when met with errors 2023-03-29 13:25:46 +02:00
unity
usb usb_host: Use up-to-date syntax in pytest 2023-04-21 15:45:42 +08:00
vfs Merge branch 'bugfix/usb_serial_driver_block' into 'master' 2023-02-24 10:22:08 +08:00
wear_levelling freertos(IDF): Remove usage of xPortGetFreeHeapSize() outside FreeRTOS 2023-03-07 02:02:28 +08:00
wifi_provisioning lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
wpa_supplicant esp32h4: removed esp32h4 related codes 2023-04-26 18:53:12 +08:00
xtensa
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.