Loading...
Searching...
No Matches
libevdev.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: MIT */
2/*
3 * Copyright © 2013 Red Hat, Inc.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22 * IN THE SOFTWARE.
23 *
24 */
25
26#ifndef LIBEVDEV_H
27#define LIBEVDEV_H
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33#include <linux/input.h>
34#include <stdarg.h>
35
36#define LIBEVDEV_ATTRIBUTE_PRINTF(_format, _args) __attribute__ ((format (printf, _format, _args)))
37
755struct libevdev;
756
767
782struct libevdev* libevdev_new(void);
783
806int libevdev_new_from_fd(int fd, struct libevdev **dev);
807
821void libevdev_free(struct libevdev *dev);
822
831
848typedef void (*libevdev_log_func_t)(enum libevdev_log_priority priority,
849 void *data,
850 const char *file, int line,
851 const char *func,
852 const char *format, va_list args)
854
874
888
901
921typedef void (*libevdev_device_log_func_t)(const struct libevdev *dev,
922 enum libevdev_log_priority priority,
923 void *data,
924 const char *file, int line,
925 const char *func,
926 const char *format, va_list args)
928
950void libevdev_set_device_log_function(struct libevdev *dev,
952 enum libevdev_log_priority priority,
953 void *data);
954
962
985int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab);
986
1019int libevdev_set_fd(struct libevdev* dev, int fd);
1020
1059int libevdev_change_fd(struct libevdev* dev, int fd);
1060
1069int libevdev_get_fd(const struct libevdev* dev);
1070
1092
1143int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev);
1144
1167int libevdev_has_event_pending(struct libevdev *dev);
1168
1183const char* libevdev_get_name(const struct libevdev *dev);
1184
1198void libevdev_set_name(struct libevdev *dev, const char *name);
1199
1215const char * libevdev_get_phys(const struct libevdev *dev);
1216
1230void libevdev_set_phys(struct libevdev *dev, const char *phys);
1231
1245const char * libevdev_get_uniq(const struct libevdev *dev);
1246
1260void libevdev_set_uniq(struct libevdev *dev, const char *uniq);
1261
1271int libevdev_get_id_product(const struct libevdev *dev);
1272
1284void libevdev_set_id_product(struct libevdev *dev, int product_id);
1285
1295int libevdev_get_id_vendor(const struct libevdev *dev);
1296
1308void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id);
1309
1319int libevdev_get_id_bustype(const struct libevdev *dev);
1320
1332void libevdev_set_id_bustype(struct libevdev *dev, int bustype);
1333
1343int libevdev_get_id_version(const struct libevdev *dev);
1344
1356void libevdev_set_id_version(struct libevdev *dev, int version);
1357
1367int libevdev_get_driver_version(const struct libevdev *dev);
1368
1379int libevdev_has_property(const struct libevdev *dev, unsigned int prop);
1380
1392int libevdev_enable_property(struct libevdev *dev, unsigned int prop);
1393
1402int libevdev_disable_property(struct libevdev *dev, unsigned int prop);
1403
1414int libevdev_has_event_type(const struct libevdev *dev, unsigned int type);
1415
1427int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code);
1428
1441int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code);
1442
1455int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code);
1456
1469int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code);
1470
1483int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code);
1484
1497int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code);
1498
1512const struct input_absinfo* libevdev_get_abs_info(const struct libevdev *dev, unsigned int code);
1513
1535int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code);
1536
1571int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value);
1572
1598int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value);
1599
1620int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code);
1621
1650int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value);
1651
1677int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value);
1678
1692int libevdev_get_num_slots(const struct libevdev *dev);
1693
1709int libevdev_get_current_slot(const struct libevdev *dev);
1710
1722void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int val);
1723
1735void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int val);
1736
1748void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int val);
1749
1761void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int val);
1762
1774void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int val);
1775
1787void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
1788
1806int libevdev_enable_event_type(struct libevdev *dev, unsigned int type);
1807
1834int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);
1835
1869int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data);
1870
1898int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code);
1899
1914int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
1915
1923
1937int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value);
1938
1962int libevdev_kernel_set_led_values(struct libevdev *dev, ...);
1963
1978int libevdev_set_clock_id(struct libevdev *dev, int clockid);
1979
2001int libevdev_event_is_type(const struct input_event *ev, unsigned int type);
2002
2026int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code);
2027
2039const char * libevdev_event_type_get_name(unsigned int type);
2052const char * libevdev_event_code_get_name(unsigned int type, unsigned int code);
2053
2074const char * libevdev_event_value_get_name(unsigned int type,
2075 unsigned int code,
2076 int value);
2090const char* libevdev_property_get_name(unsigned int prop);
2091
2104int libevdev_event_type_get_max(unsigned int type);
2105
2120int libevdev_event_type_from_name(const char *name);
2121
2138int libevdev_event_type_from_name_n(const char *name, size_t len);
2139
2159int libevdev_event_code_from_name(unsigned int type, const char *name);
2160
2182int libevdev_event_code_from_name_n(unsigned int type, const char *name,
2183 size_t len);
2184
2206int libevdev_event_value_from_name(unsigned int type, unsigned int code,
2207 const char *name);
2208
2225int
2227
2246int
2247libevdev_event_type_from_code_name_n(const char *name, size_t len);
2248
2265int
2267
2286int
2287libevdev_event_code_from_code_name_n(const char *name, size_t len);
2288
2312int libevdev_event_value_from_name_n(unsigned int type, unsigned int code,
2313 const char *name, size_t len);
2314
2327int libevdev_property_from_name(const char *name);
2328
2343int libevdev_property_from_name_n(const char *name, size_t len);
2344
2362int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period);
2363
2364/********* DEPRECATED SECTION *********/
2365#if defined(__GNUC__) && __GNUC__ >= 4
2366#define LIBEVDEV_DEPRECATED __attribute__ ((deprecated))
2367#else
2368#define LIBEVDEV_DEPRECATED
2369#endif
2370
2371#ifdef __cplusplus
2372}
2373#endif
2374
2375#endif /* LIBEVDEV_H */
int libevdev_get_id_vendor(const struct libevdev *dev)
int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value)
Fetch the current value of the event type.
int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code)
Get the axis fuzz for the given axis, as advertised by the kernel.
int libevdev_get_id_product(const struct libevdev *dev)
int libevdev_get_driver_version(const struct libevdev *dev)
int libevdev_has_property(const struct libevdev *dev, unsigned int prop)
int libevdev_has_event_type(const struct libevdev *dev, unsigned int type)
const char * libevdev_get_phys(const struct libevdev *dev)
Retrieve the device's physical location, either as set by the caller or as read from the kernel.
const char * libevdev_get_uniq(const struct libevdev *dev)
Retrieve the device's unique identifier, either as set by the caller or as read from the kernel.
int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code)
Get the minimum axis value for the given axis, as advertised by the kernel.
int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code)
Behaviour of this function is undefined if the device does not provide the event.
int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code)
Get the axis flat for the given axis, as advertised by the kernel.
int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code)
Get the axis resolution for the given axis, as advertised by the kernel.
int libevdev_get_id_version(const struct libevdev *dev)
const char * libevdev_get_name(const struct libevdev *dev)
Retrieve the device's name, either as set by the caller or as read from the kernel.
int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code)
Get the maximum axis value for the given axis, as advertised by the kernel.
int libevdev_get_id_bustype(const struct libevdev *dev)
int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code)
const struct input_absinfo * libevdev_get_abs_info(const struct libevdev *dev, unsigned int code)
Get the axis info for the given axis, as advertised by the kernel.
int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period)
Get the repeat delay and repeat period values for this device.
libevdev_read_status
Definition libevdev.h:1074
libevdev_read_flag
Definition libevdev.h:760
int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev)
Get the next event from the device.
int libevdev_has_event_pending(struct libevdev *dev)
Check if there are events waiting for us.
@ LIBEVDEV_READ_STATUS_SYNC
Depending on the libevdev_next_event() read flag:
Definition libevdev.h:1090
@ LIBEVDEV_READ_STATUS_SUCCESS
libevdev_next_event() has finished without an error and an event is available for processing.
Definition libevdev.h:1081
@ LIBEVDEV_READ_FLAG_BLOCKING
The fd is not in O_NONBLOCK and a read may block.
Definition libevdev.h:765
@ LIBEVDEV_READ_FLAG_SYNC
Process data in sync mode.
Definition libevdev.h:761
@ LIBEVDEV_READ_FLAG_FORCE_SYNC
Pretend the next event is a SYN_DROPPED and require the caller to sync.
Definition libevdev.h:763
@ LIBEVDEV_READ_FLAG_NORMAL
Process data in normal mode.
Definition libevdev.h:762
int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab)
Grab or ungrab the device through a kernel EVIOCGRAB.
int libevdev_set_fd(struct libevdev *dev, int fd)
Set the fd for this struct and initialize internal data.
int libevdev_new_from_fd(int fd, struct libevdev **dev)
Initialize a new libevdev device from the given fd.
libevdev_grab_mode
Definition libevdev.h:958
struct libevdev * libevdev_new(void)
Initialize a new libevdev device.
int libevdev_get_fd(const struct libevdev *dev)
int libevdev_change_fd(struct libevdev *dev, int fd)
Change the fd for this device, without re-reading the actual device.
void libevdev_free(struct libevdev *dev)
Clean up and free the libevdev struct.
@ LIBEVDEV_UNGRAB
Ungrab the device if currently grabbed.
Definition libevdev.h:960
@ LIBEVDEV_GRAB
Grab the device if not currently grabbed.
Definition libevdev.h:959
int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value)
Set the value for a given code for the given slot.
void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int val)
Change the resolution for the given EV_ABS event code, if the code exists.
void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int val)
Change the maximum for the given EV_ABS event code, if the code exists.
int libevdev_set_clock_id(struct libevdev *dev, int clockid)
Set the clock ID to be used for timestamps.
int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs)
Set the device's EV_ABS axis to the value defined in the abs parameter.
void libevdev_set_uniq(struct libevdev *dev, const char *uniq)
Change the device's unique identifier as returned by libevdev_get_uniq().
int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data)
Forcibly enable an event code on this device, even if the underlying device does not support it.
int libevdev_enable_event_type(struct libevdev *dev, unsigned int type)
Forcibly enable an event type on this device, even if the underlying device does not support it.
int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code)
Forcibly disable an event code on this device, even if the underlying device provides it.
void libevdev_set_id_product(struct libevdev *dev, int product_id)
int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value)
Set the value for a given event type and code.
libevdev_led_value
Definition libevdev.h:1919
void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id)
int libevdev_disable_property(struct libevdev *dev, unsigned int prop)
int libevdev_kernel_set_led_values(struct libevdev *dev,...)
Turn multiple LEDs on or off simultaneously.
void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int val)
Change the fuzz for the given EV_ABS event code, if the code exists.
int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value)
Turn an LED on or off.
int libevdev_disable_event_type(struct libevdev *dev, unsigned int type)
Forcibly disable an event type on this device, even if the underlying device provides it.
void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int val)
Change the flat for the given EV_ABS event code, if the code exists.
void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int val)
Change the minimum for the given EV_ABS event code, if the code exists.
void libevdev_set_phys(struct libevdev *dev, const char *phys)
Change the device's physical location as returned by libevdev_get_phys().
void libevdev_set_name(struct libevdev *dev, const char *name)
Change the device's name as returned by libevdev_get_name().
void libevdev_set_id_version(struct libevdev *dev, int version)
void libevdev_set_id_bustype(struct libevdev *dev, int bustype)
int libevdev_enable_property(struct libevdev *dev, unsigned int prop)
void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs)
Change the abs info for the given EV_ABS event code, if the code exists.
@ LIBEVDEV_LED_OFF
Turn the LED off.
Definition libevdev.h:1921
@ LIBEVDEV_LED_ON
Turn the LED on.
Definition libevdev.h:1920
libevdev_log_priority
Definition libevdev.h:826
enum libevdev_log_priority libevdev_get_log_priority(void)
Return the current log priority level.
void libevdev_set_device_log_function(struct libevdev *dev, libevdev_device_log_func_t logfunc, enum libevdev_log_priority priority, void *data)
Set a printf-style logging handler for library-internal logging for this device context.
void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data)
Set a printf-style logging handler for library-internal logging.
void(* libevdev_device_log_func_t)(const struct libevdev *dev, enum libevdev_log_priority priority, void *data, const char *file, int line, const char *func, const char *format, va_list args)
Logging function called by library-internal logging for a specific libevdev context.
Definition libevdev.h:921
void(* libevdev_log_func_t)(enum libevdev_log_priority priority, void *data, const char *file, int line, const char *func, const char *format, va_list args)
Logging function called by library-internal logging.
Definition libevdev.h:848
void libevdev_set_log_priority(enum libevdev_log_priority priority)
Define the minimum level to be printed to the log handler.
@ LIBEVDEV_LOG_ERROR
critical errors and application bugs
Definition libevdev.h:827
@ LIBEVDEV_LOG_INFO
informational messages
Definition libevdev.h:828
@ LIBEVDEV_LOG_DEBUG
debug information
Definition libevdev.h:829
const char * libevdev_event_value_get_name(unsigned int type, unsigned int code, int value)
This function resolves the event value for a code.
int libevdev_event_code_from_name_n(unsigned int type, const char *name, size_t len)
Look up an event code by its type and name.
int libevdev_event_value_from_name(unsigned int type, unsigned int code, const char *name)
Look up an event value by its type, code and name.
int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code)
Helper function to check if an event is of a specific type and code.
const char * libevdev_event_type_get_name(unsigned int type)
int libevdev_event_type_from_name_n(const char *name, size_t len)
Look up an event-type by its name.
const char * libevdev_event_code_get_name(unsigned int type, unsigned int code)
int libevdev_event_code_from_code_name_n(const char *name, size_t len)
Look up an event code by its name.
int libevdev_event_type_from_name(const char *name)
Look up an event-type by its name.
int libevdev_event_code_from_name(unsigned int type, const char *name)
Look up an event code by its type and name.
int libevdev_property_from_name(const char *name)
Look up an input property by its name.
const char * libevdev_property_get_name(unsigned int prop)
int libevdev_property_from_name_n(const char *name, size_t len)
Look up an input property by its name.
int libevdev_event_type_from_code_name_n(const char *name, size_t len)
Look up an event type for a event code name.
int libevdev_event_is_type(const struct input_event *ev, unsigned int type)
Helper function to check if an event is of a specific type.
int libevdev_event_code_from_code_name(const char *name)
Look up an event code by its name.
int libevdev_event_type_get_max(unsigned int type)
int libevdev_event_type_from_code_name(const char *name)
Look up an event type for a event code name.
int libevdev_event_value_from_name_n(unsigned int type, unsigned int code, const char *name, size_t len)
Look up an event value by its type, code and name.
int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code)
Return the current value of the code for the given slot.
int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value)
Fetch the current value of the code for the given slot.
int libevdev_get_current_slot(const struct libevdev *dev)
Get the currently active slot.
int libevdev_get_num_slots(const struct libevdev *dev)
Get the number of slots supported by this device.
#define LIBEVDEV_ATTRIBUTE_PRINTF(_format, _args)
Definition libevdev.h:36