libevdev  1.4
A wrapper library for evdev devices
libevdev.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Red Hat, Inc.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and its
5  * documentation for any purpose is hereby granted without fee, provided that
6  * the above copyright notice appear in all copies and that both that copyright
7  * notice and this permission notice appear in supporting documentation, and
8  * that the name of the copyright holders not be used in advertising or
9  * publicity pertaining to distribution of the software without specific,
10  * written prior permission. The copyright holders make no representations
11  * about the suitability of this software for any purpose. It is provided "as
12  * is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20  * OF THIS SOFTWARE.
21  */
22 
23 #ifndef LIBEVDEV_H
24 #define LIBEVDEV_H
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 #include <linux/input.h>
31 #include <stdarg.h>
32 
33 #define LIBEVDEV_ATTRIBUTE_PRINTF(_format, _args) __attribute__ ((format (printf, _format, _args)))
34 
738 struct libevdev;
739 
749 };
750 
765 struct libevdev* libevdev_new(void);
766 
789 int libevdev_new_from_fd(int fd, struct libevdev **dev);
790 
801 void libevdev_free(struct libevdev *dev);
802 
810 };
811 
828 typedef void (*libevdev_log_func_t)(enum libevdev_log_priority priority,
829  void *data,
830  const char *file, int line,
831  const char *func,
832  const char *format, va_list args)
834 
853 void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data);
854 
868 
881 
901 typedef void (*libevdev_device_log_func_t)(const struct libevdev *dev,
902  enum libevdev_log_priority priority,
903  void *data,
904  const char *file, int line,
905  const char *func,
906  const char *format, va_list args)
908 
930 void libevdev_set_device_log_function(struct libevdev *dev,
932  enum libevdev_log_priority priority,
933  void *data);
934 
941 };
942 
961 int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab);
962 
986 int libevdev_set_fd(struct libevdev* dev, int fd);
987 
1023 int libevdev_change_fd(struct libevdev* dev, int fd);
1024 
1033 int libevdev_get_fd(const struct libevdev* dev);
1034 
1035 
1056 };
1057 
1108 int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev);
1109 
1132 int libevdev_has_event_pending(struct libevdev *dev);
1133 
1148 const char* libevdev_get_name(const struct libevdev *dev);
1149 
1163 void libevdev_set_name(struct libevdev *dev, const char *name);
1164 
1180 const char * libevdev_get_phys(const struct libevdev *dev);
1181 
1195 void libevdev_set_phys(struct libevdev *dev, const char *phys);
1196 
1210 const char * libevdev_get_uniq(const struct libevdev *dev);
1211 
1225 void libevdev_set_uniq(struct libevdev *dev, const char *uniq);
1226 
1236 int libevdev_get_id_product(const struct libevdev *dev);
1237 
1247 void libevdev_set_id_product(struct libevdev *dev, int product_id);
1248 
1258 int libevdev_get_id_vendor(const struct libevdev *dev);
1259 
1269 void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id);
1270 
1280 int libevdev_get_id_bustype(const struct libevdev *dev);
1281 
1291 void libevdev_set_id_bustype(struct libevdev *dev, int bustype);
1292 
1302 int libevdev_get_id_version(const struct libevdev *dev);
1303 
1313 void libevdev_set_id_version(struct libevdev *dev, int version);
1314 
1324 int libevdev_get_driver_version(const struct libevdev *dev);
1325 
1336 int libevdev_has_property(const struct libevdev *dev, unsigned int prop);
1337 
1349 int libevdev_enable_property(struct libevdev *dev, unsigned int prop);
1350 
1361 int libevdev_has_event_type(const struct libevdev *dev, unsigned int type);
1362 
1374 int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code);
1375 
1388 int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code);
1389 
1402 int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code);
1403 
1416 int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code);
1417 
1430 int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code);
1431 
1444 int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code);
1445 
1459 const struct input_absinfo* libevdev_get_abs_info(const struct libevdev *dev, unsigned int code);
1460 
1483 int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code);
1484 
1516 int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value);
1517 
1543 int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value);
1544 
1565 int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code);
1566 
1593 int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value);
1594 
1620 int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value);
1621 
1635 int libevdev_get_num_slots(const struct libevdev *dev);
1636 
1652 int libevdev_get_current_slot(const struct libevdev *dev);
1653 
1665 void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int min);
1666 
1678 void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int max);
1679 
1691 void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int fuzz);
1692 
1704 void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int flat);
1705 
1717 void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int resolution);
1718 
1730 void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
1731 
1749 int libevdev_enable_event_type(struct libevdev *dev, unsigned int type);
1750 
1777 int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);
1778 
1812 int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data);
1813 
1841 int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code);
1842 
1857 int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
1858 
1859 
1866 };
1867 
1881 int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value);
1882 
1906 int libevdev_kernel_set_led_values(struct libevdev *dev, ...);
1907 
1922 int libevdev_set_clock_id(struct libevdev *dev, int clockid);
1923 
1945 int libevdev_event_is_type(const struct input_event *ev, unsigned int type);
1946 
1970 int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code);
1971 
1983 const char * libevdev_event_type_get_name(unsigned int type);
1996 const char * libevdev_event_code_get_name(unsigned int type, unsigned int code);
1997 
2011 const char* libevdev_property_get_name(unsigned int prop);
2012 
2025 int libevdev_event_type_get_max(unsigned int type);
2026 
2041 int libevdev_event_type_from_name(const char *name);
2042 
2059 int libevdev_event_type_from_name_n(const char *name, size_t len);
2060 
2080 int libevdev_event_code_from_name(unsigned int type, const char *name);
2081 
2103 int libevdev_event_code_from_name_n(unsigned int type, const char *name,
2104  size_t len);
2105 
2118 int libevdev_property_from_name(const char *name);
2119 
2134 int libevdev_property_from_name_n(const char *name, size_t len);
2135 
2153 int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period);
2154 
2155 
2156 /********* DEPRECATED SECTION *********/
2157 #if defined(__GNUC__) && __GNUC__ >= 4
2158 #define LIBEVDEV_DEPRECATED __attribute__ ((deprecated))
2159 #else
2160 #define LIBEVDEV_DEPRECATED
2161 #endif
2162 
2163 #ifdef __cplusplus
2164 }
2165 #endif
2166 
2167 #endif /* LIBEVDEV_H */
libevdev_read_status
Definition: libevdev.h:1039
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_has_event_pending(struct libevdev *dev)
Check if there are events waiting for us.
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:901
int libevdev_event_type_from_name_n(const char *name, size_t len)
Look up an event-type by its name.
int libevdev_has_property(const struct libevdev *dev, unsigned int prop)
int libevdev_change_fd(struct libevdev *dev, int fd)
Change the fd for this device, without re-reading the actual device.
informational messages
Definition: libevdev.h:808
int libevdev_enable_property(struct libevdev *dev, unsigned int prop)
const char * libevdev_event_type_get_name(unsigned int type)
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.
critical errors and application bugs
Definition: libevdev.h:807
void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int fuzz)
Change the fuzz for the given EV_ABS event code, if the code exists.
Process data in sync mode.
Definition: libevdev.h:744
int libevdev_get_fd(const struct libevdev *dev)
libevdev_led_value
Definition: libevdev.h:1863
void libevdev_set_uniq(struct libevdev *dev, const char *uniq)
Change the device's unique identifier as returned by libevdev_get_uniq().
debug information
Definition: libevdev.h:809
const char * libevdev_event_code_get_name(unsigned int type, unsigned int code)
int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period)
Get the repeat delay and repeat period values for this device.
The fd is not in O_NONBLOCK and a read may block.
Definition: libevdev.h:748
enum libevdev_log_priority libevdev_get_log_priority(void)
Return the current log priority level.
void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data)
Set a printf-style logging handler for library-internal logging.
int libevdev_has_event_type(const struct libevdev *dev, unsigned int type)
int libevdev_event_code_from_name(unsigned int type, const char *name)
Look up an event code by its type and name.
Turn the LED off.
Definition: libevdev.h:1865
void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int max)
Change the maximum for the given EV_ABS event code, if the code exists.
Pretend the next event is a SYN_DROPPED and require the caller to sync.
Definition: libevdev.h:746
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_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.
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.
void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id)
void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int resolution)
Change the resolution for the given EV_ABS event code, if the code exists.
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_grab(struct libevdev *dev, enum libevdev_grab_mode grab)
Grab or ungrab the device through a kernel EVIOCGRAB.
Turn the LED on.
Definition: libevdev.h:1864
int libevdev_get_id_bustype(const struct libevdev *dev)
int libevdev_event_type_get_max(unsigned int type)
int libevdev_event_type_from_name(const char *name)
Look up an event-type by its name.
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...
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_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. ...
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_driver_version(const struct libevdev *dev)
int libevdev_get_id_version(const struct libevdev *dev)
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_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev)
Get the next event from the device.
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...
Depending on the libevdev_next_event() read flag:
Definition: libevdev.h:1055
int libevdev_property_from_name_n(const char *name, size_t len)
Look up an input property by its name.
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:828
int libevdev_new_from_fd(int fd, struct libevdev **dev)
Initialize a new libevdev device from the given fd.
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_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value)
Set the value for a given event type and code.
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.
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_abs_maximum(const struct libevdev *dev, unsigned int code)
Get the maximum axis value for the given axis, as advertised by the kernel.
void libevdev_set_id_bustype(struct libevdev *dev, int bustype)
int libevdev_get_current_slot(const struct libevdev *dev)
Get the currently active slot.
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.
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.
void libevdev_set_id_version(struct libevdev *dev, int version)
const char * libevdev_property_get_name(unsigned int prop)
#define LIBEVDEV_ATTRIBUTE_PRINTF(_format, _args)
Definition: libevdev.h:33
int libevdev_get_id_product(const struct libevdev *dev)
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...
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.
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_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value)
Turn an LED on or off.
int libevdev_set_clock_id(struct libevdev *dev, int clockid)
Set the clock ID to be used for timestamps.
int libevdev_get_num_slots(const struct libevdev *dev)
Get the number of slots supported by this device.
int libevdev_property_from_name(const char *name)
Look up an input property by its name.
void libevdev_set_log_priority(enum libevdev_log_priority priority)
Define the minimum level to be printed to the log handler.
libevdev_next_event() has finished without an error and an event is available for processing...
Definition: libevdev.h:1046
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...
libevdev_read_flag
Definition: libevdev.h:743
int libevdev_set_fd(struct libevdev *dev, int fd)
Set the fd for this struct and initialize internal data.
int libevdev_kernel_set_led_values(struct libevdev *dev,...)
Turn multiple LEDs on or off simultaneously.
void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int flat)
Change the flat 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().
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_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.
Grab the device if not currently grabbed.
Definition: libevdev.h:939
void libevdev_set_name(struct libevdev *dev, const char *name)
Change the device's name as returned by libevdev_get_name().
void libevdev_free(struct libevdev *dev)
Clean up and free the libevdev struct.
void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int min)
Change the minimum for the given EV_ABS event code, if the code exists.
int libevdev_get_id_vendor(const struct libevdev *dev)
Process data in normal mode.
Definition: libevdev.h:745
libevdev_grab_mode
Definition: libevdev.h:938
libevdev_log_priority
Definition: libevdev.h:806
void libevdev_set_id_product(struct libevdev *dev, int product_id)
struct libevdev * libevdev_new(void)
Initialize a new libevdev device.
Ungrab the device if currently grabbed.
Definition: libevdev.h:940