[FL-2263] Flasher service & RAM exec (#1006)

* WIP on stripping fw
* Compact FW build - use RAM_EXEC=1 COMPACT=1 DEBUG=0
* Fixed uninitialized storage struct; small fixes to compact fw
* Flasher srv w/mocked flash ops
* Fixed typos & accomodated FFF changes
* Alternative fw startup branch
* Working load & jmp to RAM fw
* +manifest processing for stage loader; + crc verification for stage payload
* Fixed questionable code & potential leaks
* Lowered screen update rate; added radio stack update stubs; working dfu write
* Console EP with manifest & stage validation
* Added microtar lib; minor ui fixes for updater
* Removed microtar
* Removed mtar #2
* Added a better version of microtar
* TAR archive api; LFS backup & restore core
* Recursive backup/restore
* LFS worker thread
* Added system apps to loader - not visible in UI; full update process with restarts
* Typo fix
* Dropped BL & f6; tooling for updater WIP
* Minor py fixes
* Minor fixes to make it build after merge
* Ported flash workaround from BL + fixed visuals
* Minor cleanup
* Chmod + loader app search fix
* Python linter fix
* Removed usb stuff & float read support for staged loader == -10% of binary size
* Added backup/restore & update pb requests
* Added stub impl to RPC for backup/restore/update commands
* Reworked TAR to use borrowed Storage api; slightly reduced build size by removing `static string`; hidden update-related RPC behind defines
* Moved backup&restore to storage
* Fixed new message types
* Backup/restore/update RPC impl
* Moved furi_hal_crc to LL; minor fixes
* CRC HAL rework to LL
* Purging STM HAL
* Brought back minimal DFU boot mode (no gui); additional crc state checks
* Added splash screen, BROKEN usb function
* Clock init rework WIP
* Stripped graphics from DFU mode
* Temp fix for unused static fun
* WIP update picker - broken!
* Fixed UI
* Bumping version
* Fixed RTC setup
* Backup to update folder instead of ext root
* Removed unused scenes & more usb remnants from staged loader
* CI updates
* Fixed update bundle name
* Temporary restored USB handler
* Attempt to prevent .text corruption
* Comments on how I spent this Saturday
* Added update file icon
* Documentation updates
* Moved common code to lib folder
* Storage: more unit tests
* Storage: blocking dir open, differentiate file and dir when freed.
* Major refactoring; added input processing to updater to allow retrying on failures (not very useful prob). Added API for extraction of thread return value
* Removed re-init check for manifest
* Changed low-level path manipulation to toolbox/path.h; makefile cleanup; tiny fix in lint.py
* Increased update worker stack size
* Text fixes in backup CLI
* Displaying number of update stages to run; removed timeout in handling errors
* Bumping version
* Added thread cleanup for spawner thread
* Updated build targets to exclude firmware bundle from 'ALL'
* Fixed makefile for update_package; skipping VCP init for update mode (ugly)
* Switched github build from ALL to update_package
* Added +x for dist_update.sh
* Cli: add total heap size to "free" command
* Moved (RAM) suffix to build version instead of git commit no.
* DFU comment
* Some fixes suggested by clang-tidy
* Fixed recursive PREFIX macro
* Makefile: gather all new rules in updater namespace. FuriHal: rename bootloader to boot, isr safe delays
* Github: correct build target name in firmware build
* FuriHal: move target switch to boot
* Makefile: fix firmware flash
* Furi, FuriHal: move kernel start to furi, early init
* Drop bootloader related stuff
* Drop cube. Drop bootloader linker script.
* Renamed update_hl, moved constants to #defines
* Moved update-related boot mode to separate bitfield
* Reworked updater cli to single entry point; fixed crash on tar cleanup
* Added Python replacement for dist shell scripts
* Linter fixes for dist.py +x
* Fixes for environment suffix
* Dropped bash scripts
* Added dirty build flag to version structure & interfaces
* Version string escapes
* Fixed flag logic in dist.py; added support for App instances being imported and not terminating the whole program
* Fixed fw address in ReadMe.md
* Rpc: fix crash on double screen start
* Return back original boot behavior and fix jump to system bootloader
* Cleanup code, add error sequence for RTC
* Update firmware readme
* FuriHal: drop boot, restructure RTC registers usage and add header register check
* Furi goes first
* Toolchain: add ccache support
* Renamed update bundle dir

Co-authored-by: DrZlo13 <who.just.the.doctor@gmail.com>
Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
hedger
2022-04-13 23:50:25 +03:00
committed by GitHub
parent a25552eb99
commit e02040107b
221 changed files with 4199 additions and 11704 deletions

92
scripts/dist.py Executable file
View File

@@ -0,0 +1,92 @@
#!/usr/bin/env python3
from flipper.app import App
from os.path import join, exists
from os import makedirs
from update import Main as UpdateMain
import shutil
class Main(App):
def init(self):
self.subparsers = self.parser.add_subparsers(help="sub-command help")
self.parser_copy = self.subparsers.add_parser(
"copy", help="Copy firmware binaries & metadata"
)
self.parser_copy.add_argument("-t", dest="target", required=True)
self.parser_copy.add_argument("-p", dest="projects", nargs="+", required=True)
self.parser_copy.add_argument("-s", dest="suffix", required=True)
self.parser_copy.add_argument(
"--bundlever",
dest="version",
help="If set, bundle update package for self-update",
required=False,
)
self.parser_copy.add_argument(
"--noclean",
dest="noclean",
action="store_true",
help="Don't clean output directory",
required=False,
)
self.parser_copy.set_defaults(func=self.copy)
def get_project_filename(self, project, filetype):
return f"flipper-z-{self.args.target}-{project}-{self.args.suffix}.{filetype}"
def get_dist_filepath(self, filename):
return join(self.output_dir_path, filename)
def copy_single_project(self, project):
target_project = f"{self.args.target}-{project}"
obj_directory = join("firmware", ".obj", target_project)
for filetype in ("elf", "bin", "dfu", "json"):
shutil.copyfile(
join(obj_directory, f"{project}.{filetype}"),
self.get_dist_filepath(self.get_project_filename(project, filetype)),
)
def copy(self):
self.output_dir_path = join("dist", self.args.target)
if exists(self.output_dir_path) and not self.args.noclean:
shutil.rmtree(self.output_dir_path)
if not exists(self.output_dir_path):
makedirs(self.output_dir_path)
for project in self.args.projects:
self.copy_single_project(project)
self.logger.info(
f"Firmware binaries can be found at:\n\t{self.output_dir_path}"
)
if self.args.version:
bundle_dir = join(
self.output_dir_path, f"{self.args.target}-update-{self.args.suffix}"
)
bundle_args = [
"generate",
"-d",
bundle_dir,
"-v",
self.args.version,
"-t",
self.args.target,
"-dfu",
self.get_dist_filepath(self.get_project_filename("firmware", "dfu")),
"-stage",
self.get_dist_filepath(self.get_project_filename("updater", "bin")),
]
self.logger.info(
f"Use this directory to self-update your Flipper:\n\t{bundle_dir}"
)
return UpdateMain(no_exit=True)(bundle_args)
return 0
if __name__ == "__main__":
Main()()

View File

@@ -1,52 +0,0 @@
#!/usr/bin/env bash
set -e
suffix="${DIST_SUFFIX:=local}"
rm -rf "dist/${TARGET}"
mkdir -p "dist/${TARGET}"
# copy build outputs
cp bootloader/.obj/${TARGET}/bootloader.elf \
dist/${TARGET}/flipper-z-${TARGET}-bootloader-${suffix}.elf
cp bootloader/.obj/${TARGET}/bootloader.bin \
dist/${TARGET}/flipper-z-${TARGET}-bootloader-${suffix}.bin
cp bootloader/.obj/${TARGET}/bootloader.dfu \
dist/${TARGET}/flipper-z-${TARGET}-bootloader-${suffix}.dfu
cp bootloader/.obj/${TARGET}/bootloader.json \
dist/${TARGET}/flipper-z-${TARGET}-bootloader-${suffix}.json
cp firmware/.obj/${TARGET}/firmware.elf \
dist/${TARGET}/flipper-z-${TARGET}-firmware-${suffix}.elf
cp firmware/.obj/${TARGET}/firmware.bin \
dist/${TARGET}/flipper-z-${TARGET}-firmware-${suffix}.bin
cp firmware/.obj/${TARGET}/firmware.dfu \
dist/${TARGET}/flipper-z-${TARGET}-firmware-${suffix}.dfu
cp firmware/.obj/${TARGET}/firmware.json \
dist/${TARGET}/flipper-z-${TARGET}-firmware-${suffix}.json
# generate full.bin
cp dist/${TARGET}/flipper-z-${TARGET}-bootloader-${suffix}.bin \
dist/${TARGET}/flipper-z-${TARGET}-full-${suffix}.bin
dd if=/dev/null of=dist/${TARGET}/flipper-z-${TARGET}-full-${suffix}.bin bs=1 count=0 seek=32768 2> /dev/null
cat dist/${TARGET}/flipper-z-${TARGET}-firmware-${suffix}.bin \
>>dist/${TARGET}/flipper-z-${TARGET}-full-${suffix}.bin \
2> /dev/null
# generate full.dfu
./scripts/bin2dfu.py \
-i dist/${TARGET}/flipper-z-${TARGET}-full-${suffix}.bin \
-o dist/${TARGET}/flipper-z-${TARGET}-full-${suffix}.dfu \
-a 0x08000000 \
-l "Flipper Zero $(echo ${TARGET} | tr a-z A-Z)"
# generate full.json
./scripts/meta.py merge \
-i dist/${TARGET}/flipper-z-${TARGET}-bootloader-${suffix}.json \
dist/${TARGET}/flipper-z-${TARGET}-firmware-${suffix}.json \
>dist/${TARGET}/flipper-z-${TARGET}-full-${suffix}.json
echo "Firmware binaries can be found at:"
echo -e "\t$(pwd)/dist/${TARGET}"
echo "Use this file to flash your Flipper:"
echo -e "\tflipper-z-${TARGET}-full-${suffix}.dfu"

View File

@@ -5,8 +5,9 @@ import os
class App:
def __init__(self):
def __init__(self, no_exit=False):
# Argument Parser
self.no_exit = no_exit
self.parser = argparse.ArgumentParser()
self.parser.add_argument("-d", "--debug", action="store_true", help="Debug")
# Logging
@@ -14,8 +15,8 @@ class App:
# Application specific initialization
self.init()
def __call__(self):
self.args, _ = self.parser.parse_known_args()
def __call__(self, args=None):
self.args, _ = self.parser.parse_known_args(args=args)
# configure log output
self.log_level = logging.DEBUG if self.args.debug else logging.INFO
self.logger.setLevel(self.log_level)
@@ -30,10 +31,15 @@ class App:
return_code = self.call()
self.after()
if isinstance(return_code, int):
exit(return_code)
return self._exit(return_code)
else:
self.logger.error(f"Missing return code")
exit(255)
return self._exit(255)
def _exit(self, code):
if self.no_exit:
return code
exit(code)
def call(self):
if "func" not in self.args:

View File

@@ -95,9 +95,9 @@ class FlipperFormatFile:
self.writeKey("Version", version)
def load(self, filename: str):
file = open(filename, "r")
self.lines = file.readlines()
with open(filename, "r") as file:
self.lines = file.readlines()
def save(self, filename: str):
file = open(filename, "w")
file.write("\n".join(self.lines))
with open(filename, "w") as file:
file.write("\n".join(self.lines))

View File

@@ -83,7 +83,7 @@ class Main(App):
pool = multiprocessing.Pool()
results = pool.map(self._format_source, tasks)
return not False in results
return all(results)
def _fix_filename(self, filename: str):
return filename.replace("-", "_")

77
scripts/update.py Executable file
View File

@@ -0,0 +1,77 @@
#!/usr/bin/env python3
from flipper.app import App
from flipper.utils.fff import FlipperFormatFile
from os.path import basename, join, exists
from os import makedirs
import shutil
import zlib
class Main(App):
def init(self):
self.subparsers = self.parser.add_subparsers(help="sub-command help")
# generate
self.parser_generate = self.subparsers.add_parser(
"generate", help="Generate update description file"
)
self.parser_generate.add_argument("-d", dest="directory", required=True)
self.parser_generate.add_argument("-v", dest="version", required=True)
self.parser_generate.add_argument("-t", dest="target", required=True)
self.parser_generate.add_argument("-dfu", dest="dfu", required=True)
self.parser_generate.add_argument("-stage", dest="stage", required=True)
self.parser_generate.add_argument("-radio", dest="radiobin", required=False)
self.parser_generate.add_argument(
"-radioaddr", dest="radioaddr", required=False
)
self.parser_generate.set_defaults(func=self.generate)
def generate(self):
stage_basename = basename(self.args.stage)
dfu_basename = basename(self.args.dfu)
if not exists(self.args.directory):
makedirs(self.args.directory)
shutil.copyfile(self.args.stage, join(self.args.directory, stage_basename))
shutil.copyfile(self.args.dfu, join(self.args.directory, dfu_basename))
file = FlipperFormatFile()
file.setHeader("Flipper firmware upgrade configuration", 1)
file.writeKey("Info", self.args.version)
file.writeKey("Target", self.args.target[1:]) # dirty 'f' strip
file.writeKey("Loader", stage_basename)
file.writeComment("little-endian hex!")
file.writeKey("Loader CRC", self.int2ffhex(self.crc(self.args.stage)))
file.writeKey("Firmware", dfu_basename)
file.writeKey("Radio", self.args.radiobin or "")
file.writeKey("Radio address", self.int2ffhex(self.args.radioaddr or 0))
file.save("%s/update.fuf" % self.args.directory)
return 0
@staticmethod
def int2ffhex(value: int):
hexstr = "%08X" % value
return " ".join(list(Main.batch(hexstr, 2))[::-1])
@staticmethod
def crc(fileName):
prev = 0
with open(fileName, "rb") as file:
for eachLine in file:
prev = zlib.crc32(eachLine, prev)
return prev & 0xFFFFFFFF
@staticmethod
def batch(iterable, n=1):
l = len(iterable)
for ndx in range(0, l, n):
yield iterable[ndx : min(ndx + n, l)]
if __name__ == "__main__":
Main()()