58 Commits

Author SHA1 Message Date
Marius Vikhammer 5c572e5a60 docs: refresh broken documentation links 2026-04-01 10:17:33 +08:00
Xiao Xufeng 8dbf23630a 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-23 03:38:54 +08:00
Song Ruo Jing fc4f07abd6 feat(mspi): support 120MHz flash and psram for esp32c61 2026-01-21 14:38:04 +08:00
hebinglin 520d1de4c1 docs(pm): add flash deep power-down mode description docs 2025-12-09 17:19:27 +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
armando bd55fc8a02 doc(flash): updated 32bit addr support doc 2025-07-03 10:34:36 +08:00
Xiao Xufeng 83ca12c8e0 fix(esp_flash): fixed issue of escaping boundary check
Also patched corresponding ROM functions
2025-06-24 15:30:11 +08:00
C.S.M 6ead06c6d5 feat(spi_flash): Add XMC chip 32-bits address support 2025-05-21 10:50:04 +08:00
shenmengjing 72d858a9d9 docs: Sync CN and EN docs 2025-05-12 11:24:03 +08:00
Xiao Xufeng e97b1a8b51 fix(mmap): fixed cache2phys and phy2cache not patched when XIP on PSRAM 2025-04-11 11:02:11 +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
shenmengjing 9e40885210 docs: Update the CN translation for spi_flash_override_driver.rst 2024-12-26 17:33:11 +08:00
C.S.M 55579a2a4b docs(spi_flash): update programming guide for customize flash 2024-12-04 11:42:27 +08:00
Zhang Xiao Yan 5dda8a3211 Merge branch 'docs/update_application_examples_storage' into 'master'
docs: update application examples for storage component

See merge request espressif/esp-idf!33600
2024-10-24 11:20:19 +08:00
Linda c0417422c5 docs: update application examples for storage component 2024-10-23 16:19:42 +08:00
renpeiying 46770a50a6 docs: standardize the names of bootloaders in esp-idf 2024-10-23 11:29:24 +08:00
Xiao Xufeng ba06e0cfc8 docs(spi_flash): add version number for bootloader version using explicit DC_AWARE 2024-09-12 00:09:15 +08:00
shenmengjing 33af6856cf docs: Provide CN translation for spi-flash-optional-feature 2024-08-08 11:00:50 +08:00
Zhang Shuxian 08eecfee22 docs: Implement comments 2024-07-03 10:23:23 +08:00
C.S.M 374c89097f feat(spi_flash): Adjust flash clock to real 80M clock, and support 32bit address on eco1 2024-05-27 19:42:47 +08:00
morris dc6989796a feat(gdma): set burst size and return alignment constraint
burst size can affect the buffer alignment
2024-05-24 22:43:55 +08:00
shenmengjing 2dc3068a21 docs: Provide translation for jpeg&override_driver&arch in peripherals 2024-05-16 14:30:58 +08:00
morris 2352f17e63 test(gdma): can read data from flash rodata 2024-05-06 18:03:17 +08:00
shenmengjing 59644bccc2 docs: Provide CN translation for documents under api-reference 2024-04-25 10:59:40 +08:00
laokaiyao fc000cd7b7 ci(doc): enable doc build for esp32c5 2024-04-18 19:39:29 +08:00
Xiao Xufeng ca93d4e1eb doc(flash): fix auto suspend enabled by default issue 2024-04-15 17:47:31 +08:00
Marius Vikhammer f1e65b8373 docs(misc): fixed typos found with codespell 2024-03-28 11:50:58 +08:00
Michael (XIAO Xufeng) 35516652ad Merge branch 'doc/spi_flash_32bit_addr' into 'master'
doc(spi_flash): reorganize optional features

See merge request espressif/esp-idf!27808
2024-01-29 18:16:59 +08:00
kirill.chalov 22a053f1fc docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit 2024-01-23 15:22:29 +08:00
Xiao Xufeng ad7cc3ae4b doc(spi_flash): reorganize optional features 2024-01-22 12:44:27 +08:00
Darian Leung 024eb7218d change(docs): Update multicore tags to SOC_HP_CPU_HAS_MULTIPLE_CORES
Previously, documentation sections that were only meant for multicore ESP
targets would use tags that depend on CONFIG_FREERTOS_UNICORE or
CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE. This is not ideal as project configuration
can be changed by the user.

This commit updates those tags to use SOC_HP_CPU_HAS_MULTIPLE_CORES which is
always defined in multicore targets regardless of project configuration.
2023-12-05 10:56:48 +08:00
Cao Sen Miao dcff5220a7 feat(spi_flash): Support configurable tSUS in flash suspend 2023-11-06 18:04:43 +08:00
Xiao Xufeng 88954841b1 doc(spi_flash): hide unsupported optional features 2023-10-24 10:38:11 +08:00
Xiao Xufeng 1f5fb3f921 spi_flash: fixed issue that enabling HPM-DC by default may cause app unable to restart 2023-10-24 10:38:08 +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
Wang Fang db86b59330 Merge branch 'docs/update_cn_trans_for_22755' into 'master'
docs: Update CN translation for auto_suspend.inc (!22755)

Closes DOC-5790

See merge request espressif/esp-idf!25236
2023-08-24 11:00:46 +08:00
Shang Zhou af6f8c4c8c docs: Update CN translation for auto_suspend.inc (!22755) 2023-08-24 11:00:45 +08:00
Wang Fang 9d8b121ef2 Merge branch 'docs/fix_formatting_issues_in_spi_flash_concurrency_doc' into 'master'
docs: fix formatting issues in spi_flash_concurrency document

See merge request espressif/esp-idf!24619
2023-08-23 17:08:39 +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
Wang Fang 6ae9acb345 docs: fixed formatting issues in spi_flash_concurrency document 2023-07-06 11:15:31 +08:00
Armando 961c57a0da docs(spi_flash): Add auto-suspend description in idf_vs_rom doc 2023-06-27 11:01:06 +08:00
Cao Sen Miao 15153b5598 spi_flash: Update documents for flash-suspend 2023-05-11 20:12:22 +08:00
Cao Sen Miao db4375e9e6 docs: Add more content about 32bits address flash usage 2023-04-14 11:39:12 +08:00
gaoxu 542a61b6cb support SPI_FLASH_ENABLE_COUNTERS feature on esp_flash driver and rename the functions to esp_flash_xx 2023-04-06 11:40:40 +08:00
Jiang Guang Ming a06afc8d91 doc: remove esp32h2 or esp32c6: - Flash MMAP driver isn't ready in Chip-ROM 2023-03-27 00:30:21 -07:00