zephyr/samples/drivers/peci
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
README.rst
prj.conf
sample.yaml

README.rst

.. zephyr:code-sample:: peci
   :name: PECI interface
   :relevant-api: peci_interface

   Monitor CPU temperature using PECI.

Overview
********

This sample demonstrates how to use the :ref:`PECI API <peci_api>`.
Callbacks are registered that will write to the console indicating PECI events.
These events indicate PECI host interaction.

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

The sample can be built and executed on boards supporting PECI.
Please connect ensure the microcontroller used is connected to a PECI Host
in order to execute.

Sample output
=============

.. code-block:: console

   PECI test
   Note: You are expected to see several interactions including ID and
   temperature retrieval.