espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-06-17 11:54:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feature/remove_raw_ota_exmaple' into 'master'

Browse Source 
Update verify and document for OTA of ESP8285(ESP8266 + 1MB flash)

See merge request sdk/ESP8266_RTOS_SDK!733
This commit is contained in:
Dong Heng
2019-01-29 19:36:15 +08:00
parent 4a4ce2a661 d36793c00f
commit 3af76b4556
15 changed files with 351 additions and 771 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
components/app_update/esp_ota_ops.c
View File

@ -69,6 +69,28 @@ static ota_select s_ota_select[2];
const static char *TAG = "esp_ota_ops";
#ifndef CONFIG_ESP8266_BOOT_COPY_APP
static inline int esp_ota_verify_binary(const esp_partition_pos_t *pos, esp_image_header_t *image)
{
const int32_t entry = image->entry_addr - 0x40200010;
ESP_LOGD(TAG, "OTA binary start entry 0x%x, partition start from 0x%x to 0x%x\n", entry, pos->offset,
pos->offset + pos->size);
if (pos->offset + pos->size <= 0x100000) {
if (entry <= 0 || entry <= pos->offset || entry >= pos->offset + pos->size) {
const char *doc_str = "<<ESP8266_RTOS_SDK/examples/system/ota/README.md>>";
ESP_LOGE(TAG, "**Important**: The OTA binary link data is error, "
"please refer to document %s for how to generate OTA binaries", doc_str);
return ESP_ERR_INVALID_ARG;
}
}
return ESP_OK;
}
#endif
/* Return true if this is an OTA app partition */
static bool is_ota_partition(const esp_partition_t *p)
{
@ -244,6 +266,13 @@ esp_err_t esp_ota_end(esp_ota_handle_t handle)
goto cleanup;
}
#ifndef CONFIG_ESP8266_BOOT_COPY_APP
if (esp_ota_verify_binary(&part_pos, &data.image) != ESP_OK) {
ret = ESP_ERR_OTA_VALIDATE_FAILED;
goto cleanup;
}
#endif
#ifdef CONFIG_SECURE_BOOT_ENABLED
ret = esp_secure_boot_verify_signature(it->part->address, data.image_len);
if (ret != ESP_OK) {

10
components/esp8266/Makefile.projbuild
View File

@ -94,7 +94,7 @@ OTA_V2_TO_V3_BIN := ./build/$(PROJECT_NAME).v2_to_v3.ota.bin
CONFIG_APP2_OFFSET ?= $(CONFIG_APP1_OFFSET)
CONFIG_APP2_SIZE ?= $(CONFIG_APP1_SIZE)
OTA1_OFFSET := CONFIG_APP1_OFFSET
OTA1_OFFSET := $(CONFIG_APP1_OFFSET)
ifdef CONFIG_ESP8266_BOOT_COPY_APP
OTA2_LINK_OFFSET := $(CONFIG_APP1_OFFSET)
else
@ -102,7 +102,7 @@ OTA2_LINK_OFFSET := $(CONFIG_APP2_OFFSET)
endif
$(OTA2_BIN): all_binaries
ifeq ($(CONFIG_ESPTOOLPY_FLASHSIZE), "1MB")
ifneq ($(OTA1_OFFSET), $(OTA2_LINK_OFFSET))
@rm -f ./build/esp8266/esp8266_out.ld
@make APP_OFFSET=$(OTA2_LINK_OFFSET) APP_SIZE=$(CONFIG_APP2_SIZE) CFLAGS= CXXFLAGS=
endif
@ -110,16 +110,16 @@ endif
@echo [GEN] $(OTA2_BIN)
$(OTA1_BIN): all_binaries
ifeq ($(CONFIG_ESPTOOLPY_FLASHSIZE), "1MB")
ifneq ($(OTA1_OFFSET), $(OTA2_LINK_OFFSET))
@rm -f ./build/esp8266/esp8266_out.ld
endif
@make APP_OFFSET=$(CONFIG_APP1_OFFSET) APP_SIZE=$(CONFIG_APP1_SIZE) CFLAGS= CXXFLAGS=
@make APP_OFFSET=$(OTA1_OFFSET) APP_SIZE=$(CONFIG_APP1_SIZE) CFLAGS= CXXFLAGS=
@cp $(RAW_BIN) $(OTA1_BIN)
@echo [GEN] $(OTA1_BIN)
$(OTA_BIN): $(OTA1_BIN) $(OTA2_BIN)
@cp $(OTA1_BIN) $(OTA_BIN)
ifeq ($(CONFIG_ESPTOOLPY_FLASHSIZE), "1MB")
ifneq ($(OTA1_OFFSET), $(OTA2_LINK_OFFSET))
@cat $(OTA2_BIN) >> $(OTA_BIN)
endif
@cp $(OTA1_BIN) $(RAW_BIN)

123
examples/system/ota/README.md
View File

@ -1,4 +1,10 @@
# Important
If your development board is based on **ESP8285** or **ESP8266 + 1MB flash**, you should read this document carefully, especially the Chapter **"Principle"**.
---
# Simple OTA Demo
This example demonstrates a working OTA (over the air) firmware update workflow.
@ -11,10 +17,68 @@ This example is a *simplified demonstration*, for production firmware updates yo
An app running on ESP8266 can upgrade itself by downloading a new app "image" binary file, and storing it in flash.
In this example, the ESP8266 has 3 images in flash: factory, OTA_0, OTA_1. Each of these is a self-contained partition. The number of OTA image partition is determined by the partition table layout.
In this example, the ESP8266 has 2 images in flash: OTA_0, OTA_1. Each of these is a self-contained partition. The number of OTA image partition is determined by the partition table layout.
Flashing the example over serial with "make flash" updates the factory app image. On first boot, the bootloader loads this factory app image which then performs an OTA update (triggered in the example code). The update downloads a new image from an http server and saves it into the OTA_0 partition. At this point the example code updates the ota_data partition to indicate the new app partition, and resets. The bootloader reads ota_data, determines the new OTA image has been selected, and runs it.
Flash the example through serial port with command "make flash" to update the OTA_0 app image. In first boot, the bootloader loads this OTA_0 app image which then will execute an OTA update (triggered in the example code). The OTA update will download a new image from an http server and save it into the OTA_1 partition. After that, the example code will update the ota_data partition to indicate the new app partition, and then reboot, which leads to the second boot. During the second boot, the bootloader will read the ota_data, and select to run the new OTA image.
# Custom partition configuration
If customers want to use their own partition tables with specific partition location. Please see following steps:
## Step 1: Create partition file
Create a partition managment file with "cvs" formate, please refer to "doc/en/api-guides/partition-tables.rst"
## Step 2: Select custom partition mode
1. Select custom partition tables at "menuconfig":
```
Partition Table --->
Partition Table (XXXXXX) --->
(X) Custom partition table CSV
```
2. Configurate custom partition location at:
```
(XXXXXX)Custom partition CSV file
```
Note: System will add the absolute path of the project to the head of the "Custom partition CSV file" automatically when compling.
3. Configurate patition table location if necessary:
```
(XXXXXX)Partition table offset address at flash
```
## Step 3: Configurate application location:
Configurate application location at "mennuconfig" like following base on partition table file.
If you select 1MB flash, application location configuration menu is like following:
```
Partition Table --->
[*] Support to setup partition parameter of APP2
(0x5000) App1 offset address
(0x7B000) App1 size by bytes
(0x85000) App2 offset address
(0x7b000) App2 size by bytes
```
If you select 2MB flash and above size, application location configuration menu is like following:
```
Partition Table --->
(0x10000) APP1 partition offset
(0xF0000) APP1 partition size(by bytes)
```
Note: The firmware location information must be same as partition table file. **make ota flash** will only download the app1 at **APP1 partition offset**.
# Workflow
@ -32,11 +96,26 @@ Python has a built-in HTTP server that can be used for example purposes.
For our upgrade example OTA file, we're going to use the `get-started/project_template` example.
Open a new terminal to run the HTTP server, then run these commands to build the example and start the server:
Open a new terminal to run the HTTP server, then run these commands to build the example and start the server, if your board's flash size is "1 MB", you should firstly configure flash size to be "1 MB"(default is "2 MB") at "menuconfig" and then build project:
Configure 1MB flash if it is needed:
```
Serial flasher config --->
Flash size (2 MB) --->
(X) 1 MB
```
Build project:
```
cd $IDF_PATH/examples/get-started/project_template
make
make ota
```
Start http server at the directory of "build":
```
cd build
python -m SimpleHTTPServer 8070
```
@ -45,8 +124,6 @@ While the server is running, the contents of the build directory can be browsed
NB: On some systems, the command may be `python2 -m SimpleHTTPServer`.
NB: You've probably noticed there is nothing special about the "project_template" example when used for OTA updates. This is because any .bin app file which is built by esp-idf can be used as an app image for OTA. The only difference is whether it is written to a factory partition or an OTA partition.
If you have any firewall software running that will block incoming access to port 8070, configure it to allow access while running the example.
## Step 3: Build OTA Example
@ -59,6 +136,16 @@ Change back to the OTA example directory, and type `make menuconfig` to configur
If serving the "project_template" example, you can leave the default filename as-is.
Configure 1MB flash if need:
```
Serial flasher config --->
Flash size (2 MB) --->
(X) 1 MB
```
Configurate the application location information and it must be the same as the OTA example's information, you can refer to the **Step 3: Configurate application location** of **Custom partition configuration**.
Save your changes, and type `make` to build the example.
## Step 4: Flash OTA Example
@ -80,11 +167,29 @@ When the example starts up, it will print "ota: Starting OTA example..." then:
3. Write the image to flash, and configure the next boot from this image.
4. Reboot
# Principle
Command "make ota" will generate 3 binaries: "xxx(project name).app1.bin", "xxx(project name).app2.bin" and "xxx(project name).ota.bin". You should only upload the "xxx(project name).ota.bin" to your OTA server and let the app download it as the example.
"xxx.app1.bin" is for downloading to OTA_0 partition, and "xxx.app2.bin" is for downloading to OTA_1 partition. If your board's flash size is larger than "1 MB" or you select "Copy OTA" function, then "xxx.app1.bin" = "xxx.app2.bin" = "xxx.ota.bin". Otherwise If your board's flash size is "1 MB" and you don't select "Copy OTA" function, "xxx.app1.bin" != "xxx.app2.bin" != "xxx.ota.bin", "xxx.ota.bin" = "xxx.app1.bin" + "xxx.app2.bin". So the flash size configuration is very important. Otherwise if and at the last The example will select the binary it needs and download it into flash.
Based on the above theory, we can see that for ESP8266 + 2MB flash(or larger size), app1 and app2 are the same, you can download it directly without any distinction. But for ESP8285 (ESP8266 + 1MB flash), the ota0 (app1) and ota1 (app2) are different, you need to distinguish which one should be downloaded, and to what location, during FOTA. Now, the way in the example code is to synthesize app1 and app2 into an "xxxx (project name).ota.bin". And only write the target app (app1 or app2) into the flash, according to the location of download, when FOTA; the other part will be discarded.
On the other hand, if you want to use ESP8285(ESP8266 + 1MB flash) and don't want to upload 2 binaries for OTA, you can enable the "Copy OTA" function in menuconfig.
```
Component config --->
ESP8266-specific --->
[*] (**Expected**)Boot copy app
```
After enabling "Copy OTA" mode, the system will always download the app bin into ota_1 partition and then re-boot. After reboot, the bootloader will unpack the app bin and copy it to the ota_0 partition, then run the application in ota_0 partition.
# Troubleshooting
* Check your PC can ping the ESP8266 at its IP, and that the IP, AP and other configuration settings are correct in menuconfig.
* Check if any firewall software is preventing incoming connections on the PC.
* Check you can see the configured file (default project_template.bin) if you browse the file listing at http://127.0.0.1/
* Check whether your PC can ping the ESP8266 at its IP, and make sure that the IP, AP and other configuration settings are correct in menuconfig.
* Check if there is any firewall software on the PC that prevents incoming connections.
* Check whether you can see the configured file (default project_template.ota.bin) when browsing the file listing at http://127.0.0.1/
* If you have another PC or a phone, try viewing the file listing from the separate host.
## Error "ota_begin error err=0x104"

2
examples/system/ota/main/Kconfig.projbuild
View File

@ -32,7 +32,7 @@ config SERVER_PORT
config EXAMPLE_FILENAME
string "HTTP GET Filename"
default "/hello-world.bin"
default "/project_template.ota.bin"
help
Filename of the app image file to download for
the OTA update.

232
examples/system/ota/main/ota_example_main.c
View File

@ -32,6 +32,32 @@
#define BUFFSIZE 1500
#define TEXT_BUFFSIZE 1024
typedef enum esp_ota_firm_state {
ESP_OTA_INIT = 0,
ESP_OTA_PREPARE,
ESP_OTA_START,
ESP_OTA_RECVED,
ESP_OTA_FINISH,
} esp_ota_firm_state_t;
typedef struct esp_ota_firm {
uint8_t ota_num;
uint8_t update_ota_num;
esp_ota_firm_state_t state;
size_t content_len;
size_t read_bytes;
size_t write_bytes;
size_t ota_size;
size_t ota_offset;
const char *buf;
size_t bytes;
} esp_ota_firm_t;
static const char *TAG = "ota";
/*an ota data write buffer ready to write to the flash*/
static char ota_write_data[BUFFSIZE + 1] = { 0 };
@ -92,7 +118,7 @@ static void initialise_wifi(void)
}
/*read buffer by byte still delim ,return read bytes counts*/
static int read_until(char *buffer, char delim, int len)
static int read_until(const char *buffer, char delim, int len)
{
// /*TODO: delim check,buffer check,further: do an buffer length limited*/
int i = 0;
@ -102,38 +128,6 @@ static int read_until(char *buffer, char delim, int len)
return i + 1;
}
/* resolve a packet from http socket
* return true if packet including \r\n\r\n that means http packet header finished,start to receive packet body
* otherwise return false
* */
static bool read_past_http_header(char text[], int total_len, esp_ota_handle_t update_handle)
{
/* i means current position */
int i = 0, i_read_len = 0;
while (text[i] != 0 && i < total_len) {
i_read_len = read_until(&text[i], '\n', total_len);
// if we resolve \r\n line,we think packet header is finished
if (i_read_len == 2) {
int i_write_len = total_len - (i + 2);
memset(ota_write_data, 0, BUFFSIZE);
/*copy first http packet body to write buffer*/
memcpy(ota_write_data, &(text[i + 2]), i_write_len);
esp_err_t err = esp_ota_write( update_handle, (const void *)ota_write_data, i_write_len);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Error: esp_ota_write failed! err=0x%x", err);
return false;
} else {
ESP_LOGI(TAG, "esp_ota_write header OK");
binary_file_length += i_write_len;
}
return true;
}
i += i_read_len;
}
return false;
}
static bool connect_to_http_server()
{
ESP_LOGI(TAG, "Server IP: %s Server Port:%s", EXAMPLE_SERVER_IP, EXAMPLE_SERVER_PORT);
@ -177,6 +171,153 @@ static void __attribute__((noreturn)) task_fatal_error()
}
}
bool _esp_ota_firm_parse_http(esp_ota_firm_t *ota_firm, const char *text, size_t total_len, size_t *parse_len)
{
/* i means current position */
int i = 0, i_read_len = 0;
char *ptr = NULL, *ptr2 = NULL;
char length_str[32];
while (text[i] != 0 && i < total_len) {
if (ota_firm->content_len == 0 && (ptr = (char *)strstr(text, "Content-Length")) != NULL) {
ptr += 16;
ptr2 = (char *)strstr(ptr, "\r\n");
memset(length_str, 0, sizeof(length_str));
memcpy(length_str, ptr, ptr2 - ptr);
ota_firm->content_len = atoi(length_str);
#if defined(CONFIG_ESPTOOLPY_FLASHSIZE_1MB) && !defined(CONFIG_ESP8266_BOOT_COPY_APP)
ota_firm->ota_size = ota_firm->content_len / ota_firm->ota_num;
ota_firm->ota_offset = ota_firm->ota_size * ota_firm->update_ota_num;
#else
ota_firm->ota_size = ota_firm->content_len;
ota_firm->ota_offset = 0;
#endif
ESP_LOGI(TAG, "parse Content-Length:%d, ota_size %d", ota_firm->content_len, ota_firm->ota_size);
}
i_read_len = read_until(&text[i], '\n', total_len - i);
if (i_read_len > total_len - i) {
ESP_LOGE(TAG, "recv malformed http header");
task_fatal_error();
}
// if resolve \r\n line, http header is finished
if (i_read_len == 2) {
if (ota_firm->content_len == 0) {
ESP_LOGE(TAG, "did not parse Content-Length item");
task_fatal_error();
}
*parse_len = i + 2;
return true;
}
i += i_read_len;
}
return false;
}
static size_t esp_ota_firm_do_parse_msg(esp_ota_firm_t *ota_firm, const char *in_buf, size_t in_len)
{
size_t tmp;
size_t parsed_bytes = in_len;
switch (ota_firm->state) {
case ESP_OTA_INIT:
if (_esp_ota_firm_parse_http(ota_firm, in_buf, in_len, &tmp)) {
ota_firm->state = ESP_OTA_PREPARE;
ESP_LOGD(TAG, "Http parse %d bytes", tmp);
parsed_bytes = tmp;
}
break;
case ESP_OTA_PREPARE:
ota_firm->read_bytes += in_len;
if (ota_firm->read_bytes >= ota_firm->ota_offset) {
ota_firm->buf = &in_buf[in_len - (ota_firm->read_bytes - ota_firm->ota_offset)];
ota_firm->bytes = ota_firm->read_bytes - ota_firm->ota_offset;
ota_firm->write_bytes += ota_firm->read_bytes - ota_firm->ota_offset;
ota_firm->state = ESP_OTA_START;
ESP_LOGD(TAG, "Receive %d bytes and start to update", ota_firm->read_bytes);
ESP_LOGD(TAG, "Write %d total %d", ota_firm->bytes, ota_firm->write_bytes);
}
break;
case ESP_OTA_START:
if (ota_firm->write_bytes + in_len > ota_firm->ota_size) {
ota_firm->bytes = ota_firm->ota_size - ota_firm->write_bytes;
ota_firm->state = ESP_OTA_RECVED;
} else
ota_firm->bytes = in_len;
ota_firm->buf = in_buf;
ota_firm->write_bytes += ota_firm->bytes;
ESP_LOGD(TAG, "Write %d total %d", ota_firm->bytes, ota_firm->write_bytes);
break;
case ESP_OTA_RECVED:
parsed_bytes = 0;
ota_firm->state = ESP_OTA_FINISH;
break;
default:
parsed_bytes = 0;
ESP_LOGD(TAG, "State is %d", ota_firm->state);
break;
}
return parsed_bytes;
}
static void esp_ota_firm_parse_msg(esp_ota_firm_t *ota_firm, const char *in_buf, size_t in_len)
{
size_t parse_bytes = 0;
ESP_LOGD(TAG, "Input %d bytes", in_len);
do {
size_t bytes = esp_ota_firm_do_parse_msg(ota_firm, in_buf + parse_bytes, in_len - parse_bytes);
ESP_LOGD(TAG, "Parse %d bytes", bytes);
if (bytes)
parse_bytes += bytes;
} while (parse_bytes != in_len);
}
static inline int esp_ota_firm_is_finished(esp_ota_firm_t *ota_firm)
{
return (ota_firm->state == ESP_OTA_FINISH || ota_firm->state == ESP_OTA_RECVED);
}
static inline int esp_ota_firm_can_write(esp_ota_firm_t *ota_firm)
{
return (ota_firm->state == ESP_OTA_START || ota_firm->state == ESP_OTA_RECVED);
}
static inline const char* esp_ota_firm_get_write_buf(esp_ota_firm_t *ota_firm)
{
return ota_firm->buf;
}
static inline size_t esp_ota_firm_get_write_bytes(esp_ota_firm_t *ota_firm)
{
return ota_firm->bytes;
}
static void esp_ota_firm_init(esp_ota_firm_t *ota_firm, const esp_partition_t *update_partition)
{
memset(ota_firm, 0, sizeof(esp_ota_firm_t));
ota_firm->state = ESP_OTA_INIT;
ota_firm->ota_num = get_ota_partition_count();
ota_firm->update_ota_num = update_partition->subtype - ESP_PARTITION_SUBTYPE_APP_OTA_0;
ESP_LOGI(TAG, "Totoal OTA number %d update to %d part", ota_firm->ota_num, ota_firm->update_ota_num);
}
static void ota_example_task(void *pvParameter)
{
esp_err_t err;
@ -184,7 +325,7 @@ static void ota_example_task(void *pvParameter)
esp_ota_handle_t update_handle = 0 ;
const esp_partition_t *update_partition = NULL;
ESP_LOGI(TAG, "Starting OTA example...");
ESP_LOGI(TAG, "Starting OTA example... @ %p flash %s", ota_example_task, CONFIG_ESPTOOLPY_FLASHSIZE);
const esp_partition_t *configured = esp_ota_get_boot_partition();
const esp_partition_t *running = esp_ota_get_running_partition();
@ -246,7 +387,11 @@ static void ota_example_task(void *pvParameter)
}
ESP_LOGI(TAG, "esp_ota_begin succeeded");
bool resp_body_start = false, flag = true;
bool flag = true;
esp_ota_firm_t ota_firm;
esp_ota_firm_init(&ota_firm, update_partition);
/*deal with all receive packet*/
while (flag) {
memset(text, 0, TEXT_BUFFSIZE);
@ -255,11 +400,15 @@ static void ota_example_task(void *pvParameter)
if (buff_len < 0) { /*receive error*/
ESP_LOGE(TAG, "Error: receive data error! errno=%d", errno);
task_fatal_error();
} else if (buff_len > 0 && !resp_body_start) { /*deal with response header*/
memcpy(ota_write_data, text, buff_len);
resp_body_start = read_past_http_header(text, buff_len, update_handle);
} else if (buff_len > 0 && resp_body_start) { /*deal with response body*/
memcpy(ota_write_data, text, buff_len);
} else if (buff_len > 0) { /*deal with response body*/
esp_ota_firm_parse_msg(&ota_firm, text, buff_len);
if (!esp_ota_firm_can_write(&ota_firm))
continue;
memcpy(ota_write_data, esp_ota_firm_get_write_buf(&ota_firm), esp_ota_firm_get_write_bytes(&ota_firm));
buff_len = esp_ota_firm_get_write_bytes(&ota_firm);
err = esp_ota_write( update_handle, (const void *)ota_write_data, buff_len);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Error: esp_ota_write failed! err=0x%x", err);
@ -274,6 +423,9 @@ static void ota_example_task(void *pvParameter)
} else {
ESP_LOGE(TAG, "Unexpected recv result");
}
if (esp_ota_firm_is_finished(&ota_firm))
break;
}
ESP_LOGI(TAG, "Total Write binary data length : %d", binary_file_length);

0
examples/system/universal_ota/partitions_two_ota.1MB.mini.csv → examples/system/ota/partitions_two_ota.1MB.mini.csv
View File

0
examples/system/universal_ota/partitions_two_ota_v2tov3.1MB.csv → examples/system/ota/partitions_two_ota_v2tov3.1MB.csv
View File

12
examples/system/ota/sdkconfig.defaults
View File

@ -1,4 +1,12 @@
# Default sdkconfig parameters to use the ESP8266 OTA
CONFIG_ESPTOOLPY_FLASHSIZE_2MB=y
CONFIG_PARTITION_TABLE_TWO_OTA=y
CONFIG_LWIP_SOCKET_MULTITHREAD=
CONFIG_ESPTOOLPY_FLASHSIZE_1MB=y
CONFIG_PARTITION_TABLE_CUSTOM=y
CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_two_ota.1MB.mini.csv"
CONFIG_PARTITION_TABLE_OFFSET=0x4000
CONFIG_APP1_OFFSET=0x6000
CONFIG_APP1_SIZE=0x7A000
CONFIG_APP2_OFFSET=0x86000
CONFIG_APP2_SIZE=0x7A000

9
examples/system/universal_ota/Makefile
View File

@ -1,9 +0,0 @@
#
# This is a project Makefile. It is assumed the directory this Makefile resides in is a
# project subdirectory.
#
PROJECT_NAME := ota
include $(IDF_PATH)/make/project.mk

BIN
examples/system/universal_ota/OTA_workflow.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 56 KiB

187
examples/system/universal_ota/README.md
View File

@ -1,187 +0,0 @@
# Simple OTA Demo
This example demonstrates a working OTA (over the air) firmware update workflow.
This example is a *simplified demonstration*, for production firmware updates you should use a secure protocol such as HTTPS.
---
# Aim
An app running on ESP8266 can upgrade itself by downloading a new app "image" binary file, and storing it in flash.
In this example, the ESP8266 has 2 images in flash: OTA_0, OTA_1. Each of these is a self-contained partition. The number of OTA image partition is determined by the partition table layout.
Flashing the example over serial with "make flash" updates the OTA_0 app image. On first boot, the bootloader loads this OTA_0 app image which then performs an OTA update (triggered in the example code). The update downloads a new image from an http server and saves it into the OTA_1 partition. At this point the example code updates the ota_data partition to indicate the new app partition, and reboots. The bootloader reads ota_data, determines the new OTA image has been selected, and runs it.
# Custom partition configuration
If customers want to use their own partition tables with specific partition location. Please see following steps:
## Step 1: Create partition file
Create a partition managment file with "cvs" formate, please refer to "doc/en/api-guides/partition-tables.rst"
## Step 2: Select custom partition mode
1. Select custom partition tables at "menuconfig":
```
Partition Table --->
Partition Table (XXXXXX) --->
(X) Custom partition table CSV
```
2. Configurate custom partition location at:
```
(XXXXXX)Custom partition CSV file
```
Note: System will add the absolute path of the project to the head of the "Custom partition CSV file" automatically when compling.
3. Configurate patition table location if necessary:
```
(XXXXXX)Partition table offset address at flash
```
## Step 3: Configurate application location:
Configurate application location at "mennuconfig" like following base on partition table file.
If you select 1MB flash, application location configuration menu is like following:
```
Partition Table --->
[*] Support to setup partition parameter of APP2
(0x5000) App1 offset address
(0x7B000) App1 size by bytes
(0x85000) App2 offset address
(0x7b000) App2 size by bytes
```
If you select 2MB flash and above size, application location configuration menu is like following:
```
Partition Table --->
(0x10000) APP1 partition offset
(0xF0000) APP1 partition size(by bytes)
```
Note: The firmware location information must be same as partition table file. **make ota flash** will only download the app1 at **APP1 partition offset**.
# Workflow
The OTA_workflow.png diagram demonstrates the overall workflow:
![OTA Workflow diagram](OTA_workflow.png)
## Step 1: Connect to AP
Connect your host PC to the same AP that you will use for the ESP8266.
## Step 2: Run HTTP Server
Python has a built-in HTTP server that can be used for example purposes.
For our upgrade example OTA file, we're going to use the `get-started/project_template` example.
Open a new terminal to run the HTTP server, then run these commands to build the example and start the server, if your board's flash size is "1 MB", you should firstly configure flash size to be "1 MB"(default is "2 MB") at "menuconfig" and then build project:
Configure 1MB flash if need:
```
Serial flasher config --->
Flash size (2 MB) --->
(X) 1 MB
```
Build project:
```
cd $IDF_PATH/examples/get-started/project_template
make ota
```
Start http server at the directory of "build":
```
cd build
python -m SimpleHTTPServer 8070
```
While the server is running, the contents of the build directory can be browsed at http://localhost:8070/
NB: On some systems, the command may be `python2 -m SimpleHTTPServer`.
NB: Command "make ota" will generate 3 binaries: "xxx(project name).app1.bin", "xxx(project name).app2.bin" and "xxx(project name).ota.bin". You should only upload the "xxx(project name).ota.bin" to your OTA server and let the app download it by the example.
NB: "xxx.app1.bin" is for downloading to OTA_0 partition, and "xxx.app2.bin" is for downloading to OTA_1 partition. If your board's flash size is larger than "1 MB", then "xxx.app1.bin" = "xxx.app2.bin" = "xxx.ota.bin". Otherwise "xxx.ota.bin" = "xxx.app1.bin" + "xxx.app2.bin". So the flash size configuration is very important. The example will select the binary it needs and store it to flash.
If you have any firewall software running that will block incoming access to port 8070, configure it to allow access while running the example.
## Step 3: Build OTA Example
Change back to the OTA example directory, and type `make menuconfig` to configure the OTA example. Under the "Example Configuration" submenu, fill in the following details:
* WiFi SSID & Password
* IP address of your host PC as "HTTP Server"
* HTTP Port number (if using the Python HTTP server above, the default is correct)
If serving the "project_template" example, you can leave the default filename as-is.
Configure 1MB flash if need:
```
Serial flasher config --->
Flash size (2 MB) --->
(X) 1 MB
```
Configurate the application location information and it must be same as the OTA example's information, how to do refer to **Step 3: Configurate application location** of **Custom partition configuration**.
Save your changes, and type `make` to build the example.
## Step 4: Flash OTA Example
When flashing, use the `erase_flash` target first to erase the entire flash (this deletes any leftover data in the ota_data partition). Then flash the factory image over serial:
```
make erase_flash flash
```
(The `make erase_flash flash` means "erase everything, then flash". `make flash` only erases the parts of flash which are being rewritten.)
## Step 5: Run the OTA Example
When the example starts up, it will print "ota: Starting OTA example..." then:
1. Connect to the AP with configured SSID and password.
2. Connect to the HTTP server and download the new image.
3. Write the image to flash, and configure the next boot from this image.
4. Reboot
# Troubleshooting
* Check your PC can ping the ESP8266 at its IP, and that the IP, AP and other configuration settings are correct in menuconfig.
* Check if any firewall software is preventing incoming connections on the PC.
* Check you can see the configured file (default project_template.ota.bin) if you browse the file listing at http://127.0.0.1/
* If you have another PC or a phone, try viewing the file listing from the separate host.
## Error "ota_begin error err=0x104"
If you see this error then check that the configured (and actual) flash size is large enough for the partitions in the partition table. The default "two OTA slots" partition table only works with 4MB flash size. To use OTA with smaller flash sizes, create a custom partition table CSV (look in components/partition_table) and configure it in menuconfig.
If changing partition layout, it is usually wise to run "make erase_flash" between steps.
## Production Implementation
If scaling this example for production use, please consider:
* Using an encrypted communications channel such as HTTPS.
* Dealing with timeouts or WiFi disconnections while flashing.

40
examples/system/universal_ota/main/Kconfig.projbuild
View File

@ -1,40 +0,0 @@
menu "Example Configuration"
config WIFI_SSID
string "WiFi SSID"
default "myssid"
help
SSID (network name) for the example to connect to.
config WIFI_PASSWORD
string "WiFi Password"
default "myssid"
help
WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set.
config SERVER_IP
string "HTTP Server IP"
default "192.168.0.3"
help
HTTP Server IP to download the image file from.
See example README.md for details.
config SERVER_PORT
string "HTTP Server Port"
default "8070"
help
HTTP Server port to connect to.
Should be chosen not to conflict with any other port used
on the system.
config EXAMPLE_FILENAME
string "HTTP GET Filename"
default "/project_template.ota.bin"
help
Filename of the app image file to download for
the OTA update.
endmenu

4
examples/system/universal_ota/main/component.mk
View File

@ -1,4 +0,0 @@
#
# "main" pseudo-component makefile.
#
# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

462
examples/system/universal_ota/main/ota_example_main.c
View File

@ -1,462 +0,0 @@
/* OTA example
This example code is in the Public Domain (or CC0 licensed, at your option.)
Unless required by applicable law or agreed to in writing, this
software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.
*/
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <netdb.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/event_groups.h"
#include "esp_system.h"
#include "esp_wifi.h"
#include "esp_event_loop.h"
#include "esp_log.h"
#include "esp_ota_ops.h"
#include "nvs.h"
#include "nvs_flash.h"
#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
#define EXAMPLE_SERVER_IP CONFIG_SERVER_IP
#define EXAMPLE_SERVER_PORT CONFIG_SERVER_PORT
#define EXAMPLE_FILENAME CONFIG_EXAMPLE_FILENAME
#define BUFFSIZE 1500
#define TEXT_BUFFSIZE 1024
typedef enum esp_ota_firm_state {
ESP_OTA_INIT = 0,
ESP_OTA_PREPARE,
ESP_OTA_START,
ESP_OTA_RECVED,
ESP_OTA_FINISH,
} esp_ota_firm_state_t;
typedef struct esp_ota_firm {
uint8_t ota_num;
uint8_t update_ota_num;
esp_ota_firm_state_t state;
size_t content_len;
size_t read_bytes;
size_t write_bytes;
size_t ota_size;
size_t ota_offset;
const char *buf;
size_t bytes;
} esp_ota_firm_t;
static const char *TAG = "ota";
/*an ota data write buffer ready to write to the flash*/
static char ota_write_data[BUFFSIZE + 1] = { 0 };
/*an packet receive buffer*/
static char text[BUFFSIZE + 1] = { 0 };
/* an image total length*/
static int binary_file_length = 0;
/*socket id*/
static int socket_id = -1;
/* FreeRTOS event group to signal when we are connected & ready to make a request */
static EventGroupHandle_t wifi_event_group;
/* The event group allows multiple bits for each event,
but we only care about one event - are we connected
to the AP with an IP? */
const int CONNECTED_BIT = BIT0;
static esp_err_t event_handler(void *ctx, system_event_t *event)
{
switch (event->event_id) {
case SYSTEM_EVENT_STA_START:
esp_wifi_connect();
break;
case SYSTEM_EVENT_STA_GOT_IP:
xEventGroupSetBits(wifi_event_group, CONNECTED_BIT);
break;
case SYSTEM_EVENT_STA_DISCONNECTED:
/* This is a workaround as ESP32 WiFi libs don't currently
auto-reassociate. */
esp_wifi_connect();
xEventGroupClearBits(wifi_event_group, CONNECTED_BIT);
break;
default:
break;
}
return ESP_OK;
}
static void initialise_wifi(void)
{
tcpip_adapter_init();
wifi_event_group = xEventGroupCreate();
ESP_ERROR_CHECK( esp_event_loop_init(event_handler, NULL) );
wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
ESP_ERROR_CHECK( esp_wifi_init(&cfg) );
ESP_ERROR_CHECK( esp_wifi_set_storage(WIFI_STORAGE_RAM) );
wifi_config_t wifi_config = {
.sta = {
.ssid = EXAMPLE_WIFI_SSID,
.password = EXAMPLE_WIFI_PASS,
},
};
ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
ESP_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA) );
ESP_ERROR_CHECK( esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config) );
ESP_ERROR_CHECK( esp_wifi_start() );
}
/*read buffer by byte still delim ,return read bytes counts*/
static int read_until(const char *buffer, char delim, int len)
{
// /*TODO: delim check,buffer check,further: do an buffer length limited*/
int i = 0;
while (buffer[i] != delim && i < len) {
++i;
}
return i + 1;
}
static bool connect_to_http_server()
{
ESP_LOGI(TAG, "Server IP: %s Server Port:%s", EXAMPLE_SERVER_IP, EXAMPLE_SERVER_PORT);
int http_connect_flag = -1;
struct sockaddr_in sock_info;
socket_id = socket(AF_INET, SOCK_STREAM, 0);
if (socket_id == -1) {
ESP_LOGE(TAG, "Create socket failed!");
return false;
}
// set connect info
memset(&sock_info, 0, sizeof(struct sockaddr_in));
sock_info.sin_family = AF_INET;
sock_info.sin_addr.s_addr = inet_addr(EXAMPLE_SERVER_IP);
sock_info.sin_port = htons(atoi(EXAMPLE_SERVER_PORT));
// connect to http server
http_connect_flag = connect(socket_id, (struct sockaddr *)&sock_info, sizeof(sock_info));
if (http_connect_flag == -1) {
ESP_LOGE(TAG, "Connect to server failed! errno=%d", errno);
close(socket_id);
return false;
} else {
ESP_LOGI(TAG, "Connected to server");
return true;
}
return false;
}
static void __attribute__((noreturn)) task_fatal_error()
{
ESP_LOGE(TAG, "Exiting task due to fatal error...");
close(socket_id);
(void)vTaskDelete(NULL);
while (1) {
;
}
}
bool _esp_ota_firm_parse_http(esp_ota_firm_t *ota_firm, const char *text, size_t total_len, size_t *parse_len)
{
/* i means current position */
int i = 0, i_read_len = 0;
char *ptr = NULL, *ptr2 = NULL;
char length_str[32];
while (text[i] != 0 && i < total_len) {
if (ota_firm->content_len == 0 && (ptr = (char *)strstr(text, "Content-Length")) != NULL) {
ptr += 16;
ptr2 = (char *)strstr(ptr, "\r\n");
memset(length_str, 0, sizeof(length_str));
memcpy(length_str, ptr, ptr2 - ptr);
ota_firm->content_len = atoi(length_str);
#ifdef CONFIG_ESPTOOLPY_FLASHSIZE_1MB
ota_firm->ota_size = ota_firm->content_len / ota_firm->ota_num;
ota_firm->ota_offset = ota_firm->ota_size * ota_firm->update_ota_num;
#else
ota_firm->ota_size = ota_firm->content_len;
ota_firm->ota_offset = 0;
#endif
ESP_LOGI(TAG, "parse Content-Length:%d, ota_size %d", ota_firm->content_len, ota_firm->ota_size);
}
i_read_len = read_until(&text[i], '\n', total_len - i);
if (i_read_len > total_len - i) {
ESP_LOGE(TAG, "recv malformed http header");
task_fatal_error();
}
// if resolve \r\n line, http header is finished
if (i_read_len == 2) {
if (ota_firm->content_len == 0) {
ESP_LOGE(TAG, "did not parse Content-Length item");
task_fatal_error();
}
*parse_len = i + 2;
return true;
}
i += i_read_len;
}
return false;
}
static size_t esp_ota_firm_do_parse_msg(esp_ota_firm_t *ota_firm, const char *in_buf, size_t in_len)
{
size_t tmp;
size_t parsed_bytes = in_len;
switch (ota_firm->state) {
case ESP_OTA_INIT:
if (_esp_ota_firm_parse_http(ota_firm, in_buf, in_len, &tmp)) {
ota_firm->state = ESP_OTA_PREPARE;
ESP_LOGD(TAG, "Http parse %d bytes", tmp);
parsed_bytes = tmp;
}
break;
case ESP_OTA_PREPARE:
ota_firm->read_bytes += in_len;
if (ota_firm->read_bytes >= ota_firm->ota_offset) {
ota_firm->buf = &in_buf[in_len - (ota_firm->read_bytes - ota_firm->ota_offset)];
ota_firm->bytes = ota_firm->read_bytes - ota_firm->ota_offset;
ota_firm->write_bytes += ota_firm->read_bytes - ota_firm->ota_offset;
ota_firm->state = ESP_OTA_START;
ESP_LOGD(TAG, "Receive %d bytes and start to update", ota_firm->read_bytes);
ESP_LOGD(TAG, "Write %d total %d", ota_firm->bytes, ota_firm->write_bytes);
}
break;
case ESP_OTA_START:
if (ota_firm->write_bytes + in_len > ota_firm->ota_size) {
ota_firm->bytes = ota_firm->ota_size - ota_firm->write_bytes;
ota_firm->state = ESP_OTA_RECVED;
} else
ota_firm->bytes = in_len;
ota_firm->buf = in_buf;
ota_firm->write_bytes += ota_firm->bytes;
ESP_LOGD(TAG, "Write %d total %d", ota_firm->bytes, ota_firm->write_bytes);
break;
case ESP_OTA_RECVED:
parsed_bytes = 0;
ota_firm->state = ESP_OTA_FINISH;
break;
default:
parsed_bytes = 0;
ESP_LOGD(TAG, "State is %d", ota_firm->state);
break;
}
return parsed_bytes;
}
static void esp_ota_firm_parse_msg(esp_ota_firm_t *ota_firm, const char *in_buf, size_t in_len)
{
size_t parse_bytes = 0;
ESP_LOGD(TAG, "Input %d bytes", in_len);
do {
size_t bytes = esp_ota_firm_do_parse_msg(ota_firm, in_buf + parse_bytes, in_len - parse_bytes);
ESP_LOGD(TAG, "Parse %d bytes", bytes);
if (bytes)
parse_bytes += bytes;
} while (parse_bytes != in_len);
}
static inline int esp_ota_firm_is_finished(esp_ota_firm_t *ota_firm)
{
return (ota_firm->state == ESP_OTA_FINISH || ota_firm->state == ESP_OTA_RECVED);
}
static inline int esp_ota_firm_can_write(esp_ota_firm_t *ota_firm)
{
return (ota_firm->state == ESP_OTA_START || ota_firm->state == ESP_OTA_RECVED);
}
static inline const char* esp_ota_firm_get_write_buf(esp_ota_firm_t *ota_firm)
{
return ota_firm->buf;
}
static inline size_t esp_ota_firm_get_write_bytes(esp_ota_firm_t *ota_firm)
{
return ota_firm->bytes;
}
static void esp_ota_firm_init(esp_ota_firm_t *ota_firm, const esp_partition_t *update_partition)
{
memset(ota_firm, 0, sizeof(esp_ota_firm_t));
ota_firm->state = ESP_OTA_INIT;
ota_firm->ota_num = get_ota_partition_count();
ota_firm->update_ota_num = update_partition->subtype - ESP_PARTITION_SUBTYPE_APP_OTA_0;
ESP_LOGI(TAG, "Totoal OTA number %d update to %d part", ota_firm->ota_num, ota_firm->update_ota_num);
}
static void ota_example_task(void *pvParameter)
{
esp_err_t err;
/* update handle : set by esp_ota_begin(), must be freed via esp_ota_end() */
esp_ota_handle_t update_handle = 0 ;
const esp_partition_t *update_partition = NULL;
ESP_LOGI(TAG, "Starting OTA example... @ %p flash %s", ota_example_task, CONFIG_ESPTOOLPY_FLASHSIZE);
const esp_partition_t *configured = esp_ota_get_boot_partition();
const esp_partition_t *running = esp_ota_get_running_partition();
if (configured != running) {
ESP_LOGW(TAG, "Configured OTA boot partition at offset 0x%08x, but running from offset 0x%08x",
configured->address, running->address);
ESP_LOGW(TAG, "(This can happen if either the OTA boot data or preferred boot image become corrupted somehow.)");
}
ESP_LOGI(TAG, "Running partition type %d subtype %d (offset 0x%08x)",
running->type, running->subtype, running->address);
/* Wait for the callback to set the CONNECTED_BIT in the
event group.
*/
xEventGroupWaitBits(wifi_event_group, CONNECTED_BIT,
false, true, portMAX_DELAY);
ESP_LOGI(TAG, "Connect to Wifi ! Start to Connect to Server....");
/*connect to http server*/
if (connect_to_http_server()) {
ESP_LOGI(TAG, "Connected to http server");
} else {
ESP_LOGE(TAG, "Connect to http server failed!");
task_fatal_error();
}
/*send GET request to http server*/
const char *GET_FORMAT =
"GET %s HTTP/1.0\r\n"
"Host: %s:%s\r\n"
"User-Agent: esp-idf/1.0 esp32\r\n\r\n";
char *http_request = NULL;
int get_len = asprintf(&http_request, GET_FORMAT, EXAMPLE_FILENAME, EXAMPLE_SERVER_IP, EXAMPLE_SERVER_PORT);
if (get_len < 0) {
ESP_LOGE(TAG, "Failed to allocate memory for GET request buffer");
task_fatal_error();
}
int res = send(socket_id, http_request, get_len, 0);
free(http_request);
if (res < 0) {
ESP_LOGE(TAG, "Send GET request to server failed");
task_fatal_error();
} else {
ESP_LOGI(TAG, "Send GET request to server succeeded");
}
update_partition = esp_ota_get_next_update_partition(NULL);
ESP_LOGI(TAG, "Writing to partition subtype %d at offset 0x%x",
update_partition->subtype, update_partition->address);
assert(update_partition != NULL);
err = esp_ota_begin(update_partition, OTA_SIZE_UNKNOWN, &update_handle);
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_ota_begin failed, error=%d", err);
task_fatal_error();
}
ESP_LOGI(TAG, "esp_ota_begin succeeded");
bool flag = true;
esp_ota_firm_t ota_firm;
esp_ota_firm_init(&ota_firm, update_partition);
/*deal with all receive packet*/
while (flag) {
memset(text, 0, TEXT_BUFFSIZE);
memset(ota_write_data, 0, BUFFSIZE);
int buff_len = recv(socket_id, text, TEXT_BUFFSIZE, 0);
if (buff_len < 0) { /*receive error*/
ESP_LOGE(TAG, "Error: receive data error! errno=%d", errno);
task_fatal_error();
} else if (buff_len > 0) { /*deal with response body*/
esp_ota_firm_parse_msg(&ota_firm, text, buff_len);
if (!esp_ota_firm_can_write(&ota_firm))
continue;
memcpy(ota_write_data, esp_ota_firm_get_write_buf(&ota_firm), esp_ota_firm_get_write_bytes(&ota_firm));
buff_len = esp_ota_firm_get_write_bytes(&ota_firm);
err = esp_ota_write( update_handle, (const void *)ota_write_data, buff_len);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Error: esp_ota_write failed! err=0x%x", err);
task_fatal_error();
}
binary_file_length += buff_len;
ESP_LOGI(TAG, "Have written image length %d", binary_file_length);
} else if (buff_len == 0) { /*packet over*/
flag = false;
ESP_LOGI(TAG, "Connection closed, all packets received");
close(socket_id);
} else {
ESP_LOGE(TAG, "Unexpected recv result");
}
if (esp_ota_firm_is_finished(&ota_firm))
break;
}
ESP_LOGI(TAG, "Total Write binary data length : %d", binary_file_length);
if (esp_ota_end(update_handle) != ESP_OK) {
ESP_LOGE(TAG, "esp_ota_end failed!");
task_fatal_error();
}
err = esp_ota_set_boot_partition(update_partition);
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_ota_set_boot_partition failed! err=0x%x", err);
task_fatal_error();
}
ESP_LOGI(TAG, "Prepare to restart system!");
esp_restart();
return ;
}
void app_main()
{
// Initialize NVS.
esp_err_t err = nvs_flash_init();
if (err == ESP_ERR_NVS_NO_FREE_PAGES) {
// OTA app partition table has a smaller NVS partition size than the non-OTA
// partition table. This size mismatch may cause NVS initialization to fail.
// If this happens, we erase NVS partition and initialize NVS again.
ESP_ERROR_CHECK(nvs_flash_erase());
err = nvs_flash_init();
}
ESP_ERROR_CHECK( err );
initialise_wifi();
xTaskCreate(&ota_example_task, "ota_example_task", 8192, NULL, 5, NULL);
}

12
examples/system/universal_ota/sdkconfig.defaults
View File

@ -1,12 +0,0 @@
# Default sdkconfig parameters to use the ESP8266 OTA
CONFIG_LWIP_SOCKET_MULTITHREAD=
CONFIG_ESPTOOLPY_FLASHSIZE_1MB=y
CONFIG_PARTITION_TABLE_CUSTOM=y
CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_two_ota.1MB.mini.csv"
CONFIG_PARTITION_TABLE_OFFSET=0x4000
CONFIG_APP1_OFFSET=0x6000
CONFIG_APP1_SIZE=0x7A000
CONFIG_APP2_OFFSET=0x86000
CONFIG_APP2_SIZE=0x7A000