From 7243758b402696f06648d1b34445ae1669e7370f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=82=E3=81=8F?= Date: Fri, 29 Jan 2021 14:18:10 +0300 Subject: Update readme, add flashing scripts (#316) --- ReadMe.md | 41 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 37 insertions(+), 4 deletions(-) (limited to 'ReadMe.md') diff --git a/ReadMe.md b/ReadMe.md index 70e2261d..789477ff 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -4,14 +4,47 @@ -Welcome to [Flipper Zero](https://flipperzero.one/)'s Firmware repo! Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. This repo will become completely public closer to the device shipping date. +Welcome to [Flipper Zero](https://flipperzero.one/)'s Firmware repo! +Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. +This repo will become completely public closer to the device shipping date. # Update firmware -Flipper Zero's firmware consists of two components: Bootloader and main firmware. Bootloader controls firmware update process over USB. You need working bootloader installed before update firmware over USB. +Flipper Zero's firmware consists of three components: + +- Core2 firmware - proprietary componenets by ST: FUS + radio stack. +- Core1 Bootloader - controls basic hardware initialization and loads firmware +- Core1 Firmware - HAL + OS + Drivers + Applications + +All 3 of them must be flashed in order described. + +## With STLink + +### Core2 flashing procedures + +Prerequisites: + +- Linux / MacOs +- Terminal +- STM32_Programmer_CLI added to $PATH + +One liner: `./flash_core2_ble.sh` + +### Core1 Bootloader + Firmware + +Prerequisites: + +- Linux / MacOs +- Terminal +- Arm gcc noneabi +- openocd + +One liner: `./flash_core1_main.sh` + +## With USB DFU 1. Download latest [Firmware](https://update.flipperzero.one/full_firmware_latest.bin) @@ -21,9 +54,9 @@ Flipper Zero's firmware consists of two components: Bootloader and main firmware - Release `↩ Back` -1. Run `dfu-util -D firmware.bin -a 0 -s 0x08008000:leave` +1. Run `dfu-util -D full_firmware_latest.bin -a 0 -s 0x08000000:leave` -## Build from source +# Build from source `docker-compose exec dev make -C firmware TARGET=f4 APP_RELEASE=1 flash` for build and flash dev board (see `applications/applications.mk` for list of applications/examples) -- cgit v1.2.3