esp-idf/components
Jiang Jiang Jian 86deb8c0f5 Merge branch 'bugfix/remove_ulp_tsens' into 'master'
ulp: remove ESP32 ULP TSENS references

Closes IDF-1485

See merge request espressif/esp-idf!18883
2022-07-11 16:31:43 +08:00
..
app_trace apptrace: move all apptrace related functions to IRAM 2022-06-23 16:54:24 +08:00
app_update spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
bootloader (Xtensa) Build: add .xt.prop and .xt.lit to the compiled ELF file 2022-07-05 04:39:29 +00:00
bootloader_support Merge branch 'feature/c2_systimer_26mhz' into 'master' 2022-07-11 16:17:25 +08:00
bt Merge branch 'bugfix/fix_osi_men_dbg_xxx_not_defined_when_enable_mem_dbg' into 'master' 2022-07-11 15:36:46 +08:00
cmock
console console: allow use apb clock for uart to achieve high baud rate 2022-05-09 11:26:30 +08:00
cxx tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
driver Merge branch 'feature/ulp_riscv_adc' into 'master' 2022-07-11 12:30:31 +08:00
efuse efuse: Adds major and minor versions and others 2022-07-05 14:38:27 +08:00
esp_adc_cal adc: create common adc hal layer 2022-05-07 19:20:44 +08:00
esp_common spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
esp_eth Merge branch 'feature/eth_phy_common' into 'master' 2022-06-28 23:25:12 +08:00
esp_event examples, components: remove C/C++ standard overrides 2022-06-17 16:44:17 +02:00
esp_gdbstub components: Change copyright in components files 2022-06-17 16:59:56 +02:00
esp_hid fix wrong params of get_report_by_id_and_type in bt_hidd.c 2022-07-05 20:50:11 +08:00
esp_http_client esp_http_client/esp_https_ota: Removed errno checks 2022-05-31 15:04:21 +05:30
esp_http_server fix(websocket): Support handler deal with PING and CLOSE frame 2022-06-08 16:16:57 +08:00
esp_https_ota esp_http_client/esp_https_ota: Removed errno checks 2022-05-31 15:04:21 +05:30
esp_https_server docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
esp_hw_support Merge branch 'feature/c2_systimer_26mhz' into 'master' 2022-07-11 16:17:25 +08:00
esp_lcd spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
esp_local_ctrl mdns: Remove internal component, examples, test and docs 2022-06-29 17:30:34 +04:00
esp_netif esp_netif: added support for LwIP bridge 2022-06-14 15:29:44 +02:00
esp_phy Merge branch 'bugfix/wifi_sta_and_ble_disconnect_BCI-303_master' into 'master' 2022-07-08 19:43:10 +08:00
esp_pm esp_pm: Disable esp_pm when SMP FreeRTOS is enabled 2022-06-15 16:17:59 +08:00
esp_psram Merge branch 'bugfix/s2_s3_stack_extmem_config' into 'master' 2022-07-11 10:54:59 +08:00
esp_ringbuf spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
esp_rom Merge branch 'bugfix/fix_qos_null_update_ba_ssn' into 'master' 2022-07-08 14:00:11 +08:00
esp_serial_slave_link spi: support spi on h2 2022-03-29 11:54:08 +08:00
esp_system Merge branch 'feature/c2_systimer_26mhz' into 'master' 2022-07-11 16:17:25 +08:00
esp_timer esp_timer, hal: add support for non-integer systimer frequency 2022-07-11 12:24:37 +08:00
esp_wifi Merge branch 'bugfix/reset_ble_hw_on_inititalization' into 'master' 2022-07-08 16:21:41 +08:00
esp-tls Merge branch 'feature/esp8684_sha' into 'master' 2022-06-23 14:18:49 +08:00
espcoredump espcoredump: Fix espcoredump.py shebang and file mode 2022-07-06 21:03:11 +08:00
esptool_py tools: Generate images for ESP32-C2 with required minimal revision 2022-07-07 15:44:55 +08:00
fatfs Merge branch 'bugfix/fatfs_spiffs_vfs_dep' into 'master' 2022-07-01 18:13:51 +08:00
freertos freertos: fix inlining for xtensa port 2022-07-07 09:04:51 +00:00
hal Merge branch 'feature/c2_systimer_26mhz' into 'master' 2022-07-11 16:17:25 +08:00
heap Heap: heap_caps_*_prefer functions now properly call alloc_failed callback 2022-07-05 05:57:04 +00:00
http_parser
idf_test freertos: fix inlining for xtensa port 2022-07-07 09:04:51 +00:00
ieee802154 build: move build_from_src options to env 2022-06-29 20:26:50 +08:00
json
linux
log tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
lwip Icmp: get tos parameter in icmp reply 2022-07-05 11:37:41 +08:00
mbedtls RSA: only run generate key test if we have MPI HW support 2022-06-28 09:39:43 +08:00
mqtt [MQTT] - Adds esp-timer as dependency and change version. 2022-06-29 11:50:32 +00:00
newlib spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
nvs_flash tools: Introduce support for blank lines in config and value files for mfg utility 2022-07-08 13:22:35 +00:00
openthread Merge branch 'bugfix/timer-overflow' into 'master' 2022-07-06 12:21:25 +08:00
partition_table kconfig: move remaining kconfig options out of target component 2022-05-23 17:57:45 +08:00
perfmon ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
protobuf-c protobuf-c: Update submodule to v1.4.0 2022-05-30 09:54:31 +05:30
protocomm WifiProv: Extended support for configuring if link encryption is needed 2022-06-22 10:17:28 +05:30
pthread system: re-enable esp_event, real_time_stats and pthread examples and test for C2 2022-06-23 02:05:46 +00:00
riscv Merge branch 'refactor/remove_g0_dep_on_g1_riscv' into 'master' 2022-06-16 11:53:39 +08:00
sdmmc remove: sdspi_host deprecated api 2022-06-12 20:07:27 +00:00
soc Merge branch 'feature/c2_systimer_26mhz' into 'master' 2022-07-11 16:17:25 +08:00
spi_flash spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
spiffs Merge branch 'bugfix/fatfs_spiffs_vfs_dep' into 'master' 2022-07-01 18:13:51 +08:00
tcp_transport Merge branch 'feature/freertos-smp-adjust-performance-thresholds' into 'master' 2022-06-15 17:23:00 +08:00
tinyusb Merge branch 'contrib/github_pr_9264' into 'master' 2022-07-06 10:53:38 +08:00
touch_element touch_sensor: add description to distinguish the API on different target 2022-06-28 02:20:43 +00:00
ulp Merge branch 'bugfix/remove_ulp_tsens' into 'master' 2022-07-11 16:31:43 +08:00
unity feature (unity): added memory leak check API, integrated it into cxx tests 2022-05-09 11:09:20 +08:00
usb usbh_print_intf_desc prints wrong value for tbInterfaceClass (IDFGH-9000) 2022-05-21 15:54:21 -07:00
vfs ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
wear_levelling spi_flash: Remove legacy spi_flash drivers 2022-07-01 11:01:34 +08:00
wifi_provisioning Merge branch 'bugfix/configure_link_encryption_for_charac' into 'master' 2022-06-23 19:46:47 +08:00
wpa_supplicant Merge branch 'feature/sae_sta_h2e' into 'master' 2022-06-20 23:52:08 +08:00
xtensa G0: Support Xtensa targets for G0-only compilation 2022-06-20 11:34:20 +00:00
README.md esp_hw_support/esp_system: Re-evaluate header inclusions and include directories 2022-03-07 11:18:08 +05:30

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.

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.