zephyr

History

Adam Wojasinski 7b78393b07 samples: drivers: spi_flash: Extend requirements description The patch updates README with detailed description of the requirements regarding target devicetree needed to correctly build the sample. Signed-off-by: Adam Wojasinski <adam.wojasinski@nordicsemi.no>		2023-12-08 20:21:07 +00:00
..
boards	samples: drivers: spi_flash: add adp_xc7k_ae350 surport	2023-08-03 10:28:02 +02:00
src	samples: drivers: quadspi flash of the stm32 boards	2023-06-23 10:51:06 +00:00
CMakeLists.txt
prj.conf
README.rst	samples: drivers: spi_flash: Extend requirements description	2023-12-08 20:21:07 +00:00
sample.yaml	samples: drivers: spi_flash: Add nordic,qspi-nor to test filter	2023-12-08 20:21:07 +00: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 :ref:`devicetree <dt-guide>`
``spi-flash0`` alias that refers to an entry 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!