* Renamed assets->resources; enforcing Manifest build if it does not exist * Rebuild resources from CI * Added Manifest to repo - be sure to rebuild it with `make -C assets` before committing changes! * Actually added Manifest. * Keeping Manifest on assets clean * Spelling fix in Makefile
		
			
				
	
	
		
			224 lines
		
	
	
		
			7.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			224 lines
		
	
	
		
			7.7 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>
 | 
						|
 | 
						|
#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
 | 
						|
 | 
						|
#define EXT_PATH "/ext"
 | 
						|
 | 
						|
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_dfu_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));
 | 
						|
}
 | 
						|
 | 
						|
int32_t update_task_worker_flash_writer(void* context) {
 | 
						|
    furi_assert(context);
 | 
						|
    UpdateTask* update_task = context;
 | 
						|
    bool success = false;
 | 
						|
    DfuUpdateTask page_task = {
 | 
						|
        .address_cb = &check_address_boundaries,
 | 
						|
        .progress_cb = &update_task_dfu_progress,
 | 
						|
        .task_cb = &furi_hal_flash_program_page,
 | 
						|
        .context = update_task,
 | 
						|
    };
 | 
						|
 | 
						|
    update_task->state.current_stage_idx = 0;
 | 
						|
    update_task->state.total_stages = 4;
 | 
						|
 | 
						|
    do {
 | 
						|
        CHECK_RESULT(update_task_parse_manifest(update_task));
 | 
						|
 | 
						|
        if(!string_empty_p(update_task->manifest->firmware_dfu_image)) {
 | 
						|
            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_dfu_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));
 | 
						|
        }
 | 
						|
 | 
						|
        update_task_set_progress(update_task, UpdateTaskStageCompleted, 100);
 | 
						|
 | 
						|
        furi_hal_rtc_set_boot_mode(FuriHalRtcBootModePostUpdate);
 | 
						|
 | 
						|
        success = true;
 | 
						|
    } while(false);
 | 
						|
 | 
						|
    if(!success) {
 | 
						|
        update_task_set_progress(update_task, UpdateTaskStageError, update_task->state.progress);
 | 
						|
    }
 | 
						|
 | 
						|
    return success ? UPDATE_TASK_NOERR : UPDATE_TASK_FAILED;
 | 
						|
}
 | 
						|
 | 
						|
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->state.total_stages = 1;
 | 
						|
    update_task_set_progress(update_task, UpdateTaskStageLfsBackup, 0);
 | 
						|
    furi_hal_rtc_set_boot_mode(FuriHalRtcBootModeNormal); // to avoid bootloops
 | 
						|
    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);
 | 
						|
 | 
						|
    update_task->state.total_stages = 2;
 | 
						|
 | 
						|
    do {
 | 
						|
        CHECK_RESULT(update_task_parse_manifest(update_task));
 | 
						|
        path_concat(
 | 
						|
            string_get_cstr(update_task->update_path), LFS_BACKUP_DEFAULT_FILENAME, file_path);
 | 
						|
 | 
						|
        bool unpack_resources = !string_empty_p(update_task->manifest->resource_bundle);
 | 
						|
        if(unpack_resources) {
 | 
						|
            update_task->state.total_stages++;
 | 
						|
        }
 | 
						|
 | 
						|
        update_task_set_progress(update_task, UpdateTaskStageLfsRestore, 0);
 | 
						|
        furi_hal_rtc_set_boot_mode(FuriHalRtcBootModeNormal);
 | 
						|
 | 
						|
        CHECK_RESULT(lfs_backup_unpack(update_task->storage, string_get_cstr(file_path)));
 | 
						|
 | 
						|
        if(unpack_resources) {
 | 
						|
            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);
 | 
						|
 | 
						|
            TarArchive* archive = tar_archive_alloc(update_task->storage);
 | 
						|
            tar_archive_set_file_callback(archive, update_task_resource_unpack_cb, &progress);
 | 
						|
            success = tar_archive_open(archive, string_get_cstr(file_path), TAR_OPEN_MODE_READ);
 | 
						|
            if(success) {
 | 
						|
                progress.total_files = tar_archive_get_entries_count(archive);
 | 
						|
                if(progress.total_files > 0) {
 | 
						|
                    tar_archive_unpack_to(archive, EXT_PATH);
 | 
						|
                }
 | 
						|
            }
 | 
						|
            tar_archive_free(archive);
 | 
						|
        }
 | 
						|
    } while(false);
 | 
						|
 | 
						|
    string_clear(file_path);
 | 
						|
    return success;
 | 
						|
}
 | 
						|
 | 
						|
int32_t update_task_worker_backup_restore(void* context) {
 | 
						|
    furi_assert(context);
 | 
						|
    UpdateTask* update_task = context;
 | 
						|
    bool success = false;
 | 
						|
 | 
						|
    FuriHalRtcBootMode boot_mode = furi_hal_rtc_get_boot_mode();
 | 
						|
    if((boot_mode != FuriHalRtcBootModePreUpdate) && (boot_mode != FuriHalRtcBootModePostUpdate)) {
 | 
						|
        // no idea how we got here. Clear to normal boot
 | 
						|
        furi_hal_rtc_set_boot_mode(FuriHalRtcBootModeNormal);
 | 
						|
        return UPDATE_TASK_NOERR;
 | 
						|
    }
 | 
						|
 | 
						|
    update_task->state.current_stage_idx = 0;
 | 
						|
 | 
						|
    if(!update_operation_get_current_package_path(update_task->storage, update_task->update_path)) {
 | 
						|
        return UPDATE_TASK_FAILED;
 | 
						|
    }
 | 
						|
 | 
						|
    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_task_set_progress(update_task, UpdateTaskStageCompleted, 100);
 | 
						|
    } else {
 | 
						|
        update_task_set_progress(update_task, UpdateTaskStageError, update_task->state.progress);
 | 
						|
    }
 | 
						|
 | 
						|
    return success ? UPDATE_TASK_NOERR : UPDATE_TASK_FAILED;
 | 
						|
} |