esp-idf/components
Tomas Rohlinek b5ac4fbdf9 Merge branch 'fix/esp_vfs_register_fd_range_warning_message' into 'master'
fix(storage/vfs): incorrect log level in esp_vfs_register_fd_range

Closes IDFGH-13421

See merge request espressif/esp-idf!35682
2024-12-19 22:22:31 +08:00
..
app_trace fix(sysview): add prefix to the module desc to avoid stuck in Segger SystemView app 2024-11-21 20:30:26 +01:00
app_update feat(esp32h21): introduce target esp32h21(stage 1) 2024-11-12 15:42:27 +08:00
bootloader Merge branch 'feature/enable_rsa_based_secure_boot_for_c5_eco1' into 'master' 2024-12-04 18:00:34 +08:00
bootloader_support Merge branch 'feat/h21_introduce_step2_3' into 'master' 2024-12-14 18:58:14 +08:00
bt Merge branch 'fix/blufi_example_mem_access' into 'master' 2024-12-19 15:06:52 +08:00
cmock
console feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
cxx
driver Merge branch 'feat/c5_twaifd_lowlevel_support' into 'master' 2024-12-19 11:27:29 +08:00
efuse feat(esp32h21): add H21 efuse files (stage3) 2024-12-18 11:46:21 +08:00
esp-tls feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_adc fix(adc): fixed adc_cali_check_scheme wrong return on c2/h2/c6 2024-12-17 11:35:42 +08:00
esp_app_format feat(esp_tee): Support for ESP-TEE - `esptool_py`, `esp_rom` & other components 2024-12-02 11:27:58 +05:30
esp_bootloader_format
esp_coex Merge branch 'bugfix/protocols_examples_common_driver_dep' into 'master' 2024-11-14 22:21:57 +08:00
esp_common feat(esp_htttps_ota): handle case if server retured 304 not_modified during ota 2024-12-02 17:23:30 +08:00
esp_driver_ana_cmpr refactor(ana_cmpr): use enum types in ll 2024-12-12 10:46:54 +08:00
esp_driver_cam feat(dvp_isp_dsi_example): add an example shows DVP-ISP-DSI combination 2024-12-05 17:20:58 +08:00
esp_driver_dac
esp_driver_gpio fix(gpio): fix pu, pd, drv value incorrect from gpio_dump_io_configuration on esp32 2024-12-18 22:38:25 +08:00
esp_driver_gptimer feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_driver_i2c fix(i2c_slave): Fix the wrong semaphore take in isr 2024-12-04 11:36:49 +08:00
esp_driver_i2s fix(i2s): fixed i2s coverity issue 2024-12-18 16:23:29 +08:00
esp_driver_isp change(isp): enable yuv submodules 2024-12-05 17:21:05 +08:00
esp_driver_jpeg fix(driver): issues reported by coverity 2024-11-27 09:57:37 +08:00
esp_driver_ledc refactor(ledc): deprecate ledc_timer_set API 2024-12-05 19:02:33 +08:00
esp_driver_mcpwm feat(mcpwm): support mcpwm sleep retention on p4 2024-11-21 11:55:58 +08:00
esp_driver_parlio feat(parlio_tx): add check of fifo empty event 2024-12-04 14:50:16 +08:00
esp_driver_pcnt feat(pcnt): support step_notify on esp32h2 eco5 2024-12-11 16:57:09 +08:00
esp_driver_ppa feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_driver_rmt feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_driver_sdio
esp_driver_sdm
esp_driver_sdmmc fix(sdmmc): fixed wrong emmc test (should be sdmmc) 2024-12-12 15:51:14 +08:00
esp_driver_sdspi refactor(spi): hal driver doesn't depend on sdkconfig.h 2024-12-04 19:10:57 +08:00
esp_driver_spi fix(driver_spi): fixed slave_hd driver transaction alignment check 2024-12-13 16:15:43 +08:00
esp_driver_touch_sens
esp_driver_tsens change(esp_hw_support): update some modules sleep retention init dependency bitmap 2024-11-18 15:40:47 +08:00
esp_driver_uart feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_driver_usb_serial_jtag feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_eth fix(esp_eth): fix openeth driver to consider MAC address set in QEMU 2024-12-10 12:29:10 +01:00
esp_event
esp_gdbstub feat(gdbstub): add riscv xesppie extension support 2024-12-19 14:07:04 +07:00
esp_hid feat(ble/bluedroid): Support setting connection params when creating connection 2024-11-26 12:10:27 +08:00
esp_http_client fix(esp_http_client): updated API esp_http_client_get_url to get URL in correct format 2024-12-18 12:00:55 +05:30
esp_http_server feat(esp_http_server): add support to handle HTTP 1.0 requests 2024-12-11 15:32:32 +05:30
esp_https_ota Merge branch 'bug/overflowed_constant_in_app_update' into 'master' 2024-12-06 15:52:23 +08:00
esp_https_server feat(esp_https_server): Updated the ESP_TLS_SERVER_CERT_SELECT_HOOK config 2024-11-14 14:48:50 +05:30
esp_hw_support fix(gpio): fix pu, pd, drv value incorrect from gpio_dump_io_configuration on esp32 2024-12-18 22:38:25 +08:00
esp_lcd feat(lcd): support parlio lcd interface 2024-12-04 14:50:16 +08:00
esp_local_ctrl
esp_mm feat(esp_tee): Support for ESP-TEE - `esp_system` component 2024-12-02 12:20:04 +05:30
esp_netif Merge branch 'fix/esp_netif_ppp_nullptr_check' into 'master' 2024-12-05 17:16:04 +08:00
esp_netif_stack
esp_partition feat(esp_tee): Support for ESP-TEE - `esptool_py`, `esp_rom` & other components 2024-12-02 11:27:58 +05:30
esp_phy fix(phy): fixed calibration warning infomation inaccurate issue 2024-12-10 16:22:57 +08:00
esp_pm fix(esp_hw_support): fix mspi clock freq changed after lightsleep 2024-12-13 15:47:49 +08:00
esp_psram refactor(spi): hal driver doesn't depend on sdkconfig.h 2024-12-04 19:10:57 +08:00
esp_ringbuf fix(ringbuf): fixed logic errors when compiling with CONFIG_COMPILER_STATIC_ANALYZER 2024-11-19 11:12:39 +08:00
esp_rom feat(esp32h21): add H21 esp_rom files (stage3) 2024-12-18 11:58:34 +08:00
esp_security feat(esp32h21): introduce target esp32h21(stage 1) 2024-11-12 15:42:27 +08:00
esp_system Merge branch 'fix/esp32p4_unexpected_reset' into 'master' 2024-12-19 16:53:00 +08:00
esp_tee feat(esp_tee): Support for ESP-TEE - the `main` component 2024-12-02 12:20:05 +05:30
esp_timer
esp_vfs_console feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
esp_wifi fix(wifi): expend bit width of channel in rxctrl 2024-12-09 19:52:36 +08:00
espcoredump change(coredump): include coredump own stack into coredump file 2024-12-18 10:19:39 +03:00
esptool_py feat(esp_tee): Support for ESP-TEE - `esptool_py`, `esp_rom` & other components 2024-12-02 11:27:58 +05:30
fatfs feat(fatfs): add support for a few fcntl commands 2024-12-03 15:32:58 +01:00
freertos feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
hal Merge branch 'contrib/github_pr_14923' into 'master' 2024-12-19 21:02:50 +08:00
heap fix(heap): MALLOC_CAP_EXEC does not allocate in RTC IRAM 2024-12-09 09:34:56 +01:00
http_parser
idf_test feat(esp32h21): introduce target esp32h21(stage 1) 2024-11-12 15:42:27 +08:00
ieee802154 Merge branch 'feature/add_rx_buff_statistic' into 'master' 2024-12-12 19:55:07 +08:00
json
linux
log feat(log): Update esp_log_buffer 2024-12-03 18:03:06 +08:00
lwip feat(lwip): Declare additional POSIX API if available 2024-12-17 11:18:42 +01:00
mbedtls fix(esp_crt_bundle): remove expired DST Root CA X3 from bundle 2024-12-19 08:40:16 +05:30
mqtt
newlib feat(newlib): add dummy implementations of pathconf, chmod, dirfd 2024-12-03 15:32:57 +01:00
nvs_flash feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
nvs_sec_provider
openthread fix(openthread): fix a naming error of kconfig 2024-12-16 16:42:39 +08:00
partition_table feat(esp_tee): Support for ESP-TEE - `esptool_py`, `esp_rom` & other components 2024-12-02 11:27:58 +05:30
perfmon
protobuf-c
protocomm fix(protocomm): Added check for cur_cookie_session_id 2024-12-03 14:48:46 +05:30
pthread feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
riscv feat(esp_tee): Support for ESP-TEE - `riscv` component 2024-12-02 12:20:04 +05:30
rt
sdmmc Merge branch 'feat/sdmmc_uhs_tuning' into 'master' 2024-11-13 11:05:10 +08:00
soc Merge branch 'feat/c5_twaifd_lowlevel_support' into 'master' 2024-12-19 11:27:29 +08:00
spi_flash fix(spi_flash): fixed no_os flash API not consider branch predictor on c5/c61 2024-12-18 16:41:35 +08:00
spiffs feat(storage/spiffs): move spiffs to new VFS API 2024-11-21 07:41:41 +01:00
tcp_transport Merge branch 'bugfix/ws_head_buf_size' into 'master' 2024-12-05 16:22:56 +08:00
touch_element
ulp feat(newlib): add picolibc support 2024-12-02 21:35:56 +07:00
unity
usb feat(usb_host): Mock USB device open/close 2024-12-16 16:55:37 +01:00
vfs fix(storage/vfs): incorrect log level in esp_vfs_register_fd_range 2024-12-16 15:12:11 +01:00
wear_levelling fix(wear_levelling): Fix coverity issue overflowed constant in WL_Flash.cpp 2024-11-26 09:50:22 +01:00
wifi_provisioning fix(esp_wifi_prov): Send failure msg on first fail 2024-11-28 15:00:54 +05:30
wpa_supplicant fix(wpa_supplicant): remove duplicated code (endian.h) that exists in newlib component 2024-12-02 20:26:26 +07:00
xtensa fix(xtensa): fix confusing backtrace when PC is invalid 2024-12-02 21:36:00 +07: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) includes hal, arch (where arch is either riscv or xtensa depending on the chip), esp_rom, esp_common, and soc. This group contains information about and provides low-level access to the underlying hardware. In the case of esp_common, it contains hardware-agnostic code and utilities. These components may have dependencies on each other within the group, but outside dependencies should be minimized. The reason for this approach is that these components are fundamental, and many other components may require them. Ideally, the dependency relationship only goes one way, making it easier for this group to be usable in other projects.

The second group (referred to as G1) operates at a higher level than the first group. G1 includes the components esp_hw_support, esp_system, newlib, spi_flash, freertos, log, and heap. Like the first group, circular dependencies within this group are allowed, and these components can have dependencies on the first group. G1 components represent essential software mechanisms for 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_mm

Memory management. Currently, this encompasses:

  • Memory mapping for MMU supported memories
  • Memory synchronisation via Cache
  • Utils such as APIs to convert between virtual address and physical address

esp_psram

Contains implementation of PSRAM services

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.