unleashed-firmware/scripts
dogtopus a7f0f5ad27
Improve vscode clangd experience (#2431)
* Improve vscode clangd experience

- Resolve and use absolute path for the toolchain. This allows clangd to use compile_commands.json file without running under fbtenv, simplifies setup for vscode clangd extension. As a side effect, a rebuild is needed to update compile_commands.json after moving the source tree.
- Add the recommended default settings of the extension to settings.json.

* Use build/latest for compile-commands-dir

This makes it behave closer to c-cpp-properties.

* Reformat crosscc.py

This is a PEP-8 violation but black seems to enforce it

* Bypass --query-driver

This has some security implications as it grants clangd the ability to execute any executables anywhere while trying to probe a compiler based on CDB. However it's very hard to do this the safe and intended way without resorting to config generation due to reason listed in #2431. Besides that we already have workspace trust so what could go wrong? ;)

* Add an option for vscode_dist to switch between clangd and cpptools

This will install different extensions.json tuned for either clangd or cpptools based on user selection. It will also install c_cpp_properties.json when using cpptools since clangd doesn't use this file.

The root .gitignore now also doesn't accidentally ignore everything under the .vscode directory.

* Use absolute path for .vscode gitignore

Turns out the previously used "relative" paths aren't even valid gitignore patterns and to actually do what it means one needs to use the absolute paths instead.

* Handle variable parsing in commandline.scons

commandline.scons is the place where all other command line parsing happens. Move LANG_SERVER variable parsing there and add a constraint to make the code more consistent.

---------

Co-authored-by: hedger <hedger@users.noreply.github.com>
Co-authored-by: hedger <hedger@nanode.su>
2023-08-16 05:23:09 +04:00
..
debug Debug: sync apps on attach, makes it possible to debug already started app that has crashed (#2778) 2023-06-16 10:48:57 +04:00
fbt ufbt: fixed FAP_SRC_DIR (#2970) 2023-08-11 01:21:56 +09:00
fbt_tools Improve vscode clangd experience (#2431) 2023-08-16 05:23:09 +04:00
flipper Scripts: OB recovery (#2964) 2023-08-10 19:45:17 +10:00
testing Actions: unit_test and updater timeouts (#2807) 2023-06-28 06:47:13 +10:00
toolchain fbtenv: add additional environ variable to control execution flow (#2938) 2023-08-03 00:38:51 +09:00
ufbt ufbt: fixed FAP_SRC_DIR (#2970) 2023-08-11 01:21:56 +09:00
assets.py [FL-3285] Removed STM32CubeWB module (#2608) 2023-05-09 06:30:33 +09:00
bin2dfu.py [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
distfap.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
fastfap.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
flash.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
fwsize.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
get_env.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
guruguru.py [FL-2832] fbt: more fixes & improvements (#1854) 2022-10-13 01:12:05 +09:00
lint.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
map_mariadb_insert.py [DEVOPS-18]: Add map file parser, mariadb inserter (#2732) 2023-06-05 19:25:43 +09:00
map_parser.py Map parser licence description (#2739) 2023-06-07 17:30:26 +04:00
merge_report_qa.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
meta.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
ob.data [FL-3271] cubewb: updated to v1.16.0 (#2595) 2023-04-20 21:57:51 +09:00
ob.py Scripts: OB recovery (#2964) 2023-08-10 19:45:17 +10:00
ob_custradio.data [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
otp.py [FL-3408, FL-3429, FL-3430] Backlight notification fix (#2878) 2023-08-01 16:56:11 +09:00
power.py Splitting units and updater benches (#2165) 2022-12-28 23:16:06 +09:00
program.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
ReadMe.md Fixing various typos in readme files #2208 2022-12-28 23:30:20 +09:00
runfap.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
sconsdist.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
selfupdate.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
serial_cli.py [FL-3346] fbt: added Flipper selection when multiple are connected over USB (#2723) 2023-06-08 13:47:27 +09:00
slideshow.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
storage.py [FL-3174] Dolphin builder in ufbt; minor ufbt/fbt improvements (#2601) 2023-05-03 14:48:49 +09:00
update.py [FL-3328] Removed user-specific data from tar artifacts (#2691) 2023-05-23 19:51:21 +09:00
version.py [FL-3386] Fast FAP Loader (#2790) 2023-06-28 17:19:10 +09:00
wifi_board.py Scripts: WiFi board updater (#2625) 2023-06-08 17:28:08 +09:00

About

This folder contains supplementary scripts that automates routine actions. Flashing scripts are based on cli version of STM32CubeProgrammer. You will need to add STM32_Programmer_CLI to your path to use them.

Flashing empty MCU/Flipper

Always flash your device in the following sequence:

  • OTP (Only on empty MCU)
  • Core1 and Core2 firmware flashing
  • Option Bytes

Otp flashing

!!! Flashing incorrect OTP may permanently brick your device !!!

Normally OTP data generated and flashed at the factory. In case if MCU was replaced you'll need correct OTP data to be able to use companion applications. Use otp.py to generate and flash OTP data. You will need exact main board revision to generate OTP data. It can be found on main PCB. Also display type, region and etc...

!!! Flashing incorrect OTP may permanently brick your device !!!

Core1 and Core2 firmware flashing

Core2 goes first, then Core1. Never flash FUS or you will lose your job, girlfriend and keys in secure enclave.

Option Bytes

!!! Setting incorrect Option Bytes may brick your MCU !!!

Defaults are mostly OK, but there are couple things that we'd like to tune. Also, OB may be damaged, so we've made couple scripts to check and set option bytes.

!!! Setting incorrect Option Bytes may brick your MCU !!!

Checking option bytes:

ob.py check

Setting option bytes:

ob.py set

Assets delivery

Run in the root folder of the repo:

python scripts/storage.py -p <flipper_cli_port> send assets/resources /ext

Slideshow creation

Put fullscreen slideshow frames in .png format into assets/slideshow/my_show folder, named frame_xx.png, where xx is zero-padded frame number, starting with #0.

Then run

python scripts/slideshow.py -i assets/slideshow/my_show/ -o assets/slideshow/my_show/.slideshow

Upload generated .slideshow file to Flipper's internal storage and restart it.