espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-05-22 01:27:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(bootloader): Add startup function

Browse Source
This commit is contained in:
Dong Heng
2018-06-19 17:02:34 +08:00
parent c7c96e0066
commit 1cde2f5f81
9 changed files with 129 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/bootloader/subproject/main/esp8266.bootloader.ld
View File

@ -16,7 +16,7 @@ MEMORY
dram_seg : org = 0x3FFE8000, len = 0x18000 dram_seg : org = 0x3FFE8000, len = 0x18000
/* Functions which are critical should be put in this segment. */ /* Functions which are critical should be put in this segment. */
iram_seg : org = 0x40108000, len = 0x4000 iram_seg : org = 0x40100000, len = 0xC000
} }
/* Default entry point: */ /* Default entry point: */

14
components/bootloader_support/include/esp_secure_boot.h
View File

@ -13,9 +13,13 @@
// limitations under the License. // limitations under the License.
#pragma once #pragma once
#include "sdkconfig.h"
#include <stdbool.h> #include <stdbool.h>
#include <esp_err.h> #include <esp_err.h>
//#include "soc/efuse_reg.h"
#ifdef CONFIG_SECURE_BOOT_ENABLED
#include "soc/efuse_reg.h"
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@ -34,9 +38,9 @@ extern "C" {
* *
* @return true if secure boot is enabled. * @return true if secure boot is enabled.
*/ */
//static inline bool esp_secure_boot_enabled(void) { static inline bool esp_secure_boot_enabled(void) {
// return REG_READ(EFUSE_BLK0_RDATA6_REG) & EFUSE_RD_ABS_DONE_0; return REG_READ(EFUSE_BLK0_RDATA6_REG) & EFUSE_RD_ABS_DONE_0;
//} }
/** @brief Enable secure boot if it is not already enabled. /** @brief Enable secure boot if it is not already enabled.
@ -105,3 +109,5 @@ typedef struct {
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif /* CONFIG_SECURE_BOOT_ENABLED */

17
components/bootloader_support/src/bootloader_utility.c
View File

@ -807,15 +807,20 @@ void bootloader_utility_load_image(const esp_image_metadata_t* image_data)
} }
#endif #endif
// ESP_LOGI(TAG, "Disabling RNG early entropy source..."); #ifdef BOOTLOADER_UNPACK_APP
// bootloader_random_disable(); ESP_LOGI(TAG, "Disabling RNG early entropy source...");
bootloader_random_disable();
// copy loaded segments to RAM, set up caches for mapped segments, and start application
// unpack_load_app(image_data);
copy loaded segments to RAM, set up caches for mapped segments, and start application
unpack_load_app(image_data);
#else
Cache_Read_Enable(0, 0, 0); Cache_Read_Enable(0, 0, 0);
// ToDo: jump to application code. void (*user_start)(void);
user_start = (void *)image_data->image.entry_addr;
user_start();
#endif /* BOOTLOADER_UNPACK_APP */
} }
#endif #endif

108
components/bootloader_support/src/esp_image_format.c
View File

@ -341,7 +341,7 @@ static esp_err_t process_segment_data(intptr_t load_addr, uint32_t data_addr, ui
return ESP_FAIL; return ESP_FAIL;
} }
#ifdef BOOTLOADER_BUILD #if defined(BOOTLOADER_BUILD) && defined(BOOTLOADER_UNPACK_APP)
// Set up the obfuscation value to use for loading // Set up the obfuscation value to use for loading
while (ram_obfs_value[0] == 0 || ram_obfs_value[1] == 0) { while (ram_obfs_value[0] == 0 || ram_obfs_value[1] == 0) {
bootloader_fill_random(ram_obfs_value, sizeof(ram_obfs_value)); bootloader_fill_random(ram_obfs_value, sizeof(ram_obfs_value));
@ -355,11 +355,12 @@ static esp_err_t process_segment_data(intptr_t load_addr, uint32_t data_addr, ui
int w_i = i/4; // Word index int w_i = i/4; // Word index
uint32_t w = src[w_i]; uint32_t w = src[w_i];
*checksum ^= w; *checksum ^= w;
#ifdef BOOTLOADER_BUILD #if defined(BOOTLOADER_BUILD) && defined(BOOTLOADER_UNPACK_APP)
if (do_load) { if (do_load) {
dest[w_i] = w ^ ((w_i & 1) ? ram_obfs_value[0] : ram_obfs_value[1]); dest[w_i] = w ^ ((w_i & 1) ? ram_obfs_value[0] : ram_obfs_value[1]);
} }
#endif #endif
#ifdef CONFIG_ENABLE_BOOT_CHECK_SHA256
// SHA_CHUNK determined experimentally as the optimum size // SHA_CHUNK determined experimentally as the optimum size
// to call bootloader_sha256_data() with. This is a bit // to call bootloader_sha256_data() with. This is a bit
// counter-intuitive, but it's ~3ms better than using the // counter-intuitive, but it's ~3ms better than using the
@ -369,6 +370,7 @@ static esp_err_t process_segment_data(intptr_t load_addr, uint32_t data_addr, ui
bootloader_sha256_data(sha_handle, &src[w_i], bootloader_sha256_data(sha_handle, &src[w_i],
MIN(SHA_CHUNK, data_len - i)); MIN(SHA_CHUNK, data_len - i));
} }
#endif
} }
bootloader_munmap(data); bootloader_munmap(data);
@ -493,6 +495,7 @@ static esp_err_t verify_checksum(bootloader_sha256_handle_t sha_handle, uint32_t
static void debug_log_hash(const uint8_t *image_hash, const char *caption); static void debug_log_hash(const uint8_t *image_hash, const char *caption);
#ifdef CONFIG_SECURE_BOOT_ENABLED
static esp_err_t verify_secure_boot_signature(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data) static esp_err_t verify_secure_boot_signature(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data)
{ {
uint8_t image_hash[HASH_LEN] = { 0 }; uint8_t image_hash[HASH_LEN] = { 0 };
@ -535,6 +538,7 @@ static esp_err_t verify_secure_boot_signature(bootloader_sha256_handle_t sha_han
return ESP_OK; return ESP_OK;
} }
#endif /* CONFIG_SECURE_BOOT_ENABLED */
static esp_err_t verify_simple_hash(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data) static esp_err_t verify_simple_hash(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data)
{ {
@ -605,7 +609,7 @@ static const char *TAG = "esp_image";
/* Mmap source address mask */ /* Mmap source address mask */
#define MMAP_ALIGNED_MASK 0x0000FFFF #define MMAP_ALIGNED_MASK 0x0000FFFF
#ifdef BOOTLOADER_BUILD #if defined(BOOTLOADER_BUILD) && defined(BOOTLOADER_UNPACK_APP)
/* 64 bits of random data to obfuscate loaded RAM with, until verification is complete /* 64 bits of random data to obfuscate loaded RAM with, until verification is complete
(Means loaded code isn't executable until after the secure boot check.) (Means loaded code isn't executable until after the secure boot check.)
*/ */
@ -640,8 +644,10 @@ static esp_err_t verify_segment_header(int index, const esp_image_segment_header
static esp_err_t verify_checksum(bootloader_sha256_handle_t sha_handle, uint32_t checksum_word, esp_image_metadata_t *data); static esp_err_t verify_checksum(bootloader_sha256_handle_t sha_handle, uint32_t checksum_word, esp_image_metadata_t *data);
#if defined(CONFIG_SECURE_BOOT_ENABLED) && defined(CONFIG_ENABLE_BOOT_CHECK_SHA256)
static esp_err_t __attribute__((unused)) verify_secure_boot_signature(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data); static esp_err_t __attribute__((unused)) verify_secure_boot_signature(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data);
static esp_err_t __attribute__((unused)) verify_simple_hash(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data); static esp_err_t __attribute__((unused)) verify_simple_hash(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data);
#endif
esp_err_t esp_image_load(esp_image_load_mode_t mode, const esp_partition_pos_t *part, esp_image_metadata_t *data) esp_err_t esp_image_load(esp_image_load_mode_t mode, const esp_partition_pos_t *part, esp_image_metadata_t *data)
{ {
@ -678,14 +684,16 @@ esp_err_t esp_image_load(esp_image_load_mode_t mode, const esp_partition_pos_t *
#ifdef CONFIG_SECURE_BOOT_ENABLED #ifdef CONFIG_SECURE_BOOT_ENABLED
if (1) { if (1) {
#else #else
// if (data->image.hash_appended) { #ifdef CONFIG_ENABLE_BOOT_CHECK_SHA256
if (data->image.hash_appended) {
sha_handle = bootloader_sha256_start();
if (sha_handle == NULL) {
return ESP_ERR_NO_MEM;
}
bootloader_sha256_data(sha_handle, &data->image, sizeof(esp_image_header_t));
}
#endif
#endif #endif
// sha_handle = bootloader_sha256_start();
// if (sha_handle == NULL) {
// return ESP_ERR_NO_MEM;
// }
// bootloader_sha256_data(sha_handle, &data->image, sizeof(esp_image_header_t));
// }
ESP_LOGD(TAG, "image header: 0x%02x 0x%02x 0x%02x 0x%02x %08x", ESP_LOGD(TAG, "image header: 0x%02x 0x%02x 0x%02x 0x%02x %08x",
data->image.magic, data->image.magic,
@ -726,12 +734,16 @@ goto err;
data->image_len = end_addr - data->start_addr; data->image_len = end_addr - data->start_addr;
ESP_LOGV(TAG, "image start 0x%08x end of last section 0x%08x", data->start_addr, end_addr); ESP_LOGV(TAG, "image start 0x%08x end of last section 0x%08x", data->start_addr, end_addr);
// if (!esp_cpu_in_ocd_debug_mode()) { #ifdef CONFIG_ENABLE_BOOT_CHECK_OCD
if (!esp_cpu_in_ocd_debug_mode()) {
#endif
err = verify_checksum(sha_handle, checksum_word, data); err = verify_checksum(sha_handle, checksum_word, data);
if (err != ESP_OK) { if (err != ESP_OK) {
goto err; goto err;
} }
// } #ifdef CONFIG_ENABLE_BOOT_CHECK_OCD
}
#endif
if (data->image_len > part->size) { if (data->image_len > part->size) {
FAIL_LOAD("Image length %d doesn't fit in partition length %d", data->image_len, part->size); FAIL_LOAD("Image length %d doesn't fit in partition length %d", data->image_len, part->size);
} }
@ -747,10 +759,16 @@ goto err;
// secure boot images have a signature appended // secure boot images have a signature appended
err = verify_secure_boot_signature(sha_handle, data); err = verify_secure_boot_signature(sha_handle, data);
#else #else
#ifdef CONFIG_ENABLE_BOOT_CHECK_SHA256
// No secure boot, but SHA-256 can be appended for basic corruption detection // No secure boot, but SHA-256 can be appended for basic corruption detection
if (sha_handle != NULL && !esp_cpu_in_ocd_debug_mode()) { if (sha_handle != NULL
#ifdef CONFIG_ENABLE_BOOT_CHECK_OCD
&& !esp_cpu_in_ocd_debug_mode()
#endif
){
err = verify_simple_hash(sha_handle, data); err = verify_simple_hash(sha_handle, data);
} }
#endif
#endif // CONFIG_SECURE_BOOT_ENABLED #endif // CONFIG_SECURE_BOOT_ENABLED
} else { // is_bootloader } else { // is_bootloader
// bootloader may still have a sha256 digest handle open // bootloader may still have a sha256 digest handle open
@ -763,14 +781,14 @@ goto err;
goto err; goto err;
} }
#ifdef BOOTLOADER_BUILD #if defined(BOOTLOADER_BUILD) && defined(BOOTLOADER_UNPACK_APP)
if (do_load) { // Need to deobfuscate RAM if (do_load) { // Need to deobfuscate RAM
for (int i = 0; i < data->image.segment_count; i++) { for (int i = 0; i < data->image.segment_count; i++) {
uint32_t load_addr = data->segments[i].load_addr; uint32_t load_addr = data->segments[i].load_addr;
if (should_load(load_addr)) { if (should_load(load_addr)) {
uint32_t *loaded = (uint32_t *)load_addr; uint32_t *loaded = (uint32_t *)load_addr;
for (int j = 0; j < data->segments[i].data_len/sizeof(uint32_t); j++) { for (int j = 0; j < data->segments[i].data_len/sizeof(uint32_t); j++) {
// loaded[j] ^= (j & 1) ? ram_obfs_value[0] : ram_obfs_value[1]; loaded[j] ^= (j & 1) ? ram_obfs_value[0] : ram_obfs_value[1];
} }
} }
} }
@ -784,10 +802,12 @@ goto err;
if (err == ESP_OK) { if (err == ESP_OK) {
err = ESP_ERR_IMAGE_INVALID; err = ESP_ERR_IMAGE_INVALID;
} }
#ifdef CONFIG_ENABLE_BOOT_CHECK_SHA256
if (sha_handle != NULL) { if (sha_handle != NULL) {
// Need to finish the hash process to free the handle // Need to finish the hash process to free the handle
bootloader_sha256_finish(sha_handle, NULL); bootloader_sha256_finish(sha_handle, NULL);
} }
#endif
// Prevent invalid/incomplete data leaking out // Prevent invalid/incomplete data leaking out
bzero(data, sizeof(esp_image_metadata_t)); bzero(data, sizeof(esp_image_metadata_t));
return err; return err;
@ -828,9 +848,11 @@ static esp_err_t process_segment(int index, uint32_t flash_addr, esp_image_segme
ESP_LOGE(TAG, "bootloader_flash_read failed at 0x%08x", flash_addr); ESP_LOGE(TAG, "bootloader_flash_read failed at 0x%08x", flash_addr);
return err; return err;
} }
#ifdef CONFIG_ENABLE_BOOT_CHECK_SHA256
if (sha_handle != NULL) { if (sha_handle != NULL) {
// bootloader_sha256_data(sha_handle, header, sizeof(esp_image_segment_header_t)); bootloader_sha256_data(sha_handle, header, sizeof(esp_image_segment_header_t));
} }
#endif
intptr_t load_addr = header->load_addr; intptr_t load_addr = header->load_addr;
uint32_t data_len = header->data_len; uint32_t data_len = header->data_len;
@ -857,19 +879,21 @@ static esp_err_t process_segment(int index, uint32_t flash_addr, esp_image_segme
(do_load)?"load":(is_mapping)?"map":""); (do_load)?"load":(is_mapping)?"map":"");
} }
#ifdef BOOTLOADER_UNPACK_APP
if (do_load) { if (do_load) {
/* Before loading segment, check it doesn't clobber bootloader RAM... */ /* Before loading segment, check it doesn't clobber bootloader RAM... */
uint32_t end_addr = load_addr + data_len; uint32_t end_addr = load_addr + data_len;
if (end_addr < 0x40000000) { if (end_addr < 0x40000000) {
// intptr_t sp = (intptr_t)get_sp(); intptr_t sp = (intptr_t)get_sp();
// if (end_addr > sp - STACK_LOAD_HEADROOM) { if (end_addr > sp - STACK_LOAD_HEADROOM) {
// ESP_LOGE(TAG, "Segment %d end address 0x%08x too high (bootloader stack 0x%08x liimit 0x%08x)", ESP_LOGE(TAG, "Segment %d end address 0x%08x too high (bootloader stack 0x%08x liimit 0x%08x)",
// index, end_addr, sp, sp - STACK_LOAD_HEADROOM); index, end_addr, sp, sp - STACK_LOAD_HEADROOM);
// return ESP_ERR_IMAGE_INVALID; return ESP_ERR_IMAGE_INVALID;
// } }
} }
} }
#ifndef BOOTLOADER_BUILD #endif
#if !defined(BOOTLOADER_BUILD) && defined(CONFIG_ENABLE_FLASH_MMAP)
uint32_t free_page_count = spi_flash_mmap_get_free_pages(SPI_FLASH_MMAP_DATA); uint32_t free_page_count = spi_flash_mmap_get_free_pages(SPI_FLASH_MMAP_DATA);
ESP_LOGD(TAG, "free data page_count 0x%08x",free_page_count); ESP_LOGD(TAG, "free data page_count 0x%08x",free_page_count);
uint32_t offset_page = 0; uint32_t offset_page = 0;
@ -906,11 +930,11 @@ static esp_err_t process_segment_data(intptr_t load_addr, uint32_t data_addr, ui
return ESP_FAIL; return ESP_FAIL;
} }
#ifdef BOOTLOADER_BUILD #if defined(BOOTLOADER_BUILD) && defined(BOOTLOADER_UNPACK_APP)
// Set up the obfuscation value to use for loading // Set up the obfuscation value to use for loading
// while (ram_obfs_value[0] == 0 || ram_obfs_value[1] == 0) { while (ram_obfs_value[0] == 0 || ram_obfs_value[1] == 0) {
// bootloader_fill_random(ram_obfs_value, sizeof(ram_obfs_value)); bootloader_fill_random(ram_obfs_value, sizeof(ram_obfs_value));
// } }
ram_obfs_value[0] = 0x55; ram_obfs_value[0] = 0x55;
ram_obfs_value[1] = 0xaa; ram_obfs_value[1] = 0xaa;
uint32_t *dest = (uint32_t *)load_addr; uint32_t *dest = (uint32_t *)load_addr;
@ -1021,32 +1045,37 @@ static esp_err_t verify_checksum(bootloader_sha256_handle_t sha_handle, uint32_t
ESP_LOGE(TAG, "Checksum failed. Calculated 0x%x read 0x%x", checksum, calc); ESP_LOGE(TAG, "Checksum failed. Calculated 0x%x read 0x%x", checksum, calc);
return ESP_ERR_IMAGE_INVALID; return ESP_ERR_IMAGE_INVALID;
} }
#ifdef CONFIG_ENABLE_BOOT_CHECK_SHA256
if (sha_handle != NULL) { if (sha_handle != NULL) {
// bootloader_sha256_data(sha_handle, buf, length - unpadded_length); bootloader_sha256_data(sha_handle, buf, length - unpadded_length);
} }
// if (data->image.hash_appended) { if (data->image.hash_appended) {
// // Account for the hash in the total image length // Account for the hash in the total image length
// length += HASH_LEN; length += HASH_LEN;
// } }
#endif
data->image_len = length; data->image_len = length;
return ESP_OK; return ESP_OK;
} }
#if defined(CONFIG_SECURE_BOOT_ENABLED) && defined(CONFIG_ENABLE_BOOT_CHECK_SHA256)
static void debug_log_hash(const uint8_t *image_hash, const char *caption); static void debug_log_hash(const uint8_t *image_hash, const char *caption);
static esp_err_t verify_secure_boot_signature(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data) static esp_err_t verify_secure_boot_signature(bootloader_sha256_handle_t sha_handle, esp_image_metadata_t *data)
{ {
uint8_t image_hash[HASH_LEN] = { 0 }; uint8_t image_hash[HASH_LEN] = { 0 };
// // For secure boot, we calculate the signature hash over the whole file, which includes any "simple" hash // For secure boot, we calculate the signature hash over the whole file, which includes any "simple" hash
// // appended to the image for corruption detection // appended to the image for corruption detection
// if (data->image.hash_appended) { if (data->image.hash_appended) {
// const void *simple_hash = bootloader_mmap(data->start_addr + data->image_len - HASH_LEN, HASH_LEN); const void *simple_hash = bootloader_mmap(data->start_addr + data->image_len - HASH_LEN, HASH_LEN);
// bootloader_sha256_data(sha_handle, simple_hash, HASH_LEN); bootloader_sha256_data(sha_handle, simple_hash, HASH_LEN);
// bootloader_munmap(simple_hash); bootloader_munmap(simple_hash);
// } }
bootloader_sha256_finish(sha_handle, image_hash); bootloader_sha256_finish(sha_handle, image_hash);
@ -1119,5 +1148,6 @@ static void debug_log_hash(const uint8_t *image_hash, const char *label)
ESP_LOGD(TAG, "%s: %s", label, hash_print); ESP_LOGD(TAG, "%s: %s", label, hash_print);
#endif #endif
} }
#endif
#endif #endif

4
components/esp8266/Makefile.projbuild
View File

@ -4,11 +4,11 @@ BOOTLOADER_FIRMWARE_DIR := $(abspath $(COMPONENT_PATH))/firmware
ESPTOOLPY_FLASHSIZE ?= $(CONFIG_ESPTOOLPY_FLASHSIZE) ESPTOOLPY_FLASHSIZE ?= $(CONFIG_ESPTOOLPY_FLASHSIZE)
ifeq ($(ESPTOOLPY_FLASHSIZE), "2MB-c1") ifeq ($(ESPTOOLPY_FLASHSIZE), "2MB")
ESP_INIT_DATA_DEFAULT_BIN_OFFSET := 0x1FC000 ESP_INIT_DATA_DEFAULT_BIN_OFFSET := 0x1FC000
endif endif
ifeq ($(ESPTOOLPY_FLASHSIZE), "4MB-c1") ifeq ($(ESPTOOLPY_FLASHSIZE), "4MB")
ESP_INIT_DATA_DEFAULT_BIN_OFFSET := 0x3FC000 ESP_INIT_DATA_DEFAULT_BIN_OFFSET := 0x3FC000
endif endif

2
components/esp8266/ld/esp8266.common.ld
View File

@ -75,7 +75,7 @@ SECTIONS
{ {
_stext = .; _stext = .;
_text_start = ABSOLUTE(.); _text_start = ABSOLUTE(.);
*(.UserEnter.text) LONG(_text_start)
. = ALIGN(16); . = ALIGN(16);
*(.DebugExceptionVector.text) *(.DebugExceptionVector.text)
. = ALIGN(16); . = ALIGN(16);

BIN
components/esp8266/lib/libcore.a
View File

Binary file not shown.

35
components/esp8266/source/startup.c Normal file
View File

@ -0,0 +1,35 @@
#include "sdkconfig.h"
#include <stdint.h>
#include <stdarg.h>
#include "esp_image_format.h"
#define FLASH_MAP_ADDR 0x40200000
void call_user_start(void)
{
int i;
extern void user_start(void);
esp_image_header_t *head = (esp_image_header_t *)(FLASH_MAP_ADDR + CONFIG_PARTITION_TABLE_CUSTOM_APP_BIN_OFFSET);
esp_image_segment_header_t *segment = (esp_image_segment_header_t *)((uintptr_t)head + sizeof(esp_image_header_t));
for (i = 0; i < 3; i++) {
segment = (esp_image_segment_header_t *)((uintptr_t)segment + sizeof(esp_image_segment_header_t) + segment->data_len);
uint32_t *dest = (uint32_t *)segment->load_addr;
uint32_t *src = (uint32_t *)((uintptr_t)segment + sizeof(esp_image_segment_header_t));
uint32_t size = segment->data_len / sizeof(uint32_t);
while (size--)
*dest++ = *src++;
}
__asm__ __volatile__(
"movi a2, 0x40100000\n"
"wsr a2, vecbase\n");
user_start();
}

12
components/freertos/port/esp8266/xtensa_vectors.S
View File

@ -541,18 +541,6 @@ LoadStoreErrorHandler_common:
rsr a1, excsave1 rsr a1, excsave1
rfe rfe
.section .UserEnter.text, "ax"
.global call_user_start
.type call_user_start,@function
.align 4
.literal_position
vector_entr:
.word 0x40100000
call_user_start:
l32r a2, 0x40100000
wsr a2, vecbase
call0 user_start /* user exception handler */
#if 0 #if 0
/* /*
Panic handler. Panic handler.