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> |
||
|---|---|---|
| .. | ||
| boards | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| overlay-shell.conf | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _samples_eeprom:
EEPROM Sample
#############
Overview
********
This sample demonstrates the EEPROM driver API in a simple boot counter
application.
Building and Running
********************
In case the target board has defined an EEPROM with alias ``eeprom-0`` the
sample can be built without further ado. This applies for example to the
:ref:`native_posix` board:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/eeprom
:host-os: unix
:board: native_posix
:goals: run
:compact:
Otherwise either a board specific overlay needs to be defined, or a shield must
be activated. Any board with Arduino headers can for example build the sample
as follows:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/eeprom
:board: nrf52840dk_nrf52840
:goals: build
:shield: x_nucleo_eeprma2
:compact:
For :ref:`gd32f450i_eval` board. First bridge the JP5 to USART with the jumper cap,
Then the sample can be built and executed for the as follows:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/eeprom
:board: gd32f450i_eval
:goals: build flash
:compact:
Sample Output
=============
.. code-block:: console
Found EEPROM device "EEPROM_M24C02"
Using eeprom with size of: 256.
Device booted 7 times.
Reset the MCU to see the increasing boot counter.