From f0f4f00c2a0427444efe08795b18f4ab7bf855c8 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Wed, 4 Dec 2013 19:48:43 +1000 Subject: [PATCH] Add a doxygen page listing the ioctls and their current support Signed-off-by: Peter Hutterer Reviewed-by: David Herrmann --- libevdev/libevdev.h | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h index 3beca78..9b2de58 100644 --- a/libevdev/libevdev.h +++ b/libevdev/libevdev.h @@ -34,7 +34,7 @@ extern "C" { * @mainpage * * **libevdev** is a library for handling evdev kernel devices. It abstracts - * the ioctls through type-safe interfaces and provides functions to change + * the \ref ioctls through type-safe interfaces and provides functions to change * the appearance of the device. * * Development of libevdev is discussed on @@ -246,6 +246,68 @@ extern "C" { */ /** + * @page ioctls evdev ioctls + * + * This page lists the status of the evdev-specific ioctls in libevdev. + * + *
+ *
EVIOCGVERSION:
+ *
supported, see libevdev_get_driver_version()
+ *
EVIOCGID:
+ *
supported, see libevdev_get_id_product(), libevdev_get_id_vendor(), + * libevdev_get_id_bustype(), * * libevdev_get_id_version()
+ *
EVIOCGREP:
+ *
supported, see libevdev_get_repeat()
+ *
EVIOCSREP:
+ *
supported, see libevdev_enable_event_code()
+ *
EVIOCGKEYCODE:
+ *
currently not supported
+ *
EVIOCGKEYCODE:
+ *
currently not supported
+ *
EVIOCSKEYCODE:
+ *
currently not supported
+ *
EVIOCSKEYCODE:
+ *
currently not supported
+ *
EVIOCGNAME:
+ *
supported, see libevdev_get_name()
+ *
EVIOCGPHYS:
+ *
supported, see libevdev_get_phys()
+ *
EVIOCGUNIQ:
+ *
supported, see libevdev_get_uniq()
+ *
EVIOCGPROP:
+ *
supported, see libevdev_has_property()
+ *
EVIOCGMTSLOTS:
+ *
supported, see libevdev_get_num_slots(), libevdev_get_slot_value()
+ *
EVIOCGKEY:
+ *
supported, see libevdev_has_event_code(), libevdev_get_event_value()
+ *
EVIOCGLED:
+ *
supported, see libevdev_has_event_code(), libevdev_get_event_value()
+ *
EVIOCGSND:
+ *
currently not supported
+ *
EVIOCGSW:
+ *
supported, see libevdev_has_event_code(), libevdev_get_event_value()
+ *
EVIOCGBIT:
+ *
supported, see libevdev_has_event_code(), libevdev_get_event_value()
+ *
EVIOCGABS:
+ *
supported, see libevdev_has_event_code(), libevdev_get_event_value(), + * libevdev_get_abs_info()
+ *
EVIOCSABS:
+ *
supported, see libevdev_kernel_set_abs_info()
+ *
EVIOCSFF:
+ *
currently not supported
+ *
EVIOCRMFF:
+ *
currently not supported
+ *
EVIOCGEFFECTS:
+ *
currently not supported
+ *
EVIOCGRAB:
+ *
supported, see libevdev_grab()
+ *
EVIOCSCLOCKID:
+ *
supported, see libevdev_set_clock_id()
+ *
+ * + */ + +/** * @defgroup init Initialization and setup * * Initialization, initial setup and file descriptor handling. -- 2.7.4