Go to file
Nikolay Minaylov 84e2e321b4
RPC: more asserts and checks (#1606)
Co-authored-by: あく <alleteam@gmail.com>
2022-08-23 01:36:45 +09:00
.github Github: Update CODEOWNERS (#1631) 2022-08-21 21:51:04 +09:00
.vscode [FL-2059] Storage fixes for handling empty files (#1563) 2022-08-10 00:57:11 +09:00
applications RPC: more asserts and checks (#1606) 2022-08-23 01:36:45 +09:00
assets [FL-2714] New NFC info screens (#1605) 2022-08-18 00:08:13 +09:00
debug fbt fixes & improvements (#1490) 2022-08-02 22:46:43 +09:00
docker [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
documentation vscode: initial development configuration (#1520) 2022-08-04 01:32:31 +09:00
firmware [FL-2747, FL-2745] Browser worker fix, Device Info screen update #1620 2022-08-19 01:54:17 +09:00
furi Make printf great again (#1438) 2022-08-04 01:00:17 +09:00
lib Fix typos in subghz (#1588) 2022-08-18 01:40:09 +09:00
scripts slideshow.py: add return code on error (#1636) 2022-08-23 01:24:08 +09:00
site_scons fbt: support for LOADER_AUTOSTART; post-build size stats (#1594) 2022-08-13 08:17:11 +10:00
.clang-format [FL-2520] FW build with -Wextra (#1185) 2022-05-06 16:37:10 +03:00
.editorconfig Create .editorconfig (#889) 2021-12-15 14:33:52 +03:00
.gitattributes [FL-2554] Embedded arm-none-eabi toolchain (#1351) 2022-07-15 01:24:26 +09:00
.gitignore [FL-2554] Embedded arm-none-eabi toolchain (#1351) 2022-07-15 01:24:26 +09:00
.gitmodules PicoPass / iClass (#1298) 2022-07-03 17:44:38 +09:00
Brewfile [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
CODE_OF_CONDUCT.md Code of Conduct (#739) 2021-10-02 20:32:18 +03:00
CODING_STYLE.md [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
CONTRIBUTING.md Naming and coding style convention, new linter tool. (#945) 2022-01-05 19:10:18 +03:00
docker-compose.yml [FL-2520] FW build with -Wextra (#1185) 2022-05-06 16:37:10 +03:00
fbt [FL-2649] Drop Docker in CI/CD (#1412) 2022-08-02 23:05:31 +09:00
fbt_options.py fbt: support for LOADER_AUTOSTART; post-build size stats (#1594) 2022-08-13 08:17:11 +10:00
fbt.cmd Fix git submodules update called anyways (#1450) 2022-07-26 02:09:04 +03:00
firmware.scons fbt: support for LOADER_AUTOSTART; post-build size stats (#1594) 2022-08-13 08:17:11 +10:00
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
Makefile [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
ReadMe.md fbt fixes & improvements (#1490) 2022-08-02 22:46:43 +09:00
RoadMap.md Fixed README formatting & outdated information (#1123) 2022-04-15 21:26:23 +04:00
SConstruct vscode: initial development configuration (#1520) 2022-08-04 01:32:31 +09:00

Flipper Zero Firmware

Discord

Show me the code

Welcome to Flipper Zero's Firmware repo! Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with.

Clone the Repository

You should clone with

$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git

Update firmware

Get Latest Firmware from Update Server

Flipper Zero's firmware consists of two components:

  • Core2 firmware set - proprietary components by ST: FUS + radio stack. FUS is flashed at factory and you should never update it.
  • Core1 Firmware - HAL + OS + Drivers + Applications.

They both must be flashed in the order described.

With offline update package

With Flipper attached over USB:

./fbt flash_usb

Just building the package:

./fbt updater_package

To update, copy the resulting directory to Flipper's SD card and navigate to update.fuf file in Archive app.

Core1 Firmware

Prerequisites:

One liner: ./fbt firmware_flash

With USB DFU

  1. Download latest Firmware

  2. Reboot Flipper to Bootloader

  • Press and hold ← Left + ↩ Back for reset
  • Release ↩ Back and keep holding ← Left until blue LED lights up
  • Release ← Left
  1. Run dfu-util -D full.dfu -a 0

Build with Docker

Prerequisites

  1. Install Docker Engine and Docker Compose
  2. Prepare the container:
docker-compose up -d

Compile everything

docker-compose exec dev ./fbt

Check dist/ for build outputs.

Use flipper-z-{target}-full-{suffix}.dfu to flash your device.

If compilation fails, make sure all submodules are all initialized. Either clone with --recursive or use git submodule update --init --recursive.

Build on Linux/macOS

Check out documentation/fbt.md for details on building and flashing firmware.

macOS Prerequisites

Make sure you have brew and install all the dependencies:

brew bundle --verbose

Linux Prerequisites

gcc-arm-none-eabi

toolchain="gcc-arm-none-eabi-10.3-2021.10"
toolchain_package="$toolchain-$(uname -m)-linux"

wget -P /opt "https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.10/$toolchain_package.tar.bz2"

tar xjf /opt/$toolchain_package.tar.bz2 -C /opt
rm /opt/$toolchain_package.tar.bz2

for file in /opt/$toolchain/bin/* ; do ln -s "${file}" "/usr/bin/$(basename ${file})" ; done

Optional dependencies

  • openocd (debugging/flashing over SWD)
  • heatshrink (compiling image assets)
  • clang-format (code formatting)
  • dfu-util (flashing over USB DFU)
  • protobuf (compiling proto sources)

For example, to install them on Debian, use:

apt update
apt install openocd clang-format-13 dfu-util protobuf-compiler

heatshrink has to be compiled from sources.

Compile everything

./fbt

Check dist/ for build outputs.

Use flipper-z-{target}-full-{suffix}.dfu to flash your device.

Flash everything

Connect your device via ST-Link and run:

./fbt firmware_flash

Links

Project structure

  • applications - Applications and services used in firmware
  • assets - Assets used by applications and services
  • furi - Furi Core: os level primitives and helpers
  • debug - Debug tool: GDB-plugins, SVD-file and etc
  • docker - Docker image sources (used for firmware build automation)
  • documentation - Documentation generation system configs and input files
  • firmware - Firmware source code
  • lib - Our and 3rd party libraries, drivers and etc...
  • scripts - Supplementary scripts and python libraries home

Also pay attention to ReadMe.md files inside of those directories.