zephyr/samples/drivers/i2c_fujitsu_fram
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
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>
2022-09-05 16:31:47 +02:00
..
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. _i2c_fujitsu_fram:

I2C Fujitsu FRAM
################

Overview
********
This is a sample app to read and write the Fujitsu MB85RC256V FRAM chip via I2C
on the Quark SE Sensor Subsystem.

This assumes the slave address of FRAM is 0x50, where A0, A1, and A2 are all
tied to ground.

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

This project can be built and executed on as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/i2c_fujitsu_fram
   :host-os: unix
   :board: quark_se_c1000_devboard
   :goals: run
   :compact:


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

.. code-block:: console

    Wrote 0xAE to address 0x00.
    Wrote 0x86 to address 0x01.
    Read 0xAE from address 0x00.
    Read 0x86 from address 0x01.
    Wrote 16 bytes to address 0x00.
    Read 16 bytes from address 0x00.
    Data comparison successful.