esp-idf/components
Darian Leung 16c37f9db1 change(usb/host): Remove data buffer headers from URBs
This commit removes the ability to reserve a header in the data buffer of an
allocated URB. The header was required for a now defunct implementation of a
synchronous USB Host library API. Thus, headers are no longer required in
URB data buffers.
2023-11-24 20:57:03 +08:00
..
app_trace
app_update
bootloader fix(heap): Update the heap memory layout on esp32p4 target 2023-11-10 07:29:22 +01:00
bootloader_support fix(esp_hw_support): fix lightsleep current leakage on usb-phy controlled pad 2023-11-11 13:00:55 +08:00
bt Merge branch 'bugfix/ble_update_lib_1110' into 'master' 2023-11-23 11:05:18 +08:00
cmock
console change(console): changed unit tests according to sorted help 2023-11-14 11:33:45 +08:00
cxx
driver refactor(dac): make dac driver as component 2023-11-23 12:04:06 +08:00
efuse docs: add ECDSA peripheral chapter for H2/P4 2023-11-15 09:42:26 +05:30
esp-tls
esp_adc Merge branch 'bugfix/fix_adc_cali_error_after_light_sleep_wake_on_h2' into 'master' 2023-11-24 18:25:35 +08:00
esp_app_format
esp_bootloader_format
esp_coex feat(coex): apply struct for coex version 2023-11-21 18:00:26 +08:00
esp_common
esp_driver_ana_cmpr refactor(ana_cmpr): make analog comparator driver as component 2023-11-17 10:05:22 +08:00
esp_driver_dac refactor(dac): make dac driver as component 2023-11-23 12:04:06 +08:00
esp_driver_gpio
esp_driver_gptimer
esp_driver_i2s refactor(i2s): make i2s driver as component 2023-11-17 21:29:17 +08:00
esp_driver_mcpwm Merge branch 'bugfix/mcpwm_fault_trigger_test' into 'master' 2023-11-17 16:31:36 +08:00
esp_driver_pcnt
esp_driver_sdio refactor(sdio): place sdio slave driver into a new component 2023-11-22 10:37:31 +08:00
esp_driver_sdmmc feat(sd): added readme for dependency among SD host related components 2023-11-20 12:30:03 +08:00
esp_driver_sdspi feat(sd): added readme for dependency among SD host related components 2023-11-20 12:30:03 +08:00
esp_driver_spi refactor(spi): moved spi hw sharing func to hw support 2023-11-20 12:07:54 +08:00
esp_eth
esp_event
esp_gdbstub
esp_hid
esp_http_client
esp_http_server
esp_https_ota fix(esp_https_ota): fix return code of esp_https_ota_finish API 2023-11-21 14:49:21 +05:30
esp_https_server
esp_hw_support Merge branch 'feature/reinitialize_icg_map_in_modem_module_enable' into 'master' 2023-11-23 11:55:34 +08:00
esp_lcd feat(lcd): pre-support rgb and i80 lcd driver on esp32p4 2023-11-21 10:46:52 +08:00
esp_local_ctrl
esp_mm
esp_netif Fix(dhcps):fix dhcp subnet option api dos not work issue 2023-11-15 10:53:50 +08:00
esp_netif_stack
esp_partition refactor(esp_partition): Expose function for unloading partitions 2023-11-22 11:13:32 +01:00
esp_phy fix(ble): fixed ble occasional rx exception issue 2023-11-21 15:00:55 +08:00
esp_pm fix(pm): switch root clk src to PLL for modem reg opt and added callback 2023-11-21 10:18:32 +08:00
esp_psram
esp_ringbuf
esp_rom fix(esp_wifi): Fix crash while cancelling NAN service 2023-11-24 04:15:39 +00:00
esp_system Merge branch 'feature/reinitialize_icg_map_in_modem_module_enable' into 'master' 2023-11-23 11:55:34 +08:00
esp_timer
esp_wifi fix(esp_wifi): Fix crash while cancelling NAN service 2023-11-24 04:15:39 +00:00
espcoredump Merge branch 'task/freertos_deprecate_xtaskgetaffinity' into 'master' 2023-11-13 20:23:49 +08:00
esptool_py fix(build): fix build failure if CMAKE_EXECUTABLE_SUFFIX is set 2023-11-16 08:14:19 +01:00
fatfs Merge branch 'fix/fatfs_formatting_wrong_volume' into 'master' 2023-11-24 05:22:57 +08:00
freertos feat(freertos/idf): Add config option for FreeRTOS Timer Task core affinity 2023-11-16 11:42:40 +01:00
hal Merge branch 'feature/reinitialize_icg_map_in_modem_module_enable' into 'master' 2023-11-23 11:55:34 +08:00
heap fix(heap): Update the heap memory layout on esp32p4 target 2023-11-10 07:29:22 +01:00
http_parser
idf_test feat(sdio): sdio cross chip test app 2023-11-13 11:21:47 +08:00
ieee802154 feat(pm): change power up/down register callback name 2023-11-21 10:18:55 +08:00
json
linux
log
lwip Merge branch 'bugfix/dhcp_opts_vsi_vci' into 'master' 2023-11-14 22:36:10 +08:00
mbedtls Merge branch 'bugfix/esp32h2_ecdsa_hardware_k' into 'master' 2023-11-17 15:10:12 +08:00
mqtt
newlib Merge branch 'feature/freertos_expose_list_integrity_check_option' into 'master' 2023-11-14 21:27:19 +08:00
nvs_flash fix(nvs_flash): Fix the memory leak in the nvs_flash test app 2023-11-22 16:23:18 +05:30
nvs_sec_provider
openthread
partition_table
perfmon
protobuf-c
protocomm feat(provisioning): Generate Salt and verifier pair for given username and password 2023-11-21 18:06:24 +05:30
pthread
riscv fix(riscv): supports 1 byte and larger than 64byte range watchpoint setting 2023-11-16 18:11:57 +08:00
sdmmc feat(sd): added readme for dependency among SD host related components 2023-11-20 12:30:03 +08:00
soc Merge branch 'bugfix/fix_adc_cali_error_after_light_sleep_wake_on_h2' into 'master' 2023-11-24 18:25:35 +08:00
spi_flash Merge branch 'bugfix/improve_enc_write_performance' into 'master' 2023-11-22 15:19:28 +08:00
spiffs
tcp_transport
touch_element
ulp feat(pm): removed dependency on driver component 2023-11-13 15:49:12 +08:00
unity refactor(ci): prevent memory leak message without memory leak 2023-11-17 12:15:46 +08:00
usb change(usb/host): Remove data buffer headers from URBs 2023-11-24 20:57:03 +08:00
vfs Merge branch 'fix/uart_select_malloc' into 'master' 2023-11-24 18:57:30 +08:00
wear_levelling
wifi_provisioning
wpa_supplicant fix(wifi): allow some special igtk keyindx to workaround faulty APs 2023-11-16 20:20:08 +08:00
xtensa
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) includes hal, arch (where arch is either riscv or xtensa depending on the chip), esp_rom, esp_common, and soc. This group contains information about and provides low-level access to the underlying hardware. In the case of esp_common, it contains hardware-agnostic code and utilities. These components may have dependencies on each other within the group, but outside dependencies should be minimized. The reason for this approach is that these components are fundamental, and many other components may require them. Ideally, the dependency relationship only goes one way, making it easier for this group to be usable in other projects.

The second group (referred to as G1) operates at a higher level than the first group. G1 includes the components esp_hw_support, esp_system, newlib, spi_flash, freertos, log, and heap. Like the first group, circular dependencies within this group are allowed, and these components can have dependencies on the first group. G1 components represent essential software mechanisms for 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_mm

Memory management. Currently, this encompasses:

  • Memory mapping for MMU supported memories
  • Memory synchronisation via Cache
  • Utils such as APIs to convert between virtual address and physical address

esp_psram

Contains implementation of PSRAM services

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.