79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| src | ||
| CMakeLists.txt | ||
| Kconfig | ||
| prj.conf | ||
| README.rst | ||
| sample.yaml | ||
.. _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 page_count
Flash device contains 1024 pages.
uart:~$ flash page_erase 1023
Erasing page 1023 (start offset 0xffc00, size 0x400)
uart:~$ flash page_write 1023 8 17 19 28 39
Reading back written bytes:
11 13 1c 27
uart:~$ flash page_write 1023 4 77 9 1 2
Reading back written bytes:
4d 09 01 02
uart:~$ flash page_read 1023 4 12
4d 09 01 02 | 11 13 1c 27
ff ff ff ff
uart:~$ flash page_read 1023 0 16
ff ff ff ff | 4d 09 01 02
11 13 1c 27 | ff ff ff ff