Commit Graph
20 Commits
Author SHA1 Message Date
Xiao Xufeng 3411286544 refactor(spi_flash): reorganize header files and improve API encapsulation
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
2026-01-29 03:28:30 +08:00
Peter Dragun e3198fff3c feat: Update esptool to v5 2025-09-30 15:28:55 +02:00
C.S.M b145ede835 refactor(mspi): Make mspi hal layer independent 2025-09-26 14:57:54 +08:00
Zhang Shuxian f6cc4f6140 docs: Update translation for SPI flash and RAM Usage 2025-03-10 15:20:07 +08:00
C.S.M 8f371a5004 docs(spi_flash): Add docs for spi_flash IRAM usage 2025-02-26 18:29:35 +08:00
renpeiying 46770a50a6 docs: standardize the names of bootloaders in esp-idf 2024-10-23 11:29:24 +08:00
laokaiyao fc000cd7b7 ci(doc): enable doc build for esp32c5 2024-04-18 19:39:29 +08:00
Xiao Xufeng 88954841b1 doc(spi_flash): hide unsupported optional features 2023-10-24 10:38:11 +08:00
Adam Múdry a64f216737 docs: Remove :envvar: form spi_flash documentation 2023-10-17 13:35:42 +02:00
caixinying-git 0b0c828d5f docs: update format issues for EN and CN files under api-reference/peripherals 2023-08-30 10:08:01 +08:00
Krzysztof Budzynski 1d030b7601 Merge branch 'bugfix/description_for_AR2023-003' into 'master'
[docs] Update API Reference of SPI Flash for AR2023-003

See merge request espressif/esp-idf!25458
2023-08-28 12:17:04 +08:00
Krzysztof 290ca75ae0 [docs] Update API Reference of SPI Flash for AR2023-003 2023-08-27 18:31:31 +08:00
Shang Zhou af6f8c4c8c docs: Update CN translation for auto_suspend.inc (!22755) 2023-08-24 11:00:45 +08:00
daiziyan 1037135761 docs: provided translation for storage.rst and system.rst and updated a typo for memory-types.rst 2023-07-27 16:24:29 +08:00
Armando 75629ee6a8 spi_flash: added programming guide for ESP-IDF vs ESP-ROM flash driver 2023-03-09 14:55:13 +08:00
Linda b08017f599 docs: fix typo in api-reference/peripherals/spi_flash 2023-02-20 14:26:47 +08:00
Mo Fei Fei 600ed6ac10 Docs: update CN translation for migration-guides, api-reference, api-guides 2023-02-20 11:49:54 +08:00
Cao Sen Miao 0f8f13d21d spi_flash: only link flash vendor which is officially supported to save IRAM 2023-02-09 10:28:54 +08:00
daiziyan 4667f1b3ef docs: sync up translation for api-reference 2023-02-02 14:44:13 +08:00
Michael (XIAO Xufeng) 57a9c67c01 index 2022-12-29 01:00:31 +08:00