zephyr

History

Jordan Yates 243eb36b18 everywhere: reindent `.overlay` files with tabs `checkpatch.pl` requires that dts sources are indented with tabs, fix all the spaces that slipped in while checkpatch wasn't watching. Signed-off-by: Jordan Yates <jordan@embeint.com>		2024-06-26 15:59:44 +02:00
..
boards	everywhere: reindent `.overlay` files with tabs	2024-06-26 15:59:44 +02:00
src	samples: spi_flash: node from compat, not alias	2024-06-06 15:21:18 -05:00
CMakeLists.txt
prj.conf
README.rst	samples: spi_flash: node from compat, not alias	2024-06-06 15:21:18 -05:00
sample.yaml	samples: drivers: include the stm32 xspi node for running the samples	2024-05-15 10:56:04 +02:00

README.rst

.. zephyr:code-sample:: spi-nor
   :name: JEDEC SPI-NOR flash
   :relevant-api: flash_interface

   Use the flash API to interact with an SPI NOR serial flash memory device.

Overview
********

This sample demonstrates using the :ref:`flash API <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 devicetree node with one of the
following bindings as a compatible:

* :dtcompatible:`jedec,spi-nor`,
* :dtcompatible:`st,stm32-qspi-nor`,
* :dtcompatible:`st,stm32-ospi-nor`,
* :dtcompatible:`nordic,qspi-nor`.

.. 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!