michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: spi_flash: add README

Browse source 
Basic example of basic flash API use when selecting a serial flash
memory.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
This commit is contained in:
Peter Bigot 2020-08-26 09:48:32 -05:00 • committed by Anas Nashif
commit e81e88e52e
1 changed files with 41 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

41
samples/drivers/spi_flash/README.rst Normal file
View file

@ -0,0 +1,41 @@
.. _spi-nor-sample:
JEDEC SPI-NOR Sample
####################
Overview
********
This sample demonstrates using the flash API on a SPI NOR serial flash
memory device. While trivial it is an example of direct access and
allows confirmation that the flash is working and that automatic power
savings is correctly implemented.
Building and Running
********************
The application will build only for a target that has a :ref:`devicetree
<dt-guide>` entry with ``jedec,spi-nor`` as a compatible.
.. zephyr-app-commands::
:zephyr-app: samples/drivers/spi_flash
:board: nrf52840dk_nrf52840
:goals: build flash
:compact:
Sample Output
=============
.. code-block:: console
*** Booting Zephyr OS build zephyr-v2.3.0-2142-gca01d2e1d748 ***
JEDEC QSPI-NOR SPI flash testing
==========================
Test 1: Flash erase
Flash erase succeeded!
Test 2: Flash write
Attempting to write 4 bytes
Data read matches data written. Good!