mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
1cd54d34f6
bootloader: Blocking the Factory reset during wake up from deep sleep Closes IDFGH-1536 See merge request espressif/esp-idf!5673
130 lines
4.7 KiB
C
130 lines
4.7 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.
|
|
#include <string.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#include "esp_log.h"
|
|
#include "esp32/rom/gpio.h"
|
|
#include "esp32/rom/spi_flash.h"
|
|
#include "bootloader_config.h"
|
|
#include "bootloader_init.h"
|
|
#include "bootloader_utility.h"
|
|
#include "bootloader_common.h"
|
|
#include "sdkconfig.h"
|
|
#include "esp_image_format.h"
|
|
#include "esp32/rom/rtc.h"
|
|
|
|
static const char* TAG = "boot";
|
|
|
|
static int select_partition_number (bootloader_state_t *bs);
|
|
static int selected_boot_partition(const bootloader_state_t *bs);
|
|
/*
|
|
* We arrive here after the ROM bootloader finished loading this second stage bootloader from flash.
|
|
* The hardware is mostly uninitialized, flash cache is down and the app CPU is in reset.
|
|
* We do have a stack, so we can do the initialization in C.
|
|
*/
|
|
void __attribute__((noreturn)) call_start_cpu0(void)
|
|
{
|
|
// 1. Hardware initialization
|
|
if (bootloader_init() != ESP_OK) {
|
|
bootloader_reset();
|
|
}
|
|
|
|
#ifdef CONFIG_BOOTLOADER_SKIP_VALIDATE_IN_DEEP_SLEEP
|
|
// If this boot is a wake up from the deep sleep then go to the short way,
|
|
// try to load the application which worked before deep sleep.
|
|
// It skips a lot of checks due to it was done before (while first boot).
|
|
bootloader_utility_load_boot_image_from_deep_sleep();
|
|
// If it is not successful try to load an application as usual.
|
|
#endif
|
|
|
|
// 2. Select the number of boot partition
|
|
bootloader_state_t bs = { 0 };
|
|
int boot_index = select_partition_number(&bs);
|
|
if (boot_index == INVALID_INDEX) {
|
|
bootloader_reset();
|
|
}
|
|
|
|
// 3. Load the app image for booting
|
|
bootloader_utility_load_boot_image(&bs, boot_index);
|
|
}
|
|
|
|
// Select the number of boot partition
|
|
static int select_partition_number (bootloader_state_t *bs)
|
|
{
|
|
// 1. Load partition table
|
|
if (!bootloader_utility_load_partition_table(bs)) {
|
|
ESP_LOGE(TAG, "load partition table error!");
|
|
return INVALID_INDEX;
|
|
}
|
|
|
|
// 2. Select the number of boot partition
|
|
return selected_boot_partition(bs);
|
|
}
|
|
|
|
/*
|
|
* Selects a boot partition.
|
|
* The conditions for switching to another firmware are checked.
|
|
*/
|
|
static int selected_boot_partition(const bootloader_state_t *bs)
|
|
{
|
|
int boot_index = bootloader_utility_get_selected_boot_partition(bs);
|
|
if (boot_index == INVALID_INDEX) {
|
|
return boot_index; // Unrecoverable failure (not due to corrupt ota data or bad partition contents)
|
|
}
|
|
if (rtc_get_reset_reason(0) != DEEPSLEEP_RESET) {
|
|
// Factory firmware.
|
|
#ifdef CONFIG_BOOTLOADER_FACTORY_RESET
|
|
if (bootloader_common_check_long_hold_gpio(CONFIG_BOOTLOADER_NUM_PIN_FACTORY_RESET, CONFIG_BOOTLOADER_HOLD_TIME_GPIO) == 1) {
|
|
ESP_LOGI(TAG, "Detect a condition of the factory reset");
|
|
bool ota_data_erase = false;
|
|
#ifdef CONFIG_BOOTLOADER_OTA_DATA_ERASE
|
|
ota_data_erase = true;
|
|
#endif
|
|
const char *list_erase = CONFIG_BOOTLOADER_DATA_FACTORY_RESET;
|
|
ESP_LOGI(TAG, "Data partitions to erase: %s", list_erase);
|
|
if (bootloader_common_erase_part_type_data(list_erase, ota_data_erase) == false) {
|
|
ESP_LOGE(TAG, "Not all partitions were erased");
|
|
}
|
|
return bootloader_utility_get_selected_boot_partition(bs);
|
|
}
|
|
#endif
|
|
// TEST firmware.
|
|
#ifdef CONFIG_BOOTLOADER_APP_TEST
|
|
if (bootloader_common_check_long_hold_gpio(CONFIG_BOOTLOADER_NUM_PIN_APP_TEST, CONFIG_BOOTLOADER_HOLD_TIME_GPIO) == 1) {
|
|
ESP_LOGI(TAG, "Detect a boot condition of the test firmware");
|
|
if (bs->test.offset != 0) {
|
|
boot_index = TEST_APP_INDEX;
|
|
return boot_index;
|
|
} else {
|
|
ESP_LOGE(TAG, "Test firmware is not found in partition table");
|
|
return INVALID_INDEX;
|
|
}
|
|
}
|
|
#endif
|
|
// Customer implementation.
|
|
// if (gpio_pin_1 == true && ...){
|
|
// boot_index = required_boot_partition;
|
|
// } ...
|
|
}
|
|
return boot_index;
|
|
}
|
|
|
|
// Return global reent struct if any newlib functions are linked to bootloader
|
|
struct _reent* __getreent(void) {
|
|
return _GLOBAL_REENT;
|
|
}
|
|
|