zephyr

History

Benjamin Cabé df294e34e1 doc: sphinx-lint: fix bad usage of "default role" Fixes bad usage of single backticks in lieu of double backticks for rendering inline literals, or simple '*' for italics. When appropriate, a better construct than double backticks has been selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref: have been used if the original intention was to have a link. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2024-09-13 11:42:51 -05:00
..
boards	…
src	…
CMakeLists.txt	…
README.rst	doc: sphinx-lint: fix bad usage of "default role"	2024-09-13 11:42:51 -05:00
prj.conf	…
sample.yaml	…

README.rst

.. zephyr:code-sample:: mspi-async
   :name: MSPI asynchronous transfer
   :relevant-api: mspi_interface

   Use the MSPI API to interact with MSPI memory device asynchronously.

Overview
********

This sample demonstrates using the :ref:`MSPI API <mspi_api>` on a MSPI
memory device.  The asynchronous transceive call need to be supported
either by a software queue or hardware queue from the controller hardware.
To this sample, however, the implementation should make no difference.

Building and Running
********************

The application will build only for a target that has a :ref:`devicetree <dt-guide>`
``dev0`` alias that refers to an entry with the following bindings as a compatible:

* :dtcompatible:`ambiq,mspi-device`, :dtcompatible:`mspi-aps6404l`

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/mspi/mspi_async
   :board: apollo3p_evb
   :goals: build flash
   :compact:

Sample Output
=============

.. code-block:: console

   *** Booting Zephyr OS build zephyr-v3.5.0-8581-gc80b243c7598 ***
   w:3,r:3
   Read data matches written data