Skip to content

Latest commit

 

History

History
155 lines (102 loc) · 4.21 KB

ReadMe.md

File metadata and controls

155 lines (102 loc) · 4.21 KB
Raw

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.

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.

With STLink

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.

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.