adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

samples: driver: flash_shell: Add readme

Browse source 
Add readme to flash_shell driver sample.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-05-08 16:50:22 +02:00 committed by Carles Cufí
parent 2d21eb97d0
commit 6c6c03d60c
1 changed files with 43 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
samples/drivers/flash_shell/README.rst Normal file
View file

@ -0,0 +1,43 @@
.. _samples_flash_shell:
Flash Shell Sample
##################
Overview
********
This is a simple shell module that allows arbitrary boards with flash
driver support to explore the flash device.
Building and Running
********************
This project can be built and executed on as follows:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/flash_shell
:host-os: unix
:board: qemu_x86
:goals: run
:compact:
Sample Output
=============
.. code-block:: console
uart:~$ flash page_count
Flash device contains 1024 pages.
uart:~$ flash page_erase 1023
Erasing page 1023 (start offset 0xffc00, size 0x400)
uart:~$ flash page_write 1023 8 17 19 28 39
Reading back written bytes:
11 13 1c 27
uart:~$ flash page_write 1023 4 77 9 1 2
Reading back written bytes:
4d 09 01 02
uart:~$ flash page_read 1023 4 12
4d 09 01 02 | 11 13 1c 27
ff ff ff ff
uart:~$ flash page_read 1023 0 16
ff ff ff ff | 4d 09 01 02
11 13 1c 27 | ff ff ff ff