zephyr/samples/drivers/ps2
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 sample: driver: ps2: use aliases to select the ps2 instance 2023-08-31 10:19:52 +02:00
src sample: driver: ps2: use aliases to select the ps2 instance 2023-08-31 10:19:52 +02:00
CMakeLists.txt
prj.conf drivers: ps2: microchip: Low power and wakeup enabled 2023-06-17 07:59:07 -04:00
README.rst doc: driver: samples: Update driver samples to use new Sphinx extension 2023-09-22 09:21:43 +02:00
sample.yaml tests: cleanup metadata and filtering 2023-06-13 09:38:27 -04:00

.. zephyr:code-sample:: ps2
   :name: PS/2 interface
   :relevant-api: ps2_interface

   Communicate with a PS/2 mouse.

Overview
********

This sample demonstrates how to use the :ref:`PS/2 API <ps2_api>`.
Callbacks are registered that will write to the console indicating PS2 events.
These events indicate mouse configuration responses and mouse interaction.

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

The sample can be built and executed on boards supporting PS/2.
It requires a correct fixture setup. Please connect a PS/2 mouse in order to
exercise the functionality.
For the correct execution of that sample in twister, add into boards's
map-file next fixture settings::

      - fixture: fixture_connect_mouse

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

.. code-block:: console

   PS/2 test with mouse
   Note: You are expected to see several interrupts
   as you configure/move the mouse!