2 * kmscon - udev input hotplug and evdev handling
4 * Copyright (c) 2011 Ran Benita <ran234@gmail.com>
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files
8 * (the "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 * This module provides an input object which can deliver all useful input
28 * events to the program.
30 * Its use should be as simple as the following (but also see below):
31 * - Create a new input object.
32 * - Provide a callback function to receive the events.
33 * - Connect the input object to a kmscon_eloop.
34 * - Wake up the input object to begin receiving input events through the
37 * A few things to note:
38 * - This module uses evdev for input, and reads from input devices directly.
39 * This requires root privileges; waking up the input object will fail
41 * - evdev has no inhert notion of "focus" like tty input. In other words,
42 * it will deliver input events whether they are intended for the program
43 * or not. This may also pose a security risk. Therefore, make sure to put
44 * the object to sleep when the program is not active, for example by
45 * reacting to VT changes.
48 #ifndef KMSCON_INPUT_H
49 #define KMSCON_INPUT_H
57 enum kmscon_modifier {
58 KMSCON_SHIFT_MASK = (1 << 0),
59 KMSCON_LOCK_MASK = (1 << 1),
60 KMSCON_CONTROL_MASK = (1 << 2),
61 KMSCON_MOD1_MASK = (1 << 3),
62 KMSCON_MOD2_MASK = (1 << 4),
63 KMSCON_MOD3_MASK = (1 << 5),
64 KMSCON_MOD4_MASK = (1 << 6),
65 KMSCON_MOD5_MASK = (1 << 7),
68 #define KMSCON_INPUT_INVALID 0xffffffff
70 struct kmscon_input_event {
71 uint16_t keycode; /* linux keycode - KEY_* - linux/input.h */
72 uint32_t keysym; /* X keysym - XK_* - X11/keysym.h */
73 unsigned int mods; /* active modifiers - kmscon_modifier mask */
74 uint32_t unicode; /* UCS-4 unicode value or KMSCON_INPUT_INVALID */
77 typedef void (*kmscon_input_cb) (struct kmscon_input *input,
78 struct kmscon_input_event *ev, void *data);
81 * These are the values sent by the kernel in the /value/ field of the
82 * /input_event/ struct.
83 * See Documentation/input/event-codes.txt in the kernel tree.
85 enum kmscon_key_state {
86 KMSCON_KEY_RELEASED = 0,
87 KMSCON_KEY_PRESSED = 1,
88 KMSCON_KEY_REPEATED = 2,
91 int kmscon_input_new(struct kmscon_input **out);
92 void kmscon_input_ref(struct kmscon_input *input);
93 void kmscon_input_unref(struct kmscon_input *input);
95 int kmscon_input_connect_eloop(struct kmscon_input *input,
96 struct kmscon_eloop *eloop, kmscon_input_cb cb, void *data);
97 void kmscon_input_disconnect_eloop(struct kmscon_input *input);
99 void kmscon_input_sleep(struct kmscon_input *input);
100 void kmscon_input_wake_up(struct kmscon_input *input);
101 bool kmscon_input_is_asleep(struct kmscon_input *input);
103 #endif /* KMSCON_INPUT_H */