zephyr/samples/drivers/espi
Fabio Baltieri 792469aae9 yamllint: indentation: fix files in samples/
Fix the YAML files indentation for files in samples/.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-01-04 14:23:53 +01:00
..
boards samples: drivers: espi: Re-enable eSPI SAF for MEC152x board 2022-09-29 14:59:32 +00:00
dts/bindings yamllint: indentation: fix files in samples/ 2023-01-04 14:23:53 +01:00
src samples: drivers: espi: Re-enable eSPI SAF for MEC152x board 2022-09-29 14:59:32 +00:00
CMakeLists.txt cmake: increase minimal required version to 3.20.0 2021-08-20 09:47:34 +02:00
Kconfig samples: drivers: espi: Convert espi sample to devicetree 2020-08-18 14:22:10 -04:00
prj.conf samples: drivers: espi: Add simple SAF tests 2021-02-15 08:22:01 -05:00
prj_mec15xxevb_assy6853.conf samples: drivers: espi: Re-enable eSPI SAF for MEC152x board 2022-09-29 14:59:32 +00:00
prj_mec1501modular_assy6885.conf samples: drivers: espi: Showcase OOB Rx asynchronous handling 2021-02-14 18:22:47 -05:00
prj_npcx7m6fb_evb.conf driver: espi: npcx: add the controller attached flash sharing API 2022-09-09 16:30:51 -04:00
prj_npcx9m6f_evb.conf driver: espi: npcx: add the controller attached flash sharing API 2022-09-09 16:30:51 -04:00
README.rst cleanup: rename sanitycheck references to twister 2021-01-14 07:50:52 -06:00
sample.yaml yamllint: indentation: fix files in samples/ 2023-01-04 14:23:53 +01:00

.. _espi-sample:

Enhanced Serial Peripheral Interface
####################################

Overview
********

This sample demonstrates how to use the Enhanced Serial Peripheral Interface
(eSPI) API.
It shows how to configure and select eSPI controller capabilities as part of
a simple eSPI handshake that includes exchanging virtual wire packets.

Standard platform signals are sent virtual wire packets over the bus.
Callbacks are registered that will write to the console indicating main
eSPI events and when a virtual wire is received.

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

The sample can be built and executed on boards supporting eSPI.
Any pins required for minimum eSPI handshake should be configured.
Sample requires a correct harness and fixture setup.
Please connect an eSPI device to the testing board.
After that for the correct execution of that sample in twister, add into
boards's map-file next fixture settings::

      - fixture: espi_device_connect

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

.. code-block:: console

   Hello eSPI test!
   eSPI test - I/O initialization...complete
   eSPI slave configured successfully!
   eSPI test - callbacks initialization... complete
   eSPI test - callbacks registration... complete
   eSPI test - Power initialization...complete
   eSPI test - Handshake
   eSPI BUS reset 0
   VW channel is ready

   PLT_RST changed 1
        1st phase completed
        2nd phase completed
        3rd phase completed

note:: The values shown above might differ.