esp-idf/components
Roland Dobai 8e88444f29 Merge branch 'bugfix/enable-extending-fat-table' into 'master'
fatfsgen.py/fatfsparse.py: enabled extension of the FAT table

Closes IDF-5688 and IDF-5733

See merge request espressif/esp-idf!19299
2022-08-02 22:39:06 +08: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 use enum and designated initializers in soc_memory_type define 2022-07-29 17:07:41 +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/memory_debug_not_work' into 'master' 2022-08-02 15:48:58 +08:00
cmock Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
console tools: fix idf.py monitor consol problem 2022-07-27 08:35:30 +00:00
cxx esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
driver Merge branch 'refactor/move_common_adc_part_to_hw_support' into 'master' 2022-08-01 15:39:45 +08:00
efuse esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
esp_adc esp_adc: move adc common hw related code into esp_hw_support 2022-07-28 03:49:48 +00: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 fix memory leak in esp_bt_hidh_dev_report_write and esp_bt_hidh_dev_set_report in bt_hidh.c 2022-07-11 14:30:00 +08:00
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 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 'refactor/move_common_adc_part_to_hw_support' into 'master' 2022-08-01 15:39:45 +08:00
esp_lcd rgb_lcd: support mirror and swap axis 2022-08-01 03:05:19 +00:00
esp_local_ctrl mdns: Remove internal component, examples, test and docs 2022-06-29 17:30:34 +04:00
esp_netif esp_netif/lwip: Use netif-client-data to store esp_netif ptr 2022-07-27 11:55:18 +00:00
esp_phy esp_adc: move adc common hw related code into esp_hw_support 2022-07-28 03:49:48 +00: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 esp_psram: improve mapping log when physical range is larger 2022-07-27 10:22:09 +00:00
esp_ringbuf esp_ringbuf: placement in flash is no longer controlled by CONFIG_FREERTOS_PLACE_FUNCTIONS_INTO_FLASH 2022-07-11 09:24:20 +08:00
esp_rom soc: fix register header files not self-contain 2022-07-29 11:18:06 +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 'bugfix/rtc_brownout_isr_handler_stall' into 'master' 2022-08-02 10:38:29 +08:00
esp_timer ci: setup 26mhz esp32c2 runner 2022-07-29 17:10:34 +08:00
esp_wifi Merge branch 'bugfix/set_default_authmode_wpa2' into 'master' 2022-08-02 11:10:56 +08:00
esp-tls Merge branch 'feature/esp8684_sha' into 'master' 2022-06-23 14:18:49 +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 fatfsgen.py: enabled extension of the FAT table 2022-08-01 20:29:02 +02:00
freertos Merge branch 'bugfix/update-doc-freertos-task-header' into 'master' 2022-08-01 13:07:45 +08:00
hal Merge branch 'refactor/add_missing_include_path_for_soc_struct_files' into 'master' 2022-08-01 10:14:04 +08:00
heap use enum and designated initializers in soc_memory_type define 2022-07-29 17:07:41 +08:00
http_parser docs/en: Add entry for http_parser in copyrights page 2022-01-11 10:26:25 +05:30
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 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 hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
lwip Merge branch 'feat/lwip_dhcps_append_opts' into 'master' 2022-07-29 14:02:20 +08:00
mbedtls esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
mqtt test: Add mqtt5 unit-test 2022-07-28 06:24:43 +00: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 nvs_partition_gen: Allow up to 4000 byte strings with NVS V2 2022-07-22 15:43:19 +10:00
openthread esp_netif/openthread: Update ot_br and ot_port libs 2022-07-21 10:01:19 +02: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 Merge branch 'feature/rainmaker_BT_configurable' into 'master' 2022-07-26 15:21:27 +05:30
pthread esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08: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 'refactor/add_missing_include_path_for_soc_struct_files' into 'master' 2022-08-01 10:14:04 +08:00
spi_flash spi_flash: fix hpm dummy error when using 80m flash and psram 2022-07-28 14:32:30 +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 usb: Add HID device example 2022-07-27 05:31:09 +00:00
touch_element touch_sensor: make touch_element compile on esp32s3 2022-08-01 13:16:03 +08:00
ulp Merge branch 'feature/ulp_uart' into 'master' 2022-08-02 09:14:48 +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 usbh_print_intf_desc prints wrong value for tbInterfaceClass (IDFGH-9000) 2022-05-21 15:54:21 -07:00
vfs Merge branch 'bugfix/usb_console_reset' into 'master' 2022-08-01 13:36:44 +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 Merge branch 'feature/rainmaker_BT_configurable' into 'master' 2022-07-26 15:21:27 +05:30
wpa_supplicant wpa_supplicant: fix invalid pointer free 2022-07-28 12:47:31 +00:00
xtensa xtensa: fix swapped breakpoint and watchpoint numbers 2022-07-25 09:43:10 +02: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.