esp-idf/components
andylinpersonal 88c476e630 fix(ulp): Add the missing extern "C" guard to ulp_lp_core_print.h
This commit adds the missing extern `C` guards the ulp_lp_core_print.h
header file.

Closes https://github.com/espressif/esp-idf/pull/14329
2024-08-13 23:08:30 +02:00
..
app_trace Merge branch 'fix/gcov_win_mixed_path' into 'master' 2024-04-11 13:56:10 +08:00
app_update fix(bootloader_support): Make esp_flash_encrypt.h independent of spi_flash_mmap.h header 2024-05-20 14:40:49 +08:00
bootloader fix(system): place idf's stray sections while linking 2024-05-20 13:31:04 +04:00
bootloader_support fix(ci): fix the readme check of c5 mp 2024-07-30 15:40:19 +08:00
bt fix(nimble): Modify Advertising Tx power levels 2024-08-03 14:42:10 +05:30
cmock
console fix(console): USB Serial JTAG freezes when input received before init 2024-07-15 10:17:00 +02:00
cxx fix(cxx): use __cxa_throw() stub in case exceptions disabled 2024-05-07 08:52:36 +04:00
driver fix(ci): fix the readme check of c5 mp 2024-07-30 15:40:19 +08:00
efuse fix(ci): fix the readme check of c5 mp 2024-07-30 15:40:19 +08:00
esp_adc change(adc): refactor DMA memory allocation 2024-06-25 13:49:24 +08:00
esp_app_format ci(esp32c5mp): disable the unsupported tests 2024-04-07 12:13:29 +08:00
esp_bootloader_format
esp_coex fix(coex): Fixed coexist scheme phase index overflow issue 2024-07-23 17:56:01 +08:00
esp_common test(psram): enable bss psram test 2024-07-15 15:58:00 +08:00
esp_driver_ana_cmpr
esp_driver_cam Merge branch 'feature/dvp_cam_driver_optimize_v5.3' into 'release/v5.3' 2024-07-25 16:46:56 +08:00
esp_driver_dac fix(kconfig): fixed peripheral driver kconfig inconsistencies 2024-06-04 10:19:31 +08:00
esp_driver_gpio Merge branch 'feature/esp32c5_mp_gpio_support_v5.3' into 'release/v5.3' 2024-06-12 00:51:06 +08:00
esp_driver_gptimer fix(ci): fix the readme check of c5 mp 2024-07-30 15:40:19 +08:00
esp_driver_i2c fix(i2c): Fix i2c not release semaphore in command send loop, 2024-07-08 15:12:49 +08:00
esp_driver_i2s refactor(i2s): clean up DMA buffer allocation 2024-06-12 10:16:24 +08:00
esp_driver_isp feat(isp_ccm): support isp color correction matrix (v5.3) 2024-07-31 11:16:17 +08:00
esp_driver_jpeg fix(jpeg): Modify jpeg deocde/encode error handling logic (backport v5.3) 2024-06-10 03:28:52 +08:00
esp_driver_ledc ci: disable failing esp32c5 builds 2024-06-18 08:27:00 +02:00
esp_driver_mcpwm fix(rmt): calarify partial receive is not support on esp32 2024-04-07 14:33:39 +08:00
esp_driver_parlio fix(parlio): fix cache sync issue on P4 2024-07-30 19:46:35 +08:00
esp_driver_pcnt fix(kconfig): fixed peripheral driver kconfig inconsistencies 2024-06-04 10:19:31 +08:00
esp_driver_ppa feat(ppa): add test cases to test PPA data correctness 2024-06-11 21:59:05 +08:00
esp_driver_rmt fix(rmt): fix gcc static analyzer warnings 2024-07-17 18:42:32 +08:00
esp_driver_sdio feat(sdmmc_io): support sending CMD53 with fixed address 2024-05-24 20:27:57 +08:00
esp_driver_sdm fix(kconfig): fixed peripheral driver kconfig inconsistencies 2024-06-04 10:19:31 +08:00
esp_driver_sdmmc ci(sdmmc): enable tests for ESP32-P4 2024-07-31 18:39:40 +02:00
esp_driver_sdspi
esp_driver_spi fix(spi_slave_hd): fix seg mode potential iwdt timeout when multi task call 2024-07-30 19:38:45 +08:00
esp_driver_touch_sens refactor(touch): refactor the filter configuration 2024-07-13 15:47:20 +08:00
esp_driver_tsens fix(kconfig): fixed peripheral driver kconfig inconsistencies 2024-06-04 10:19:31 +08:00
esp_driver_uart fix(uart): fix uart_config_t structure size difference in C and C++ 2024-07-31 15:15:59 +08:00
esp_driver_usb_serial_jtag refactor(usb-serial-jtag): usb-serial-jtag driver simplification to fix rom print coexistence 2024-07-29 11:44:15 +08:00
esp_eth feat(esp_eth): enable openeth in QEMU for ESP32-S3 2024-07-30 19:37:32 +08:00
esp_event
esp_gdbstub
esp_hid Fix stack overflow bug for examples/bluetooth/esp_hid_device when using esp32s3 with nimble 2024-06-14 14:28:59 +05:30
esp_http_client fix: fixed allocating if_name in client context multiple times 2024-07-07 21:19:42 +08:00
esp_http_server fix: Add warning to enable LWIP_NETIF_LOOPBACK to use control socket API 2024-05-20 10:43:41 +05:30
esp_https_ota
esp_https_server fix(esp_https_server): fix memory leak during configuring http server 2024-05-07 13:51:38 +05:30
esp_hw_support fix(startup): move rtc initialization before MSPI timing tuning to improve stability 2024-08-05 00:35:10 +08:00
esp_lcd change(examples): set the ili9881c version to 0.2.x 2024-08-05 11:01:40 +08:00
esp_local_ctrl
esp_mm fix(mmu_map): make a static function force inline in order not be put in flash 2024-08-05 11:00:50 +08:00
esp_netif Merge branch 'fix/netif_ppp_ip6_autoconfig_v5.3' into 'release/v5.3' 2024-08-02 13:43:51 +08:00
esp_netif_stack
esp_partition fix(bootloader_support): Make esp_flash_encrypt.h independent of spi_flash_mmap.h header 2024-05-20 14:40:49 +08:00
esp_phy fix(phy): add phy calibration data check when mode is not none calibration 2024-06-24 20:05:09 +08:00
esp_pm change(esp_hw_support): do timergroup watchdogs retention by needs 2024-06-13 14:08:26 +08:00
esp_psram Merge branch 'feat/support_psram_aps3204l_v5.3' into 'release/v5.3' 2024-07-29 16:00:25 +08:00
esp_ringbuf
esp_rom Merge branch 'feature/ulp_hp_core_printf_debug_v5.3' into 'release/v5.3' 2024-08-02 14:05:55 +08:00
esp_system fix(startup): move rtc initialization before MSPI timing tuning to improve stability 2024-08-05 00:35:10 +08:00
esp_timer test(misc): enable misc tests that have been missed during bringup 2024-06-28 15:02:03 +08:00
esp_vfs_console fix(storage/vfs_console): remove possible infinite recursion 2024-06-10 16:07:49 +02:00
esp_wifi fix(wifi): Avoid internal retries for offchannel FTM Requests 2024-08-02 10:41:49 +05:30
esp-tls fix(esp-tls): Fix compilation for linux target on macos 2024-05-13 13:44:25 +02:00
espcoredump fix(coredump): fix array out of the bounds error 2024-08-01 16:16:52 +08:00
esptool_py Merge branch 'feat/add_merged_bin_cmd' into 'master' 2024-04-22 17:55:36 +08:00
fatfs fix(vfs): FATFS mount immediately after format if mount failed 2024-07-29 17:58:49 +08:00
freertos fix(freertos): Fixed memory leak issue in vTaskDeleteWithCaps() 2024-07-30 19:45:52 +08:00
hal Merge branch 'feat/gpspi_flash_support_v5.3' into 'release/v5.3' 2024-08-05 17:13:53 +08:00
heap ci(system): disable c5 system tests 2024-07-30 13:19:04 +08:00
http_parser
idf_test feat(adc): support ADC continuous mode on ESP32P4 2024-06-12 18:34:04 +08:00
ieee802154 fix(ieee802154): refactor the next opteration logic for multiple events 2024-07-29 11:16:37 +08:00
json feat(cjson): update submodule to v1.7.18 2024-05-22 13:34:31 +05:30
linux
log
lwip fix(lwip): Fixed compilation error referencing undefined POSIX interface API 2024-07-30 19:36:18 +08:00
mbedtls Merge branch 'fix/fix_aes_dma_desc_align_v5.3' into 'release/v5.3' 2024-07-26 11:46:23 +08:00
mqtt feat(esp_eth): a new folder structure of the driver and other improvements 2024-06-07 15:26:18 +02:00
newlib Merge branch 'fix/fix-gcc13-dirent-breaking_v5.3' into 'release/v5.3' 2024-08-02 16:26:05 +08:00
nvs_flash fix(bootloader_support): Make esp_flash_encrypt.h independent of spi_flash_mmap.h header 2024-05-20 14:40:49 +08:00
nvs_sec_provider
openthread feat(openthread): add task switching lock holder check 2024-07-31 11:33:40 +08:00
partition_table
perfmon
protobuf-c
protocomm fix(wifi_prov): Use calloc instead of malloc to zero initialize variable 2024-08-02 10:35:51 +05:30
pthread fix(pthread): Remove TLS pointer/deletion callback from correct thread 2024-07-30 19:39:17 +08:00
riscv fix(riscv): fix a that affected mintstatus CSR value in the CLIC 2024-07-26 13:57:14 +08:00
sdmmc Merge branch 'feat/sdmmc_spi_no_crc_v5.3' into 'release/v5.3' 2024-07-10 17:15:24 +08:00
soc Merge branch 'feature/support_uart_sleep_retention_v5.3' into 'release/v5.3' 2024-07-31 22:07:59 +08:00
spi_flash fix(spi_flash): Add external flash support on esp32c6,esp32h2,esp32p4 2024-08-05 11:47:55 +08:00
spiffs ci(esp32c5mp): disable the unsupported tests 2024-04-07 12:13:29 +08:00
tcp_transport fix(ws_transport): utility functions minor improvments 2024-05-20 17:54:43 +04:00
touch_element
ulp fix(ulp): Add the missing extern "C" guard to ulp_lp_core_print.h 2024-08-13 23:08:30 +02:00
unity
usb Merge branch 'feature/usb_host_multi_configuration_backport_v5.3' into 'release/v5.3' 2024-08-02 11:45:29 +08:00
vfs fix(vfs): make case eventfd_select_block exit normally 2024-04-18 11:29:25 +08:00
wear_levelling
wifi_provisioning fix(wifi_prov): Added API to set random address 2024-07-24 20:52:37 +05:30
wpa_supplicant fix(wpa_supplicant):Deinit old dpp authentication data after receiving config. 2024-07-30 13:57:42 +05:30
xtensa
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.