esp-idf/components
Ivan Grokhotkov 330da63548 Merge branch 'bugfix/nvs_oom_check_wrong_pointer_v4.4' into 'release/v4.4'
nvs: fixed OOM check wrong pointer issue (backport 4.4)

See merge request espressif/esp-idf!16976
2022-02-08 14:54:48 +00:00
..
app_trace esp32c3: fix portSTACK_GROWTH redefinition error 2022-02-07 09:47:57 +01:00
app_update bootloader: Fixes bootloader_common_get_sha256_of_partition. Adds hash check. 2022-01-25 19:58:29 +08:00
asio openssl: Add deprecation warning to ssl.h 2021-10-05 11:45:52 +02:00
bootloader feat (bootloader): added rng sampling 2022-01-03 16:24:41 +05:30
bootloader_support bootloader: Fixes bootloader_common_get_sha256_of_partition. Adds hash check. 2022-01-25 19:58:29 +08:00
bt Merge branch 'bugfix/fix_bluedroid_ble50_adv_data_length_issue_v4.4' into 'release/v4.4' 2022-02-07 08:01:55 +00:00
cbor cbor: add a workaround for -ffreestanding being passed to clang 2021-09-16 11:07:54 +02:00
cmock
coap mbedtls: fix build fail with client only mbedtls 2021-10-04 19:18:45 +08:00
console fix console stuck in auto test 2022-01-25 17:04:48 +08:00
cxx vfs_usb_serial: set secondary selection for making usb port can output under default menu 2021-11-17 19:54:15 +08:00
driver Merge branch 'bugfix/fix_common_clock_bug_v4.4' into 'release/v4.4' 2022-02-08 09:10:34 +00:00
efuse efuse: Fixes eFuse timesettings issue on esp32c3 2022-01-25 19:14:31 +08:00
esp32 components/bt: move config BT_RESERVE_DRAM from bluedroid to ESP32 controller 2021-09-16 20:26:35 +08:00
esp32c3 light sleep: add software workaround for esp32s3 gpio reset issue 2021-10-20 11:36:22 +08:00
esp32h2 Merge branch 'feature/xtwdt' into 'master' 2021-09-02 02:44:47 +00:00
esp32s2 WDT: Add support for XTAL32K Watchdog timer 2021-09-02 09:09:00 +08:00
esp32s3 docs: enable publishing of S3 docs 2021-09-06 09:11:17 +08:00
esp_adc_cal adc: support adc dma driver on all chips 2021-12-23 17:13:46 +08:00
esp_common build: fix unused tag string 2022-01-28 11:59:45 +08:00
esp_eth Fixed ESP32 EMAC driver insufficient TX buffer size which could followed esp_eth_stop and esp_eth_start sequence 2021-12-21 14:04:55 +01:00
esp_event [mocks]: moved mocks dir to tools/ 2021-08-10 14:45:42 +08:00
esp_gdbstub bugfix/esp-gdbstrub: add missing function for esp32c3/esp32h2. 2021-10-26 20:00:58 +03:00
esp_hid Fixed left right key confusion in comments. 2022-01-05 10:46:46 +08:00
esp_http_client http: Fix parsing invalid url cause to crash 2021-12-31 14:40:21 +08:00
esp_http_server Added more convenient functions for sending data to websocket 2021-09-16 10:53:29 +02:00
esp_https_ota esp_https_ota: Fix esp_https_ota_begin may return ESP_OK when http status code is not 200 and may exist memory leak 2022-01-12 19:53:08 +08:00
esp_https_server feature: Added user callback for esp_https_server 2021-10-11 09:41:01 +05:30
esp_hw_support build: fix unused tag string 2022-01-28 11:59:45 +08:00
esp_ipc esp_ipc: Update documentation and API descriptions 2021-12-20 12:41:10 +08:00
esp_lcd lcd: rgb pclk idle default to low 2021-12-06 10:02:55 +08:00
esp_local_ctrl Added support for security1 in local control 2021-08-26 17:35:09 +08:00
esp_netif esp_wifi: support station only mode for code size down 2021-12-06 17:34:56 +08:00
esp_phy esp_phy: move lib_printf.c to esp_phy 2022-01-11 12:09:11 +08:00
esp_pm Merge branch 'bugfix/esp32_light_sleep_crash_4.4' into 'release/v4.4' 2021-11-11 03:38:49 +00:00
esp_ringbuf Merge branch 'bugfix/ringbuf_send_semaphore_release_order_v4.4' into 'release/v4.4' 2021-12-08 10:26:12 +00:00
esp_rom Fix copyright headers for few include files 2021-12-28 14:29:33 +05:30
esp_serial_slave_link adc: support adc dma driver on all chips 2021-12-23 17:13:46 +08:00
esp_system System/Security: Memprot API unified (ESP32C3,ESP32S3) 2022-01-27 12:40:27 +08:00
esp_timer esp_timer: init rtc timer and system timer in early init 2021-11-15 19:38:09 +08:00
esp_websocket_client Merge branch 'bugfix/ws_client_const_correct' into 'master' 2021-06-22 16:30:29 +00:00
esp_wifi Merge branch 'bugfix/fix_smartconfig_setopt_fail_v4.4' into 'release/v4.4' 2022-01-27 05:44:35 +00:00
esp-tls Encoding base64 with wolfSSL should produce the same result as esp_crypto_bas64_encode_mbedtls and not encode in PEM format /w new lines 2021-10-17 00:01:23 +08:00
espcoredump coredump: update test data for toolchain 2021r2 2021-10-25 19:55:41 +07:00
esptool_py trax: Adds ESP32-S3 support 2022-01-05 19:34:28 +01:00
expat expat: upgrade to v2.4.3 release 2022-01-31 11:13:26 +05:30
fatfs fix: pin definitions for other boards 2022-01-27 12:06:41 +01:00
freemodbus freemodbus: fixed timer config struct not initialized issue (v4.4) 2021-12-23 17:15:00 +00:00
freertos Merge branch 'bugfix/freertos_pd_ticks_to_ms_precision_v4.4' into 'release/v4.4' 2022-01-26 00:50:35 +00:00
hal i2s: fix mclk stopped when setting clock 2022-02-07 15:27:35 +08:00
heap Merge branch 'bugfix/MR16031_v4.4' into 'release/v4.4' 2022-01-27 05:30:02 +00:00
idf_test ci: move integration test related files outside of components 2022-01-26 22:33:14 +08:00
ieee802154 trax: Adds ESP32-S3 support 2022-01-05 19:34:28 +01:00
jsmn
json cJSON: Update submodule to latest release. 2021-08-27 12:04:38 +08:00
libsodium libsodium: fix source directory names to address build issues with Make 2021-08-05 12:28:09 +08:00
linux [mocks]: freertos mock 2021-08-06 17:08:21 +08:00
log esp_log: add note about reentrancy for custom logging function 2021-09-14 16:57:15 +05:30
lwip lwip: Update LWIP_DHCP_OPTIONS_LEN default value when LWIP_DHCP_DISABLE_VENDOR_CLASS_ID disabled 2021-12-03 17:23:35 +08:00
mbedtls ci: Fix issues for build stage 2022-02-02 15:03:48 +05:30
mdns mdns: Fix alloc issue if TXT has empty value 2022-01-21 22:52:33 +04:00
mqtt trax: Adds ESP32-S3 support 2022-01-05 19:34:28 +01:00
newlib Merge branch 'feature/posix_compat_functions_v4.4' into 'release/v4.4' 2021-12-23 11:20:54 +00:00
nghttp
nvs_flash bugfix (nvs): fixed wrong pointer check 2022-01-28 11:37:53 +08:00
openssl asio: Fix ssl example build removing openssl warning 2021-10-25 11:59:02 +00:00
openthread trax: Adds ESP32-S3 support 2022-01-05 19:34:28 +01:00
partition_table tools: replace _ with - in idf.py 2021-10-13 17:30:38 +08:00
perfmon esp32h2: enable more components to support esp32h2 2021-07-01 19:53:11 +08:00
protobuf-c
protocomm protocomm: Updated function for constant time buffer comparison 2022-02-02 10:56:48 +05:30
pthread feat (pthread): reader-writer locks implementation 2021-11-08 10:21:37 +08:00
riscv RISC-V: fix usage of special register when interrupts are enabled 2021-11-30 11:45:18 +08:00
sdmmc docs: fix typo in header files 2021-12-14 11:01:17 +08:00
soc System/Security: Memprot API unified (ESP32C3,ESP32S3) 2022-01-27 12:40:27 +08:00
spi_flash spi_flash_test: remove threshold from unit test 2022-01-17 15:07:06 +08:00
spiffs spiffs: only add GCC-specific flags when building with GCC 2021-09-16 11:07:54 +02:00
tcp_transport tcp_transport: fix tcp trasnport exception 2022-01-20 15:38:44 +08:00
tcpip_adapter esp_wifi: support station only mode for code size down 2021-12-06 17:34:56 +08:00
tinyusb tinyusb: Update tinyusb.c to use the usb_phy API to configure PHY 2022-01-19 18:18:08 +08:00
touch_element touch_element: add unit test for Touch Element lib 2021-07-12 10:02:46 +08:00
ulp ulp: fix quoting issues for linker script and map file arguments 2021-10-06 10:42:07 +02:00
unity [build system]: Fixed common requirement for Linux 2021-08-13 16:50:29 +08:00
usb USB: added MSC Host Driver with VFS support 2021-12-23 18:30:24 +01:00
vfs vfs: add test for errno value after 'open' 2022-02-07 11:36:00 +01:00
wear_levelling host tests: add missing header files for compiling host tests 2021-07-20 17:44:20 +08:00
wifi_provisioning wifi_prov_mgr: Fix provisioning not stopping in release mode 2022-02-01 09:49:45 +05:30
wpa_supplicant wpa_supplicant: Saved message-type digest used in handshake for PRF operations 2022-02-02 10:56:48 +05:30
xtensa esp32h2: add some more fixes and TODOs 2021-07-01 20:36:39 +08: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.