zephyr/samples/drivers/flash_shell
Keith Packard 0b90fd5adf samples, tests, boards: Switch main return type from void to int
As both C and C++ standards require applications running under an OS to
return 'int', adapt that for Zephyr to align with those standard. This also
eliminates errors when building with clang when not using -ffreestanding,
and reduces the need for compiler flags to silence warnings for both clang
and gcc.

Most of these changes were automated using coccinelle with the following
script:

@@
@@
- void
+ int
main(...) {
	...
-	return;
+	return 0;
	...
}

Approximately 40 files had to be edited by hand as coccinelle was unable to
fix them.

Signed-off-by: Keith Packard <keithp@keithp.com>
2023-04-14 07:49:41 +09:00
..
boards samples: flash_shell: add support for gd32 boards 2022-09-08 10:13:05 +02:00
src samples, tests, boards: Switch main return type from void to int 2023-04-14 07:49:41 +09:00
CMakeLists.txt cmake: increase minimal required version to 3.20.0 2021-08-20 09:47:34 +02:00
Kconfig
prj.conf samples: drivers: flash_shell: do not enable CONFIG_SERIAL 2020-12-02 23:20:32 -05:00
README.rst samples: drivers: flash_shell: disambiguate flash shell app 2022-11-19 14:24:38 -05:00
sample.yaml boards: arm: add Arduino GIGA 2023-03-06 12:33:57 +01:00

.. _samples_flash_shell:

Flash Shell Sample
##################

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