2021-05-09 22:56:51 -04:00
|
|
|
/*
|
2023-12-22 00:45:26 -05:00
|
|
|
* SPDX-FileCopyrightText: 2020-2023 Espressif Systems (Shanghai) CO LTD
|
2021-05-09 22:56:51 -04:00
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
*/
|
2020-07-12 15:23:12 -04:00
|
|
|
#pragma once
|
|
|
|
|
2022-02-25 04:03:45 -05:00
|
|
|
#include <stdint.h>
|
2020-07-12 15:23:12 -04:00
|
|
|
#include <esp_err.h>
|
2022-06-27 03:24:07 -04:00
|
|
|
#include "spi_flash_mmap.h" /* including in bootloader for error values */
|
|
|
|
#include "esp_private/spi_flash_os.h"
|
2020-07-12 15:23:12 -04:00
|
|
|
#include "sdkconfig.h"
|
|
|
|
#include "soc/soc_caps.h"
|
2021-09-24 00:03:03 -04:00
|
|
|
#include "bootloader_flash_override.h"
|
2020-07-12 15:23:12 -04:00
|
|
|
|
2021-05-07 03:25:06 -04:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2021-08-01 02:23:36 -04:00
|
|
|
/**
|
|
|
|
* @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);
|
|
|
|
|
2020-07-12 15:23:12 -04:00
|
|
|
#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
|
2021-05-07 03:25:06 -04:00
|
|
|
|
2021-09-24 00:03:03 -04:00
|
|
|
/**
|
|
|
|
* @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);
|
|
|
|
|
2021-05-07 03:25:06 -04:00
|
|
|
/**
|
|
|
|
* @brief Unlock Flash write protect.
|
|
|
|
* Please do not call this function in SDK.
|
|
|
|
*
|
|
|
|
* @note This can be overridden because it's attribute weak.
|
|
|
|
*/
|
2022-01-19 21:25:43 -05:00
|
|
|
esp_err_t __attribute__((weak)) bootloader_flash_unlock(void);
|
2021-05-07 03:25:06 -04:00
|
|
|
|
2022-05-30 04:49:19 -04:00
|
|
|
/**
|
|
|
|
* @brief Reset the flash chip (66H + 99H).
|
|
|
|
*
|
|
|
|
* @return ESP_OK if success, otherwise ESP_FAIL.
|
|
|
|
*/
|
|
|
|
esp_err_t bootloader_flash_reset_chip(void);
|
2021-08-01 02:23:36 -04:00
|
|
|
|
2023-12-22 00:45:26 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @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);
|
2021-05-07 03:25:06 -04:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|