kernel - Bring in evdev from FreeBSD
[dragonfly.git] / sys / dev / misc / evdev / evdev.h
1 /*-
2  * Copyright (c) 2014 Jakub Wojciech Klama <jceel@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28
29 #ifndef _DEV_EVDEV_EVDEV_H
30 #define _DEV_EVDEV_EVDEV_H
31
32 #include <sys/types.h>
33 #include <sys/kbio.h>
34 #include <dev/misc/evdev/input.h>
35 #include <dev/misc/kbd/kbdreg.h>
36
37 #define NAMELEN         80
38
39 struct evdev_dev;
40
41 typedef int (evdev_open_t)(struct evdev_dev *, void *);
42 typedef void (evdev_close_t)(struct evdev_dev *, void *);
43 typedef void (evdev_event_t)(struct evdev_dev *, void *, uint16_t,
44     uint16_t, int32_t);
45 typedef void (evdev_keycode_t)(struct evdev_dev *, void *,
46     struct input_keymap_entry *);
47
48 /*
49  * Keyboard and mouse events recipient mask.
50  * evdev_rcpt_mask variable should be respected by keyboard and mouse drivers
51  * that are able to send events through both evdev and sysmouse/kbdmux
52  * interfaces so user can choose prefered one to not receive one event twice.
53  */
54 #define EVDEV_RCPT_SYSMOUSE     (1<<0)
55 #define EVDEV_RCPT_KBDMUX       (1<<1)
56 #define EVDEV_RCPT_HW_MOUSE     (1<<2)
57 #define EVDEV_RCPT_HW_KBD       (1<<3)
58 extern int evdev_rcpt_mask;
59 /*
60  * Sysmouse protocol does not support horizontal wheel movement reporting.
61  * To overcome this limitation different drivers use different sysmouse proto
62  * extensions. Set kern.evdev.sysmouse_t_axis to tell sysmouse evdev driver
63  * which protocol extension is used.
64  * 0 - do not extract horizontal wheel movement (default).
65  * 1 - ums(4) horizontal wheel encoding. T-axis is mapped to buttons 6 and 7
66  * 2 - psm(4) wheels encoding: z = 1,-1 - vert. wheel, z = 2,-2 - horiz. wheel
67  */
68 enum
69 {
70         EVDEV_SYSMOUSE_T_AXIS_NONE = 0,
71         EVDEV_SYSMOUSE_T_AXIS_UMS = 1,
72         EVDEV_SYSMOUSE_T_AXIS_PSM = 2,
73 };
74 extern int evdev_sysmouse_t_axis;
75
76 #define ABS_MT_FIRST    ABS_MT_TOUCH_MAJOR
77 #define ABS_MT_LAST     ABS_MT_TOOL_Y
78 #define ABS_IS_MT(x)    ((x) >= ABS_MT_FIRST && (x) <= ABS_MT_LAST)
79 #define ABS_MT_INDEX(x) ((x) - ABS_MT_FIRST)
80 #define MT_CNT          (ABS_MT_INDEX(ABS_MT_LAST) + 1)
81 /* Multitouch protocol type A */
82 #define MAX_MT_REPORTS  5
83 /* Multitouch protocol type B interface */
84 #define MAX_MT_SLOTS    16
85
86 #define EVDEV_FLAG_SOFTREPEAT   0x00    /* use evdev to repeat keys */
87 #define EVDEV_FLAG_MT_STCOMPAT  0x01    /* autogenerate ST-compatible events
88                                          * for MT protocol type B reports */
89 #define EVDEV_FLAG_MT_AUTOREL   0x02    /* Autorelease MT-slots not listed in
90                                          * current MT protocol type B report */
91 #define EVDEV_FLAG_MAX          0x1F
92 #define EVDEV_FLAG_CNT          (EVDEV_FLAG_MAX + 1)
93
94 struct evdev_methods
95 {
96         evdev_open_t            *ev_open;
97         evdev_close_t           *ev_close;
98         evdev_event_t           *ev_event;
99         evdev_keycode_t         *ev_get_keycode;
100         evdev_keycode_t         *ev_set_keycode;
101 };
102
103 /* Input device interface: */
104 struct evdev_dev *evdev_alloc(void);
105 void evdev_free(struct evdev_dev *);
106 void evdev_set_name(struct evdev_dev *, const char *);
107 void evdev_set_id(struct evdev_dev *, uint16_t, uint16_t, uint16_t, uint16_t);
108 void evdev_set_phys(struct evdev_dev *, const char *);
109 void evdev_set_serial(struct evdev_dev *, const char *);
110 void evdev_set_methods(struct evdev_dev *, void *,
111     const struct evdev_methods *);
112 int evdev_register(struct evdev_dev *);
113 int evdev_register_mtx(struct evdev_dev *, struct lock *); //dfly lock
114 int evdev_unregister(struct evdev_dev *);
115 int evdev_push_event(struct evdev_dev *, uint16_t, uint16_t, int32_t);
116 void evdev_support_prop(struct evdev_dev *, uint16_t);
117 void evdev_support_event(struct evdev_dev *, uint16_t);
118 void evdev_support_key(struct evdev_dev *, uint16_t);
119 void evdev_support_rel(struct evdev_dev *, uint16_t);
120 void evdev_support_abs(struct evdev_dev *, uint16_t, int32_t, int32_t, int32_t,
121    int32_t, int32_t, int32_t);
122 void evdev_support_msc(struct evdev_dev *, uint16_t);
123 void evdev_support_led(struct evdev_dev *, uint16_t);
124 void evdev_support_snd(struct evdev_dev *, uint16_t);
125 void evdev_support_sw(struct evdev_dev *, uint16_t);
126 void evdev_set_repeat_params(struct evdev_dev *, uint16_t, int);
127 int evdev_set_report_size(struct evdev_dev *, size_t);
128 void evdev_set_flag(struct evdev_dev *, uint16_t);
129
130 /* Multitouch related functions: */
131 int32_t evdev_get_mt_slot_by_tracking_id(struct evdev_dev *, int32_t);
132 void evdev_support_nfingers(struct evdev_dev *, int32_t);
133 void evdev_support_mt_compat(struct evdev_dev *);
134 void evdev_push_nfingers(struct evdev_dev *, int32_t);
135 void evdev_push_mt_compat(struct evdev_dev *);
136
137 /* Utility functions: */
138 uint16_t evdev_hid2key(int);
139 void evdev_support_all_known_keys(struct evdev_dev *);
140 uint16_t evdev_scancode2key(int *, int);
141 void evdev_push_mouse_btn(struct evdev_dev *, int);
142 void evdev_push_leds(struct evdev_dev *, int);
143 void evdev_push_repeats(struct evdev_dev *, keyboard_t *);
144 evdev_event_t evdev_ev_kbd_event;
145
146 /* Event reporting shortcuts: */
147 static __inline int
148 evdev_sync(struct evdev_dev *evdev)
149 {
150
151         return (evdev_push_event(evdev, EV_SYN, SYN_REPORT, 1));
152 }
153
154 static __inline int
155 evdev_mt_sync(struct evdev_dev *evdev)
156 {
157
158         return (evdev_push_event(evdev, EV_SYN, SYN_MT_REPORT, 1));
159 }
160
161 static __inline int
162 evdev_push_key(struct evdev_dev *evdev, uint16_t code, int32_t value)
163 {
164
165         return (evdev_push_event(evdev, EV_KEY, code, value != 0));
166 }
167
168 static __inline int
169 evdev_push_rel(struct evdev_dev *evdev, uint16_t code, int32_t value)
170 {
171
172         return (evdev_push_event(evdev, EV_REL, code, value));
173 }
174
175 static __inline int
176 evdev_push_abs(struct evdev_dev *evdev, uint16_t code, int32_t value)
177 {
178
179         return (evdev_push_event(evdev, EV_ABS, code, value));
180 }
181
182 static __inline int
183 evdev_push_msc(struct evdev_dev *evdev, uint16_t code, int32_t value)
184 {
185
186         return (evdev_push_event(evdev, EV_MSC, code, value));
187 }
188
189 static __inline int
190 evdev_push_led(struct evdev_dev *evdev, uint16_t code, int32_t value)
191 {
192
193         return (evdev_push_event(evdev, EV_LED, code, value != 0));
194 }
195
196 static __inline int
197 evdev_push_snd(struct evdev_dev *evdev, uint16_t code, int32_t value)
198 {
199
200         return (evdev_push_event(evdev, EV_SND, code, value != 0));
201 }
202
203 static __inline int
204 evdev_push_sw(struct evdev_dev *evdev, uint16_t code, int32_t value)
205 {
206
207         return (evdev_push_event(evdev, EV_SW, code, value != 0));
208 }
209
210 #endif  /* _DEV_EVDEV_EVDEV_H */