Go to file
2022-06-13 10:08:28 +09:00
.github Fix CLI storage read (#1305) 2022-06-10 10:28:05 +09:00
applications HW LED blink integration (#1310) 2022-06-13 10:08:28 +09:00
assets [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
core [FL-2245] Introduce Mifare Classic Emulation (#1242) 2022-05-24 17:00:15 +03:00
debug [FL-2198], [FL-2161] NFC emulation refactoring (#968) 2022-02-02 22:59:28 +03:00
docker Naming and coding style convention, new linter tool. (#945) 2022-01-05 19:10:18 +03:00
documentation [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
firmware [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
lib nfc: add debug PCAP output, refactor Mifare DESFire following #1095 (#1294) 2022-06-09 17:35:34 +09:00
make Compile commands generator (#1223) 2022-05-12 14:38:33 +03:00
scripts [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09: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-2156] Switch to smaller radio stack. (#923) 2021-12-23 19:24:09 +03:00
.gitignore [FL-2430] Automatic Desktop Locking (#1101) 2022-04-14 15:20:41 +03:00
.gitmodules [FL-2263] Flasher service & RAM exec (#1006) 2022-04-13 23:50:25 +03:00
Brewfile Gui: refactor text input module and fix debug on MacOS 12.3 (#1045) 2022-03-22 11:03:26 +03:00
CODE_OF_CONDUCT.md Code of Conduct (#739) 2021-10-02 20:32:18 +03:00
CODING_STYLE.md [FL-2230] SubGhz: protocol API refactoring (#969) 2022-03-03 12:48:56 +03: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
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
Makefile [FL-2580] FuriHal: add more supported radio stacks (#1301) 2022-06-09 18:07:42 +09:00
ReadMe.md Add instruction for missing deps. (#1265) 2022-05-23 21:19:41 +03:00
RoadMap.md Fixed README formatting & outdated information (#1123) 2022-04-15 21:26:23 +04: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 order described.

Core1 Firmware

Prerequisites:

One liner: make flash

Core2 flashing procedures

Prerequisites:

  • Linux / macOS
  • Terminal
  • STM32_Programmer_CLI (v2.5.0) added to $PATH

One liner: make flash_radio

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 make

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

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

make

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:

make whole

Links

Project structure

  • applications - Applications and services used in firmware
  • assets - Assets used by applications and services
  • core - 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...
  • make - Make helpers
  • scripts - Supplementary scripts and python libraries home

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