esp-idf/components
Darian Leung 1c60d6a895 freertos: Add SPDX license identifiers and update xtensa port files
This commit does the following:

- Adds SPDX license identifiers to FreeRTOS sources. Remove those FreeRTOS sources from
  the copyright ignore list.
- Update xtensa port files to match FreeRTOS v10.4.3. Added SPDX license identifiers
  to the port files.
- Fixed some improperly licensed files
- Removed portbenchmark.h from RISC-V port
2022-02-03 17:08:14 +08:00
..
app_trace vfs: add support for semihosting on ESP32-C3 2022-01-14 17:29:03 +01:00
app_update bootloader: Fixes bootloader_common_get_sha256_of_partition. Adds hash check. 2022-01-25 02:16:18 +08:00
asio asio: Use internal ssl context and engine impl 2021-12-03 09:32:42 +01:00
bootloader efuse(esp32c2): Support eFuse key APIs 2022-02-01 17:30:31 +08:00
bootloader_support Merge branch 'feature/efuse_esp8684' into 'master' 2022-02-01 11:30:00 +00:00
bt Merge branch 'bugfix/nocommon' into 'master' 2022-01-28 14:39:51 +00:00
cmock Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
coap 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 unit_tests: replace legacy timer group with gptimer 2022-01-07 14:59:09 +08:00
driver Merge branch 'docs/add_cb_to_ledc_rst' into 'master' 2022-01-28 03:12:10 +00:00
efuse Merge branch 'feature/efuse_esp8684' into 'master' 2022-02-01 11:30:00 +00:00
esp32 ulp: refactor ulp component 2022-01-27 11:54:42 +05:30
esp32c2 esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
esp32c3 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp32h2 Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp32s2 ulp: refactor ulp component 2022-01-27 11:54:42 +05:30
esp32s3 ulp: refactor ulp component 2022-01-27 11:54:42 +05:30
esp_adc_cal Merge branch 'bugfix/adc2_cal_assert_arbiter_failed' into 'master' 2022-01-19 15:55:07 +00:00
esp_common ulp: refactor ulp component 2022-01-27 11:54:42 +05:30
esp_eth ci: add flaky test 2022-01-24 16:37:23 +08:00
esp_event unit_tests: replace legacy timer group with gptimer 2022-01-07 14:59:09 +08:00
esp_gdbstub xtensa: Move saving of a0 register to match upstream 2022-02-03 17:08:14 +08:00
esp_hid Fixed left right key confusion in comments. 2022-01-05 14:23:47 +08:00
esp_http_client esp_http_client: Added event for HTTP redirect 2022-01-12 11:40:32 +05:30
esp_http_server Add http_parser (new component) dependency 2022-01-11 10:26:25 +05:30
esp_https_ota esp_https_ota: fix for checking chip id at start of OTA 2022-01-13 15:20:26 +05:30
esp_https_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_hw_support Merge branch 'bugfix/ds_gen_test_cases_fix' into 'master' 2022-02-01 04:25:32 +00:00
esp_lcd lcd: add i2c oled example with lvgl port 2022-01-21 11:21:38 +08: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 Merge branch 'feature/dhcps_more_client_info' into 'master' 2022-01-28 07:31:32 +00:00
esp_phy usb_serial_jtag: remove the strict condition check in esp_phy 2022-01-19 19:08:35 +08:00
esp_pm ulp: refactor ulp component 2022-01-27 11:54:42 +05:30
esp_ringbuf unit_tests: replace legacy timer group with gptimer 2022-01-07 14:59:09 +08:00
esp_rom esp_rom: support building for Linux target with Clang 2022-01-24 18:51:40 +01:00
esp_serial_slave_link esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
esp_system xtensa: Move saving of a0 register to match upstream 2022-02-03 17:08:14 +08:00
esp_timer esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
esp_websocket_client Add http_parser (new component) dependency 2022-01-11 10:26:25 +05:30
esp_wifi esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
esp-tls Add http_parser (new component) dependency 2022-01-11 10:26:25 +05:30
espcoredump Merge branch 'bugfix/coredump_data_section' into 'master' 2022-01-11 07:43:25 +00:00
esptool_py efuse: Fixes eFuse timesettings issue on esp32S3 2022-01-25 22:09:14 +08:00
fatfs fatfs: make global constants extern 2022-01-27 11:00:09 +07:00
freemodbus freemodbus: allow address gaps in master data dictionary (support of UID field in MBAP) 2022-01-21 05:18:00 +00:00
freertos freertos: Add SPDX license identifiers and update xtensa port files 2022-02-03 17:08:14 +08:00
hal hal: fix CONFIG_TWAI_ISR_IN_IRAM not taking effect for C3/H2 2022-01-20 22:24:27 +01:00
heap Merge branch 'refactor/rename_esp8684_to_esp32c2' into 'master' 2022-01-19 09:08:58 +00: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 esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
lwip Merge branch 'feature/dhcps_more_client_info' into 'master' 2022-01-28 07:31:32 +00:00
mbedtls ci: Fix issues for build stage 2022-01-25 10:51:27 +05:30
mdns Merge branch 'feat/tools_monitor_console_baud' into 'master' 2022-01-25 11:17:56 +00:00
mqtt mqtt: Fix sending log data; dup flag after queue 2022-01-20 12:58:55 +01:00
newlib ci: replace all component ut with pytest-embedded 2022-01-24 16:37:23 +08:00
nvs_flash Merge branch 'bugfix/nvs_coverity_issues' into 'master' 2022-01-29 21:52:18 +00:00
openssl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
openthread openthread: enable 1.2 multicast routing 2022-01-27 15:22:27 +08:00
partition_table partition_table: allow enabling this component for Linux target 2022-01-24 18:51:40 +01:00
perfmon esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
protobuf-c Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
protocomm protocomm: Updated function for constant time buffer comparison 2022-01-25 10:51:27 +05:30
pthread Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
riscv riscv: fix panic_reasons being an instance of enum, not type name 2022-01-27 11:00:09 +07: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/efuse_esp8684' into 'master' 2022-02-01 11:30:00 +00:00
spi_flash esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
spiffs newlib: auto-detect sizeof(time_t) 2022-01-11 19:01:21 +01:00
tcp_transport tcp_transport: fix tcp transport execption pointer 2022-01-19 13:44:20 +01:00
tcpip_adapter Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
tinyusb tinyusb: removed set-but-never-used global variable tusb_desc_set 2022-01-27 11:00:09 +07:00
touch_element Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
ulp ulp: refactor ulp component 2022-01-27 11:54:42 +05:30
unity esp_hw_support: Removed deprecated CPU util functions 2021-12-28 16:58:37 +05:30
usb usb: mark global variable declared in header 'extern' 2022-01-27 11:00:09 +07:00
vfs Merge branch 'bugfix/lwipopts_cleanup' into 'master' 2022-01-17 06:46:27 +00:00
wear_levelling ci: replace all component ut with pytest-embedded 2022-01-24 16:37:23 +08: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/nocommon' into 'master' 2022-01-28 14:39:51 +00: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.