fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2025-12-20 06:50:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document FreeBSD quirks

Browse source 
Document FreeBSD quirks related to syspath.

Signed-off-by: Niclas Zeising <zeising@daemonic.se>
This commit is contained in:
Niclas Zeising 2020-08-12 00:32:42 +02:00
parent 4194023122
commit 1f54f82f70
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
libevdev/libevdev-uinput.h
View file

@ -138,6 +138,9 @@ enum libevdev_uinput_open_mode {
* REP_PERIOD will default to the kernel defaults, not to the ones set in the
* source device.
*
* @note On FreeBSD, if the UI_GET_SYSNAME ioctl() fails, there is no other way
* to get a device, and the function call will fail.
*
* @param dev The device to duplicate
* @param uinput_fd @ref LIBEVDEV_UINPUT_OPEN_MANAGED or a file descriptor to @c /dev/uinput,
* @param[out] uinput_dev The newly created libevdev device.
@ -195,6 +198,9 @@ int libevdev_uinput_get_fd(const struct libevdev_uinput *uinput_dev);
* To avoid false positives, wait at least wait at least 1.5s between
* creating devices that have the same name.
*
* @note FreeBSD does not have sysfs, on FreeBSD this function always returns
* NULL.
*
* @param uinput_dev A previously created uinput device.
* @return The syspath for this device, including the preceding /sys
*
@ -212,6 +218,11 @@ const char* libevdev_uinput_get_syspath(struct libevdev_uinput *uinput_dev);
*
* @note This function may return NULL. libevdev may have to guess the
* syspath and the device node. See libevdev_uinput_get_syspath() for details.
*
* @note On FreeBSD, this function can not return NULL. libudev uses the
* UI_GET_SYSNAME ioctl to get the device node on this platform and if that
* fails, the call to libevdev_uinput_create_from_device() fails.
*
* @param uinput_dev A previously created uinput device.
* @return The device node for this device, in the form of /dev/input/eventN
*