esp-idf/components
chenjianhua 909ec6673e Update bt-lib for esp32
1 Fixed disconnection delay on peripheral when slave latency is not zero
2 Fixed LLCP info init for central and peripheral
3 Fixed sent cmd status evt twice when process disconnect cmd
2023-06-12 12:12:14 +08:00
..
app_trace gcov: Do not link with libgcov when Clang is used 2023-06-08 16:49:42 +03:00
app_update
bootloader build: Adds support for Clangs's toolchain compiler-rt 2023-06-08 16:49:37 +03:00
bootloader_support Merge branch 'bugfix/incorrect_time_after_ota' into 'master' 2023-06-09 00:30:52 +08:00
bt Update bt-lib for esp32 2023-06-12 12:12:14 +08:00
cmock
console
cxx build: Adds support for Clangs's toolchain compiler-rt 2023-06-08 16:49:37 +03:00
driver adc: port gh pr to current adc continuous mode driver 2023-06-05 14:25:53 +08:00
efuse efuse: Use 'hal_memcpy' instead of 'memcpy' in ESP32-H2 driver 2023-06-08 16:49:42 +03:00
esp-tls
esp_adc Merge branch 'feature/use_circular_dma_desc_link_in_adc_continuous_mode' into 'master' 2023-06-08 11:51:08 +08:00
esp_app_format
esp_bootloader_format
esp_coex
esp_common esp_wifi: itwt add setup timeout timer to track response frame 2023-06-02 21:10:32 +08:00
esp_eth
esp_event
esp_gdbstub
esp_hid
esp_http_client
esp_http_server
esp_https_ota
esp_https_server
esp_hw_support Merge branch 'bugfix/support_esp326_xtal_xpd' into 'master' 2023-06-12 11:28:59 +08:00
esp_lcd
esp_local_ctrl
esp_mm
esp_netif
esp_netif_stack
esp_partition
esp_phy Merge branch 'bufix/update_esp_phy_h_comments' into 'master' 2023-06-06 10:20:59 +08:00
esp_pm Kconfig: add more help info for pm related options help 2023-05-29 16:35:03 +08:00
esp_psram esp32: stop using deprecated name PICOD2 to avoid confusion 2023-06-08 02:09:12 +08:00
esp_ringbuf
esp_rom esp_wifi: fix some txop issues 2023-06-09 22:37:15 +08:00
esp_system Merge branch 'bugfix/incorrect_time_after_ota' into 'master' 2023-06-09 00:30:52 +08:00
esp_timer
esp_wifi esp_wifi: fix some txop issues 2023-06-09 22:37:15 +08:00
espcoredump
esptool_py system-hardware/efuse: fixed efuse summary description containing ; breaking efuse-summary 2023-05-30 10:55:27 +08:00
fatfs CI: fix sdcard fatfs test_apps format timeout 2023-05-25 08:52:59 +00:00
freertos core-system: changed CONFIG_COMPILER_OPTIMIZATION_DEFAULT to CONFIG_COMPILER_OPTIMIZATION_DEBUG 2023-06-02 15:16:50 +08:00
hal Merge branch 'feature/use_circular_dma_desc_link_in_adc_continuous_mode' into 'master' 2023-06-08 11:51:08 +08:00
heap Merge branch 'bugfix/incorrect_time_after_ota' into 'master' 2023-06-09 00:30:52 +08:00
http_parser
idf_test adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
ieee802154 IEEE802154: modification of the action when stop tx/rx ack 2023-06-06 11:31:54 +08:00
json
linux
log
lwip
mbedtls aes: fix DMA descriptor calculation for the alignment case 2023-05-31 14:19:58 +05:30
mqtt
newlib build: Adds support for Clangs's toolchain compiler-rt 2023-06-08 16:49:37 +03:00
nvs_flash nvs_flash: Extended test-app and host tests for the HMAC-based NVS encr-keys protection scheme 2023-05-23 13:55:59 +05:30
nvs_sec_provider nvs_flash: Added helper component `nvs_sec_provider` 2023-05-23 13:55:53 +05:30
openthread Merge branch 'feature/support_border_router' into 'master' 2023-06-09 10:20:46 +08:00
partition_table nvs_flash: Added helper component `nvs_sec_provider` 2023-05-23 13:55:53 +05:30
perfmon
protobuf-c
protocomm
pthread
riscv bugfix: fix pmp retention and add pma retention 2023-05-29 16:35:03 +08:00
sdmmc sdmmc: implement card power control for esp32c3 sdmmc breakout board 2023-06-01 11:01:19 +02:00
soc crypto: add support for DPA protection configuration in C6/H2 2023-06-08 11:09:23 +05:30
spi_flash spi_flash: support esp_flash rom impl test on c6 and h2 2023-06-02 16:56:46 +08:00
spiffs
tcp_transport
touch_element drivers: fix issue reported by coverity 2023-06-06 14:16:09 +08:00
ulp ulp-riscv-touch: Added support for the touch sensor on ULP RISC-V 2023-06-09 08:41:34 +02:00
unity
usb usb_host: Run formatting script 2023-05-29 17:30:41 +08:00
vfs vfs: select sanity NULL check 2023-05-23 18:02:24 +02:00
wear_levelling
wifi_provisioning
wpa_supplicant esp_wifi: Fix WPS issue for WPA3+WPA2 mode 2023-06-05 10:50:53 +05:30
xtensa tools: strip trailing whitespaces/newline from dump_machine 2023-05-30 13:35:10 +02:00
README.md

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.