zephyr

History

Benjamin Cabé f6a4217a88 doc: driver: samples: Update driver samples to use new Sphinx extension Migrated existing driver samples to use the new code-sample directive and role. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2023-09-22 09:21:43 +02:00
..
boards
src
CMakeLists.txt
Kconfig
prj.conf
README.rst	doc: driver: samples: Update driver samples to use new Sphinx extension	2023-09-22 09:21:43 +02:00
sample.yaml

README.rst

.. zephyr:code-sample:: flash-shell
   :name: Flash shell
   :relevant-api: flash_interface

   Explore a flash device using shell commands.

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_sample page_count
    Flash device contains 1024 pages.
    uart:~$ flash_sample page_erase 1023
    Erasing page 1023 (start offset 0xffc00, size 0x400)
    uart:~$ flash_sample page_write 1023 8 17 19 28 39
    Reading back written bytes:
    11 13 1c 27
    uart:~$ flash_sample page_write 1023 4 77 9 1 2
    Reading back written bytes:
    4d 09 01 02
    uart:~$ flash_sample page_read 1023 4 12
    4d 09 01 02 | 11 13 1c 27
    ff ff ff ff
    uart:~$ flash_sample page_read 1023 0 16
    ff ff ff ff | 4d 09 01 02
    11 13 1c 27 | ff ff ff ff