917410a0a8
* fbt: reworking targets & assets handling WIP * fbt: dist fixes * fbt: moved SD card resources to owning apps * unit_tests: moved resources to app folder * github: updated unit_tests paths * github: packaging fixes * unit_tests: fixes * fbt: assets: internal cleanup * fbt: reworked assets handling * github: unit_tests: reintroducing fixes * minor cleanup * fbt: naming changes to reflect private nature of scons tools * fbt: resources: fixed dist archive paths * docs: updated paths * docs: updated more paths * docs: included "resources" parameter in app manifest docs; updated assets readme * updated gitignore for assets * github: updated action versions * unit_tests: restored timeout; scripts: assets: logging changes * gh: don't upload desktop animations for unit test run Co-authored-by: あく <alleteam@gmail.com>
3.2 KiB
What a Firmware Target is
Flipper's firmware is modular and supports different hardware configurations in a common code base. It encapsulates hardware-specific differences in furi_hal, board initialization code, linker files, SDK data and other information in a target definition.
Target-specific files are placed in a single sub-folder in targets. It must contain a target definition file, target.json, and may contain other files if they are referenced by current target's definition. By default, fbt gathers all source files in target folder, unless they are explicitly excluded.
Targets can inherit most code parts from other targets, to reduce common code duplication.
Target Definition File
A target definition file, target.json, is a JSON file that can contain the following fields:
include_paths: list of strings, folder paths relative to current target folder to add to global C/C++ header path lookup list.sdk_header_paths: list of strings, folder paths relative to current target folder to gather headers from for including in SDK.startup_script: filename of a startup script, performing initial hardware initialization.linker_script_flash: filename of a linker script for creating the main firmware image.linker_script_ram: filename of a linker script to use in "updater" build configuration.linker_script_app: filename of a linker script to use for linking .fap files.sdk_symbols: filename of a .csv file containing current SDK configuration for this target.linker_dependencies: list of libraries to link the firmware with. Note that those not in the list won't be built byfbt. Also several link passes might be needed, in such case you may need to specify same library name twice.inherit: string, specifies hardware target to borrow main configuration from. Current configuration may specify additional values for parameters that are lists of strings, or override values that are not lists.excluded_sources: list of filenames from the inherited configuration(s) NOT to be built.excluded_headers: list of headers from the inherited configuration(s) NOT to be included in generated SDK.excluded_modules: list of strings specifying fbt library (module) names to exclude from being used to configure build environment.
Applications & Hardware
Not all applications are available on different hardware targets.
-
For applications built into the firmware, you have to specify a compatible application set using
FIRMWARE_APP_SET=...fbt option. See fbt docs for details on build configurations. -
For applications built as external .faps, you have to explicitly specify compatible targets in application's manifest,
application.fam. For example, to limit application to a single target, addtargets=["f7"],to the manifest. It won't be built for other targets.
For details on application manifests, check out their docs page.
Building Firmware for a Specific Target
You have to specify TARGET_HW (and, optionally, FIRMWARE_APP_SET) for fbt to build firmware for non-default target. For example, building and flashing debug firmware for f18 can be done with
./fbt TARGET_HW=18 flash_usb_full