4000f0cac5
* Furi strings: printf attribute * Logs: printf attribute * Plugins: adapt * Plugins: accommodate * Unit tests: accommodate Co-authored-by: あく <alleteam@gmail.com>
365 lines
14 KiB
C
365 lines
14 KiB
C
#include "update_task.h"
|
|
#include "update_task_i.h"
|
|
|
|
#include <furi.h>
|
|
#include <furi_hal.h>
|
|
#include <storage/storage.h>
|
|
#include <toolbox/path.h>
|
|
#include <update_util/dfu_file.h>
|
|
#include <update_util/lfs_backup.h>
|
|
#include <update_util/update_operation.h>
|
|
#include <toolbox/tar/tar_archive.h>
|
|
#include <toolbox/crc32_calc.h>
|
|
|
|
#define TAG "UpdWorkerRAM"
|
|
|
|
#define CHECK_RESULT(x) \
|
|
if(!(x)) { \
|
|
break; \
|
|
}
|
|
|
|
#define STM_DFU_VENDOR_ID 0x0483
|
|
#define STM_DFU_PRODUCT_ID 0xDF11
|
|
/* Written into DFU file by build pipeline */
|
|
#define FLIPPER_ZERO_DFU_DEVICE_CODE 0xFFFF
|
|
/* Time, in ms, to wait for system restart by C2 before crashing */
|
|
#define C2_MODE_SWITCH_TIMEOUT 10000
|
|
|
|
static const DfuValidationParams flipper_dfu_params = {
|
|
.device = FLIPPER_ZERO_DFU_DEVICE_CODE,
|
|
.product = STM_DFU_PRODUCT_ID,
|
|
.vendor = STM_DFU_VENDOR_ID,
|
|
};
|
|
|
|
static void update_task_file_progress(const uint8_t progress, void* context) {
|
|
UpdateTask* update_task = context;
|
|
update_task_set_progress(update_task, UpdateTaskStageProgress, progress);
|
|
}
|
|
|
|
static bool page_task_compare_flash(
|
|
const uint8_t i_page,
|
|
const uint8_t* update_block,
|
|
uint16_t update_block_len) {
|
|
const size_t page_addr = furi_hal_flash_get_base() + furi_hal_flash_get_page_size() * i_page;
|
|
return (memcmp(update_block, (void*)page_addr, update_block_len) == 0);
|
|
}
|
|
|
|
/* Verifies a flash operation address for fitting into writable memory
|
|
*/
|
|
static bool check_address_boundaries(const size_t address) {
|
|
const size_t min_allowed_address = furi_hal_flash_get_base();
|
|
const size_t max_allowed_address = (size_t)furi_hal_flash_get_free_end_address();
|
|
return ((address >= min_allowed_address) && (address < max_allowed_address));
|
|
}
|
|
|
|
static bool update_task_flash_program_page(
|
|
const uint8_t i_page,
|
|
const uint8_t* update_block,
|
|
uint16_t update_block_len) {
|
|
furi_hal_flash_program_page(i_page, update_block, update_block_len);
|
|
return true;
|
|
}
|
|
|
|
static bool update_task_write_dfu(UpdateTask* update_task) {
|
|
DfuUpdateTask page_task = {
|
|
.address_cb = &check_address_boundaries,
|
|
.progress_cb = &update_task_file_progress,
|
|
.task_cb = &update_task_flash_program_page,
|
|
.context = update_task,
|
|
};
|
|
|
|
bool success = false;
|
|
do {
|
|
update_task_set_progress(update_task, UpdateTaskStageValidateDFUImage, 0);
|
|
CHECK_RESULT(
|
|
update_task_open_file(update_task, update_task->manifest->firmware_dfu_image));
|
|
CHECK_RESULT(
|
|
dfu_file_validate_crc(update_task->file, &update_task_file_progress, update_task));
|
|
|
|
const uint8_t valid_targets =
|
|
dfu_file_validate_headers(update_task->file, &flipper_dfu_params);
|
|
if(valid_targets == 0) {
|
|
break;
|
|
}
|
|
|
|
update_task_set_progress(update_task, UpdateTaskStageFlashWrite, 0);
|
|
CHECK_RESULT(dfu_file_process_targets(&page_task, update_task->file, valid_targets));
|
|
|
|
page_task.task_cb = &page_task_compare_flash;
|
|
|
|
update_task_set_progress(update_task, UpdateTaskStageFlashValidate, 0);
|
|
CHECK_RESULT(dfu_file_process_targets(&page_task, update_task->file, valid_targets));
|
|
success = true;
|
|
} while(false);
|
|
|
|
return success;
|
|
}
|
|
|
|
static bool update_task_write_stack_data(UpdateTask* update_task) {
|
|
furi_check(storage_file_is_open(update_task->file));
|
|
const size_t FLASH_PAGE_SIZE = furi_hal_flash_get_page_size();
|
|
|
|
uint32_t stack_size = storage_file_size(update_task->file);
|
|
storage_file_seek(update_task->file, 0, true);
|
|
|
|
if(!check_address_boundaries(update_task->manifest->radio_address) ||
|
|
!check_address_boundaries(update_task->manifest->radio_address + stack_size)) {
|
|
return false;
|
|
}
|
|
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioWrite, 0);
|
|
uint8_t* fw_block = malloc(FLASH_PAGE_SIZE);
|
|
uint16_t bytes_read = 0;
|
|
uint32_t element_offs = 0;
|
|
|
|
while(element_offs < stack_size) {
|
|
uint32_t n_bytes_to_read = FLASH_PAGE_SIZE;
|
|
if((element_offs + n_bytes_to_read) > stack_size) {
|
|
n_bytes_to_read = stack_size - element_offs;
|
|
}
|
|
|
|
bytes_read = storage_file_read(update_task->file, fw_block, n_bytes_to_read);
|
|
CHECK_RESULT(bytes_read != 0);
|
|
|
|
int16_t i_page =
|
|
furi_hal_flash_get_page_number(update_task->manifest->radio_address + element_offs);
|
|
CHECK_RESULT(i_page >= 0);
|
|
|
|
furi_hal_flash_program_page(i_page, fw_block, bytes_read);
|
|
|
|
element_offs += bytes_read;
|
|
update_task_set_progress(
|
|
update_task, UpdateTaskStageProgress, element_offs * 100 / stack_size);
|
|
}
|
|
|
|
free(fw_block);
|
|
return element_offs == stack_size;
|
|
}
|
|
|
|
static void update_task_wait_for_restart(UpdateTask* update_task) {
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioBusy, 10);
|
|
furi_delay_ms(C2_MODE_SWITCH_TIMEOUT);
|
|
furi_crash("C2 timeout");
|
|
}
|
|
|
|
static bool update_task_write_stack(UpdateTask* update_task) {
|
|
bool success = false;
|
|
UpdateManifest* manifest = update_task->manifest;
|
|
do {
|
|
FURI_LOG_W(TAG, "Writing stack");
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioImageValidate, 0);
|
|
CHECK_RESULT(update_task_open_file(update_task, manifest->radio_image));
|
|
CHECK_RESULT(
|
|
crc32_calc_file(update_task->file, &update_task_file_progress, update_task) ==
|
|
manifest->radio_crc);
|
|
|
|
CHECK_RESULT(update_task_write_stack_data(update_task));
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioInstall, 0);
|
|
CHECK_RESULT(
|
|
ble_glue_fus_stack_install(manifest->radio_address, 0) != BleGlueCommandResultError);
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioInstall, 80);
|
|
CHECK_RESULT(ble_glue_fus_wait_operation() == BleGlueCommandResultOK);
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioInstall, 100);
|
|
/* ...system will restart here. */
|
|
update_task_wait_for_restart(update_task);
|
|
success = true;
|
|
} while(false);
|
|
return success;
|
|
}
|
|
|
|
static bool update_task_remove_stack(UpdateTask* update_task) {
|
|
bool success = false;
|
|
do {
|
|
FURI_LOG_W(TAG, "Removing stack");
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioErase, 30);
|
|
CHECK_RESULT(ble_glue_fus_stack_delete() != BleGlueCommandResultError);
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioErase, 80);
|
|
CHECK_RESULT(ble_glue_fus_wait_operation() == BleGlueCommandResultOK);
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioErase, 100);
|
|
/* ...system will restart here. */
|
|
update_task_wait_for_restart(update_task);
|
|
success = true;
|
|
} while(false);
|
|
return success;
|
|
}
|
|
|
|
static bool update_task_manage_radiostack(UpdateTask* update_task) {
|
|
bool success = false;
|
|
do {
|
|
CHECK_RESULT(ble_glue_wait_for_c2_start(FURI_HAL_BT_C2_START_TIMEOUT));
|
|
|
|
const BleGlueC2Info* c2_state = ble_glue_get_c2_info();
|
|
|
|
const UpdateManifestRadioVersion* radio_ver = &update_task->manifest->radio_version;
|
|
bool stack_version_match = (c2_state->VersionMajor == radio_ver->version.major) &&
|
|
(c2_state->VersionMinor == radio_ver->version.minor) &&
|
|
(c2_state->VersionSub == radio_ver->version.sub) &&
|
|
(c2_state->VersionBranch == radio_ver->version.branch) &&
|
|
(c2_state->VersionReleaseType == radio_ver->version.release);
|
|
bool stack_missing = (c2_state->VersionMajor == 0) && (c2_state->VersionMinor == 0);
|
|
|
|
if(c2_state->mode == BleGlueC2ModeStack) {
|
|
/* Stack type is not available when we have FUS running. */
|
|
bool total_stack_match = stack_version_match &&
|
|
(c2_state->StackType == radio_ver->version.type);
|
|
if(total_stack_match) {
|
|
/* Nothing to do. */
|
|
FURI_LOG_W(TAG, "Stack version is up2date");
|
|
furi_hal_rtc_reset_flag(FuriHalRtcFlagC2Update);
|
|
success = true;
|
|
break;
|
|
} else {
|
|
/* Version or type mismatch. Let's boot to FUS and start updating. */
|
|
FURI_LOG_W(TAG, "Restarting to FUS");
|
|
furi_hal_rtc_set_flag(FuriHalRtcFlagC2Update);
|
|
CHECK_RESULT(furi_hal_bt_ensure_c2_mode(BleGlueC2ModeFUS));
|
|
/* ...system will restart here. */
|
|
update_task_wait_for_restart(update_task);
|
|
}
|
|
} else if(c2_state->mode == BleGlueC2ModeFUS) {
|
|
/* OK, we're in FUS mode. */
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioBusy, 10);
|
|
FURI_LOG_W(TAG, "Waiting for FUS to settle");
|
|
ble_glue_fus_wait_operation();
|
|
if(stack_version_match) {
|
|
/* We can't check StackType with FUS, but partial version matches */
|
|
if(furi_hal_rtc_is_flag_set(FuriHalRtcFlagC2Update)) {
|
|
/* This flag was set when full version was checked.
|
|
* And something in versions of the stack didn't match.
|
|
* So, clear the flag and drop the stack. */
|
|
furi_hal_rtc_reset_flag(FuriHalRtcFlagC2Update);
|
|
FURI_LOG_W(TAG, "Forcing stack removal (match)");
|
|
CHECK_RESULT(update_task_remove_stack(update_task));
|
|
} else {
|
|
/* We might just had the stack installed.
|
|
* Let's start it up to check its version */
|
|
FURI_LOG_W(TAG, "Starting stack to check full version");
|
|
update_task_set_progress(update_task, UpdateTaskStageRadioBusy, 40);
|
|
CHECK_RESULT(furi_hal_bt_ensure_c2_mode(BleGlueC2ModeStack));
|
|
/* ...system will restart here. */
|
|
update_task_wait_for_restart(update_task);
|
|
}
|
|
} else {
|
|
if(stack_missing) {
|
|
/* Install stack. */
|
|
CHECK_RESULT(update_task_write_stack(update_task));
|
|
} else {
|
|
CHECK_RESULT(update_task_remove_stack(update_task));
|
|
}
|
|
}
|
|
}
|
|
} while(false);
|
|
|
|
return success;
|
|
}
|
|
|
|
bool update_task_validate_optionbytes(UpdateTask* update_task) {
|
|
update_task_set_progress(update_task, UpdateTaskStageOBValidation, 0);
|
|
|
|
bool match = true;
|
|
bool ob_dirty = false;
|
|
const UpdateManifest* manifest = update_task->manifest;
|
|
const FuriHalFlashRawOptionByteData* device_data = furi_hal_flash_ob_get_raw_ptr();
|
|
for(size_t idx = 0; idx < FURI_HAL_FLASH_OB_TOTAL_VALUES; ++idx) {
|
|
update_task_set_progress(
|
|
update_task, UpdateTaskStageProgress, idx * 100 / FURI_HAL_FLASH_OB_TOTAL_VALUES);
|
|
const uint32_t ref_value = manifest->ob_reference.obs[idx].values.base;
|
|
const uint32_t device_ob_value = device_data->obs[idx].values.base;
|
|
const uint32_t device_ob_value_masked = device_ob_value &
|
|
manifest->ob_compare_mask.obs[idx].values.base;
|
|
if(ref_value != device_ob_value_masked) {
|
|
match = false;
|
|
FURI_LOG_E(
|
|
TAG,
|
|
"OB MISMATCH: #%d: real %08lX != %08lX (exp.), full %08lX",
|
|
idx,
|
|
device_ob_value_masked,
|
|
ref_value,
|
|
device_ob_value);
|
|
|
|
/* any bits we are allowed to write?.. */
|
|
bool can_patch = ((device_ob_value_masked ^ ref_value) &
|
|
manifest->ob_write_mask.obs[idx].values.base) != 0;
|
|
|
|
if(can_patch) {
|
|
const uint32_t patched_value =
|
|
/* take all non-writable bits from real value */
|
|
(device_ob_value & ~(manifest->ob_write_mask.obs[idx].values.base)) |
|
|
/* take all writable bits from reference value */
|
|
(manifest->ob_reference.obs[idx].values.base &
|
|
manifest->ob_write_mask.obs[idx].values.base);
|
|
|
|
FURI_LOG_W(TAG, "Fixing up OB byte #%d to %08lX", idx, patched_value);
|
|
ob_dirty = true;
|
|
|
|
bool is_fixed = furi_hal_flash_ob_set_word(idx, patched_value) &&
|
|
((device_data->obs[idx].values.base &
|
|
manifest->ob_compare_mask.obs[idx].values.base) == ref_value);
|
|
|
|
if(!is_fixed) {
|
|
/* Things are so bad that fixing what we are allowed to still doesn't match
|
|
* reference value */
|
|
FURI_LOG_W(
|
|
TAG,
|
|
"OB #%d is FUBAR (fixed&masked %08lX, not %08lX)",
|
|
idx,
|
|
patched_value,
|
|
ref_value);
|
|
}
|
|
}
|
|
} else {
|
|
FURI_LOG_D(
|
|
TAG,
|
|
"OB MATCH: #%d: real %08lX == %08lX (exp.)",
|
|
idx,
|
|
device_ob_value_masked,
|
|
ref_value);
|
|
}
|
|
}
|
|
if(!match) {
|
|
update_task_set_progress(update_task, UpdateTaskStageOBError, 0);
|
|
}
|
|
|
|
if(ob_dirty) {
|
|
FURI_LOG_W(TAG, "OBs were changed, applying");
|
|
furi_hal_flash_ob_apply();
|
|
}
|
|
return match;
|
|
}
|
|
|
|
int32_t update_task_worker_flash_writer(void* context) {
|
|
furi_assert(context);
|
|
UpdateTask* update_task = context;
|
|
bool success = false;
|
|
|
|
do {
|
|
CHECK_RESULT(update_task_parse_manifest(update_task));
|
|
|
|
if(update_task->state.groups & UpdateTaskStageGroupRadio) {
|
|
CHECK_RESULT(update_task_manage_radiostack(update_task));
|
|
}
|
|
|
|
if(update_task->state.groups & UpdateTaskStageGroupOptionBytes) {
|
|
CHECK_RESULT(update_task_validate_optionbytes(update_task));
|
|
}
|
|
|
|
if(update_task->state.groups & UpdateTaskStageGroupFirmware) {
|
|
CHECK_RESULT(update_task_write_dfu(update_task));
|
|
}
|
|
|
|
furi_hal_rtc_set_boot_mode(FuriHalRtcBootModePostUpdate);
|
|
// Format LFS before restoring backup on next boot
|
|
furi_hal_rtc_set_flag(FuriHalRtcFlagFactoryReset);
|
|
|
|
update_task_set_progress(update_task, UpdateTaskStageCompleted, 100);
|
|
success = true;
|
|
} while(false);
|
|
|
|
if(!success) {
|
|
update_task_set_progress(update_task, UpdateTaskStageError, 0);
|
|
return UPDATE_TASK_FAILED;
|
|
}
|
|
|
|
return UPDATE_TASK_NOERR;
|
|
}
|