History

SG ad421a81bc [FL-1191][FL-1524] Filesystem rework (#568 ) * FS-Api: removed datetime manipulation functions and most of the file flags * Filesystem: common proxy api * Filesystem: renamed to Storage. Work has begun on a glue layer. Added functions for reentrance. * Storage: sd mount and sd file open * Storage: sd file close * Storage: temporary test app * Storage: free filedata on close * Storage: sd file read and write * Storage: added internal storage (LittleFS) * Storage: renamed internal commands * Storage: seek, tell, truncate, size, sync, eof * Storage: error descriptions * Storage: directory management api (open, close, read, rewind) * Storage: common management api (stat, fs_stat, remove, rename, mkdir) * Dolphin app and Notifications app now use raw storage. * Storage: storage statuses renamed. Implemented sd card icon. * Storage: added raw sd-card api. * Storage settings: work started * Assets: use new icons approach * Storage settings: working storage settings * Storage: completely redesigned api, no longer sticking out FS_Api * Storage: more simplified api, getting error_id from file is hidden from user, pointer to api is hidden inside file * Storage: cli info and format commands * Storage-cli: file list * Storage: a simpler and more reliable api * FatFS: slightly lighter and faster config. Also disabled reentrancy and file locking functions. They moved to a storage service. * Storage-cli: accommodate to the new cli api. * Storage: filesystem api is separated into internal and common api. * Cli: added the ability to print the list of free heap blocks * Storage: uses a list instead of an array to store the StorageFile. Rewrote api calls to use semaphores instead of thread flags. * Storage settings: added the ability to benchmark the SD card. * Gui module file select: uses new storage api * Apps: removed deprecated sd_card_test application * Args lib: support for enquoted arguments * Dialogs: a new gui app for simple non-asynchronous apps * Dialogs: view holder for easy single view work * File worker: use new storage api * IButton and lfrrfid apps: save keys to any storage * Apps: fix ibutton and lfrfid stack, remove sd_card_test. * SD filesystem: app removed * File worker: fixed api pointer type * Subghz: loading assets using the new storage api * NFC: use the new storage api * Dialogs: the better api for the message element * Archive: use new storage api * Irda: changed assest path, changed app path * FileWorker: removed unused file_buf_cnt * Storage: copying and renaming files now works between storages * Storage cli: read, copy, remove, rename commands * Archive: removed commented code * Storage cli: write command * Applications: add SRV_STORAGE and SRV_DIALOGS * Internal-storage: removed * Storage: improved api * Storage app: changed api pointer from StorageApp to Storage * Storage: better file_id handling * Storage: more consistent errors * Loader: support for NULL icons * Storage: do nothing with the lfs file or directory if it is not open * Storage: fix typo * Storage: minor float usage cleanup, rename some symbols. * Storage: compact doxygen comments. Co-authored-by: あく <alleteam@gmail.com>		2021-07-23 15:20:19 +03:00
..
targets	[FL-1191][FL-1524] Filesystem rework (#568 )	2021-07-23 15:20:19 +03:00
Makefile	[FL-1546, FL-1534, FL-1550] Drop F5, Certification preparation, Global application start lock (#585 )	2021-07-18 21:09:00 +03:00
ReadMe.md	Remove obsolete target. Cleanup and update ReadMe. (#279 )	2020-12-28 11:52:35 +06:00

ReadMe.md

Project structure

.
├── applications    # Flipper applications
├── assets          # Assets: icons, animation
├── bootloader      # Bootloader make project
├── core            # Main feature like OS, HAL (target-independed)
├── core-rs         # Rust code
├── debug           # Debug helpers, configs and plugins
├── docker          # Docker toolchain container
├── firmware        # Firmware make project
├── lib             # Libs and 3rd parties
├── make            # Makefile scripts

Bootloader

Bootloader must be flashed first. Detailed instruction on how to compile and flash it you can find in bootloader folder.

OS

CMSIS-RTOS2 over FreeRTOS

Platform code

CMSIS, Freertos and HAL files are generated by CubeMX. You can find platform code for STM32WB55 version in f4 folder:

├── Inc                             # CubeMX generated headers
├── Src                             # CubeMX generated code
├── api-hal                         # Our HAL wrappers and platform specifics
├── ble-glue                        # BLE specific code(Glue for STMWPAN)
├── f4.ioc                          # CubeMX project file
├── startup_stm32wb55xx_cm4.s       # Board startup/initialization assembler code
├── stm32wb55xx_flash_cm4*.ld       # Linker scripts
├── target.mk                       # Makefile include

Working with CubeMX:

Download CubeMX from st.com
Open *.ioc file
Do whatever you want to
Click generate code
After regenerating, look at git status, regeneration may brake some files.
Check one more time that things that you've changes are not covered in platform api-hal. Because you know...

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)

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 has factory 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.

List of FURI records