From 8b988e2b17ec512505f7c9362794e82ff49fe17d Mon Sep 17 00:00:00 2001 From: hedger Date: Tue, 28 Jun 2022 16:03:49 +0300 Subject: [PATCH] fbt: updater over USB (#1344) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Scripts: added update package uploader over USB; fbt: added flash_usb target * fbt: additional dependencies for flash_usb * Cli: fix cursor_position corruption Co-authored-by: あく --- SConstruct | 13 ++- applications/cli/cli.c | 3 +- documentation/fbt.md | 4 +- scripts/flipper/storage.py | 4 +- scripts/selfupdate.py | 143 ++++++++++++++++++++++++++++++ scripts/storage.py | 24 +++-- site_scons/site_tools/fbt_dist.py | 10 +++ 7 files changed, 188 insertions(+), 13 deletions(-) create mode 100644 scripts/selfupdate.py diff --git a/SConstruct b/SConstruct index a31811ae..312b23a6 100644 --- a/SConstruct +++ b/SConstruct @@ -84,6 +84,16 @@ if GetOption("fullenv"): debug_updater_elf = distenv.AddDebugTarget(updater_out, False) Alias("updater_debug", debug_updater_elf) + # Installation over USB & CLI + usb_update_package = distenv.UsbInstall( + "usbinstall.flag", + (distenv["DIST_DEPENDS"], firmware_out["FW_RESOURCES"], selfupdate_dist), + ) + if distenv["FORCE"]: + AlwaysBuild(usb_update_package) + Depends(usb_update_package, selfupdate_dist) + Alias("flash_usb", usb_update_package) + # Target for copying & renaming binaries to dist folder basic_dist = distenv.DistBuilder("dist.pseudo", distenv["DIST_DEPENDS"]) @@ -92,6 +102,7 @@ AlwaysBuild(basic_dist) Alias("fw_dist", basic_dist) Default(basic_dist) + # Target for bundling core2 package for qFlipper copro_dist = distenv.CoproBuilder( Dir("assets/core2_firmware"), @@ -113,7 +124,7 @@ debug_other = distenv.GDBPy( None, GDBPYOPTS= # '-ex "source ${ROOT_DIR.abspath}/debug/FreeRTOS/FreeRTOS.py" ' - '-ex "source debug/PyCortexMDebug/PyCortexMDebug.py" ' + '-ex "source debug/PyCortexMDebug/PyCortexMDebug.py" ', ) distenv.Pseudo("debugother.pseudo") AlwaysBuild(debug_other) diff --git a/applications/cli/cli.c b/applications/cli/cli.c index eefbb305..aa48e93b 100644 --- a/applications/cli/cli.c +++ b/applications/cli/cli.c @@ -149,7 +149,8 @@ void cli_reset(Cli* cli) { } static void cli_handle_backspace(Cli* cli) { - if(string_size(cli->line) > 0) { + if(cli->cursor_position > 0) { + furi_assert(string_size(cli->line) > 0); // Other side printf("\e[D\e[1P"); fflush(stdout); diff --git a/documentation/fbt.md b/documentation/fbt.md index 7ada4bea..061339da 100644 --- a/documentation/fbt.md +++ b/documentation/fbt.md @@ -28,6 +28,8 @@ FBT keeps track of internal dependencies, so you only need to build the highest- - `fw_dist` - build & publish firmware to `dist` folder - `updater_package` - build self-update package. _Requires `--with-updater` option_ - `copro_dist` - bundle Core2 FUS+stack binaries for qFlipper +- `flash` - flash attached device with OpenOCD over ST-Link +- `flash_usb` - build, upload and install update package to device over USB. _Requires `--with-updater` option_ - `debug` - build and flash firmware, then attach with gdb with firmware's .elf loaded - `debug_updater` - attach gdb with updater's .elf loaded. _Requires `--with-updater` option_ - `debug_other` - attach gdb without loading built elf. Allows to manually add external elf files with `add-symbol-file` in gdb. @@ -39,7 +41,7 @@ FBT keeps track of internal dependencies, so you only need to build the highest- - `firmware_snake_game`, etc - build single plug-in as .elf by its name - Check out `--extra-ext-apps` for force adding extra apps to external build - `firmware_snake_game_list`, etc - generate source + assembler listing for app's .elf -- `firmware_flash` - flash current version to attached device with OpenOCD +- `flash`, `firmware_flash` - flash current version to attached device with OpenOCD over ST-Link - `firmware_cdb` - generate compilation database - `firmware_all`, `updater_all` - build basic set of binaries - `firmware_list`, `updater_list` - generate source + assembler listing diff --git a/scripts/flipper/storage.py b/scripts/flipper/storage.py index e15377d7..3d1b46b9 100644 --- a/scripts/flipper/storage.py +++ b/scripts/flipper/storage.py @@ -53,11 +53,11 @@ class FlipperStorage: CLI_PROMPT = ">: " CLI_EOL = "\r\n" - def __init__(self, portname: str): + def __init__(self, portname: str, portbaud: int = 115200): self.port = serial.Serial() self.port.port = portname self.port.timeout = 2 - self.port.baudrate = 115200 + self.port.baudrate = portbaud self.read = BufferedRead(self.port) self.last_error = "" diff --git a/scripts/selfupdate.py b/scripts/selfupdate.py new file mode 100644 index 00000000..538ecdb9 --- /dev/null +++ b/scripts/selfupdate.py @@ -0,0 +1,143 @@ +#!/usr/bin/env python3 + +from flipper.storage import FlipperStorage + +import logging +import argparse +import os +import sys +import pathlib +import serial.tools.list_ports as list_ports + + +class Main: + def __init__(self): + # command args + self.parser = argparse.ArgumentParser() + self.parser.add_argument("-d", "--debug", action="store_true", help="Debug") + self.parser.add_argument("-p", "--port", help="CDC Port", default="auto") + self.parser.add_argument( + "-b", + "--baud", + help="Port Baud rate", + required=False, + default=115200 * 4, + type=int, + ) + + self.subparsers = self.parser.add_subparsers(help="sub-command help") + + self.parser_install = self.subparsers.add_parser( + "install", help="Install OTA package" + ) + self.parser_install.add_argument("manifest_path", help="Manifest path") + self.parser_install.add_argument( + "--pkg_dir_name", help="Update dir name", default="pcbundle", required=False + ) + self.parser_install.set_defaults(func=self.install) + + # logging + self.logger = logging.getLogger() + + def __call__(self): + self.args = self.parser.parse_args() + if "func" not in self.args: + self.parser.error("Choose something to do") + # configure log output + self.log_level = logging.DEBUG if self.args.debug else logging.INFO + self.logger.setLevel(self.log_level) + self.handler = logging.StreamHandler(sys.stdout) + self.handler.setLevel(self.log_level) + self.formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(message)s") + self.handler.setFormatter(self.formatter) + self.logger.addHandler(self.handler) + # execute requested function + self.args.func() + + # make directory with exist check + def mkdir_on_storage(self, storage, flipper_dir_path): + if not storage.exist_dir(flipper_dir_path): + self.logger.debug(f'"{flipper_dir_path}" does not exist, creating') + if not storage.mkdir(flipper_dir_path): + self.logger.error(f"Error: {storage.last_error}") + return False + else: + self.logger.debug(f'"{flipper_dir_path}" already exists') + return True + + # send file with exist check and hash check + def send_file_to_storage(self, storage, flipper_file_path, local_file_path, force): + exists = storage.exist_file(flipper_file_path) + do_upload = not exists + if exists: + hash_local = storage.hash_local(local_file_path) + hash_flipper = storage.hash_flipper(flipper_file_path) + self.logger.debug(f"hash check: local {hash_local}, flipper {hash_flipper}") + do_upload = force or (hash_local != hash_flipper) + + if do_upload: + self.logger.info(f'Sending "{local_file_path}" to "{flipper_file_path}"') + if not storage.send_file(local_file_path, flipper_file_path): + self.logger.error(f"Error: {storage.last_error}") + return False + return True + + def _get_port(self): + if self.args.port != "auto": + return self.args.port + # Try guessing + flippers = list(list_ports.grep("flip")) + if len(flippers) == 1: + flipper = flippers[0] + self.logger.info(f"Using {flipper.serial_number} on {flipper.device}") + return flipper.device + elif len(flippers) == 0: + self.logger.error("Failed to find connected Flipper") + elif len(flippers) > 1: + self.logger.error("More than one Flipper is attached") + self.logger.error("Failed to guess which port to use. Specify --port") + + def install(self): + if not (port := self._get_port()): + return 1 + + storage = FlipperStorage(port, self.args.baud) + storage.start() + + if not os.path.isfile(self.args.manifest_path): + self.logger.error("Error: manifest not found") + return 2 + + manifest_path = pathlib.Path(os.path.abspath(self.args.manifest_path)) + manifest_name, pkg_name = manifest_path.parts[-1], manifest_path.parts[-2] + + pkg_dir_name = self.args.pkg_dir_name or pkg_name + flipper_update_path = f"/ext/update/{pkg_dir_name}" + + self.logger.info(f'Installing "{pkg_name}" from {flipper_update_path}') + # if not os.path.exists(self.args.manifest_path): + # self.logger.error("Error: package not found") + if not self.mkdir_on_storage(storage, flipper_update_path): + self.logger.error(f"Error: cannot create {storage.last_error}") + return -2 + + for dirpath, dirnames, filenames in os.walk(manifest_path.parents[0]): + for fname in filenames: + self.logger.debug(f"Uploading {fname}") + local_file_path = os.path.join(dirpath, fname) + flipper_file_path = f"{flipper_update_path}/{fname}" + if not self.send_file_to_storage( + storage, flipper_file_path, local_file_path, False + ): + self.logger.error(f"Error: {storage.last_error}") + return -3 + + storage.send_and_wait_eol( + f"update install {flipper_update_path}/{manifest_name}\r" + ) + break + storage.stop() + + +if __name__ == "__main__": + Main()() diff --git a/scripts/storage.py b/scripts/storage.py index 4364eb28..1281253b 100755 --- a/scripts/storage.py +++ b/scripts/storage.py @@ -18,6 +18,14 @@ class Main: self.parser = argparse.ArgumentParser() self.parser.add_argument("-d", "--debug", action="store_true", help="Debug") self.parser.add_argument("-p", "--port", help="CDC Port", required=True) + self.parser.add_argument( + "-b", + "--baud", + help="Port Baud rate", + required=False, + default=115200 * 4, + type=int, + ) self.subparsers = self.parser.add_subparsers(help="sub-command help") self.parser_mkdir = self.subparsers.add_parser("mkdir", help="Create directory") @@ -195,31 +203,31 @@ class Main: # make directory with exist check def mkdir_on_storage(self, storage, flipper_dir_path): if not storage.exist_dir(flipper_dir_path): - self.logger.debug(f'"{flipper_dir_path}" not exist, creating') + self.logger.debug(f'"{flipper_dir_path}" does not exist, creating') if not storage.mkdir(flipper_dir_path): self.logger.error(f"Error: {storage.last_error}") else: - self.logger.debug(f'"{flipper_dir_path}" already exist') + self.logger.debug(f'"{flipper_dir_path}" already exists') # send file with exist check and hash check def send_file_to_storage(self, storage, flipper_file_path, local_file_path, force): if not storage.exist_file(flipper_file_path): self.logger.debug( - f'"{flipper_file_path}" not exist, sending "{local_file_path}"' + f'"{flipper_file_path}" does not exist, sending "{local_file_path}"' ) self.logger.info(f'Sending "{local_file_path}" to "{flipper_file_path}"') if not storage.send_file(local_file_path, flipper_file_path): self.logger.error(f"Error: {storage.last_error}") elif force: self.logger.debug( - f'"{flipper_file_path}" exist, but will be overwritten by "{local_file_path}"' + f'"{flipper_file_path}" exists, but will be overwritten by "{local_file_path}"' ) self.logger.info(f'Sending "{local_file_path}" to "{flipper_file_path}"') if not storage.send_file(local_file_path, flipper_file_path): self.logger.error(f"Error: {storage.last_error}") else: self.logger.debug( - f'"{flipper_file_path}" exist, compare hash with "{local_file_path}"' + f'"{flipper_file_path}" exists, compare hash with "{local_file_path}"' ) hash_local = storage.hash_local(local_file_path) hash_flipper = storage.hash_flipper(flipper_file_path) @@ -229,11 +237,11 @@ class Main: if hash_local == hash_flipper: self.logger.debug( - f'"{flipper_file_path}" are equal to "{local_file_path}"' + f'"{flipper_file_path}" is equal to "{local_file_path}"' ) else: self.logger.debug( - f'"{flipper_file_path}" are not equal to "{local_file_path}"' + f'"{flipper_file_path}" is NOT equal to "{local_file_path}"' ) self.logger.info( f'Sending "{local_file_path}" to "{flipper_file_path}"' @@ -242,7 +250,7 @@ class Main: self.logger.error(f"Error: {storage.last_error}") def read(self): - storage = FlipperStorage(self.args.port) + storage = FlipperStorage(self.args.port, self.args.baud) storage.start() self.logger.debug(f'Reading "{self.args.flipper_path}"') data = storage.read_file(self.args.flipper_path) diff --git a/site_scons/site_tools/fbt_dist.py b/site_scons/site_tools/fbt_dist.py index 8fad2156..8bfb4068 100644 --- a/site_scons/site_tools/fbt_dist.py +++ b/site_scons/site_tools/fbt_dist.py @@ -1,6 +1,7 @@ from SCons.Builder import Builder from SCons.Action import Action from SCons.Script import Mkdir +from SCons.Defaults import Touch def get_variant_dirname(env, project=None): @@ -47,6 +48,7 @@ def AddFwProject(env, base_env, fw_type, fw_env_key): project_env["FW_ARTIFACTS"], ], ) + env.Replace(DIST_DIR=get_variant_dirname(env)) return project_env @@ -80,6 +82,14 @@ def generate(env): '@${PYTHON3} ${ROOT_DIR.abspath}/scripts/sconsdist.py copy -p ${DIST_PROJECTS} -s "${DIST_SUFFIX}" ${DIST_EXTRA}', ), ), + "UsbInstall": Builder( + action=[ + Action( + "${PYTHON3} ${ROOT_DIR.abspath}/scripts/selfupdate.py install dist/${DIST_DIR}/f${TARGET_HW}-update-${DIST_SUFFIX}/update.fuf" + ), + Touch("${TARGET}"), + ] + ), "CoproBuilder": Builder( action=Action( [