Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/flipperzero-firmware.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorあく <alleteam@gmail.com>2021-01-29 14:18:10 +0300
committerGitHub <noreply@github.com>2021-01-29 14:18:10 +0300
commit7243758b402696f06648d1b34445ae1669e7370f (patch)
treea1a40e273187fd1f4aaa8e1ce2d1d0554c89ae55 /ReadMe.md
parent584c0962d8685c02669ea81a9dba0ee1e1d0c4b6 (diff)
Update readme, add flashing scripts (#316)
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md41
1 files changed, 37 insertions, 4 deletions
diff --git a/ReadMe.md b/ReadMe.md
index 70e2261d..789477ff 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -4,14 +4,47 @@
<img src="https://habrastorage.org/webt/eo/m0/e4/eom0e4btudte7nrhnyic-laiog0.png" />
-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
<a href="https://update.flipperzero.one/full_firmware_latest.bin"><img width="300" src="https://update.flipperzero.one/latest-firmware-banner.png" /></a>
-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`
<img src="https://habrastorage.org/webt/uu/c3/g2/uuc3g2n36f2sju19rskcvjzjf6w.png" />
-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)