Initial implementation of custom upgrade code

This commit is contained in:
Gunnar Skjold
2024-08-02 17:56:39 +02:00
parent 9a4a8a10f2
commit 054fd43a0d
20 changed files with 792 additions and 313 deletions

View File

@@ -0,0 +1,490 @@
#include "AmsFirmwareUpdater.h"
#include "AmsStorage.h"
#include "FirmwareVersion.h"
#if defined(ESP32)
#include "esp_ota_ops.h"
#include "driver/spi_common.h"
#include "esp_flash_spi_init.h"
#include "MD5Builder.h"
#elif defined(ESP8266)
#include ""
#endif
AmsFirmwareUpdater::AmsFirmwareUpdater(Print* debugger, HwTools* hw, AmsData* meterState) {
this->debugger = debugger;
this->hw = hw;
this->meterState = meterState;
memset(nextVersion, 0, sizeof(nextVersion));
firmwareVariant = 0;
autoUpgrade = false;
}
char* AmsFirmwareUpdater::getNextVersion() {
return nextVersion;
}
bool AmsFirmwareUpdater::setTargetVersion(const char* version) {
if(strcmp(version, FirmwareVersion::VersionString) == 0) {
memset(updateStatus.toVersion, 0, sizeof(updateStatus.toVersion));
return false;
}
if(strcmp(version, updateStatus.toVersion) == 0) {
return true;
}
strcpy(updateStatus.fromVersion, FirmwareVersion::VersionString);
strcpy(updateStatus.toVersion, version);
updateStatus.size = 0;
updateStatus.retry_count = 0;
updateStatus.block_position = 0;
updateStatus.errorCode = AMS_UPDATE_ERR_OK;
return true;
}
void AmsFirmwareUpdater::getUpgradeInformation(UpgradeInformation& upinfo) {
memcpy(&upinfo, &updateStatus, sizeof(upinfo));
}
float AmsFirmwareUpdater::getProgress() {
if(strlen(updateStatus.toVersion) == 0 || updateStatus.size == 0) return -1.0;
return min((float) 100.0, ((((float) updateStatus.block_position) * UPDATE_BUF_SIZE) / updateStatus.size) * 100);
}
void AmsFirmwareUpdater::loop() {
if(strlen(updateStatus.toVersion) > 0) {
if(updateStatus.errorCode > 0) return;
if(!hw->isVoltageOptimal(0.1)) {
writeUpdateStatus();
return;
}
unsigned long start = 0, end = 0;
if(buf == NULL) buf = (char*) malloc(UPDATE_BUF_SIZE);
if(updateStatus.size == 0) {
start = millis();
if(!fetchVersionDetails()) {
updateStatus.errorCode = AMS_UPDATE_ERR_DETAILS;
return;
}
end = millis();
debugger->printf_P(PSTR("fetch details took %lums\n"), end-start);
updateStatus.retry_count = 0;
updateStatus.block_position = 0;
updateStatus.errorCode = AMS_UPDATE_ERR_OK;
} else if(updateStatus.block_position * UPDATE_BUF_SIZE < updateStatus.size) {
HTTPClient http;
start = millis();
if(!fetchFirmwareChunk(http)) {
if(updateStatus.retry_count++ == 3) {
updateStatus.errorCode = AMS_UPDATE_ERR_FETCH;
}
writeUpdateStatus();
http.end();
return;
}
end = millis();
debugger->printf_P(PSTR("fetch chunk took %lums\n"), end-start);
start = millis();
WiFiClient* client = http.getStreamPtr();
updateStatus.retry_count = 0;
if(!client->available()) {
http.end();
return;
}
end = millis();
debugger->printf_P(PSTR("get ptr took %lums (%d) \n"), end-start, client->available());
size_t bytes = UPDATE_BUF_SIZE; // To start first loop
while(bytes > 0 && client->available() > 0) {
start = millis();
bytes = client->readBytes(buf, UPDATE_BUF_SIZE);
end = millis();
debugger->printf_P(PSTR("read buffer took %lums (%lu bytes, %d left)\n"), end-start, bytes, client->available());
if(bytes > 0) {
start = millis();
if(!writeBufferToFlash(bytes)) {
http.end();
return;
}
end = millis();
debugger->printf_P(PSTR("write buffer took %lums\n"), end-start);
}
start = millis();
if(!hw->isVoltageOptimal(0.2)) {
writeUpdateStatus();
}
end = millis();
debugger->printf_P(PSTR("check voltage took %lums\n"), end-start);
}
start = millis();
http.end();
end = millis();
debugger->printf_P(PSTR("http end took %lums\n"), end-start);
} else if(updateStatus.block_position * UPDATE_BUF_SIZE >= updateStatus.size) {
if(!verifyChecksum()) {
updateStatus.errorCode = AMS_UPDATE_ERR_MD5;
return;
}
if(!activateNewFirmware()) {
return;
}
}
} else {
uint32_t seconds = millis() / 1000.0;
if((lastVersionCheck == 0 && seconds > 20) || seconds - lastVersionCheck > 86400) {
fetchNextVersion();
lastVersionCheck = seconds;
}
}
}
bool AmsFirmwareUpdater::fetchNextVersion() {
HTTPClient http;
const char * headerkeys[] = { "x-version" };
http.collectHeaders(headerkeys, 1);
char firmwareVariant[10] = "stable";
char url[128];
snprintf_P(url, 128, PSTR("http://hub.amsleser.no/hub/firmware/%s/%s/next"), chipType, firmwareVariant);
if(http.begin(url)) {
http.useHTTP10(true);
http.setTimeout(30000);
http.setFollowRedirects(HTTPC_FORCE_FOLLOW_REDIRECTS);
http.setUserAgent("AMS-Firmware-Updater");
http.addHeader(F("Cache-Control"), "no-cache");
http.addHeader(F("x-AMS-version"), FirmwareVersion::VersionString);
int status = http.GET();
if(status == 204) {
String nextVersion = http.header("x-version");
strcpy(this->nextVersion, nextVersion.c_str());
if(autoUpgrade && strcmp(updateStatus.toVersion, this->nextVersion) != 0) {
strcpy(updateStatus.toVersion, this->nextVersion);
updateStatus.size = 0;
}
http.end();
return strlen(this->nextVersion) > 0;
} else if(status == 200) {
memset(this->nextVersion, 0, sizeof(this->nextVersion));
}
http.end();
}
return false;
}
bool AmsFirmwareUpdater::fetchVersionDetails() {
HTTPClient http;
const char * headerkeys[] = { "x-size" };
http.collectHeaders(headerkeys, 1);
char firmwareVariant[10] = "stable";
char url[128];
snprintf_P(url, 128, PSTR("http://hub.amsleser.no/hub/firmware/%s/%s/%s/details"), chipType, firmwareVariant, updateStatus.toVersion);
if(http.begin(url)) {
http.useHTTP10(true);
http.setTimeout(30000);
http.setFollowRedirects(HTTPC_FORCE_FOLLOW_REDIRECTS);
http.setUserAgent("AMS-Firmware-Updater");
http.addHeader(F("Cache-Control"), "no-cache");
http.addHeader(F("x-AMS-STA-MAC"), WiFi.macAddress());
http.addHeader(F("x-AMS-AP-MAC"), WiFi.softAPmacAddress());
http.addHeader(F("x-AMS-free-space"), String(ESP.getFreeSketchSpace()));
http.addHeader(F("x-AMS-sketch-size"), String(ESP.getSketchSize()));
String sketchMD5 = ESP.getSketchMD5();
if(!sketchMD5.isEmpty()) {
http.addHeader(F("x-AMS-sketch-md5"), sketchMD5);
}
http.addHeader(F("x-AMS-chip-size"), String(ESP.getFlashChipSize()));
http.addHeader(F("x-AMS-sdk-version"), ESP.getSdkVersion());
http.addHeader(F("x-AMS-mode"), "sketch");
http.addHeader(F("x-AMS-version"), FirmwareVersion::VersionString);
http.addHeader(F("x-AMS-board-type"), String(hw->getBoardType(), 10));
if(meterState->getMeterType() != AmsTypeAutodetect) {
http.addHeader(F("x-AMS-meter-mfg"), String(meterState->getMeterType(), 10));
}
if(!meterState->getMeterModel().isEmpty()) {
http.addHeader(F("x-AMS-meter-model"), meterState->getMeterModel());
}
int status = http.GET();
if(status == 204) {
String size = http.header("x-size");
updateStatus.size = size.toInt();
http.end();
return true;
}
http.end();
}
return false;
}
bool AmsFirmwareUpdater::fetchFirmwareChunk(HTTPClient& http) {
const char * headerkeys[] = { "x-MD5" };
http.collectHeaders(headerkeys, 1);
uint32_t start = updateStatus.block_position * UPDATE_BUF_SIZE;
uint32_t end = start + (UPDATE_BUF_SIZE * 1);
char range[24];
snprintf_P(range, 24, PSTR("bytes=%lu-%lu"), start, end);
char firmwareVariant[10] = "stable";
char url[128];
snprintf_P(url, 128, PSTR("http://hub.amsleser.no/hub/firmware/%s/%s/%s/chunk"), chipType, firmwareVariant, updateStatus.toVersion);
if(http.begin(url)) {
http.useHTTP10(true);
http.setTimeout(30000);
http.setFollowRedirects(HTTPC_FORCE_FOLLOW_REDIRECTS);
http.setUserAgent("AMS-Firmware-Updater");
http.addHeader(F("Cache-Control"), "no-cache");
http.addHeader(F("x-AMS-version"), FirmwareVersion::VersionString);
http.addHeader(F("Range"), range);
if(http.GET() == 206) {
this->md5 = http.header("x-MD5");
return true;
}
}
return false;
}
bool AmsFirmwareUpdater::writeUpdateStatus() {
return false; // TODO
}
#if defined(ESP32)
bool AmsFirmwareUpdater::writeBufferToFlash(size_t bytes) {
uint32_t offset = updateStatus.block_position * UPDATE_BUF_SIZE;
const esp_partition_t* partition = esp_ota_get_next_update_partition(NULL);
esp_err_t eraseErr = esp_partition_erase_range(partition, offset, UPDATE_BUF_SIZE);
if(eraseErr != ESP_OK) {
debugger->printf_P(PSTR("esp_partition_erase_range(%s, %lu, %lu) failed with %d\n"), partition->label, offset, UPDATE_BUF_SIZE, eraseErr);
updateStatus.errorCode = AMS_UPDATE_ERR_ERASE;
return false;
}
esp_err_t writeErr = esp_partition_write(partition, offset, buf, bytes);
if(writeErr != ESP_OK) {
debugger->printf_P(PSTR("esp_partition_write(%s, %lu, buf, %lu) failed with %d\n"), partition->label, offset, bytes, writeErr);
updateStatus.errorCode = AMS_UPDATE_ERR_WRITE;
return false;
}
updateStatus.block_position++;
return true;
}
bool AmsFirmwareUpdater::activateNewFirmware() {
const esp_partition_t* partition = esp_ota_get_next_update_partition(NULL);
if(esp_ota_set_boot_partition(partition) != ESP_OK) {
updateStatus.errorCode = AMS_UPDATE_ERR_ACTIVATE;
return false;
}
ESP.restart();
return true;
}
bool AmsFirmwareUpdater::relocateOrRepartitionIfNecessary() {
const esp_partition_t* active = esp_ota_get_running_partition();
debugger->printf_P(PSTR("Firmware currently running from %s\n"), active->label);
if(active->type != ESP_PARTITION_TYPE_APP) {
debugger->printf_P(PSTR("Not running on APP partition?\n"));
return false;
}
if(active->size >= AMS_PARTITION_APP_SIZE) {
debugger->printf_P(PSTR("Partition is large enough, no change\n"));
return false;
}
if(buf == NULL) buf = (char*) malloc(UPDATE_BUF_SIZE);
esp_partition_info_t p_nvs, p_ota, p_app0, p_app1, p_spiffs, p_coredump;
readPartition(0, &p_nvs);
readPartition(1, &p_ota);
readPartition(2, &p_app0);
readPartition(3, &p_app1);
readPartition(4, &p_spiffs);
readPartition(5, &p_coredump);
const esp_partition_t* app0 = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_OTA_MIN, NULL);
if(active->subtype != ESP_PARTITION_SUBTYPE_APP_OTA_MIN) {
debugger->printf_P(PSTR("Relocating %s to %s\n"), active->label, p_app0.label);
if(!copyData(&p_app1, &p_app0)) {
debugger->printf_P(PSTR("Unable to copy app0 to app1\n"));
return false;
}
if(esp_ota_set_boot_partition(app0) != ESP_OK) {
debugger->printf_P(PSTR("Unable to set app0 active\n"));
return false;
}
return true;
}
debugger->printf_P(PSTR("Small partition, repartitioning\n"));
p_app0.pos.offset = AMS_PARTITION_APP0_OFFSET;
p_app0.pos.size = AMS_PARTITION_APP_SIZE;
p_app1.pos.offset = p_app0.pos.offset + p_app0.pos.size;
p_app1.pos.size = AMS_PARTITION_APP_SIZE;
p_spiffs.pos.offset = p_app1.pos.offset + p_app1.pos.size;
p_spiffs.pos.size = AMS_PARTITION_SPIFFS_SIZE;
esp_err_t p_erase_err = esp_flash_erase_region(NULL, AMS_PARTITION_TABLE_OFFSET, 4096);
if(p_erase_err != ESP_OK) {
debugger->printf_P(PSTR("Unable to erase partition table (%d)\n"), p_erase_err);
return false;
}
writePartition(0, &p_nvs);
writePartition(1, &p_ota);
writePartition(2, &p_app0);
writePartition(3, &p_app1);
writePartition(4, &p_spiffs);
writePartition(5, &p_coredump);
uint32_t md5pos = 0;
esp_partition_info_t part;
for(uint8_t i = 0; i < 10; i++) {
uint16_t size = sizeof(part);
uint32_t pos = i * size;
readPartition(i, &part);
if(part.magic == ESP_PARTITION_MAGIC) {
debugger->printf_P(PSTR("Partition %d, magic: %04X, offset: %X, size: %d, type: %d:%d, label: %s, flags: %04X\n"), i, part.magic, part.pos.offset, part.pos.size, part.type, part.subtype, part.label, part.flags);
} else {
md5pos = pos;
break;
}
}
memset(buf, 0, UPDATE_BUF_SIZE);
MD5Builder md5;
md5.begin();
md5.add((uint8_t*) &p_nvs, sizeof(p_nvs));
md5.add((uint8_t*) &p_ota, sizeof(p_ota));
md5.add((uint8_t*) &p_app0, sizeof(p_app0));
md5.add((uint8_t*) &p_app1, sizeof(p_app1));
md5.add((uint8_t*) &p_spiffs, sizeof(p_spiffs));
md5.add((uint8_t*) &p_coredump, sizeof(p_coredump));
md5.calculate();
md5.getChars(buf);
debugger->printf_P(PSTR("Writing MD5 %s to position %d\n"), buf, md5pos);
part.magic = ESP_PARTITION_MAGIC_MD5;
if(esp_flash_write(NULL, (uint8_t*) &part, AMS_PARTITION_TABLE_OFFSET + md5pos, 2) != ESP_OK) {
debugger->printf_P(PSTR("Unable to write md5 header\n"));
return false;
}
md5.getBytes((uint8_t*) buf);
if(esp_flash_write(NULL, buf, AMS_PARTITION_TABLE_OFFSET + md5pos + ESP_PARTITION_MD5_OFFSET, ESP_ROM_MD5_DIGEST_LEN) != ESP_OK) {
debugger->printf_P(PSTR("Unable to write md5\n"));
return false;
}
if(esp_flash_erase_region(NULL, p_app1.pos.offset, p_app1.pos.size) != ESP_OK) {
debugger->printf_P(PSTR("Unable to erase app1\n"));
}
uint32_t eraseForFsStart = p_spiffs.pos.offset + p_spiffs.pos.size - UPDATE_BUF_SIZE;
if(esp_flash_erase_region(NULL, eraseForFsStart, UPDATE_BUF_SIZE) == ESP_OK) {
fs::LittleFSFS newFs;
if(newFs.begin(true, "/newfs", 10, (char*) p_spiffs.label)) {
copyFile(&LittleFS, &newFs, FILE_MQTT_CA);
copyFile(&LittleFS, &newFs, FILE_MQTT_CERT);
copyFile(&LittleFS, &newFs, FILE_MQTT_KEY);
copyFile(&LittleFS, &newFs, FILE_DAYPLOT);
copyFile(&LittleFS, &newFs, FILE_MONTHPLOT);
copyFile(&LittleFS, &newFs, FILE_ENERGYACCOUNTING);
copyFile(&LittleFS, &newFs, FILE_PRICE_CONF);
} else {
debugger->printf_P(PSTR("Unable to start spiffs on new location\n"));
}
} else {
debugger->printf_P(PSTR("Unable to erase fs\n"));
}
esp_image_header_t h_app0;
if(esp_flash_read(NULL, buf, p_app0.pos.offset, sizeof(&h_app0)) == ESP_OK) {
if(esp_flash_write(NULL, buf, p_app1.pos.offset, sizeof(&h_app0)) != ESP_OK) {
debugger->printf_P(PSTR("Unable to write header to app1\n"));
}
} else {
debugger->printf_P(PSTR("Unable to read header from app0\n"));
}
return true;
}
bool AmsFirmwareUpdater::readPartition(uint8_t num, const esp_partition_info_t* partition) {
uint32_t pos = num * sizeof(*partition);
if(esp_flash_read(NULL, (uint8_t*) partition, AMS_PARTITION_TABLE_OFFSET + pos, sizeof(*partition)) != ESP_OK) {
debugger->printf_P(PSTR("Unable to read partition %d\n"), num);
return false;
}
return true;
}
bool AmsFirmwareUpdater::writePartition(uint8_t num, const esp_partition_info_t* partition) {
uint32_t pos = num * sizeof(*partition);
if(esp_flash_write(NULL, (uint8_t*) partition, AMS_PARTITION_TABLE_OFFSET + pos, sizeof(*partition)) != ESP_OK) {
debugger->printf_P(PSTR("Unable to write partition %d\n"), num);
return false;
}
return true;
}
bool AmsFirmwareUpdater::copyData(const esp_partition_info_t* src, esp_partition_info_t* dst) {
if(esp_flash_erase_region(NULL, dst->pos.offset, dst->pos.size) != ESP_OK) {
return false;
}
uint32_t pos = 0;
while(pos < dst->pos.size) {
if(esp_flash_read(NULL, buf, src->pos.offset + pos, UPDATE_BUF_SIZE) != ESP_OK) {
return false;
}
if(esp_flash_write(NULL, buf, dst->pos.offset + pos, UPDATE_BUF_SIZE) != ESP_OK) {
return false;
}
pos += UPDATE_BUF_SIZE;
}
return true;
}
bool AmsFirmwareUpdater::copyFile(fs::LittleFSFS* srcFs, fs::LittleFSFS* dstFs, const char* filename) {
if(srcFs->exists(filename)) {
File src = srcFs->open(filename, "r");
File dst = dstFs->open(filename, "w");
size_t size;
while((size = src.readBytes(buf, UPDATE_BUF_SIZE)) > 0) {
dst.write((uint8_t*) buf, size);
}
dst.close();
src.close();
return true;
}
return false;
}
bool AmsFirmwareUpdater::verifyChecksum() {
const esp_partition_t *partition = esp_ota_get_next_update_partition(NULL);
if (!partition) {
return false;
}
MD5Builder md5;
md5.begin();
uint32_t offset = 0;
uint32_t lengthLeft = updateStatus.size;
while( lengthLeft > 0) {
size_t bytes = (lengthLeft < UPDATE_BUF_SIZE) ? lengthLeft : UPDATE_BUF_SIZE;
if(esp_partition_read(partition, offset, buf, bytes) != ESP_OK) {
updateStatus.errorCode = AMS_UPDATE_ERR_READ;
return false;
}
md5.add((uint8_t*) buf, bytes);
lengthLeft -= bytes;
offset += bytes;
delay(1);
}
md5.calculate();
return !this->md5.isEmpty() && this->md5.equals(md5.toString());
}
#endif