esp-idf/components
Ivan Grokhotkov c8b43ee0c1 Merge branch 'bugfix/sdspi_example_esp32s3' into 'master'
examples: sdspi: re-enable for ESP32-S3, add Kconfig options for pins

Closes IDF-4641

See merge request espressif/esp-idf!17067
2022-03-04 18:42:53 +08:00
..
app_trace G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
app_update G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
asio mbedtls-3 update: 2022-03-03 01:37:10 +05:30
bootloader soc: Adds efuse hal 2022-02-24 22:20:09 +08:00
bootloader_support mbedtls-3.0: Fixed ESP32 build issues 2022-03-03 01:37:10 +05:30
bt Update ESP32-C3 and ESP32-S3 bt lib and phy lib 2022-03-03 07:39:22 +00:00
cmock Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
console fix console stuck in auto test 2022-01-25 16:19:35 +08:00
cxx G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
driver Merge branch 'bugfix/sdspi_example_esp32s3' into 'master' 2022-03-04 18:42:53 +08:00
efuse remove esp32h2 rev1/2 unsupported efuse field 2022-02-28 19:37:43 +08:00
esp32 Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp32c2 Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp32c3 Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp32h2 Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp32s2 Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp32s3 Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp_adc_cal soc: Adds efuse hal 2022-02-24 22:20:09 +08:00
esp_common esp_common: update copyright headers 2022-02-21 00:51:49 +03:00
esp_eth G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
esp_event esp_event: constify event_data pointer 2022-02-16 16:16:45 +01:00
esp_gdbstub freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
esp_hid freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
esp_http_client esp_http_client: Cache received data in http_on_body callback. 2022-03-01 15:41:36 +00:00
esp_http_server mbedtls-3.0: Fixed ESP32 build issues 2022-03-03 01:37:10 +05:30
esp_https_ota esp_https_ota: rename config option for more clarity 2022-02-17 10:54:06 +05:30
esp_https_server esp_https_server: API cleanup 2022-02-14 16:25:54 +05:30
esp_hw_support Merge branch 'feature/support_esp32h2_gpio' into 'master' 2022-03-04 18:22:28 +08:00
esp_lcd G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
esp_local_ctrl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_netif G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
esp_phy Update ESP32-C3 and ESP32-S3 bt lib and phy lib 2022-03-03 07:39:22 +00:00
esp_pm G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
esp_ringbuf freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
esp_rom Merge branch 'feature/i2c_support_on_esp8684_esp32h2' into 'master' 2022-02-28 13:59:02 +08:00
esp_serial_slave_link esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
esp_system Merge branch 'feature/move_target_kconfig' into 'master' 2022-03-03 09:39:54 +08:00
esp_timer esp_timer: remove legacy ESP32 FRC timer implementation. 2022-02-10 15:17:49 +08:00
esp_websocket_client freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
esp_wifi Merge branch 'bugfix/ignore_pmf_capable_flag' into 'master' 2022-03-03 19:34:36 +08:00
esp-tls mbedtls: Fix build errors related to TLS 1.3 2022-03-03 01:37:10 +05:30
espcoredump mbedtls: Update licenses of files updated in mbedtls-3.1 update 2022-03-04 05:18:58 +00:00
esptool_py Merge branch 'bugfix/update_esp32c2_soc_memory_addr' into 'master' 2022-02-22 10:23:35 +00:00
fatfs fatfs: Update to version 0.14b 2022-02-21 14:54:55 +01:00
freemodbus modbus: fix tcp slave destroy issues 2022-03-03 16:34:33 +08:00
freertos system: move kconfig options out of target component 2022-03-02 01:22:26 +00:00
hal Merge branch 'feature/support_esp32h2_gpio' into 'master' 2022-03-04 18:22:28 +08:00
heap fix param passed to assert_valid_block, should be block not ptr 2022-02-24 13:50:16 +08:00
http_parser docs/en: Add entry for http_parser in copyrights page 2022-01-11 10:26:25 +05:30
idf_test ci: move integration test related files outside of components 2022-01-25 11:49:55 +08:00
ieee802154 openthread: update libs 2021-12-03 12:18:59 +08:00
json Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
linux linux: add dummy sys/lock.h implementation (single threaded only) 2022-01-24 18:51:40 +01:00
log esp_timer: remove legacy ESP32 FRC timer implementation. 2022-02-10 15:17:49 +08:00
lwip mbedtls-3.0: Fixed ESP32 build issues 2022-03-03 01:37:10 +05:30
mbedtls mbedtls: Update licenses of files updated in mbedtls-3.1 update 2022-03-04 05:18:58 +00:00
mdns system: move kconfig options out of target component 2022-03-02 01:22:26 +00:00
mqtt freertos: Remove legacy hooks 2022-02-18 19:56:35 +08:00
newlib esp_timer: remove legacy ESP32 FRC timer implementation. 2022-02-10 15:17:49 +08:00
nvs_flash Merge branch 'bugfix/nvs_coverity_issues' into 'master' 2022-01-29 21:52:18 +00:00
openthread mbedtls-3.X: Updated the openthread submodule 2022-03-03 01:37:10 +05:30
partition_table partition_table: add a test for total partition size error 2022-02-21 10:28:29 +03:00
perfmon perfmon: add SDPX headers 2022-02-07 08:02:13 +00:00
protobuf-c Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
protocomm mbedtls: Update licenses of files updated in mbedtls-3.1 update 2022-03-04 05:18:58 +00:00
pthread freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
riscv riscv: Use semihosting to set breakpoint and watchpoint when running under debugger 2022-02-24 08:55:40 +00:00
sdmmc soc: don't expose unstable soc header files in public api 2022-01-06 23:10:22 +08:00
soc Merge branch 'feature/support_esp32h2_gpio' into 'master' 2022-03-04 18:22:28 +08:00
spi_flash esp32h2: support GPIO peripheral, IO_MUX, GPIO matrix. 2022-03-04 11:25:05 +08:00
spiffs spiffs, wear_levelling: update copyright headers 2022-02-22 00:09:24 +03:00
tcp_transport transport_ssl: use return value from close for non-TLS case 2022-02-07 17:17:16 +05:30
tcpip_adapter Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
tinyusb G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
touch_element Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
ulp Merge branch 'docs/ulp_documentation_updates' into 'master' 2022-03-03 19:16:27 +08:00
unity unity: unity_gets remove unnecessary UINT8_MAX clamp + extra comments 2022-02-03 10:09:32 +00:00
usb G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
vfs freertos: Remove legacy data types 2022-02-09 23:05:45 +08:00
wear_levelling Merge branch 'bugfix/spiffs_wear_levelling_update_copyrights' into 'master' 2022-02-22 11:57:27 +00:00
wifi_provisioning wifi_prov_mgr: Fix provisioning not stopping in release mode 2022-01-31 15:03:54 +05:30
wpa_supplicant Merge branch 'bugfix/ignore_pmf_capable_flag' into 'master' 2022-03-03 19:34:36 +08:00
xtensa freertos: Add SPDX license identifiers and update xtensa port files 2022-02-03 17:08:14 +08:00
README.md docs: core components description 2021-09-13 12:05:20 +08:00

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. However, to maintain backward compatibility, esp_system.h includes these headers.

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.