bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

samples: Update fs format sample README

Browse Source 
Update the README.md to README.rst format and
rephrased parts of the description.

Signed-off-by: Simon Hein <Shein@baumer.com>
This commit is contained in:
Simon Hein 2023-04-05 13:56:12 +00:00 committed by Carles Cufí
parent c2a51fd336
commit 72f2b01e5a
2 changed files with 50 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
samples/subsys/fs/format/README.md
View File

@ -1,34 +0,0 @@
# Format Sample Application
## Overview
The aim of this sample application is to show how to format different storage
devices for different file systems. There are 2 scenarios prepared for this
sample:
* littleFS on flash device
* FAT file system on RAM disk
## Building and running
To run this demo, build it for the desired board and flash it.
To build demo that will use RAM disk use `prj_ram.conf` configuration file (e.g.
by setting `CONF_FILE=prj_ram.conf`).
The demo was build for 2 boards:
1. nRF 52DK with flash
```
west build -b nrf52dk_nrf52832 samples/subsys/fs/format
west flash
```
2. MIMXRT1064-EVK with RAM disk
```
CONF_FILE=prj_ram.conf west build -b mimxrt1064_evk samples/subsys/fs/format
west flash
```
When sample runs successfully you should see following message on the screen:
```
I: LittleFS version 2.4, disk version 2.0
I: FS at flash-controller@4001e000:0x7a000 is 6 0x1000-byte blocks with 512 cycle
I: sizes: rd 16 ; pr 16 ; ca 64 ; la 32
I: Format successful
```

50
samples/subsys/fs/format/README.rst Normal file
View File

@ -0,0 +1,50 @@
.. _fs_format_sample:
FS Format Sample
################
Overview
***********
This sample shows how to format different storage
devices for different file systems. There are 2 scenarios prepared for this
sample:
* littleFS on flash device
* FAT file system on RAM disk
Building and running
********************
To run this sample, build it for the desired board and scenario and flash it.
The Flash scenario is supported on the nrf52dk_nrf52832 board.
The RAM disk scenario is supported on the mimxrt1064_evk board.
To build the RAM disk sample, the configuration `prj_ram.conf` needs to be used by setting `CONF_FILE=prj_ram.conf`.
The Flash sample for the nrf 52DK board can be build as follow:
.. zephyr-app-commands::
:zephyr-app: samples/subsys/fs/format
:board: nrf52dk_nrf52832
:goals: build flash
:compact:
The RAM disk sample for the MIMXRT1064-EVK board can be build as follow:
.. zephyr-app-commands::
:zephyr-app: samples/subsys/fs/format
:board: mimxrt1064_evk
:conf: "prj_ram.conf"
:goals: build flash
:compact:
Sample Output
=============
When the sample runs successfully you should see following message on the screen:
.. code-block:: console
I: LittleFS version 2.4, disk version 2.0
I: FS at flash-controller@4001e000:0x7a000 is 6 0x1000-byte blocks with 512 cycle
I: sizes: rd 16 ; pr 16 ; ca 64 ; la 32
I: Format successful