esp-idf/components
2022-01-01 03:13:45 +08:00
..
app_trace esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
app_update spi_flash: refactor spi_flash.h to esp_rom_spiflash.h but keep the content in spi_flash.h 2021-12-30 14:12:31 +08:00
asio asio: Use internal ssl context and engine impl 2021-12-03 09:32:42 +01:00
bootloader spi_flash: move patch files to common rom patch folder 2021-12-30 14:05:12 +08:00
bootloader_support spi_flash: refactor spi_flash.h to esp_rom_spiflash.h but keep the content in spi_flash.h 2021-12-30 14:12:31 +08:00
bt components/bt: Fix bluedroid compile issue 2021-12-30 11:54:47 +08:00
cmock Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
coap Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
console i2s: deprecate confusing names 2021-11-24 13:21:13 +08:00
cxx Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
driver esp8684: support GPIO peripheral, IO_MUX, GPIO matrix. 2021-12-29 22:01:45 +08:00
efuse spi_flash: refactor spi_flash.h to esp_rom_spiflash.h but keep the content in spi_flash.h 2021-12-30 14:12:31 +08:00
esp32 rom: remove deprecated headers from esp32 components 2021-12-14 09:48:11 +08:00
esp32c3 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp32h2 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp32s2 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp32s3 psram: add octal psram ECC feature 2021-12-13 20:24:52 +08:00
esp8684 rtc_clk: change clock source from xtal to pll on real board(ESP8684) 2021-12-15 12:21:11 +08:00
esp_adc_cal adc: support adc dma driver on all chips 2021-12-16 00:19:15 +00:00
esp_common System/Security: Memprot API unified (ESP32C3) 2021-12-21 01:50:36 +01:00
esp_eth apll: add lock for apll 2021-12-29 10:13:13 +08:00
esp_event freertos: update module handles to struct type 2021-12-06 08:37:06 +05:30
esp_gdbstub esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
esp_hid Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_http_client http: Fix parsing invalid url cause to crash 2021-12-02 14:15:43 +08:00
esp_http_server Clarify when the socket is closed if a custom session closing callback is used 2021-11-25 17:19:11 +08:00
esp_https_ota Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_https_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_hw_support sleep: fixed ext1 cannot wakeup via RTCIO >= 18 issue 2021-12-31 08:09:43 +00:00
esp_lcd Merge branch 'refactor/i2s_deprecate_confusing_names' into 'master' 2021-12-07 11:52:44 +00:00
esp_local_ctrl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_netif CI: Enable ESP8684 build stage CI on master 2021-12-13 19:18:47 +08:00
esp_phy usb_serial_jtag: can print when wifi enabled by default 2021-12-27 14:52:07 +08:00
esp_pm esp_clk: refactor target/clk.h to private/esp_clk.h 2021-11-26 14:56:30 +08:00
esp_ringbuf i2s: deprecate confusing names 2021-11-24 13:21:13 +08:00
esp_rom spi_flash: refactor spi_flash.h to esp_rom_spiflash.h but keep the content in spi_flash.h 2021-12-30 14:12:31 +08:00
esp_serial_slave_link adc: support adc dma driver on all chips 2021-12-16 00:19:15 +00:00
esp_system spi_flash: move patch files to common rom patch folder 2021-12-30 14:05:12 +08:00
esp_timer Fix various warnings generated from Coverity scan 2021-12-09 09:38:53 +05:30
esp_websocket_client websocket: removed deprecated API "esp_websocket_client_send" 2021-12-09 13:28:13 +04:00
esp_wifi esp_wifi: Refactor key install code 2021-12-23 21:31:31 +08:00
esp-tls refactor (test_utils)!: separate file for memory check functions 2021-12-08 11:06:00 +08:00
espcoredump esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
esptool_py Merge branch 'feature/espefuse_adds_args_to_execute_scripts_cmd' into 'master' 2021-12-21 12:24:06 +00:00
expat Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
fatfs bootloader: move bootloader flash support to isolate folders 2021-12-30 14:05:12 +08:00
freemodbus freemodbus: fix port contains lgpl licensed files 2021-11-29 12:50:53 +01:00
freertos esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
hal esp8684: support GPIO peripheral, IO_MUX, GPIO matrix. 2021-12-29 22:01:45 +08:00
heap heap: adjust the order of RTC memory heap caps and regions 2021-12-29 08:49:42 +00:00
idf_test CI: change ap authmode from number to string 2021-12-27 19:55:56 +08:00
ieee802154 openthread: update libs 2021-12-03 12:18:59 +08:00
json Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
linux [mocks]: freertos mock 2021-08-06 17:08:21 +08:00
log i2s: deprecate confusing names 2021-11-24 13:21:13 +08:00
lwip lwip: make some of the component dependencies optional 2021-12-13 10:53:22 +01:00
mbedtls esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
mdns Merge branch 'bugfix/mdns_network_socket_err_prints' into 'master' 2021-12-21 13:59:01 +00:00
mqtt refactor (test_utils)!: separate file for memory check functions 2021-12-08 11:06:00 +08:00
newlib esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
nghttp Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
nvs_flash bugfix (nvs): fixed wrong pointer check 2021-12-13 10:42:45 +08:00
openssl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
openthread openthread: fix rcp version, update openthread lib and submodule 2021-12-27 12:13:53 +08:00
partition_table Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
perfmon Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
protobuf-c Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
protocomm Fix various warnings generated from Coverity scan 2021-12-09 09:38:53 +05:30
pthread Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
riscv RISC-V: Fix vectors.S assembly file indentation and macro usage 2021-11-15 17:17:24 +08:00
sdmmc docs: fix typo in header files 2021-12-13 13:17:17 +08:00
soc soc: updated soc_caps about rtc_io and the format 2022-01-01 03:13:45 +08:00
spi_flash spi_flash: refactor spi_flash.h to esp_rom_spiflash.h but keep the content in spi_flash.h 2021-12-30 14:12:31 +08:00
spiffs bootloader: move bootloader flash support to isolate folders 2021-12-30 14:05:12 +08:00
tcp_transport tcp_transport: Fix Websocket transport initialization 2021-12-06 14:28:30 -03:00
tcpip_adapter Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
tinyusb global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
touch_element Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
ulp esp_clk: refactor target/clk.h to private/esp_clk.h 2021-11-26 14:56:30 +08:00
unity esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
usb USB: added MSC Host Driver with VFS support 2021-12-20 12:39:45 +01:00
vfs Merge branch 'contrib/github_pr_8013' into 'master' 2021-12-31 07:09:08 +00:00
wear_levelling bootloader: move bootloader flash support to isolate folders 2021-12-30 14:05:12 +08:00
wifi_provisioning wifi_prov_mgr: Added check for passphrase length in softAP scheme 2021-12-27 10:57:50 +05:30
wpa_supplicant Merge branch 'bugfix/rrm_dpp_task_delete' into 'master' 2021-12-27 10:26:33 +00:00
xtensa esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
README.md docs: core components description 2021-09-13 12:05:20 +08:00

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. However, to maintain backward compatibility, esp_system.h includes these headers.

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.