zephyr/samples/drivers/peci
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 drivers: peci: microchip: Enabled low power mode 2023-04-07 13:30:40 +02:00
src samples, tests, boards: Switch main return type from void to int 2023-04-14 07:49:41 +09:00
CMakeLists.txt
prj.conf drivers: peci: microchip: Enabled low power mode 2023-04-07 13:30:40 +02:00
README.rst
sample.yaml yamllint: indentation: fix files in samples/ 2023-01-04 14:23:53 +01:00

.. _peci-sample:

PECI Interface
####################################

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.