esp-idf/components
morris c41bb46d92 Merge branch 'bugfix/ledc_glb_clk_compiler_warning_v5.0' into 'release/v5.0'
ledc: Fix -Werror=maybe-uninitialized warning on glb_clk variable on ESP32 (v5.0)

See merge request espressif/esp-idf!21941
2023-01-17 10:30:11 +08:00
..
app_trace sysview: Adds FreeRTOS SMP port 2022-09-07 13:47:26 +03:00
app_update partition: use esp_partition_munmap instead of spi_flash_munmap 2022-11-10 11:26:51 +08:00
bootloader all: Apply new version logic (major * 100 + minor) 2023-01-06 02:00:52 +08:00
bootloader_support Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
bt Merge branch 'staging/esp_static_assert_v5.0' into 'release/v5.0' 2022-12-20 20:53:02 +08:00
cmock
console console: argtable3: upgrade to v3.2.2 2022-11-09 10:59:39 +01:00
cxx cxx: fixed stack smash test case failing due to changed output 2022-12-14 12:37:23 +01:00
driver ledc: Fix -Werror=maybe-uninitialized warning on glb_clk variable on specific kconfig options selected 2023-01-07 17:29:45 +08:00
efuse all: Apply new version logic (major * 100 + minor) 2023-01-06 02:00:52 +08:00
esp_adc adc: no longer support adc2 oneshot mode on esp32c3 2022-12-16 12:07:38 +08:00
esp_app_format C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-19 15:06:15 +01:00
esp_common Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
esp_eth Merge branch 'feature/emac_buff_v5.0' into 'release/v5.0' 2022-12-21 23:35:30 +08:00
esp_event WDT: implement interrupt wdt and task wdt for ESP32-C2 2022-12-01 10:45:35 +00:00
esp_gdbstub gdbstub: fixed build-error due to potentially uninitialized variable on -O2 2022-09-21 03:08:50 +00:00
esp_hid optimize HID Host disconnection procedure 2022-11-25 08:54:04 +08:00
esp_http_client fix: esp_http_client fix behaviour when disable_auto_redirect is enabled 2022-11-14 15:56:17 +05:30
esp_http_server esp_http_server: Added support for esp_events 2022-12-29 18:08:38 +05:30
esp_https_ota docs: Update esp_https_ota docs to have information about OTA events 2022-12-21 10:39:35 +05:30
esp_https_server Merge branch 'bugfix/fix_esp_https_server_initialize_v5.0' into 'release/v5.0' 2022-12-08 16:00:14 +08:00
esp_hw_support esp32c2: fixed chip revision of ECO2 2023-01-06 02:00:52 +08:00
esp_lcd Merge branch 'bugfix/esp_lcd_modify_bounce_buffer_index_v5.0' into 'release/v5.0' 2022-12-21 10:48:18 +08:00
esp_local_ctrl esp_local_ctrl: Add support for insecure HTTP server transport 2022-12-28 11:17:10 +05:30
esp_netif esp_netif: Post IP event for PPP netifs unconditionally 2022-12-16 18:32:55 +01:00
esp_partition partition: use esp_partition_munmap instead of spi_flash_munmap 2022-11-10 11:26:51 +08:00
esp_phy Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
esp_pm Merge branch 'ci/upload_elf_map_to_minio_v5.0' into 'release/v5.0' 2022-12-05 18:17:59 +08:00
esp_psram all: Apply new version logic (major * 100 + minor) 2023-01-06 02:00:52 +08:00
esp_ringbuf Storage: Partition APIs moved to the new component 'esp_partition' 2022-11-02 21:49:08 +01:00
esp_rom Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
esp_system Merge branch 'bugfix/esp32s3_int_wdt_v5.0' into 'release/v5.0' 2023-01-12 16:19:27 +08:00
esp_timer Merge branch 'feature/add_int_task_wdt_esp32c2_v5.0' into 'release/v5.0' 2022-12-05 16:38:35 +08:00
esp_wifi esp_wifi: Fix missing disconnected callback 2023-01-13 13:27:32 +05:30
esp-tls esp_tls: Fix issue when timeout is not explicitly given in esp_tls_cfg_t 2022-12-21 14:42:33 +05:30
espcoredump ci: Fix environment variable IDF_CI_BUILD is not set 2023-01-06 02:00:52 +08:00
esptool_py all: Apply new version logic (major * 100 + minor) 2023-01-06 02:00:52 +08:00
fatfs Storage: Partition APIs moved to the new component 'esp_partition' 2022-11-02 21:49:08 +01:00
freertos Merge branch 'contrib/github_pr_10199_v5.0' into 'release/v5.0' 2022-12-21 19:56:13 +08:00
hal Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
heap Merge branch 'staging/esp_static_assert_v5.0' into 'release/v5.0' 2022-12-20 20:53:02 +08:00
http_parser
idf_test freertos: fix inlining for xtensa port 2022-07-07 09:04:51 +00:00
ieee802154 openthread: Add some flash optimization options for openthread component 2022-09-29 09:40:05 +08:00
json
linux
log log: fix -Wformat issue when uint32_t == unsigned long 2022-08-03 16:42:47 +04:00
lwip lwip:optimization dns ipv4 ipv6 timeir 2022-12-06 16:06:57 +08:00
mbedtls mbedtls: GCM implementation is replaced with CTR-based calculation 2023-01-09 18:37:07 +05:30
mqtt Merge branch 'feature/mqtt_cmakefile_cleanup_v5.0' into 'release/v5.0' 2022-12-05 20:43:10 +08:00
newlib Storage: Partition APIs moved to the new component 'esp_partition' 2022-11-02 21:49:08 +01:00
nvs_flash Storage: Partition APIs moved to the new component 'esp_partition' 2022-11-02 21:49:08 +01:00
openthread openthread: Add some flash optimization options for openthread component 2022-09-29 09:40:05 +08:00
partition_table parttool: fix extra_partition_subtypes attribute parsing 2022-11-24 10:45:05 +05:30
perfmon build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
protobuf-c protobuf-c: Update submodule to v1.4.0 2022-05-30 09:54:31 +05:30
protocomm protocomm: Increase Bluedroid-BLE maximum buffer size 2022-10-27 09:56:10 +05:30
pthread build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
riscv C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-19 15:06:15 +01:00
sdmmc build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
soc Merge branch 'feature/apply_new_version_logic_v5.0' into 'release/v5.0' 2023-01-12 16:18:23 +08:00
spi_flash C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-19 15:06:15 +01:00
spiffs C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-19 15:06:15 +01:00
tcp_transport Merge branch 'feature/mqtt_cmakefile_cleanup_v5.0' into 'release/v5.0' 2022-12-05 20:43:10 +08:00
touch_element build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
ulp Merge branch 'bugfix/s3_ulp_riscv_cocpu_trap_v5.0' into 'release/v5.0' 2022-12-05 14:50:48 +08:00
unity ci: Fix environment variable IDF_CI_BUILD is not set 2023-01-06 02:00:52 +08:00
usb C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-19 15:06:15 +01:00
vfs vfs: use recommended esp_cpu_dbgr_is_attached API 2022-09-01 13:18:17 +02:00
wear_levelling Storage: Partition APIs moved to the new component 'esp_partition' 2022-11-02 21:49:08 +01:00
wifi_provisioning Changed wifi provisioning scan method 2022-12-31 18:09:45 +05:30
wpa_supplicant wpa_supplicant: Set PMK from PMKSA incase of caching 2023-01-11 11:17:02 +05:30
xtensa xtensa: fix swapped breakpoint and watchpoint numbers 2022-07-25 09:43:10 +02:00
README.md riscv: Remove redundant riscv_interrupts.h header 2022-09-19 14:19:11 +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
  • 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.