mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 11:03:11 +00:00
Xiao Xufeng
8dbf23630a
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
93 lines
2.9 KiB
C
93 lines
2.9 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include "sdkconfig.h"
|
|
#include "esp_err.h"
|
|
#include "esp_log.h"
|
|
#include "esp_attr.h"
|
|
|
|
#include "hal/spi_flash_hal.h"
|
|
#include "esp_flash_chips/spi_flash_chip_generic.h"
|
|
|
|
/*******************************************************************************
|
|
* Flash deep power-down mode.
|
|
* DPD: Deep power-down mode.
|
|
* TDP: CS high to deep power-down mode duration.
|
|
* TRES1: CS high to standby mode without ID read duration.
|
|
*
|
|
* Different flash chips might have different deep power-down strategy.
|
|
* 1. Most flash chips send B9H to enter DPD and send ABH to exist DPD.
|
|
* 2. Some flash chips send ABH followed by 3-dummy bytes to get device ID.
|
|
* 3. Some flash chips send B9H to enter PD(power-down) → send 79H to enter UDPD(ultra-deep power-down mode); send FFH to exit UDPD → send ABH to exit PD (ABH).
|
|
* 4. Some flash chips do nothing.
|
|
******************************************************************************/
|
|
|
|
__attribute__((unused)) const static char *DPD_TAG = "flash DPD";
|
|
|
|
#ifdef CONFIG_ESP_SLEEP_SPI_FLASH_ENTER_DPD_MODE_DELAY
|
|
#define SPI_FLASH_TDP_SAFE_VAL_US CONFIG_ESP_SLEEP_SPI_FLASH_ENTER_DPD_MODE_DELAY
|
|
#else
|
|
#define SPI_FLASH_TDP_SAFE_VAL_US (25)
|
|
#endif
|
|
|
|
#ifdef CONFIG_ESP_SLEEP_SPI_FLASH_EXIT_DPD_MODE_DELAY
|
|
#define SPI_FLASH_TRES1_SAFE_VAL_US CONFIG_ESP_SLEEP_SPI_FLASH_EXIT_DPD_MODE_DELAY
|
|
#else
|
|
#define SPI_FLASH_TRES1_SAFE_VAL_US (40)
|
|
#endif
|
|
|
|
/*
|
|
* Note: This file should only be compiled when DPD_ON, which is only available when (!APP_BUILD_TYPE_PURE_RAM_APP && !ESP_SLEEP_POWER_DOWN_FLASH).
|
|
* However when DPD_ON, there are still some cases this file is not actually used:
|
|
* TODO: PM-623
|
|
*/
|
|
|
|
uint32_t spi_flash_dpd_get_enter_duration(void)
|
|
{
|
|
#ifndef CONFIG_ESP_SLEEP_SPI_FLASH_ENTER_DPD_MODE_DELAY
|
|
ESP_EARLY_LOGW(DPD_TAG, "No DPD enter delay value defined. Using default safe delay value. Verify with your flash datasheet.");
|
|
#endif
|
|
return SPI_FLASH_TDP_SAFE_VAL_US;
|
|
}
|
|
|
|
uint32_t spi_flash_dpd_get_exit_duration(void)
|
|
{
|
|
#ifndef CONFIG_ESP_SLEEP_SPI_FLASH_EXIT_DPD_MODE_DELAY
|
|
ESP_EARLY_LOGW(DPD_TAG, "No DPD exit delay value defined. Using default safe delay value. Verify with your flash datasheet.");
|
|
#endif
|
|
return SPI_FLASH_TRES1_SAFE_VAL_US;
|
|
}
|
|
|
|
static esp_err_t spi_flash_enter_dpd(void)
|
|
{
|
|
esp_err_t ret = spi_flash_hal_enter_dpd_mode(esp_flash_default_chip->host);
|
|
esp_rom_delay_us(spi_flash_dpd_get_enter_duration());
|
|
|
|
return ret;
|
|
}
|
|
|
|
static esp_err_t spi_flash_exit_dpd(void)
|
|
{
|
|
esp_err_t ret = spi_flash_hal_exit_dpd_mode(esp_flash_default_chip->host);
|
|
esp_rom_delay_us(spi_flash_dpd_get_exit_duration());
|
|
|
|
return ret;
|
|
}
|
|
|
|
esp_err_t spi_flash_enable_deep_power_down_mode(bool enable)
|
|
{
|
|
esp_err_t ret = ESP_OK;
|
|
|
|
if (enable) {
|
|
ret = spi_flash_enter_dpd();
|
|
} else {
|
|
ret = spi_flash_exit_dpd();
|
|
}
|
|
|
|
return ret;
|
|
}
|