esp-idf/components
Darian 150818e4f5 Merge branch 'feature/freertos_try_enter_critical' into 'master'
freertos: Add portTRY_ENTER_CRITICAL() and clean up old port mux API

Closes IDF-2047 and IDFGH-3318

See merge request espressif/esp-idf!15568
2021-11-22 10:34:09 +00:00
..
app_trace freertos: Add portTRY_ENTRY_CRITICAL() and deprecate legacy spinlock fucntions 2021-11-22 13:28:39 +08:00
app_update Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
asio Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
bootloader Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
bootloader_support Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
bt [nimble]: clear timer handler during de-initialization 2021-11-19 15:08:55 +08:00
cbor Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01: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 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
cxx Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
driver Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
efuse Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
esp32 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01: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 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp8684 ESP8684: add esp8684, esp_adc_cal, esp_common 2021-11-06 17:33:44 +08:00
esp_adc_cal Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_common Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_eth Merge branch 'feature/eth_ioctl_speed_duplex' into 'master' 2021-11-16 11:56:18 +00:00
esp_event Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_gdbstub Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_hid Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_http_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_http_server Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00: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 Merge branch 'feature/freertos_try_enter_critical' into 'master' 2021-11-22 10:34:09 +00:00
esp_lcd Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01: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 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_phy Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
esp_pm Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_ringbuf freertos: Add portTRY_ENTRY_CRITICAL() and deprecate legacy spinlock fucntions 2021-11-22 13:28:39 +08:00
esp_rom Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_serial_slave_link Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_system esp_ipc: Update documentation and API descriptions 2021-11-18 21:34:50 +08:00
esp_timer Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
esp_websocket_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_wifi Merge branch 'mesh/bugfix_fix_layer2_node_connection_issue' into 'master' 2021-11-18 03:55:00 +00:00
esp-tls Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
espcoredump Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esptool_py Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
expat Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
fatfs Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
freemodbus Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
freertos freertos: Add portTRY_ENTRY_CRITICAL() and deprecate legacy spinlock fucntions 2021-11-22 13:28:39 +08:00
hal Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
heap freertos: Add portTRY_ENTRY_CRITICAL() and deprecate legacy spinlock fucntions 2021-11-22 13:28:39 +08:00
idf_test freertos: Add portTRY_ENTRY_CRITICAL() and deprecate legacy spinlock fucntions 2021-11-22 13:28:39 +08:00
ieee802154 ieee802154: add timer APIs 2021-11-02 14:08:34 +08:00
jsmn Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
json Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
libsodium 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 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
lwip Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mbedtls Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mdns Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mqtt freertos: Add portTRY_ENTRY_CRITICAL() and deprecate legacy spinlock fucntions 2021-11-22 13:28:39 +08:00
newlib Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
nghttp Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
nvs_flash Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
openssl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
openthread Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01: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 Merge branch 'bugfix/protocomm_nimble_allocation' into 'master' 2021-11-18 14:15:08 +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 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
soc Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
spi_flash Merge branch 'feat/rm_makefiles' into 'master' 2021-11-16 03:44:41 +00:00
spiffs Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
tcp_transport Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01: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 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
unity Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
usb Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
vfs Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
wear_levelling Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
wifi_provisioning Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
wpa_supplicant esp_wifi: Remove scan done event for supplicant scans 2021-11-20 18:25:55 +05:30
xtensa Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
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.