mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
72 lines
1.8 KiB
C
72 lines
1.8 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2020-2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#pragma once
|
|
|
|
#include <esp_err.h>
|
|
#include <esp_spi_flash.h> /* including in bootloader for error values */
|
|
#include "sdkconfig.h"
|
|
#include "soc/soc_caps.h"
|
|
#if CONFIG_IDF_TARGET_ESP32
|
|
#include "esp32/rom/spi_flash.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32S2
|
|
#include "esp32s2/rom/spi_flash.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32S3
|
|
#include "esp32s3/rom/spi_flash.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32C3
|
|
#include "esp32c3/rom/spi_flash.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32H2
|
|
#include "esp32h2/rom/spi_flash.h"
|
|
#endif
|
|
#include "bootloader_flash_override.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Read flash ID by sending RDID command (0x9F)
|
|
* @return flash raw ID
|
|
* mfg_id = (ID >> 16) & 0xFF;
|
|
flash_id = ID & 0xffff;
|
|
*/
|
|
uint32_t bootloader_read_flash_id(void);
|
|
|
|
#if SOC_CACHE_SUPPORT_WRAP
|
|
/**
|
|
* @brief Set the burst mode setting command for specified wrap mode.
|
|
*
|
|
* @param mode The specified warp mode.
|
|
* @return always ESP_OK
|
|
*/
|
|
esp_err_t bootloader_flash_wrap_set(spi_flash_wrap_mode_t mode);
|
|
#endif
|
|
|
|
/**
|
|
* @brief Startup flow recommended by XMC. Call at startup before any erase/write operation.
|
|
*
|
|
* @return ESP_OK When startup successfully, otherwise ESP_FAIL (indiciating you should reboot before erase/write).
|
|
*/
|
|
esp_err_t bootloader_flash_xmc_startup(void);
|
|
|
|
/**
|
|
* @brief Unlock Flash write protect.
|
|
* Please do not call this function in SDK.
|
|
*
|
|
* @note This can be overridden because it's attribute weak.
|
|
*/
|
|
esp_err_t IRAM_ATTR __attribute__((weak)) bootloader_flash_unlock(void);
|
|
|
|
/**
|
|
* @brief Get the spi flash working mode.
|
|
*
|
|
* @return The mode of flash working mode, see `esp_rom_spiflash_read_mode_t`
|
|
*/
|
|
esp_rom_spiflash_read_mode_t bootloader_flash_get_spi_mode(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|