[FL-2627] Flipper applications: SDK, build and debug system (#1387)
* Added support for running applications from SD card (FAPs - Flipper Application Packages) * Added plugin_dist target for fbt to build FAPs * All apps of type FlipperAppType.EXTERNAL and FlipperAppType.PLUGIN are built as FAPs by default * Updated VSCode configuration for new fbt features - re-deploy stock configuration to use them * Added debugging support for FAPs with fbt debug & VSCode * Added public firmware API with automated versioning Co-authored-by: hedger <hedger@users.noreply.github.com> Co-authored-by: SG <who.just.the.doctor@gmail.com> Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
SG
Aleksandr Kutuzov
350
applications/system/updater/util/update_task.c
Normal file
350
applications/system/updater/util/update_task.c
Normal file
@@ -0,0 +1,350 @@
|
||||
#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>
|
||||
|
||||
static const char* update_task_stage_descr[] = {
|
||||
[UpdateTaskStageProgress] = "...",
|
||||
[UpdateTaskStageReadManifest] = "Loading update manifest",
|
||||
[UpdateTaskStageValidateDFUImage] = "Checking DFU file",
|
||||
[UpdateTaskStageFlashWrite] = "Writing flash",
|
||||
[UpdateTaskStageFlashValidate] = "Validating flash",
|
||||
[UpdateTaskStageRadioImageValidate] = "Checking radio FW",
|
||||
[UpdateTaskStageRadioErase] = "Uninstalling radio FW",
|
||||
[UpdateTaskStageRadioWrite] = "Writing radio FW",
|
||||
[UpdateTaskStageRadioInstall] = "Installing radio FW",
|
||||
[UpdateTaskStageRadioBusy] = "Radio is updating",
|
||||
[UpdateTaskStageOBValidation] = "Validating opt. bytes",
|
||||
[UpdateTaskStageLfsBackup] = "Backing up LFS",
|
||||
[UpdateTaskStageLfsRestore] = "Restoring LFS",
|
||||
[UpdateTaskStageResourcesUpdate] = "Updating resources",
|
||||
[UpdateTaskStageSplashscreenInstall] = "Installing splashscreen",
|
||||
[UpdateTaskStageCompleted] = "Restarting...",
|
||||
[UpdateTaskStageError] = "Error",
|
||||
[UpdateTaskStageOBError] = "OB, report",
|
||||
};
|
||||
|
||||
typedef struct {
|
||||
UpdateTaskStageGroup group;
|
||||
uint8_t weight;
|
||||
} UpdateTaskStageGroupMap;
|
||||
|
||||
#define STAGE_DEF(GROUP, WEIGHT) \
|
||||
{ .group = (GROUP), .weight = (WEIGHT), }
|
||||
|
||||
static const UpdateTaskStageGroupMap update_task_stage_progress[] = {
|
||||
[UpdateTaskStageProgress] = STAGE_DEF(UpdateTaskStageGroupMisc, 0),
|
||||
|
||||
[UpdateTaskStageReadManifest] = STAGE_DEF(UpdateTaskStageGroupPreUpdate, 5),
|
||||
[UpdateTaskStageLfsBackup] = STAGE_DEF(UpdateTaskStageGroupPreUpdate, 15),
|
||||
|
||||
[UpdateTaskStageRadioImageValidate] = STAGE_DEF(UpdateTaskStageGroupRadio, 15),
|
||||
[UpdateTaskStageRadioErase] = STAGE_DEF(UpdateTaskStageGroupRadio, 60),
|
||||
[UpdateTaskStageRadioWrite] = STAGE_DEF(UpdateTaskStageGroupRadio, 80),
|
||||
[UpdateTaskStageRadioInstall] = STAGE_DEF(UpdateTaskStageGroupRadio, 60),
|
||||
[UpdateTaskStageRadioBusy] = STAGE_DEF(UpdateTaskStageGroupRadio, 80),
|
||||
|
||||
[UpdateTaskStageOBValidation] = STAGE_DEF(UpdateTaskStageGroupOptionBytes, 10),
|
||||
|
||||
[UpdateTaskStageValidateDFUImage] = STAGE_DEF(UpdateTaskStageGroupFirmware, 50),
|
||||
[UpdateTaskStageFlashWrite] = STAGE_DEF(UpdateTaskStageGroupFirmware, 200),
|
||||
[UpdateTaskStageFlashValidate] = STAGE_DEF(UpdateTaskStageGroupFirmware, 30),
|
||||
|
||||
[UpdateTaskStageLfsRestore] = STAGE_DEF(UpdateTaskStageGroupPostUpdate, 30),
|
||||
|
||||
[UpdateTaskStageResourcesUpdate] = STAGE_DEF(UpdateTaskStageGroupResources, 255),
|
||||
[UpdateTaskStageSplashscreenInstall] = STAGE_DEF(UpdateTaskStageGroupSplashscreen, 5),
|
||||
|
||||
[UpdateTaskStageCompleted] = STAGE_DEF(UpdateTaskStageGroupMisc, 1),
|
||||
[UpdateTaskStageError] = STAGE_DEF(UpdateTaskStageGroupMisc, 1),
|
||||
[UpdateTaskStageOBError] = STAGE_DEF(UpdateTaskStageGroupMisc, 1),
|
||||
};
|
||||
|
||||
static UpdateTaskStageGroup update_task_get_task_groups(UpdateTask* update_task) {
|
||||
UpdateTaskStageGroup ret = UpdateTaskStageGroupPreUpdate | UpdateTaskStageGroupPostUpdate;
|
||||
UpdateManifest* manifest = update_task->manifest;
|
||||
if(!string_empty_p(manifest->radio_image)) {
|
||||
ret |= UpdateTaskStageGroupRadio;
|
||||
}
|
||||
if(update_manifest_has_obdata(manifest)) {
|
||||
ret |= UpdateTaskStageGroupOptionBytes;
|
||||
}
|
||||
if(!string_empty_p(manifest->firmware_dfu_image)) {
|
||||
ret |= UpdateTaskStageGroupFirmware;
|
||||
}
|
||||
if(!string_empty_p(manifest->resource_bundle)) {
|
||||
ret |= UpdateTaskStageGroupResources;
|
||||
}
|
||||
if(!string_empty_p(manifest->splash_file)) {
|
||||
ret |= UpdateTaskStageGroupSplashscreen;
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
static void update_task_calc_completed_stages(UpdateTask* update_task) {
|
||||
uint32_t completed_stages_points = 0;
|
||||
for(UpdateTaskStage past_stage = UpdateTaskStageProgress;
|
||||
past_stage < update_task->state.stage;
|
||||
++past_stage) {
|
||||
const UpdateTaskStageGroupMap* grp_descr = &update_task_stage_progress[past_stage];
|
||||
if((grp_descr->group & update_task->state.groups) == 0) {
|
||||
continue;
|
||||
}
|
||||
completed_stages_points += grp_descr->weight;
|
||||
}
|
||||
update_task->state.completed_stages_points = completed_stages_points;
|
||||
}
|
||||
|
||||
void update_task_set_progress(UpdateTask* update_task, UpdateTaskStage stage, uint8_t progress) {
|
||||
if(stage != UpdateTaskStageProgress) {
|
||||
/* do not override more specific error states */
|
||||
if((stage >= UpdateTaskStageError) && (update_task->state.stage >= UpdateTaskStageError)) {
|
||||
return;
|
||||
}
|
||||
/* Build error message with code "[stage_idx-stage_percent]" */
|
||||
if(stage >= UpdateTaskStageError) {
|
||||
string_printf(
|
||||
update_task->state.status,
|
||||
"%s #[%d-%d]",
|
||||
update_task_stage_descr[stage],
|
||||
update_task->state.stage,
|
||||
update_task->state.stage_progress);
|
||||
} else {
|
||||
string_set_str(update_task->state.status, update_task_stage_descr[stage]);
|
||||
}
|
||||
/* Store stage update */
|
||||
update_task->state.stage = stage;
|
||||
/* If we are still alive, sum completed stages weights */
|
||||
if((stage > UpdateTaskStageProgress) && (stage < UpdateTaskStageCompleted)) {
|
||||
update_task_calc_completed_stages(update_task);
|
||||
}
|
||||
}
|
||||
|
||||
/* Store stage progress for all non-error updates - to provide details on error state */
|
||||
if(!update_stage_is_error(stage)) {
|
||||
update_task->state.stage_progress = progress;
|
||||
}
|
||||
|
||||
/* Calculate "overall" progress, based on stage weights */
|
||||
uint32_t adapted_progress = 1;
|
||||
if(update_task->state.total_progress_points != 0) {
|
||||
if(stage < UpdateTaskStageCompleted) {
|
||||
adapted_progress = MIN(
|
||||
(update_task->state.completed_stages_points +
|
||||
(update_task_stage_progress[update_task->state.stage].weight * progress / 100)) *
|
||||
100 / (update_task->state.total_progress_points),
|
||||
100u);
|
||||
|
||||
} else {
|
||||
adapted_progress = update_task->state.overall_progress;
|
||||
}
|
||||
}
|
||||
update_task->state.overall_progress = adapted_progress;
|
||||
|
||||
if(update_task->status_change_cb) {
|
||||
(update_task->status_change_cb)(
|
||||
string_get_cstr(update_task->state.status),
|
||||
adapted_progress,
|
||||
update_stage_is_error(update_task->state.stage),
|
||||
update_task->status_change_cb_state);
|
||||
}
|
||||
}
|
||||
|
||||
static void update_task_close_file(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
if(!storage_file_is_open(update_task->file)) {
|
||||
return;
|
||||
}
|
||||
|
||||
storage_file_close(update_task->file);
|
||||
}
|
||||
|
||||
static bool update_task_check_file_exists(UpdateTask* update_task, string_t filename) {
|
||||
furi_assert(update_task);
|
||||
string_t tmp_path;
|
||||
string_init_set(tmp_path, update_task->update_path);
|
||||
path_append(tmp_path, string_get_cstr(filename));
|
||||
bool exists = storage_file_exists(update_task->storage, string_get_cstr(tmp_path));
|
||||
string_clear(tmp_path);
|
||||
return exists;
|
||||
}
|
||||
|
||||
bool update_task_open_file(UpdateTask* update_task, string_t filename) {
|
||||
furi_assert(update_task);
|
||||
update_task_close_file(update_task);
|
||||
|
||||
string_t tmp_path;
|
||||
string_init_set(tmp_path, update_task->update_path);
|
||||
path_append(tmp_path, string_get_cstr(filename));
|
||||
bool open_success = storage_file_open(
|
||||
update_task->file, string_get_cstr(tmp_path), FSAM_READ, FSOM_OPEN_EXISTING);
|
||||
string_clear(tmp_path);
|
||||
return open_success;
|
||||
}
|
||||
|
||||
static void update_task_worker_thread_cb(FuriThreadState state, void* context) {
|
||||
UpdateTask* update_task = context;
|
||||
|
||||
if(state != FuriThreadStateStopped) {
|
||||
return;
|
||||
}
|
||||
|
||||
if(furi_thread_get_return_code(update_task->thread) == UPDATE_TASK_NOERR) {
|
||||
furi_delay_ms(UPDATE_DELAY_OPERATION_OK);
|
||||
furi_hal_power_reset();
|
||||
}
|
||||
}
|
||||
|
||||
UpdateTask* update_task_alloc() {
|
||||
UpdateTask* update_task = malloc(sizeof(UpdateTask));
|
||||
|
||||
update_task->state.stage = UpdateTaskStageProgress;
|
||||
update_task->state.stage_progress = 0;
|
||||
update_task->state.overall_progress = 0;
|
||||
string_init(update_task->state.status);
|
||||
|
||||
update_task->manifest = update_manifest_alloc();
|
||||
update_task->storage = furi_record_open(RECORD_STORAGE);
|
||||
update_task->file = storage_file_alloc(update_task->storage);
|
||||
update_task->status_change_cb = NULL;
|
||||
update_task->boot_mode = furi_hal_rtc_get_boot_mode();
|
||||
string_init(update_task->update_path);
|
||||
|
||||
FuriThread* thread = update_task->thread = furi_thread_alloc();
|
||||
|
||||
furi_thread_set_name(thread, "UpdateWorker");
|
||||
furi_thread_set_stack_size(thread, 5120);
|
||||
furi_thread_set_context(thread, update_task);
|
||||
|
||||
furi_thread_set_state_callback(thread, update_task_worker_thread_cb);
|
||||
furi_thread_set_state_context(thread, update_task);
|
||||
#ifdef FURI_RAM_EXEC
|
||||
UNUSED(update_task_worker_backup_restore);
|
||||
furi_thread_set_callback(thread, update_task_worker_flash_writer);
|
||||
#else
|
||||
UNUSED(update_task_worker_flash_writer);
|
||||
furi_thread_set_callback(thread, update_task_worker_backup_restore);
|
||||
#endif
|
||||
|
||||
return update_task;
|
||||
}
|
||||
|
||||
void update_task_free(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
|
||||
furi_thread_join(update_task->thread);
|
||||
|
||||
furi_thread_free(update_task->thread);
|
||||
update_task_close_file(update_task);
|
||||
storage_file_free(update_task->file);
|
||||
update_manifest_free(update_task->manifest);
|
||||
|
||||
furi_record_close(RECORD_STORAGE);
|
||||
string_clear(update_task->update_path);
|
||||
|
||||
free(update_task);
|
||||
}
|
||||
|
||||
bool update_task_parse_manifest(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
update_task->state.stage_progress = 0;
|
||||
update_task->state.overall_progress = 0;
|
||||
update_task->state.total_progress_points = 0;
|
||||
update_task->state.completed_stages_points = 0;
|
||||
update_task->state.groups = 0;
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageReadManifest, 0);
|
||||
bool result = false;
|
||||
string_t manifest_path;
|
||||
string_init(manifest_path);
|
||||
|
||||
do {
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 13);
|
||||
if(!furi_hal_version_do_i_belong_here()) {
|
||||
break;
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 20);
|
||||
if(!update_operation_get_current_package_manifest_path(
|
||||
update_task->storage, manifest_path)) {
|
||||
break;
|
||||
}
|
||||
|
||||
path_extract_dirname(string_get_cstr(manifest_path), update_task->update_path);
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 30);
|
||||
|
||||
UpdateManifest* manifest = update_task->manifest;
|
||||
if(!update_manifest_init(manifest, string_get_cstr(manifest_path))) {
|
||||
break;
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 40);
|
||||
if(manifest->manifest_version < UPDATE_OPERATION_MIN_MANIFEST_VERSION) {
|
||||
break;
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 50);
|
||||
if(manifest->target != furi_hal_version_get_hw_target()) {
|
||||
break;
|
||||
}
|
||||
|
||||
update_task->state.groups = update_task_get_task_groups(update_task);
|
||||
for(size_t stage_counter = 0; stage_counter < COUNT_OF(update_task_stage_progress);
|
||||
++stage_counter) {
|
||||
const UpdateTaskStageGroupMap* grp_descr = &update_task_stage_progress[stage_counter];
|
||||
if((grp_descr->group & update_task->state.groups) != 0) {
|
||||
update_task->state.total_progress_points += grp_descr->weight;
|
||||
}
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 60);
|
||||
if((update_task->state.groups & UpdateTaskStageGroupFirmware) &&
|
||||
!update_task_check_file_exists(update_task, manifest->firmware_dfu_image)) {
|
||||
break;
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 80);
|
||||
if((update_task->state.groups & UpdateTaskStageGroupRadio) &&
|
||||
(!update_task_check_file_exists(update_task, manifest->radio_image) ||
|
||||
(manifest->radio_version.version.type == 0))) {
|
||||
break;
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageProgress, 100);
|
||||
result = true;
|
||||
} while(false);
|
||||
|
||||
string_clear(manifest_path);
|
||||
return result;
|
||||
}
|
||||
|
||||
void update_task_set_progress_cb(UpdateTask* update_task, updateProgressCb cb, void* state) {
|
||||
update_task->status_change_cb = cb;
|
||||
update_task->status_change_cb_state = state;
|
||||
}
|
||||
|
||||
void update_task_start(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
furi_thread_start(update_task->thread);
|
||||
}
|
||||
|
||||
bool update_task_is_running(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
return furi_thread_get_state(update_task->thread) == FuriThreadStateRunning;
|
||||
}
|
||||
|
||||
UpdateTaskState const* update_task_get_state(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
return &update_task->state;
|
||||
}
|
||||
|
||||
UpdateManifest const* update_task_get_manifest(UpdateTask* update_task) {
|
||||
furi_assert(update_task);
|
||||
return update_task->manifest;
|
||||
}
|
||||
89
applications/system/updater/util/update_task.h
Normal file
89
applications/system/updater/util/update_task.h
Normal file
@@ -0,0 +1,89 @@
|
||||
#pragma once
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <update_util/update_manifest.h>
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include <m-string.h>
|
||||
|
||||
#define UPDATE_DELAY_OPERATION_OK 300
|
||||
#define UPDATE_DELAY_OPERATION_ERROR INT_MAX
|
||||
|
||||
typedef enum {
|
||||
UpdateTaskStageProgress = 0,
|
||||
|
||||
UpdateTaskStageReadManifest,
|
||||
UpdateTaskStageLfsBackup,
|
||||
|
||||
UpdateTaskStageRadioImageValidate,
|
||||
UpdateTaskStageRadioErase,
|
||||
UpdateTaskStageRadioWrite,
|
||||
UpdateTaskStageRadioInstall,
|
||||
UpdateTaskStageRadioBusy,
|
||||
|
||||
UpdateTaskStageOBValidation,
|
||||
|
||||
UpdateTaskStageValidateDFUImage,
|
||||
UpdateTaskStageFlashWrite,
|
||||
UpdateTaskStageFlashValidate,
|
||||
|
||||
UpdateTaskStageLfsRestore,
|
||||
UpdateTaskStageResourcesUpdate,
|
||||
UpdateTaskStageSplashscreenInstall,
|
||||
|
||||
UpdateTaskStageCompleted,
|
||||
UpdateTaskStageError,
|
||||
UpdateTaskStageOBError,
|
||||
UpdateTaskStageMAX
|
||||
} UpdateTaskStage;
|
||||
|
||||
inline bool update_stage_is_error(const UpdateTaskStage stage) {
|
||||
return stage >= UpdateTaskStageError;
|
||||
}
|
||||
|
||||
typedef enum {
|
||||
UpdateTaskStageGroupMisc = 0,
|
||||
UpdateTaskStageGroupPreUpdate = 1 << 1,
|
||||
UpdateTaskStageGroupFirmware = 1 << 2,
|
||||
UpdateTaskStageGroupOptionBytes = 1 << 3,
|
||||
UpdateTaskStageGroupRadio = 1 << 4,
|
||||
UpdateTaskStageGroupPostUpdate = 1 << 5,
|
||||
UpdateTaskStageGroupResources = 1 << 6,
|
||||
UpdateTaskStageGroupSplashscreen = 1 << 7,
|
||||
} UpdateTaskStageGroup;
|
||||
|
||||
typedef struct {
|
||||
UpdateTaskStage stage;
|
||||
uint8_t overall_progress, stage_progress;
|
||||
string_t status;
|
||||
UpdateTaskStageGroup groups;
|
||||
uint32_t total_progress_points;
|
||||
uint32_t completed_stages_points;
|
||||
} UpdateTaskState;
|
||||
|
||||
typedef struct UpdateTask UpdateTask;
|
||||
|
||||
typedef void (
|
||||
*updateProgressCb)(const char* status, const uint8_t stage_pct, bool failed, void* state);
|
||||
|
||||
UpdateTask* update_task_alloc();
|
||||
|
||||
void update_task_free(UpdateTask* update_task);
|
||||
|
||||
void update_task_set_progress_cb(UpdateTask* update_task, updateProgressCb cb, void* state);
|
||||
|
||||
void update_task_start(UpdateTask* update_task);
|
||||
|
||||
bool update_task_is_running(UpdateTask* update_task);
|
||||
|
||||
UpdateTaskState const* update_task_get_state(UpdateTask* update_task);
|
||||
|
||||
UpdateManifest const* update_task_get_manifest(UpdateTask* update_task);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
26
applications/system/updater/util/update_task_i.h
Normal file
26
applications/system/updater/util/update_task_i.h
Normal file
@@ -0,0 +1,26 @@
|
||||
#pragma once
|
||||
|
||||
#include <storage/storage.h>
|
||||
#include <furi_hal.h>
|
||||
|
||||
#define UPDATE_TASK_NOERR 0
|
||||
#define UPDATE_TASK_FAILED -1
|
||||
|
||||
typedef struct UpdateTask {
|
||||
UpdateTaskState state;
|
||||
string_t update_path;
|
||||
UpdateManifest* manifest;
|
||||
FuriThread* thread;
|
||||
Storage* storage;
|
||||
File* file;
|
||||
updateProgressCb status_change_cb;
|
||||
void* status_change_cb_state;
|
||||
FuriHalRtcBootMode boot_mode;
|
||||
} UpdateTask;
|
||||
|
||||
void update_task_set_progress(UpdateTask* update_task, UpdateTaskStage stage, uint8_t progress);
|
||||
bool update_task_parse_manifest(UpdateTask* update_task);
|
||||
bool update_task_open_file(UpdateTask* update_task, string_t filename);
|
||||
|
||||
int32_t update_task_worker_flash_writer(void* context);
|
||||
int32_t update_task_worker_backup_restore(void* context);
|
||||
150
applications/system/updater/util/update_task_worker_backup.c
Normal file
150
applications/system/updater/util/update_task_worker_backup.c
Normal file
@@ -0,0 +1,150 @@
|
||||
#include "update_task.h"
|
||||
#include "update_task_i.h"
|
||||
|
||||
#include <furi.h>
|
||||
#include <furi_hal.h>
|
||||
#include <storage/storage.h>
|
||||
#include <desktop/helpers/slideshow_filename.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 "UpdWorkerBackup"
|
||||
|
||||
#define CHECK_RESULT(x) \
|
||||
if(!(x)) { \
|
||||
break; \
|
||||
}
|
||||
|
||||
static bool update_task_pre_update(UpdateTask* update_task) {
|
||||
bool success = false;
|
||||
string_t backup_file_path;
|
||||
string_init(backup_file_path);
|
||||
path_concat(
|
||||
string_get_cstr(update_task->update_path), LFS_BACKUP_DEFAULT_FILENAME, backup_file_path);
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageLfsBackup, 0);
|
||||
/* to avoid bootloops */
|
||||
furi_hal_rtc_set_boot_mode(FuriHalRtcBootModeNormal);
|
||||
if((success = lfs_backup_create(update_task->storage, string_get_cstr(backup_file_path)))) {
|
||||
furi_hal_rtc_set_boot_mode(FuriHalRtcBootModeUpdate);
|
||||
}
|
||||
|
||||
string_clear(backup_file_path);
|
||||
return success;
|
||||
}
|
||||
|
||||
typedef struct {
|
||||
UpdateTask* update_task;
|
||||
int32_t total_files, processed_files;
|
||||
} TarUnpackProgress;
|
||||
|
||||
static bool update_task_resource_unpack_cb(const char* name, bool is_directory, void* context) {
|
||||
UNUSED(name);
|
||||
UNUSED(is_directory);
|
||||
TarUnpackProgress* unpack_progress = context;
|
||||
unpack_progress->processed_files++;
|
||||
update_task_set_progress(
|
||||
unpack_progress->update_task,
|
||||
UpdateTaskStageProgress,
|
||||
unpack_progress->processed_files * 100 / (unpack_progress->total_files + 1));
|
||||
return true;
|
||||
}
|
||||
|
||||
static bool update_task_post_update(UpdateTask* update_task) {
|
||||
bool success = false;
|
||||
|
||||
string_t file_path;
|
||||
string_init(file_path);
|
||||
|
||||
TarArchive* archive = tar_archive_alloc(update_task->storage);
|
||||
do {
|
||||
path_concat(
|
||||
string_get_cstr(update_task->update_path), LFS_BACKUP_DEFAULT_FILENAME, file_path);
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageLfsRestore, 0);
|
||||
|
||||
CHECK_RESULT(lfs_backup_unpack(update_task->storage, string_get_cstr(file_path)));
|
||||
|
||||
if(update_task->state.groups & UpdateTaskStageGroupResources) {
|
||||
TarUnpackProgress progress = {
|
||||
.update_task = update_task,
|
||||
.total_files = 0,
|
||||
.processed_files = 0,
|
||||
};
|
||||
update_task_set_progress(update_task, UpdateTaskStageResourcesUpdate, 0);
|
||||
|
||||
path_concat(
|
||||
string_get_cstr(update_task->update_path),
|
||||
string_get_cstr(update_task->manifest->resource_bundle),
|
||||
file_path);
|
||||
|
||||
tar_archive_set_file_callback(archive, update_task_resource_unpack_cb, &progress);
|
||||
CHECK_RESULT(
|
||||
tar_archive_open(archive, string_get_cstr(file_path), TAR_OPEN_MODE_READ));
|
||||
|
||||
progress.total_files = tar_archive_get_entries_count(archive);
|
||||
if(progress.total_files > 0) {
|
||||
CHECK_RESULT(tar_archive_unpack_to(archive, STORAGE_EXT_PATH_PREFIX, NULL));
|
||||
}
|
||||
}
|
||||
|
||||
if(update_task->state.groups & UpdateTaskStageGroupSplashscreen) {
|
||||
update_task_set_progress(update_task, UpdateTaskStageSplashscreenInstall, 0);
|
||||
string_t tmp_path;
|
||||
string_init_set(tmp_path, update_task->update_path);
|
||||
path_append(tmp_path, string_get_cstr(update_task->manifest->splash_file));
|
||||
if(storage_common_copy(
|
||||
update_task->storage,
|
||||
string_get_cstr(tmp_path),
|
||||
INT_PATH(SLIDESHOW_FILE_NAME)) != FSE_OK) {
|
||||
// actually, not critical
|
||||
}
|
||||
string_clear(tmp_path);
|
||||
update_task_set_progress(update_task, UpdateTaskStageSplashscreenInstall, 100);
|
||||
}
|
||||
success = true;
|
||||
} while(false);
|
||||
|
||||
tar_archive_free(archive);
|
||||
string_clear(file_path);
|
||||
return success;
|
||||
}
|
||||
|
||||
int32_t update_task_worker_backup_restore(void* context) {
|
||||
furi_assert(context);
|
||||
UpdateTask* update_task = context;
|
||||
|
||||
FuriHalRtcBootMode boot_mode = update_task->boot_mode;
|
||||
if((boot_mode != FuriHalRtcBootModePreUpdate) && (boot_mode != FuriHalRtcBootModePostUpdate)) {
|
||||
/* no idea how we got here. Do nothing */
|
||||
return UPDATE_TASK_NOERR;
|
||||
}
|
||||
|
||||
bool success = false;
|
||||
do {
|
||||
if(!update_task_parse_manifest(update_task)) {
|
||||
break;
|
||||
}
|
||||
|
||||
if(boot_mode == FuriHalRtcBootModePreUpdate) {
|
||||
success = update_task_pre_update(update_task);
|
||||
} else if(boot_mode == FuriHalRtcBootModePostUpdate) {
|
||||
success = update_task_post_update(update_task);
|
||||
if(success) {
|
||||
update_operation_disarm();
|
||||
}
|
||||
}
|
||||
} while(false);
|
||||
|
||||
if(!success) {
|
||||
update_task_set_progress(update_task, UpdateTaskStageError, 0);
|
||||
return UPDATE_TASK_FAILED;
|
||||
}
|
||||
|
||||
update_task_set_progress(update_task, UpdateTaskStageCompleted, 100);
|
||||
return UPDATE_TASK_NOERR;
|
||||
}
|
||||
356
applications/system/updater/util/update_task_worker_flasher.c
Normal file
356
applications/system/updater/util/update_task_worker_flasher.c
Normal file
@@ -0,0 +1,356 @@
|
||||
#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_write_dfu(UpdateTask* update_task) {
|
||||
DfuUpdateTask page_task = {
|
||||
.address_cb = &check_address_boundaries,
|
||||
.progress_cb = &update_task_file_progress,
|
||||
.task_cb = &furi_hal_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);
|
||||
|
||||
CHECK_RESULT(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 %08X != %08X (exp.), full %08X",
|
||||
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 %08X", 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 %08X, not %08X)",
|
||||
idx,
|
||||
patched_value,
|
||||
ref_value);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
FURI_LOG_I(
|
||||
TAG,
|
||||
"OB MATCH: #%d: real %08X == %08X (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;
|
||||
}
|
||||
Reference in New Issue
Block a user