esp-idf/components
Ivan Grokhotkov a97686f607
xtensa: fix swapped breakpoint and watchpoint numbers
2022-07-25 09:43:10 +02:00
..
app_trace esp_system: Remove deprecate section from esp_cpu.h 2022-07-22 00:06:06 +08:00
app_update refactor (bootloader_support, efuse)!: remove target-specific rom includes 2022-07-13 10:29:02 +08:00
bootloader refactor (bootloader_support, efuse)!: remove target-specific rom includes 2022-07-13 10:29:02 +08:00
bootloader_support Merge branch 'feature/deprecate-old-cpu-api' into 'master' 2022-07-23 00:37:33 +08:00
bt Merge branch 'bugfix/make_sure_sempher_and_queue_used_in_isr_is_in_DRAM' into 'master' 2022-07-22 14:04:27 +08:00
cmock
console
cxx esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
driver Merge branch 'test/spi_param_redund_desc' into 'master' 2022-07-23 02:22:58 +08:00
efuse esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
esp-tls
esp_adc Merge branch 'feature/deprecate-old-cpu-api' into 'master' 2022-07-23 00:37:33 +08:00
esp_common driver: fix public header exceptions for driver 2022-07-22 00:12:36 +00:00
esp_eth hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
esp_event esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
esp_gdbstub hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
esp_hid
esp_http_client esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
esp_http_server
esp_https_ota
esp_https_server
esp_hw_support Merge branch 'feature/deprecate-old-cpu-api' into 'master' 2022-07-23 00:37:33 +08:00
esp_lcd rgb_lcd: workaround pclk polarity bug by setting mo>=2 2022-07-21 13:06:09 +00:00
esp_local_ctrl
esp_netif esp_netif: Make set_link_speed() conditional on MIB2_STATS 2022-07-20 14:59:34 +02:00
esp_phy Merge branch 'bugfix/esp_netif_clean_deps_lwip' into 'master' 2022-07-21 20:18:05 +08:00
esp_pm hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
esp_psram feat: use standalone project idf-build-apps for find/build apps utils 2022-07-14 08:26:31 +08:00
esp_ringbuf
esp_rom esp_wifi: select slowclk as coex hardware timer source on esp32c2 2022-07-22 21:44:11 +08:00
esp_serial_slave_link esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
esp_system Merge branch 'feature/deprecate-old-cpu-api' into 'master' 2022-07-23 00:37:33 +08:00
esp_timer bugfix (esp_timer): made os spinlock static 2022-07-19 15:35:32 +08:00
esp_wifi Merge branch 'bugfix/esp32c2_coex_timer_clk_src' into 'master' 2022-07-23 11:37:35 +08:00
espcoredump hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
esptool_py spi_flash: re-enable the HPM mode on several XMC chips 2022-07-22 09:54:56 +08:00
fatfs Merge branch 'contrib/github_pr_9361' into 'master' 2022-07-24 16:49:22 +08:00
freertos hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
hal driver: fix public header exceptions for driver 2022-07-22 00:12:36 +00:00
heap Merge branch 'feature/deprecate-old-cpu-api' into 'master' 2022-07-23 00:37:33 +08:00
http_parser
idf_test
ieee802154
json
linux
log hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
lwip esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
mbedtls esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
mqtt esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
newlib hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
nvs_flash docs: update nvs encryption cn trans 2022-07-18 14:40:56 +08:00
openthread esp_netif/openthread: Update ot_br and ot_port libs 2022-07-21 10:01:19 +02:00
partition_table
perfmon
protobuf-c
protocomm Merge branch 'bugfix/remove_inappropriate_bluetooth_init_api' into 'master' 2022-07-21 14:53:44 +08:00
pthread esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
riscv
sdmmc
soc driver: fix public header exceptions for driver 2022-07-22 00:12:36 +00:00
spi_flash Merge branch 'feature/deprecate-old-cpu-api' into 'master' 2022-07-23 00:37:33 +08:00
spiffs esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
tcp_transport [tcp_transport] Fix initialition of transport 2022-07-14 12:29:58 +00:00
tinyusb
touch_element
ulp Merge branch 'feature/adc_driver_ng' into 'master' 2022-07-19 21:28:31 +08:00
unity hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
usb
vfs Merge branch 'feature/vfs_serial_fcntl_get_rd_wr_state' into 'master' 2022-07-24 16:15:28 +08:00
wear_levelling hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
wifi_provisioning esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
wpa_supplicant esp_wifi: WPA3 SAE keep default value as h2e and hunting and pecking for sae pwe 2022-07-22 12:23:13 +05:30
xtensa xtensa: fix swapped breakpoint and watchpoint numbers 2022-07-25 09:43:10 +02: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 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.