haptics: Introduces a haptics API

Introduces a haptics API for use with LRA driver ICs to
create haptic feedback events.

Signed-off-by: Ricardo Rivera-Matos <ricardo.rivera-matos@cirrus.com>
This commit is contained in:
Ricardo Rivera-Matos 2023-10-17 14:46:29 -05:00 committed by Carles Cufí
commit 977c70a6c0
8 changed files with 171 additions and 0 deletions

View file

@ -0,0 +1,26 @@
.. _haptics_api:
Haptics
#######
Overview
********
The haptics API allows for the control of haptic driver devices for the
purposes of performing haptic feedback events.
During a haptic feedback event the haptic device drives a signal to an
actuator. The source of the haptic event signal varies depending on the
capabilities of the haptic device.
Some examples of haptic signal sources are analog signals, preprogrammed
(ROM) wavetables, synthesized (RAM) wavetables, and digital audio streams.
Additionally, haptic driver devices often offer controls for adjusting and
tuning the drive signal to meet the electrical requirements of their respective
actuators.
API Reference
*************
.. doxygengroup:: haptics_interface

View file

@ -31,6 +31,7 @@ Peripherals
fuel_gauge.rst
gnss.rst
gpio.rst
haptics.rst
hwinfo.rst
i2c_eeprom_target.rst
i3c.rst