esp-idf/components
2023-06-29 11:07:03 +02:00
..
app_trace heap: Add a configuration that places all the heap component and related functionalities in flash when enabled 2023-04-25 01:12:10 +00:00
app_update esp32h4: checked all the corner stuffs of the removal 2023-04-26 18:53:12 +08:00
bootloader build-system: replace ADDITIONAL_MAKE_CLEAN_FILES with ADDITIONAL_CLEAN_FILES 2023-05-10 09:53:55 +08:00
bootloader_support esp_hw_support: decrease RNG read frequency on C6 and H2 2023-05-31 16:16:25 +00:00
bt Revert "bluedroid: report disconnect event after BLE link closed" 2023-06-02 16:51:07 +08:00
cmock
console console: Fix building issue when serial JTAG is set 2023-05-16 04:37:09 +00:00
cxx ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
driver Merge branch 'contrib/github_pr_10532_v5.1' into 'release/v5.1' 2023-05-20 07:35:38 +08:00
efuse mac_addr(C6 and H2): Fix byte order of MAC_EXT and change format of IEEE802154 MAC 2023-06-13 16:56:13 +08:00
esp_adc bugfix: move adc_oneshot_power_acquire/release to adc_oneshot_read 2023-05-18 20:08:47 +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_wifi: itwt add setup timeout timer to track response frame 2023-06-02 19:46:15 +08:00
esp_eth tests: update Root certificate for the test endpoints 2023-05-17 15:27:24 +05:30
esp_event ci: fixed test apps overriding pytest configs 2023-04-27 14:29:06 +08:00
esp_gdbstub esp_gdbstub: refactor code 2023-04-28 12:38:26 +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_https_server: Add dependency on MBEDTLS_TLS_SERVER config 2022-12-16 10:30:41 +05:30
esp_hw_support Merge branch 'bugfix/mac_ext_order_for_c6_h2_v5.1' into 'release/v5.1' 2023-06-28 17:33:53 +08:00
esp_lcd spi: added an API to get max transaction length and use in spi lcd driver 2023-05-17 09:03:26 +00: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-netif: Support non-lwip mode, add test 2022-12-14 14:12:50 +00:00
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 esp_phy: updating lib phy to adapt the voltage changes 2023-05-24 10:35:39 +08:00
esp_pm Kconfig: add more help info for pm related options help 2023-05-19 13:51:29 +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 ci: fixed test apps overriding pytest configs 2023-04-27 14:29:06 +08:00
esp_rom compiler: replaced noreturn by __noreturn__ in header files 2023-05-18 12:49:40 +08:00
esp_system compiler: replaced noreturn by __noreturn__ in header files 2023-05-18 12:49:40 +08:00
esp_timer Merge branch 'contrib/github_pr_11215_v5.1' into 'release/v5.1' 2023-05-18 13:06:46 +08:00
esp_wifi esp_wifi: itwt add setup timeout timer to track response frame 2023-06-02 19:46:15 +08:00
esp-tls esp-tls: Added getter/setter function for the conn_state. 2023-04-24 14:49:26 +05:30
espcoredump coredump: remove tests (moved to esp-coredump repo) 2023-05-16 12:43:04 +08:00
esptool_py system-hardware/efuse: fixed efuse summary description containing ; breaking efuse-summary 2023-05-30 14:07:50 +08:00
fatfs Merge branch 'contrib/github_pr_10532_v5.1' into 'release/v5.1' 2023-05-20 07:35:38 +08:00
freertos Kconfig: add more help info for pm related options help 2023-05-19 13:51:29 +08:00
hal Merge branch 'feature/c6_bootloader_rng_v5.1' into 'release/v5.1' 2023-05-26 15:36:45 +08:00
heap Merge branch 'feature/heap-in-flash_v5.1' into 'release/v5.1' 2023-05-12 15:57:31 +08:00
http_parser
idf_test esp32h4: removed esp32h4 related files 2023-04-26 18:53:12 +08:00
ieee802154 ieee802154: fix a typo in set_channel API 2023-05-18 10:39:51 +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 cxx: gnu++23 -> gnu++2b for clang compatibility, added docs and test 2023-05-11 17:48:38 +08:00
lwip netdb:fixed bug for getaddrinfo returns null when IPV4 mapped address 2023-05-19 12:26:07 +08:00
mbedtls esp_ds: ignore releasing mutex if not called from same task 2023-05-19 08:31:34 +05:30
mqtt ci: Migrateunit test for mqtt test to unit test app 2023-03-24 10:32:43 +01:00
newlib ci: misc fixes for newlib test app 2023-05-11 09:27:09 +08:00
nvs_flash NVS: nvs_tool.py entry.data None check fix 2023-06-29 11:07:03 +02:00
openthread openthread: fix frame counter when re-transmition 2023-05-24 10:43:16 +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 wifi_prov_mgr: Fixed memory leak after bluetooth stack was stopping. 2023-04-25 15:48:09 +05:30
pthread pthread: Implemented POSIX unnamed semaphore 2023-03-21 10:23:58 +08:00
riscv bugfix: fix pmp retention and add pma retention 2023-05-19 13:51:20 +08:00
sdmmc sdmmc: incrementally increase delay of vTaskDelay 2023-05-19 14:01:43 +02:00
soc Merge branch 'bugfix/fix_rc_fast_calibration_v5.1' into 'release/v5.1' 2023-05-31 17:40:28 +08:00
spi_flash Merge branch 'feature/spi_hal_move_out_iram_v5.1' into 'release/v5.1' 2023-04-27 23:31:16 +08:00
spiffs build-system: replace ADDITIONAL_MAKE_CLEAN_FILES with ADDITIONAL_CLEAN_FILES 2023-05-10 09:53:55 +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 lp-i2c: Added support for LP I2C peripheral to LP core 2023-05-19 07:33:01 +02:00
unity gpio: Refactor pytest_gpio to separate cases with labels, and update to use new IdfDut class in pytest_embedded_idf 2022-12-20 15:28:33 +08:00
usb usb_host: Use up-to-date syntax in pytest 2023-04-21 15:45:42 +08:00
vfs esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h 2023-04-27 11:11:18 +00: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 esp_wifi: Bugfix wpsreg AP not responding to assoc req 2023-06-01 15:36:54 +05:30
xtensa Fix possible conversion errors by using __builtin_ffsll instead of __builtin_ffs 2023-05-11 11:16:45 +08:00
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.