esp-idf/components
David Čermák b52e796654 Merge branch 'bugfix/wifi_netif_const_correct' into 'master'
esp-wifi/netif: Made esp_netif_create_wifi() const correct

Closes IDFGH-8500

See merge request espressif/esp-idf!20745
2022-10-31 21:31:30 +08:00
..
app_trace freertos, app_trace, heap: use esp_cpu_get_cycle_count to get ccount 2022-10-12 11:20:55 +02:00
app_update ci: Migrate app_update unit tests from unit-test-app to component-test-app 2022-10-21 07:37:37 +00:00
bootloader bootloader: update bootloader memory map 2022-09-29 11:13:06 +08:00
bootloader_support spi_flash: Support select flash mode automatically at run time(Quad flash or Octal flash) 2022-10-18 11:25:35 +08:00
bt Merge branch 'bugfix/spp_50005_crash' into 'master' 2022-10-28 17:12:44 +08:00
cmock
console console: argtable3: upgrade to v3.2.2 2022-10-27 11:38:49 +02:00
cxx esp_hw_support: Remove compare_set.h API 2022-07-22 00:06:06 +08:00
driver driver: test with non-isr freertos functions in the flash 2022-10-26 13:43:13 +08:00
efuse efuse: Migrate efuse unit tests from unit-test-app to component test app 2022-10-26 15:41:48 +08:00
esp_adc esp_adc: added esp32c2 adc runners 2022-10-17 16:23:22 +08:00
esp_app_format Make esp_app_desc a weak symbol 2022-10-02 18:46:46 +02:00
esp_common soc/esp_ds.h: Unify esp_ds error codes for all targets 2022-10-27 11:09:25 +05:30
esp_eth Merge branch 'bugfix/esp_eth_test_rx' into 'master' 2022-08-05 14:02:39 +08:00
esp_event esp_event: move tests to pytest framework 2022-10-14 11:07:58 +08:00
esp_gdbstub esp32c6: add esp_gdb_stub support 2022-09-26 20:32:13 +08:00
esp_hid fix esp hid crash when auth failed 2022-08-11 19:41:35 +08:00
esp_http_client esp_http_client: free cached data in case connection gets closed for redirection 2022-10-20 12:45:06 +05:30
esp_http_server esp_http_server: fix few coverity warnings 2022-10-10 15:35:43 +05:30
esp_https_ota esp_https_ota: fix bug where http_client_init_cb is called after esp_http_client_perform() instead of before. 2022-09-01 12:04:40 +05:30
esp_https_server esp_https_server: fix issue with default initialization through HTTPD_SSL_CONFIG_DEFAULT 2022-09-01 15:01:37 +05:30
esp_hw_support rtc: united sar peripheral control 2022-10-27 16:51:25 +08:00
esp_lcd driver: test with non-isr freertos functions in the flash 2022-10-26 13:43:13 +08:00
esp_local_ctrl build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
esp_netif esp_netif: Migrate SLIP interface to user-space 2022-08-16 14:08:15 +00:00
esp_phy Coexistence: remove reset for esp32's modem when PU to avoid SoftAP fail to work in some cases 2022-10-19 17:26:26 +08:00
esp_pm esp_timer: add a function to restart timer 2022-10-18 04:42:27 +00:00
esp_psram esp_psram: update flash content moved to psram kconfig description 2022-10-11 15:15:04 +08:00
esp_ringbuf esp_ringbuf: migrated esp_ringbuf component tests to pytest framework 2022-10-11 11:31:04 +02:00
esp_rom esp_rom: put rom tlsf patch code in iram by default 2022-10-26 20:41:15 +08:00
esp_system Merge branch 'contrib/github_pr_10027' into 'master' 2022-10-28 12:04:36 +08:00
esp_timer esp_timer: add a function to restart timer 2022-10-18 04:42:27 +00:00
esp_wifi Merge branch 'bugfix/wifi_netif_const_correct' into 'master' 2022-10-31 21:31:30 +08:00
esp-tls esp-tls: Fix memory leak in mbedtls ds peripheral when MBEDTLS_THREADING_C enabled 2022-10-13 14:17:42 +08:00
espcoredump espcoredump: enable tests for esp32c2 target 2022-09-28 20:41:01 +05:30
esptool_py spi_flash: Support select flash mode automatically at run time(Quad flash or Octal flash) 2022-10-18 11:25:35 +08:00
fatfs Merge branch 'bugfix/storage_wformat' into 'master' 2022-10-18 20:21:53 +08:00
freertos freertos-smp: Disable CONFIG_FREERTOS_CHECK_MUTEX_GIVEN_BY_OWNER for FreeRTOS SMP 2022-10-26 09:02:55 +02:00
hal rtc: united sar peripheral control 2022-10-27 16:51:25 +08:00
heap heap: Added note to increase INT_WDT timeout for integrity-check APIs 2022-10-30 10:36:01 +05:30
http_parser
idf_test mbedtls: Added performance tests for ECP and ECDSA operations 2022-10-13 10:01:06 +05:30
ieee802154 ieee802154: add 154 lib CI initialization. 2022-10-24 16:19:00 +08:00
json
linux
log log: fix -Wformat issue when uint32_t == unsigned long 2022-08-03 16:42:47 +04:00
lwip Merge branch 'Bugfix/increase_ping_task_stack_size' into 'master' 2022-10-19 19:19:25 +08:00
mbedtls esp32: mpi: add workaround for data corruption issue observed with IDF 5.x toolchain 2022-10-21 14:29:02 +05:30
mqtt [MQTT] Simplifies MQTT CMakeLists file 2022-09-19 09:11:15 +00:00
newlib esp32c6: add newlib support 2022-09-26 20:32:13 +08:00
nvs_flash refactor(nvs): using define for namespace len instead of magic number 2022-10-21 18:12:24 +02:00
openthread openthread: Add some flash optimization options for openthread component 2022-09-28 20:37:44 +08:00
partition_table partition_table: Improve an error msg and doc 2022-10-20 17:18:01 +08:00
perfmon perfmon: fix xtensa_perfmon build target 2022-09-01 12:28:00 +08:00
protobuf-c protobuf-c: Update submodule to v1.4.1 2022-09-29 15:35:19 +05:30
protocomm protocomm: Increase Bluedroid-BLE maximum buffer size 2022-10-26 13:34:39 +05:30
pthread Merge branch 'feature/cmake_use_new_features' into 'master' 2022-09-21 11:05:06 +08:00
riscv esp_system: Minor update for esp32c6 2022-09-26 20:32:13 +08:00
sdmmc sdmmc/sdspi: allow custom setup of SD card frequency 2022-09-12 17:08:36 +02:00
soc rtc: united sar peripheral control 2022-10-27 16:51:25 +08:00
spi_flash spi_flash: Support select flash mode automatically at run time(Quad flash or Octal flash) 2022-10-18 11:25:35 +08:00
spiffs Merge branch 'bugfix/storage_wformat' into 'master' 2022-10-18 20:21:53 +08:00
tcp_transport Merge branch 'bugfix/wrong_ws_mask_check' into 'master' 2022-10-05 21:47:42 +08:00
tinyusb Merge branch 'fix/usb_midi_tinyusb_refactor' into 'master' 2022-10-19 16:27:53 +08:00
touch_element touch_sleep: complete the support for touch sleep 2022-08-15 20:04:57 +08:00
ulp Merge branch 'bugfix/s3_ulp_riscv_cocpu_trap' into 'master' 2022-10-25 13:50:36 +08:00
unity unity: add linux port 2022-08-15 18:15:19 +02:00
usb usb: Allow settings of all signals in usb_phy 2022-10-18 09:18:29 +02:00
vfs Merge branch 'bugfix/storage_wformat' into 'master' 2022-10-18 20:21:53 +08:00
wear_levelling build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
wifi_provisioning wifi_provisioning: fix error codes for wifi connect retry 2022-10-12 12:10:21 +05:30
wpa_supplicant Merge branch 'feature/move_eloop_to_pptask' into 'master' 2022-10-31 12:48:43 +08:00
xtensa xtensa: fix swapped breakpoint and watchpoint numbers 2022-07-25 09:43:10 +02:00
README.md riscv: Remove redundant riscv_interrupts.h header 2022-09-16 16:45:43 +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
  • 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.