esp-idf/components
zhangyanjiao ce4b54361e esp_wifi:
1. mesh: layer2 node will scan all channels when fixed root leave
2. show warning info when setting max connection num for softAP
2023-05-26 11:33:33 +08:00
..
app_trace Modifies the argument of the sizeof statement to a legitimate array name 2023-04-21 18:44:06 +08:00
app_update esp_app_format: IRAM space optimization 2023-05-17 23:40:59 +08:00
bootloader nvs_flash: Add support for HMAC-based NVS encryption keys protection scheme 2023-05-23 13:55:52 +05:30
bootloader_support esp_hw_support/bootloader: made ESP32-C6 and ESP32-H2 RNG available 2023-05-23 18:14:51 +08:00
bt Nimble: Fixes for memory leak / optimization 2023-05-23 11:56:23 +05:30
cmock
console Merge branch 'fix/console-build-error' into 'master' 2023-05-04 20:15:42 +08:00
cxx ci: update test apps to use run_all_single_board_cases 2023-03-10 14:27:09 +08:00
driver adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
efuse Merge branch 'feature/adds_new_efuses_for_h2' into 'master' 2023-05-25 14:36:50 +08:00
esp_adc adc: add digi monitor test case 2023-05-24 17:46:52 +08:00
esp_app_format esp_app_format: IRAM space optimization 2023-05-17 23:40:59 +08:00
esp_bootloader_format esp_bootloader_format: Adds bootloader description structure to read bootloader version from app 2023-05-10 21:39:52 +08:00
esp_coex esp32h4: removed esp32h4 related codes 2023-04-23 12:03:07 +00:00
esp_common nvs_flash: Added helper component nvs_sec_provider 2023-05-23 13:55:53 +05:30
esp_eth Merge branch 'contrib/github_pr_11337' into 'master' 2023-05-23 13:23:51 +08:00
esp_event esp_event: fix build error related to format 2023-05-23 09:09:45 +02:00
esp_gdbstub esp_gdbstub: fix bp and wp numbers 2023-05-19 20:15:58 +08:00
esp_hid fix HID Host bug when handling the two consecutive connection request 2023-03-09 14:25:25 +08:00
esp_http_client Set state to HTTP_STATE_REQ_COMPLETE_HEADER prior to calling the 2023-05-17 14:06:51 +05:30
esp_http_server feat(httpd): add support for asynchronous request handling 2023-05-19 10:05:42 +05:30
esp_https_ota esp_https_ota: Set user configurable ota authorization retries 2023-03-29 17:29:31 +05:30
esp_https_server esp_https_server: Add dependency on MBEDTLS_TLS_SERVER config 2022-12-16 10:30:41 +05:30
esp_hw_support Merge branch 'bugfix/add_warning_for_rc_fast_calibration_h2' into 'master' 2023-05-25 21:39:02 +08:00
esp_lcd rgb_lcd: make pclk gpio setting optional 2023-05-08 14:55:26 +08:00
esp_local_ctrl esp_local_ctrl: Fix header inclusion 2023-01-12 16:16:45 +05:30
esp_mm ci: remove redundent ci configs for chip support and network components 2023-04-26 09:54:29 +08:00
esp_netif fix(c++): invalid conversion from int to enumeration 2023-05-12 15:08:53 +08:00
esp_netif_stack esp-netif: Support non-lwip mode, add test 2022-12-14 14:12:50 +00:00
esp_partition support SPI_FLASH_ENABLE_COUNTERS feature on esp_flash driver and rename the functions to esp_flash_xx 2023-04-06 11:40:40 +08:00
esp_phy esp_phy: updating H2 lib phy to adapt the voltage changes 2023-05-24 14:11:48 +08:00
esp_pm feature: support configuration of sleep clock calibration frequency 2023-05-04 12:09:26 +08:00
esp_psram psram: supported 32MB psram on ESP32S3 2023-05-15 15:36:43 +08:00
esp_ringbuf ci: fixed test apps overriding pytest configs 2023-04-26 11:07:35 +08:00
esp_rom compiler: replaced noreturn by __noreturn__ in header files 2023-05-11 16:07:45 +08:00
esp_system Merge branch 'feature/esp_ipc_isr_fix' into 'master' 2023-05-24 23:17:37 +08:00
esp_timer ci: fix invalid kconfig options in system test apps 2023-05-09 11:27:55 +08:00
esp_wifi esp_wifi: 2023-05-26 11:33:33 +08:00
esp-tls lwip/linux: Add lwip support for networking component under linux 2023-05-05 05:03:39 +00:00
espcoredump esp_app_format: IRAM space optimization 2023-05-17 23:40:59 +08:00
esptool_py build-system: replace ADDITIONAL_MAKE_CLEAN_FILES with ADDITIONAL_CLEAN_FILES 2023-05-08 15:51:48 +08:00
fatfs Merge branch 'fix/cd_input_sd_mode_fails' into 'master' 2023-05-15 17:37:29 +08:00
freertos freertos/linux: Fix use after scope exit in select() wrap 2023-05-15 10:28:54 +02:00
hal Merge branch 'fix/xts_aes_register_prefix_discrepency' into 'master' 2023-05-25 16:40:13 +08:00
heap ci: fix invalid kconfig options in system test apps 2023-05-09 11:27:55 +08:00
http_parser
idf_test adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
ieee802154 ieee802154: fix a typo in set_channel API 2023-05-17 14:11:34 +08:00
json
linux lwip/linux: Add lwip support for networking component under linux 2023-05-05 05:03:39 +00:00
log log: Add master log option 2023-05-18 18:35:19 +08:00
lwip netdb:fixed bug for getaddrinfo returns null when IPV4 mapped address 2023-05-12 03:07:14 +00:00
mbedtls Merge branch 'contrib/github_pr_11402' into 'master' 2023-05-19 10:59:33 +08:00
mqtt ci: Migrateunit test for mqtt test to unit test app 2023-03-24 10:32:43 +01:00
newlib ci: misc fixes for newlib test app 2023-05-10 11:14:15 +08:00
nvs_flash nvs_flash: Extended test-app and host tests for the HMAC-based NVS encr-keys protection scheme 2023-05-23 13:55:59 +05:30
nvs_sec_provider nvs_flash: Added helper component nvs_sec_provider 2023-05-23 13:55:53 +05:30
openthread Merge branch 'support/add_kconfig_for_mac_filter' into 'master' 2023-05-24 14:42:47 +08:00
partition_table nvs_flash: Added helper component nvs_sec_provider 2023-05-23 13:55:53 +05:30
perfmon
protobuf-c
protocomm wifi_prov: Exposed events for secure session establishment 2023-05-23 12:00:40 +05:30
pthread pthread: fix restrict keyword usage in function declarations 2023-05-05 13:35:19 +08:00
riscv esp_gdbstup: implement runtime gdbstub for riscv 2023-05-19 20:15:58 +08:00
sdmmc Merge branch 'bugfix/sdmmc_driver_vtaskdelay_slowdown' into 'master' 2023-05-19 18:22:51 +08:00
soc Merge branch 'fix/xts_aes_register_prefix_discrepency' into 'master' 2023-05-25 16:40:13 +08:00
spi_flash spi_flash: remove unnecessary header includes in test_app 2023-05-19 11:28:50 +08:00
spiffs build-system: replace ADDITIONAL_MAKE_CLEAN_FILES with ADDITIONAL_CLEAN_FILES 2023-05-08 15:51:48 +08:00
tcp_transport lwip/linux: Add lwip support for networking component under linux 2023-05-05 05:03:39 +00:00
touch_element TWDT: Use the new TWDT Kconfig options in the examples and tests 2023-02-17 11:22:25 +08:00
ulp lp-i2c: Added support for LP I2C peripheral to LP core 2023-05-19 07:27:51 +02:00
unity gpio: Refactor pytest_gpio to separate cases with labels, and update to use new IdfDut class in pytest_embedded_idf 2022-12-20 15:28:33 +08:00
usb usb_host: better debugging information during hcd_pipe_alloc() when usb_host_interface_claim() is being fulfiled. 2023-04-24 08:37:57 +02:00
vfs vfs: select sanity NULL check 2023-05-23 18:02:24 +02:00
wear_levelling host_test: cleanup of make based obsolete code in wl, fatfs and spi_flash 2023-04-21 10:45:17 +02:00
wifi_provisioning wifi_prov: Fix build issue when building only for sec1 or sec2 2023-05-23 12:00:45 +05:30
wpa_supplicant Merge branch 'bugfix/mbo_ie_absent_prob_req' into 'master' 2023-05-19 16:58:12 +08:00
xtensa Merge branch 'contrib/github_pr_10895' into 'master' 2023-05-04 10:41:46 +08:00
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 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.