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/evdev/input.h> 35 #include <dev/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 #define ABS_MT_FIRST ABS_MT_TOUCH_MAJOR 61 #define ABS_MT_LAST ABS_MT_TOOL_Y 62 #define ABS_IS_MT(x) ((x) >= ABS_MT_FIRST && (x) <= ABS_MT_LAST) 63 #define ABS_MT_INDEX(x) ((x) - ABS_MT_FIRST) 64 #define MT_CNT (ABS_MT_INDEX(ABS_MT_LAST) + 1) 65 /* Multitouch protocol type A */ 66 #define MAX_MT_REPORTS 5 67 /* Multitouch protocol type B interface */ 68 #define MAX_MT_SLOTS 16 69 70 #define EVDEV_FLAG_SOFTREPEAT 0x00 /* use evdev to repeat keys */ 71 #define EVDEV_FLAG_MT_STCOMPAT 0x01 /* autogenerate ST-compatible events 72 * for MT protocol type B reports */ 73 #define EVDEV_FLAG_MT_AUTOREL 0x02 /* Autorelease MT-slots not listed in 74 * current MT protocol type B report */ 75 #define EVDEV_FLAG_MAX 0x1F 76 #define EVDEV_FLAG_CNT (EVDEV_FLAG_MAX + 1) 77 78 struct evdev_methods 79 { 80 evdev_open_t *ev_open; 81 evdev_close_t *ev_close; 82 evdev_event_t *ev_event; 83 evdev_keycode_t *ev_get_keycode; 84 evdev_keycode_t *ev_set_keycode; 85 }; 86 87 /* Input device interface: */ 88 struct evdev_dev *evdev_alloc(void); 89 void evdev_free(struct evdev_dev *); 90 void evdev_set_name(struct evdev_dev *, const char *); 91 void evdev_set_id(struct evdev_dev *, uint16_t, uint16_t, uint16_t, uint16_t); 92 void evdev_set_phys(struct evdev_dev *, const char *); 93 void evdev_set_serial(struct evdev_dev *, const char *); 94 void evdev_set_methods(struct evdev_dev *, void *, 95 const struct evdev_methods *); 96 int evdev_register(struct evdev_dev *); 97 int evdev_register_mtx(struct evdev_dev *, struct mtx *); 98 int evdev_unregister(struct evdev_dev *); 99 int evdev_push_event(struct evdev_dev *, uint16_t, uint16_t, int32_t); 100 void evdev_support_prop(struct evdev_dev *, uint16_t); 101 void evdev_support_event(struct evdev_dev *, uint16_t); 102 void evdev_support_key(struct evdev_dev *, uint16_t); 103 void evdev_support_rel(struct evdev_dev *, uint16_t); 104 void evdev_support_abs(struct evdev_dev *, uint16_t, int32_t, int32_t, int32_t, 105 int32_t, int32_t, int32_t); 106 void evdev_support_msc(struct evdev_dev *, uint16_t); 107 void evdev_support_led(struct evdev_dev *, uint16_t); 108 void evdev_support_snd(struct evdev_dev *, uint16_t); 109 void evdev_support_sw(struct evdev_dev *, uint16_t); 110 void evdev_set_repeat_params(struct evdev_dev *, uint16_t, int); 111 int evdev_set_report_size(struct evdev_dev *, size_t); 112 void evdev_set_flag(struct evdev_dev *, uint16_t); 113 114 /* Multitouch related functions: */ 115 int32_t evdev_get_mt_slot_by_tracking_id(struct evdev_dev *, int32_t); 116 void evdev_support_nfingers(struct evdev_dev *, int32_t); 117 void evdev_support_mt_compat(struct evdev_dev *); 118 void evdev_push_nfingers(struct evdev_dev *, int32_t); 119 void evdev_push_mt_compat(struct evdev_dev *); 120 121 /* Utility functions: */ 122 uint16_t evdev_hid2key(int); 123 void evdev_support_all_known_keys(struct evdev_dev *); 124 uint16_t evdev_scancode2key(int *, int); 125 void evdev_push_mouse_btn(struct evdev_dev *, int); 126 void evdev_push_leds(struct evdev_dev *, int); 127 void evdev_push_repeats(struct evdev_dev *, keyboard_t *); 128 evdev_event_t evdev_ev_kbd_event; 129 130 /* Event reporting shortcuts: */ 131 static __inline int 132 evdev_sync(struct evdev_dev *evdev) 133 { 134 135 return (evdev_push_event(evdev, EV_SYN, SYN_REPORT, 1)); 136 } 137 138 static __inline int 139 evdev_mt_sync(struct evdev_dev *evdev) 140 { 141 142 return (evdev_push_event(evdev, EV_SYN, SYN_MT_REPORT, 1)); 143 } 144 145 static __inline int 146 evdev_push_key(struct evdev_dev *evdev, uint16_t code, int32_t value) 147 { 148 149 return (evdev_push_event(evdev, EV_KEY, code, value != 0)); 150 } 151 152 static __inline int 153 evdev_push_rel(struct evdev_dev *evdev, uint16_t code, int32_t value) 154 { 155 156 return (evdev_push_event(evdev, EV_REL, code, value)); 157 } 158 159 static __inline int 160 evdev_push_abs(struct evdev_dev *evdev, uint16_t code, int32_t value) 161 { 162 163 return (evdev_push_event(evdev, EV_ABS, code, value)); 164 } 165 166 static __inline int 167 evdev_push_msc(struct evdev_dev *evdev, uint16_t code, int32_t value) 168 { 169 170 return (evdev_push_event(evdev, EV_MSC, code, value)); 171 } 172 173 static __inline int 174 evdev_push_led(struct evdev_dev *evdev, uint16_t code, int32_t value) 175 { 176 177 return (evdev_push_event(evdev, EV_LED, code, value != 0)); 178 } 179 180 static __inline int 181 evdev_push_snd(struct evdev_dev *evdev, uint16_t code, int32_t value) 182 { 183 184 return (evdev_push_event(evdev, EV_SND, code, value != 0)); 185 } 186 187 static __inline int 188 evdev_push_sw(struct evdev_dev *evdev, uint16_t code, int32_t value) 189 { 190 191 return (evdev_push_event(evdev, EV_SW, code, value != 0)); 192 } 193 194 #endif /* _DEV_EVDEV_EVDEV_H */ 195