esp-idf/components
Mahavir Jain e67128dd0a nvs: add config to ignore "encrypted" flag of nvs partitions
This is to allow having pre IDF v4.3 behavior where "encrypted"
flag was not being checked for NVS partitions.

It is recommended to enable this new config only if you have
production devices where NVS partition was being set with "encrypted"
flag by mistake.

Please see commit aca9ec28b3 which
introduced check to not allow NVS partitions with "encrypted" flag set.

More discussion on this at:
https://github.com/espressif/esp-idf/issues/5747#issuecomment-956223024
https://github.com/espressif/esp-idf/issues/7839#issuecomment-961477667

Closes https://github.com/espressif/esp-idf/issues/7839
Closes IDFGH-6162
2021-11-11 15:20:57 +05:30
..
app_trace gcov: Do not use shrunk ROM's fake stdout and stderr FILE struct 2021-11-04 01:33:24 +03:00
app_update build: add CONFIG_APP_REPRODUCIBLE_BUILD menuconfig option to produce reproducible binaries 2021-10-26 10:43:15 +08:00
asio openssl: Add deprecation warning to ssl.h 2021-10-05 11:45:52 +02:00
bootloader ESP8684: update bootloader, bootloader_support, esp_rom 2021-11-06 17:33:44 +08:00
bootloader_support global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
bt global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
cbor cbor: add a workaround for -ffreestanding being passed to clang 2021-09-16 11:07:54 +02:00
cmock
coap mbedtls: fix build fail with client only mbedtls 2021-10-04 19:18:45 +08:00
console argtable: move GCC-specific pragma to cmake/make files 2021-09-16 11:07:54 +02:00
cxx vfs_usb_serial: set secondary selection for making usb port can output under default menu 2021-11-01 15:48:36 +08:00
driver gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
efuse ESP8684: add spi_flash, efuse, hw_support support 2021-11-06 17:33:44 +08:00
esp32 components/bt: move config BT_RESERVE_DRAM from bluedroid to ESP32 controller 2021-09-16 20:26:35 +08:00
esp32c3 debug_stubs: Refactor and add support for RISCV 2021-11-04 01:33:24 +03:00
esp32h2 debug_stubs: Refactor and add support for RISCV 2021-11-04 01:33:24 +03:00
esp32s2 debug_stubs: Refactor and add support for RISCV 2021-11-04 01:33:24 +03:00
esp32s3 debug_stubs: Refactor and add support for RISCV 2021-11-04 01:33:24 +03:00
esp8684 ESP8684: add esp8684, esp_adc_cal, esp_common 2021-11-06 17:33:44 +08:00
esp_adc_cal ESP8684: add esp8684, esp_adc_cal, esp_common 2021-11-06 17:33:44 +08:00
esp_common ESP8684: add esp8684, esp_adc_cal, esp_common 2021-11-06 17:33:44 +08:00
esp_eth global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_event global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_gdbstub ESP8684: Add esp_gdbstub, mbedtls, esp_timer 2021-11-06 17:33:45 +08:00
esp_hid fix unit test failure for report_len in Boot Protocol 2021-09-09 17:32:22 +08:00
esp_http_client ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
esp_http_server Added more convenient functions for sending data to websocket 2021-09-16 10:53:29 +02:00
esp_https_ota esp_http_client: Fixed handling of EAGAIN return 2021-09-07 14:33:49 +05:30
esp_https_server feature: Added user callback for esp_https_server 2021-10-11 09:41:01 +05:30
esp_hw_support global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_ipc gcov: Fixes interference of gcov dump with normal IPC calls 2021-11-04 01:33:24 +03:00
esp_lcd global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_local_ctrl Added support for security1 in local control 2021-08-26 17:35:09 +08:00
esp_netif esp_wifi: support station only mode for code size down 2021-10-27 11:48:22 +08:00
esp_phy global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_pm ESP8684: add driver esp_pm heap support 2021-11-06 17:33:44 +08:00
esp_ringbuf ringbuf: Fix bug where comparision between a signed and unsigned operand resulted in incorrect free size for no-split/allow-split buffers 2021-10-28 14:02:18 +05:30
esp_rom ESP8684: update bootloader, bootloader_support, esp_rom 2021-11-06 17:33:44 +08:00
esp_serial_slave_link global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_system global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_timer global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp_websocket_client Merge branch 'bugfix/ws_client_const_correct' into 'master' 2021-06-22 16:30:29 +00:00
esp_wifi global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
esp-tls mbedtls: disable Diffie-Hellman key exchange modes by default 2021-11-02 15:52:09 +08:00
espcoredump coredump: update test data for toolchain 2021r2 2021-10-20 22:00:39 +07:00
esptool_py ESP8684: update esptool 2021-11-06 17:33:45 +08:00
expat expat: Update library from 2.2.9 to 2.4.1 2021-06-21 17:45:43 +08:00
fatfs support for generating FATFS on a host 2021-11-03 13:06:11 +01:00
freemodbus modbus: update to support other targets 2021-11-08 16:28:55 +00:00
freertos FreeRTOS: Fix xStreamBufferReset function always crashing 2021-11-09 14:04:02 +08:00
hal gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
heap ESP8684: add driver esp_pm heap support 2021-11-06 17:33:44 +08:00
idf_test ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
ieee802154 ieee802154: add timer APIs 2021-11-02 14:08:34 +08:00
jsmn
json cJSON: Update submodule to latest release. 2021-08-27 12:04:38 +08:00
libsodium libsodium: fix source directory names to address build issues with Make 2021-08-05 12:28:09 +08:00
linux [mocks]: freertos mock 2021-08-06 17:08:21 +08:00
log ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
lwip ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
mbedtls global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
mdns freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
mqtt freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
newlib ESP8684: add soc, riscv, newlib support 2021-11-06 17:33:44 +08:00
nghttp
nvs_flash nvs: add config to ignore "encrypted" flag of nvs partitions 2021-11-11 15:20:57 +05:30
openssl openssl: Add deprecation warning to ssl.h 2021-10-05 11:45:52 +02:00
openthread openthread: support updating RCP with OTA over spinel 2021-11-05 16:47:30 +08:00
partition_table tools: replace _ with - in idf.py 2021-10-13 17:30:38 +08:00
perfmon ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
protobuf-c
protocomm Wifi_prov_mgr:Fix for ios device needs to do forget device 2021-10-06 17:46:22 +08:00
pthread feat (pthread): reader-writer locks implementation 2021-11-03 16:38:14 +08:00
riscv ESP8684: add soc, riscv, newlib support 2021-11-06 17:33:44 +08:00
sdmmc fatfs: Implementation of disk_status nad disk_initialize for SD/MMC card 2021-11-01 15:11:40 +08:00
soc gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
spi_flash nvs: add config to ignore "encrypted" flag of nvs partitions 2021-11-11 15:20:57 +05:30
spiffs ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
tcp_transport tcp_transport: Fix NULL pointer dereference in esp_transport_esp_tls_create 2021-09-08 11:04:08 +08:00
tcpip_adapter esp_wifi: support station only mode for code size down 2021-10-27 11:48:22 +08:00
tinyusb global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
touch_element touch_element: add unit test for Touch Element lib 2021-07-12 10:02:46 +08:00
ulp ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
unity ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
usb global: make periph enable/disable APIs private 2021-11-08 10:37:47 +08:00
vfs ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +08:00
wear_levelling wear_levelling: move tests from unit-test-app to a component test app 2021-11-03 09:56:20 +01:00
wifi_provisioning esp_wifi: support station only mode for code size down 2021-10-27 11:48:22 +08:00
wpa_supplicant esp_wifi: support station only mode for code size down 2021-10-27 11:48:22 +08:00
xtensa ESP8684: Add esp8684 target to other repo for passing build 2021-11-06 17:33:45 +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.