2f2f6b5f50
* BLE: working version * BLE: cleanup * BLE: update device description and DIS. * BLE: explicitly take semaphore and configure CLK48, bt subsystem status, remove LPM. * HAL: add missing api_hal_bt_is_alive symbol * TODO about valuemutex * duplicate f3-1 (f4) ioc from f3 * regenerate project * use target dir for ble glue path * update f4 from f3 Co-authored-by: coreglitch <mail@s3f.ru> |
||
---|---|---|
.. | ||
targets | ||
Makefile | ||
ReadMe.md |
Overview of Flipper firmware architecture:
Project structure
.
├── applications # Flipper applications
├── bootloader # Bootloader make project
├── core # Main feature like OS, HAL (target-independed)
├── core-rs # Rust code
├── docker # Docker toolchain container
├── firmware # Firmware make project
├── lib # Libs and 3rd parties
├── make # Makefile scripts
├── wiki # Documentation (wiki) generates from this files
└── wiki_static # Static files for wiki
HAL
We use STM32 HAL/LL. Description available here: dm00105879.pdf
Flipper HAL
Some flipper-specific implementation of gpio/HAL:
- Init gpio pin:
app_gpio_init
- Fast write gpio (inline):
app_gpio_write
- Fast read gpio (inline):
app_gpio_read
- Microsecond delay
delay_us
- Set PWM on timer's pin:
pwm_set
Files location: /app/app_hal.[ch]
Bootloader
For production targets('f2' and newer) bootloader must be flashed first.
Detailed instruction on how to compile and flash it you can find in bootloader
folder.
Production version is going to have following features:
- Hardware initialization
- Firmware CRC check
- Firmware update
- Interactive UI
- Boot process LED indicators
- FS check
- Recovery mode
OS
CMSIS-RTOS2 over FreeRTOS
Platform code
CMSIS, Freertos and HAL files are generated by CubeMX.
You can find platform code for L476 version in f2
folder:
Inc
Src
— CubeMX generated headers & codeMiddlewares/Third_Party/FreeRTOS/Source
— freeRTOSdeploy.sh
— flash firmware to deviceSTM32L476RGTx_FLASH.ld
— linker scriptstartup_stm32l476xx.s
— board startup/initialization assembler codecube.ioc
— CubeMX project file
You can regenerate platform code:
- Download CubeMX from st.com
- Open
*.ioc
file - Click
generate code
- After regenerating, look at git status, regenerating may broke some files.
Flipper Universal Registry Implementation (FURI)
FURI is used to:
- application control (start, exit, switch between active)
- data exchange between application (create/open channel, subscribe and push messages or read/write values)
- non-volatile data storage for application (create/open value and read/write)
Read more at FURI page
FS (not implemented)
File system is used to volaile storage some files (config, application data, etc.). There are some folders mounted to different volumes:
/usr
for store static data like assets, menu items. Build system add files to usr while building. It can be useful for exchange some static data between application. For example, your app can add link to itself to Plugins menu items file, user will see your app and can call it from this menu.- Specially
/usr/etc-default
folder contains default configs for apps. Bootloader hasfactory default
options to reset applications config. Also when new app is bootstapping, system copy files from default config folder to/etc
. /etc
for store configs of application. This volume not overwrite during flashing./var
for store some application data (saved keys, application database, logs). This volume also not overwrite during flashing./media/*
mounted if SD card is inserted.
Flipper applications
Each flipper functionality except OS/HAL/FURI doing by Flipper application. Some application are called at startup, the rest are called by the user (for example, from menu).
(you can see some examples)
For exchange data between application each app expose own record in FURI. You can subscribe on/read record to get data from application and write to record to send data to application.