esp-idf/components
Zim Kalinowski 39a4ec2045 Merge branch 'refactor/nvs_allocatable_objects_v4.4' into 'release/v4.4'
refactor(nvs): custom allocator for all objects allocated in NVS (v4.4)

See merge request espressif/esp-idf!21793
2023-02-08 18:01:10 +08:00
..
app_trace apptrace: move all apptrace related functions to IRAM 2022-06-29 10:17:48 +08:00
app_update docs: fix all doxygen warnings 2022-07-05 11:14:40 +08:00
asio openssl: Add deprecation warning to ssl.h 2021-10-05 11:45:52 +02:00
bootloader Merge branch 'feature/efuse_rev_major_minor_v4.4' into 'release/v4.4' 2023-01-12 16:24:59 +08:00
bootloader_support efuse: Adds major and minor versions and others 2022-12-20 16:30:13 +08:00
bt Merge branch 'doc/update_nimble_mesh_example_information_v4.4' into 'release/v4.4' 2023-02-03 13:53:29 +08:00
cbor cbor: add a workaround for -ffreestanding being passed to clang 2021-09-16 11:07:54 +02:00
cmock
coap coap_config_posix.h: Set up defines for correct mutex usage 2022-05-24 14:43:02 +05:30
console console: argtable3: upgrade to v3.2.2 2022-11-10 11:05:24 +01: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 'feature/_spi_slave_reset_trans_queue_api_v4.4' into 'release/v4.4' 2023-02-02 21:39:51 +08:00
efuse efuse: Adds major and minor versions and others 2022-12-20 16:30:13 +08:00
esp32 components/bt: move config BT_RESERVE_DRAM from bluedroid to ESP32 controller 2021-09-16 20:26:35 +08:00
esp32c3 esp32c3: Adds ECO4 revision 2022-04-20 08:40:56 +00:00
esp32h2 esp32h2/kconfig: remove repeated kconfig 2022-08-11 15:05:12 +08:00
esp32s2 psram: remove CS/CLK pin settings in kconfig on ESP32S2/S3 2022-11-11 17:45:03 +08:00
esp32s3 psram: remove CS/CLK pin settings in kconfig on ESP32S2/S3 2022-11-11 17:45:03 +08:00
esp_adc_cal adc_cal: fixed the assertion failure or returning wrong error code when ADC2 failed the arbitration 2022-03-28 10:23:48 +00:00
esp_common versions: Update version to 4.4.4 2023-01-20 02:12:49 +08:00
esp_eth C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-05 18:16:08 +08:00
esp_event
esp_gdbstub bugfix/esp-gdbstrub: add missing function for esp32c3/esp32h2. 2021-10-26 20:00:58 +03:00
esp_hid optimize HID Host disconnection procedure 2022-11-25 09:34:12 +08:00
esp_http_client esp_http_client: free cached data in case connection gets closed for redirection 2022-10-26 10:11:33 +05:30
esp_http_server esp_http_server: fix wrong context pointer in httpd_req_cleanup function 2022-12-22 10:14:34 +05:30
esp_https_ota esp_https_ota: fix bug where http_client_init_cb is called after esp_http_client_perform() instead of before. 2022-09-02 16:15:50 +05:30
esp_https_server esp_https_server: Fix initializers missing in esp_https_server 2022-12-07 15:10:03 +08:00
esp_hw_support Merge branch 'feature/mac_crc_v4.4' into 'release/v4.4' 2023-02-08 17:04:30 +08:00
esp_ipc esp_hw_support: Fix esp_light_sleep_start() deadlock 2022-09-16 17:02:38 +08:00
esp_lcd lcd: Support rotation SSD1306 and fix mirror y. 2022-12-06 15:43:17 +01:00
esp_local_ctrl esp_local_ctrl: Regenerated proto-c and python with protobuf compiler v3.21.0 2022-06-07 15:59:41 +05:30
esp_netif lwip: Fixed that ipv6 dns cannot work 2022-07-15 16:18:01 +08:00
esp_phy esp_hw_support(esp32): If the MAC_FACTORY CRC check fails, then esp_efuse_mac_get_default returns INVALID_CRC instead of abort 2023-01-23 20:05:53 +08:00
esp_pm pm_impl: fix neither enter light sleep nor enter waiti state in idle task 2022-04-20 19:37:46 +08:00
esp_ringbuf rename xHoldSemaphore to result 2022-08-12 17:54:34 +08:00
esp_rom efuse: Adds major and minor versions and others 2022-12-20 16:30:13 +08:00
esp_serial_slave_link SPI: Fixed Quad SPI wrong dummy cycle issue on ESP32C3/ESP32S3 and put get-command/dummy-bits functions in spi_ll.h 2022-09-07 18:55:38 +08:00
esp_system Merge branch 'feature/lower-iram-utilization-of-heap-component_v4.4' into 'release/v4.4' 2023-02-07 16:54:58 +08:00
esp_timer esp_timer: fix ESP_TIMER_ISR dispatch method due to off by one error 2022-11-10 15:03:15 +08:00
esp_websocket_client
esp_wifi esp_wifi:bugfix for optimize abnormal beacon log 2023-02-06 14:52:46 +08:00
esp-tls esp_tls: Fix issue when timeout is not explicitly given in esp_tls_cfg_t 2022-12-21 14:42:44 +05:30
espcoredump coredump: custom core dump stack is now supported on Xtensa targets 2022-12-26 12:24:26 +01:00
esptool_py re-enable some dummy based HPM flash chips 2022-09-30 11:29:43 +08:00
expat expat: Upgrade version to release v2.5.0 2022-11-28 13:55:21 +05:30
fatfs fatfs: fix incorrect mtime returned for files created during DST 2022-06-09 22:02:46 +02:00
freemodbus freemodbus: remove component files from esp-idf (backport v4.4) 2022-12-22 17:05:55 +08:00
freertos Merge branch 'contrib/github_pr_10199_v4.4' into 'release/v4.4' 2022-12-22 19:28:20 +08:00
hal Merge branch 'feature/usb_host_feature_and_refactor_backports_v4.4' into 'release/v4.4' 2023-02-07 17:54:35 +08:00
heap Merge branch 'feature/lower-iram-utilization-of-heap-component_v4.4' into 'release/v4.4' 2023-02-07 16:54:58 +08: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
libsodium
linux
log esp_log: add note about reentrancy for custom logging function 2021-09-14 16:57:15 +05:30
lwip lwip: fix the bug that long time to get IP 2022-12-07 11:24:13 +08:00
mbedtls Merge branch 'update_v4.4/mbedtls_v2.28.2' into 'release/v4.4' 2023-02-02 22:27:22 +08:00
mdns mdns: Fix add_service() to report error if no-hostname 2022-08-19 18:41:38 +02:00
mqtt Merge branch 'feature/mqtt_cmakefile_cleanup_v4.4' into 'release/v4.4' 2022-11-25 19:27:08 +08:00
newlib newlib: dirent d_ino type fix 2022-06-21 14:40:13 +01:00
nghttp
nvs_flash refactor(nvs): custom allocator for all objects allocated in NVS 2022-12-26 15:06:38 +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 partition_table: add a test for total partition size error 2022-04-19 14:00:11 +00:00
perfmon
protobuf-c protobuf-c: Update submodule to v1.4.0 2022-06-07 15:59:39 +05:30
protocomm wifi_provisioning : Increased 1 byte of BLE advertising device name to store '\0', at the end, to ensure we adhere to the max name length as per spec. 2022-09-27 16:09:11 +05:30
pthread feat (pthread): reader-writer locks implementation 2021-11-08 10:21:37 +08:00
riscv C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-05 18:16:08 +08:00
sdmmc docs: fix typo in header files 2021-12-14 11:01:17 +08:00
soc Merge branch 'feature/usb_host_feature_and_refactor_backports_v4.4' into 'release/v4.4' 2023-02-07 17:54:35 +08:00
spi_flash Merge branch 'bugfix/fix_mspi_timing_tuning_psram_timing_issue_v4.4' into 'release/v4.4' 2023-02-06 11:11:07 +08:00
spiffs C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-05 18:16:08 +08:00
tcp_transport [tcp_transport] Fix initialition of transport 2022-09-12 11:49:25 +02:00
tcpip_adapter esp_wifi: support station only mode for code size down 2021-12-06 17:34:56 +08:00
tinyusb tinyusb: fix typo naming of ACM 2022-09-22 20:33:31 +08:00
touch_element docs: fix all doxygen warnings 2022-07-05 11:14:40 +08:00
ulp ulp-riscv: ULP RISC-V I2C example gets stuck on esp32s2 2023-01-02 14:24:16 +01:00
unity
usb usb: Fix incorrect bmRequestType direction flag in USB Host Library 2022-12-13 22:28:02 +08:00
vfs Merge branch 'feature/semihosting_call_number_change_v4.4' into 'release/v4.4' 2022-06-06 20:31:19 +08:00
wear_levelling
wifi_provisioning Wifi Prov: Disabled the default support for BLE Encrpytion on characteristics read /write 2022-11-25 14:18:15 +05:30
wpa_supplicant Merge branch 'bugfix/bdsa_security_issues_v4.4' into 'release/v4.4' 2023-02-06 12:12:09 +08:00
xtensa coredump: custom core dump stack is now supported on Xtensa targets 2022-12-26 12:24:26 +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.