All Files Functions Typedefs Enumerations Enumerator Macros Groups Pages
libevdev.h
Go to the documentation of this file.
/*
* Copyright © 2013 Red Hat, Inc.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that copyright
* notice and this permission notice appear in supporting documentation, and
* that the name of the copyright holders not be used in advertising or
* publicity pertaining to distribution of the software without specific,
* written prior permission. The copyright holders make no representations
* about the suitability of this software for any purpose. It is provided "as
* is" without express or implied warranty.
*
* THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
* EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE.
*/
#ifndef LIBEVDEV_H
#define LIBEVDEV_H
#ifdef __cplusplus
extern "C" {
#endif
#include <linux/input.h>
#include <stdarg.h>
struct libevdev;
enum libevdev_read_flag {
LIBEVDEV_READ_FLAG_SYNC = 1,
LIBEVDEV_READ_FLAG_NORMAL = 2,
LIBEVDEV_READ_FLAG_FORCE_SYNC = 4,
LIBEVDEV_READ_FLAG_BLOCKING = 8
};
struct libevdev* libevdev_new(void);
int libevdev_new_from_fd(int fd, struct libevdev **dev);
void libevdev_free(struct libevdev *dev);
enum libevdev_log_priority {
LIBEVDEV_LOG_ERROR = 10,
LIBEVDEV_LOG_INFO = 20,
LIBEVDEV_LOG_DEBUG = 30
};
typedef 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);
void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data);
void libevdev_set_log_priority(enum libevdev_log_priority priority);
enum libevdev_log_priority libevdev_get_log_priority(void);
enum libevdev_grab_mode {
LIBEVDEV_GRAB = 3,
LIBEVDEV_UNGRAB = 4
};
int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab);
int libevdev_set_fd(struct libevdev* dev, int fd);
int libevdev_change_fd(struct libevdev* dev, int fd);
int libevdev_get_fd(const struct libevdev* dev);
enum libevdev_read_status {
LIBEVDEV_READ_STATUS_SUCCESS = 0,
LIBEVDEV_READ_STATUS_SYNC = 1
};
int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev);
int libevdev_has_event_pending(struct libevdev *dev);
const char* libevdev_get_name(const struct libevdev *dev);
void libevdev_set_name(struct libevdev *dev, const char *name);
const char * libevdev_get_phys(const struct libevdev *dev);
void libevdev_set_phys(struct libevdev *dev, const char *phys);
const char * libevdev_get_uniq(const struct libevdev *dev);
void libevdev_set_uniq(struct libevdev *dev, const char *uniq);
int libevdev_get_id_product(const struct libevdev *dev);
void libevdev_set_id_product(struct libevdev *dev, int product_id);
int libevdev_get_id_vendor(const struct libevdev *dev);
void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id);
int libevdev_get_id_bustype(const struct libevdev *dev);
void libevdev_set_id_bustype(struct libevdev *dev, int bustype);
int libevdev_get_id_version(const struct libevdev *dev);
void libevdev_set_id_version(struct libevdev *dev, int version);
int libevdev_get_driver_version(const struct libevdev *dev);
int libevdev_has_property(const struct libevdev *dev, unsigned int prop);
int libevdev_enable_property(struct libevdev *dev, unsigned int prop);
int libevdev_has_event_type(const struct libevdev *dev, unsigned int type);
int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code);
int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code);
const struct input_absinfo* libevdev_get_abs_info(const struct libevdev *dev, unsigned int code);
int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code);
int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value);
int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value);
int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code);
int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value);
int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value);
int libevdev_get_num_slots(const struct libevdev *dev);
int libevdev_get_current_slot(const struct libevdev *dev);
void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int min);
void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int max);
void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int fuzz);
void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int flat);
void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int resolution);
void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
int libevdev_enable_event_type(struct libevdev *dev, unsigned int type);
int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);
int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data);
int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code);
int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
enum libevdev_led_value {
LIBEVDEV_LED_ON = 3,
LIBEVDEV_LED_OFF = 4
};
int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value);
int libevdev_kernel_set_led_values(struct libevdev *dev, ...);
int libevdev_set_clock_id(struct libevdev *dev, int clockid);
int libevdev_event_is_type(const struct input_event *ev, unsigned int type);
int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code);
const char * libevdev_event_type_get_name(unsigned int type);
const char * libevdev_event_code_get_name(unsigned int type, unsigned int code);
const char* libevdev_property_get_name(unsigned int prop);
int libevdev_event_type_get_max(unsigned int type);
int libevdev_event_type_from_name(const char *name);
int libevdev_event_type_from_name_n(const char *name, size_t len);
int libevdev_event_code_from_name(unsigned int type, const char *name);
int libevdev_event_code_from_name_n(unsigned int type, const char *name,
size_t len);
int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period);
/********* DEPRECATED SECTION *********/
#if defined(__GNUC__) && __GNUC__ >= 4
#define LIBEVDEV_DEPRECATED __attribute__ ((deprecated))
#else
#define LIBEVDEV_DEPRECATED
#endif
#ifdef __cplusplus
}
#endif
#endif /* LIBEVDEV_H */
libevdev_read_status
libevdev_read_status
Definition: libevdev.h:830
libevdev_get_abs_resolution
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.
libevdev_has_event_pending
int libevdev_has_event_pending(struct libevdev *dev)
Check if there are events waiting for us.
libevdev_log_priority
libevdev_log_priority
Definition: libevdev.h:662
libevdev_event_type_from_name_n
int libevdev_event_type_from_name_n(const char *name, size_t len)
Look up an event-type by its name.
libevdev_get_log_priority
enum libevdev_log_priority libevdev_get_log_priority(void)
Return the current log priority level.
libevdev_has_property
int libevdev_has_property(const struct libevdev *dev, unsigned int prop)
libevdev_change_fd
int libevdev_change_fd(struct libevdev *dev, int fd)
Change the fd for this device, without re-reading the actual device.
libevdev_enable_property
int libevdev_enable_property(struct libevdev *dev, unsigned int prop)
libevdev_event_type_get_name
const char * libevdev_event_type_get_name(unsigned int type)
libevdev_has_event_code
int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code)
libevdev_get_abs_info
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.
libevdev_set_abs_fuzz
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.
LIBEVDEV_READ_FLAG_SYNC
Process data in sync mode.
Definition: libevdev.h:600
libevdev_get_fd
int libevdev_get_fd(const struct libevdev *dev)
libevdev_led_value
libevdev_led_value
Definition: libevdev.h:1650
libevdev_set_uniq
void libevdev_set_uniq(struct libevdev *dev, const char *uniq)
Change the device's unique identifier as returned by libevdev_get_uniq().
LIBEVDEV_LOG_DEBUG
debug information
Definition: libevdev.h:665
libevdev_event_code_get_name
const char * libevdev_event_code_get_name(unsigned int type, unsigned int code)
libevdev_get_repeat
int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period)
Get the repeat delay and repeat period values for this device.
libevdev_set_log_function
void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data)
Set a printf-style logging handler for library-internal logging.
LIBEVDEV_READ_FLAG_BLOCKING
The fd is not in O_NONBLOCK and a read may block.
Definition: libevdev.h:604
libevdev_has_event_type
int libevdev_has_event_type(const struct libevdev *dev, unsigned int type)
libevdev_event_code_from_name
int libevdev_event_code_from_name(unsigned int type, const char *name)
Look up an event code by its type and name.
LIBEVDEV_LED_OFF
Turn the LED off.
Definition: libevdev.h:1652
libevdev_set_abs_maximum
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.
LIBEVDEV_READ_FLAG_FORCE_SYNC
Pretend the next event is a SYN_DROPPED and require the caller to sync.
Definition: libevdev.h:602
libevdev_get_abs_fuzz
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.
libevdev_set_slot_value
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.
libevdev_event_code_from_name_n
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.
libevdev_set_id_vendor
void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id)
libevdev_set_log_priority
void libevdev_set_log_priority(enum libevdev_log_priority priority)
Define the minimum level to be printed to the log handler.
libevdev_set_abs_resolution
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.
libevdev_get_abs_minimum
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.
libevdev_grab
int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab)
Grab or ungrab the device through a kernel EVIOCGRAB.
LIBEVDEV_LED_ON
Turn the LED on.
Definition: libevdev.h:1651
libevdev_get_id_bustype
int libevdev_get_id_bustype(const struct libevdev *dev)
libevdev_event_type_get_max
int libevdev_event_type_get_max(unsigned int type)
libevdev_event_type_from_name
int libevdev_event_type_from_name(const char *name)
Look up an event-type by its name.
libevdev_disable_event_code
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...
libevdev_get_slot_value
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.
libevdev_get_event_value
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. ...
libevdev_get_name
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.
libevdev_get_driver_version
int libevdev_get_driver_version(const struct libevdev *dev)
libevdev_get_id_version
int libevdev_get_id_version(const struct libevdev *dev)
libevdev_get_abs_flat
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.
libevdev_next_event
int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev)
Get the next event from the device.
libevdev_get_uniq
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...
LIBEVDEV_READ_STATUS_SYNC
Depending on the libevdev_next_event() read flag:
Definition: libevdev.h:846
libevdev_new_from_fd
int libevdev_new_from_fd(int fd, struct libevdev **dev)
Initialize a new libevdev device from the given fd.
libevdev_log_func_t
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:684
libevdev_fetch_event_value
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.
libevdev_set_event_value
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_kernel_set_abs_info
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.
libevdev_fetch_slot_value
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.
libevdev_get_abs_maximum
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.
libevdev_set_id_bustype
void libevdev_set_id_bustype(struct libevdev *dev, int bustype)
libevdev_get_current_slot
int libevdev_get_current_slot(const struct libevdev *dev)
Get the currently active slot.
libevdev_event_is_code
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.
libevdev_event_is_type
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.
libevdev_set_id_version
void libevdev_set_id_version(struct libevdev *dev, int version)
libevdev_property_get_name
const char * libevdev_property_get_name(unsigned int prop)
libevdev_get_id_product
int libevdev_get_id_product(const struct libevdev *dev)
libevdev_get_phys
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...
libevdev_enable_event_type
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...
libevdev_kernel_set_led_value
int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value)
Turn an LED on or off.
libevdev_set_clock_id
int libevdev_set_clock_id(struct libevdev *dev, int clockid)
Set the clock ID to be used for timestamps.
libevdev_get_num_slots
int libevdev_get_num_slots(const struct libevdev *dev)
Get the number of slots supported by this device.
LIBEVDEV_READ_STATUS_SUCCESS
libevdev_next_event() has finished without an error and an event is available for processing...
Definition: libevdev.h:837
libevdev_enable_event_code
int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data)
Forcibly enable an event type on this device, even if the underlying device does not support it...
libevdev_read_flag
libevdev_read_flag
Definition: libevdev.h:599
libevdev_set_fd
int libevdev_set_fd(struct libevdev *dev, int fd)
Set the fd for this struct and initialize internal data.
libevdev_kernel_set_led_values
int libevdev_kernel_set_led_values(struct libevdev *dev,...)
Turn multiple LEDs on or off simultaneously.
libevdev_set_abs_flat
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.
libevdev_set_phys
void libevdev_set_phys(struct libevdev *dev, const char *phys)
Change the device's physical location as returned by libevdev_get_phys().
libevdev_disable_event_type
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...
LIBEVDEV_LOG_ERROR
critical errors and application bugs
Definition: libevdev.h:663
libevdev_set_abs_info
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_GRAB
Grab the device if not currently grabbed.
Definition: libevdev.h:730
libevdev_set_name
void libevdev_set_name(struct libevdev *dev, const char *name)
Change the device's name as returned by libevdev_get_name().
libevdev_free
void libevdev_free(struct libevdev *dev)
Clean up and free the libevdev struct.
libevdev_set_abs_minimum
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.
LIBEVDEV_LOG_INFO
informational messages
Definition: libevdev.h:664
libevdev_get_id_vendor
int libevdev_get_id_vendor(const struct libevdev *dev)
LIBEVDEV_READ_FLAG_NORMAL
Process data in normal mode.
Definition: libevdev.h:601
libevdev_grab_mode
libevdev_grab_mode
Definition: libevdev.h:729
libevdev_set_id_product
void libevdev_set_id_product(struct libevdev *dev, int product_id)
libevdev_new
struct libevdev * libevdev_new(void)
Initialize a new libevdev device.
LIBEVDEV_UNGRAB
Ungrab the device if currently grabbed.
Definition: libevdev.h:731