zephyr/samples/drivers/ps2
Carles Cufi bf41dd943b doc: reference: Clean up and restructure a bit
Name all subsystem reference consistently with an '_api' postfix and
clean up naming and folder structure in some cases.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-03-18 11:47:24 +01:00
..
src drivers: ps2: mchp_xec: convert to DT_INST defines 2020-03-11 07:59:38 -06:00
CMakeLists.txt
README.rst doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
prj.conf
prj_mec15xxevb_assy6853.conf
sample.yaml

README.rst

.. ps2-sample:

PS/2 Interface
####################################

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.
Please connect a PS/2 mouse in order to exercise the functionality.

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

.. code-block:: console

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