mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
9eb135fd73
* App access functions are all flash encryption-aware * Documentation for flash encryption * Partition read/write is flash aware * New encrypted write function
92 lines
3.6 KiB
C
92 lines
3.6 KiB
C
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
#ifndef __ESP32_FLASH_ENCRYPT_H
|
|
#define __ESP32_FLASH_ENCRYPT_H
|
|
|
|
#include <stdbool.h>
|
|
#include <esp_err.h>
|
|
#include "esp_spi_flash.h"
|
|
#include "soc/efuse_reg.h"
|
|
|
|
/* Support functions for flash encryption features.
|
|
|
|
Can be compiled as part of app or bootloader code.
|
|
*/
|
|
|
|
/** @brief Is flash encryption currently enabled in hardware?
|
|
*
|
|
* Flash encryption is enabled if the FLASH_CRYPT_CNT efuse has an odd number of bits set.
|
|
*
|
|
* @return true if flash encryption is enabled.
|
|
*/
|
|
static inline bool esp_flash_encryption_enabled(void) {
|
|
uint32_t flash_crypt_cnt = REG_GET_FIELD(EFUSE_BLK0_RDATA0_REG, EFUSE_RD_FLASH_CRYPT_CNT);
|
|
return __builtin_parity(flash_crypt_cnt) == 1;
|
|
}
|
|
|
|
/* @brief Update on-device flash encryption
|
|
*
|
|
* Intended to be called as part of the bootloader process if flash
|
|
* encryption is enabled in device menuconfig.
|
|
*
|
|
* If FLASH_CRYPT_CNT efuse parity is 1 (ie odd number of bits set),
|
|
* then return ESP_OK immediately (indicating flash encryption is enabled
|
|
* and functional).
|
|
*
|
|
* If FLASH_CRYPT_CNT efuse parity is 0 (ie even number of bits set),
|
|
* assume the flash has just been written with plaintext that needs encrypting.
|
|
*
|
|
* The following regions of flash are encrypted in place:
|
|
*
|
|
* - The bootloader image, if a valid plaintext image is found.[*]
|
|
* - The partition table, if a valid plaintext table is found.
|
|
* - Any app partition that contains a valid plaintext app image.
|
|
* - Any other partitions with the "encrypt" flag set. [**]
|
|
*
|
|
* After the re-encryption process completes, a '1' bit is added to the
|
|
* FLASH_CRYPT_CNT value (setting the parity to 1) and the EFUSE is re-burned.
|
|
*
|
|
* [*] If reflashing bootloader with secure boot enabled, pre-encrypt
|
|
* the bootloader before writing it to flash or secure boot will fail.
|
|
*
|
|
* [**] For this reason, if serial re-flashing a previous flashed
|
|
* device with secure boot enabled and using FLASH_CRYPT_CNT to
|
|
* trigger re-encryption, you must simultaneously re-flash plaintext
|
|
* content to all partitions with the "encrypt" flag set or this
|
|
* data will be corrupted (encrypted twice).
|
|
*
|
|
* @note The post-condition of this function is that all
|
|
* partitions that should be encrypted are encrypted.
|
|
*
|
|
* @note Take care not to power off the device while this function
|
|
* is running, or the partition currently being encrypted will be lost.
|
|
*
|
|
* @return ESP_OK if all operations succeeded, ESP_ERR_INVALID_STATE
|
|
* if a fatal error occured during encryption of all partitions.
|
|
*/
|
|
esp_err_t esp_flash_encrypt_check_and_update(void);
|
|
|
|
|
|
/** @brief Encrypt-in-place a block of flash sectors
|
|
*
|
|
* @param src_addr Source offset in flash. Should be multiple of 4096 bytes.
|
|
* @param data_length Length of data to encrypt in bytes. Will be rounded up to next multiple of 4096 bytes.
|
|
*
|
|
* @return ESP_OK if all operations succeeded, ESP_ERR_FLASH_OP_FAIL
|
|
* if SPI flash fails, ESP_ERR_FLASH_OP_TIMEOUT if flash times out.
|
|
*/
|
|
esp_err_t esp_flash_encrypt_region(uint32_t src_addr, size_t data_length);
|
|
|
|
#endif
|