Xiao Xufeng
3411286544
This commit reorganizes SPI flash header files to better reflect their visibility and intended usage: 1. Rename `esp_flash_port/` to `esp_flash_chips/`: - Better reflects that these headers are for chip driver implementations - All chip driver headers moved to `esp_flash_chips/` directory - Added README.md explaining semi-public nature of these headers 2. Move internal headers to `esp_private/`: - `esp_flash_internal.h` -> `esp_private/esp_flash_internal.h` - `memspi_host_driver.h` -> `esp_private/memspi_host_driver.h` 3. Move chip driver related headers to `esp_flash_chips/`: - `esp_private/esp_flash_types.h` -> `esp_flash_chips/esp_flash_types.h` - `spi_flash/spi_flash_defs.h` -> `esp_flash_chips/spi_flash_defs.h` - `spi_flash_override.h` -> `esp_flash_chips/spi_flash_override.h` - All `spi_flash_chip_*.h` headers moved to `esp_flash_chips/` 4. Code improvements: - Remove unused includes (e.g., `spi_flash_override.h` from `cache_utils.c`) - Use public API `esp_flash_get_size()` instead of direct member access - Add `esp_flash_is_quad_mode` to linker.lf for IRAM placement 5. Documentation updates: - Add README.md in `esp_flash_chips/` explaining semi-public headers - Update programming guide with warnings about internal headers - Update both English and Chinese documentation 6. Update all references across the codebase: - Update includes in `spi_flash` component - Update `bootloader_support`, `app_update`, `esp_tee`, `espcoredump` - Update example projects Breaking changes: - Headers moved to new locations require include path updates - `custom_flash_driver` example temporarily disabled until external components are updated
Test Apps
This directory contains a set of ESP-IDF projects to be used as tests only, which aim to exercise various configuration of components to check completely arbitrary functionality should it be building only, executing under various conditions or combination with other components, including custom test frameworks.
The test apps are not intended to demonstrate the ESP-IDF functionality in any way.
Test Apps projects
Test applications are treated the same way as ESP-IDF examples, so each project directory shall contain
- Build recipe in cmake and the main component with app sources
- Configuration files,
sdkconfig.ciand similar (see below) - Python test scripts,
pytest_....py(optional)
Test Apps layout
The test apps should be grouped into subdirectories by category. Categories are:
protocolscontains test of protocol interactions.networkcontains system network testssystemcontains tests on the internal chip features, debugging and development tools.securitycontains tests on the chip security features.
CI Behavior
Configuration Files
For each project in test_apps (and also examples):
- If a file
sdkconfig.ciexists then it's built as thedefaultCI config. - If any additional files
sdkconfig.ci.<CONFIG>exist then these are built as alternative configs, with the specified<CONFIG>name.
The CI system expects to see at least a "default" config, so add sdkconfig.ci before adding any sdkconfig.ci.CONFIG files.
- By default, every CI configurations is built for every target SoC (an
m * nconfiguration matrix). However if anysdkconfig.ci.*file contains a line of the formCONFIG_IDF_TARGET="targetname"then that CI config is only built for that one target. This only works insdkconfig.ci.CONFIG, not in the defaultsdkconfig.ci. - Each configuration is also built with the contents of any
sdkconfig.defaultsfile or a file namedsdkconfig.defaults.<TARGET>appended. (Same as a normal ESP-IDF project build.)
Test Apps local execution
Some of the examples have pytest_....py scripts that are using the pytest as the test framework. For detailed information, please refer to the "Run the Tests Locally" Section under ESP-IDF tests in Pytest documentation