1 /*- 2 * Copyright (c) 2014 Jakub Wojciech Klama <jceel@FreeBSD.org> 3 * Copyright (c) 2015-2016 Vladimir Kondratyev <wulf@cicgroup.ru> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 */ 29 30 #ifndef _DEV_EVDEV_EVDEV_PRIVATE_H 31 #define _DEV_EVDEV_EVDEV_PRIVATE_H 32 33 #include <sys/bitstring.h> 34 #include <sys/queue.h> 35 #include <sys/malloc.h> 36 #include <sys/kbio.h> 37 #include <sys/selinfo.h> 38 #include <dev/evdev/evdev.h> 39 #include <dev/evdev/input.h> 40 #include <dev/kbd/kbdreg.h> 41 42 #define NAMELEN 80 43 44 /* 45 * bitstr_t implementation must be identical to one found in EVIOCG* 46 * libevdev ioctls. Our bitstring(3) API is compatible since r299090. 47 */ 48 _Static_assert(sizeof(bitstr_t) == sizeof(unsigned long), 49 "bitstr_t size mismatch"); 50 51 MALLOC_DECLARE(M_EVDEV); 52 53 struct evdev_client; 54 struct evdev_mt; 55 56 #define CURRENT_MT_SLOT(evdev) ((evdev)->ev_absinfo[ABS_MT_SLOT].value) 57 #define MAXIMAL_MT_SLOT(evdev) ((evdev)->ev_absinfo[ABS_MT_SLOT].maximum) 58 59 enum evdev_key_events 60 { 61 KEY_EVENT_UP, 62 KEY_EVENT_DOWN, 63 KEY_EVENT_REPEAT 64 }; 65 66 /* evdev clock IDs in Linux semantic */ 67 enum evdev_clock_id 68 { 69 EV_CLOCK_REALTIME = 0, /* UTC clock */ 70 EV_CLOCK_MONOTONIC, /* monotonic, stops on suspend */ 71 EV_CLOCK_BOOTTIME /* monotonic, suspend-awared */ 72 }; 73 74 enum evdev_lock_type 75 { 76 EV_LOCK_INTERNAL = 0, /* Internal evdev mutex */ 77 EV_LOCK_MTX, /* Driver`s mutex */ 78 }; 79 80 struct evdev_dev 81 { 82 char ev_name[NAMELEN]; 83 char ev_shortname[NAMELEN]; 84 char ev_serial[NAMELEN]; 85 struct cdev * ev_cdev; 86 int ev_unit; 87 enum evdev_lock_type ev_lock_type; 88 struct mtx * ev_lock; 89 struct mtx ev_mtx; 90 struct input_id ev_id; 91 struct evdev_client * ev_grabber; 92 size_t ev_report_size; 93 94 /* Supported features: */ 95 bitstr_t bit_decl(ev_prop_flags, INPUT_PROP_CNT); 96 bitstr_t bit_decl(ev_type_flags, EV_CNT); 97 bitstr_t bit_decl(ev_key_flags, KEY_CNT); 98 bitstr_t bit_decl(ev_rel_flags, REL_CNT); 99 bitstr_t bit_decl(ev_abs_flags, ABS_CNT); 100 bitstr_t bit_decl(ev_msc_flags, MSC_CNT); 101 bitstr_t bit_decl(ev_led_flags, LED_CNT); 102 bitstr_t bit_decl(ev_snd_flags, SND_CNT); 103 bitstr_t bit_decl(ev_sw_flags, SW_CNT); 104 struct input_absinfo * ev_absinfo; 105 bitstr_t bit_decl(ev_flags, EVDEV_FLAG_CNT); 106 107 /* Repeat parameters & callout: */ 108 int ev_rep[REP_CNT]; 109 struct callout ev_rep_callout; 110 uint16_t ev_rep_key; 111 112 /* State: */ 113 bitstr_t bit_decl(ev_key_states, KEY_CNT); 114 bitstr_t bit_decl(ev_led_states, LED_CNT); 115 bitstr_t bit_decl(ev_snd_states, SND_CNT); 116 bitstr_t bit_decl(ev_sw_states, SW_CNT); 117 bool ev_report_opened; 118 119 /* Multitouch protocol type B state: */ 120 struct evdev_mt * ev_mt; 121 122 /* Counters: */ 123 uint64_t ev_event_count; 124 uint64_t ev_report_count; 125 126 /* Parent driver callbacks: */ 127 const struct evdev_methods * ev_methods; 128 void * ev_softc; 129 130 LIST_ENTRY(evdev_dev) ev_link; 131 LIST_HEAD(, evdev_client) ev_clients; 132 }; 133 134 #define EVDEV_LOCK(evdev) mtx_lock((evdev)->ev_lock) 135 #define EVDEV_UNLOCK(evdev) mtx_unlock((evdev)->ev_lock) 136 #define EVDEV_LOCK_ASSERT(evdev) mtx_assert((evdev)->ev_lock, MA_OWNED) 137 138 struct evdev_client 139 { 140 struct evdev_dev * ec_evdev; 141 struct mtx ec_buffer_mtx; 142 size_t ec_buffer_size; 143 size_t ec_buffer_head; 144 size_t ec_buffer_tail; 145 size_t ec_buffer_ready; 146 enum evdev_clock_id ec_clock_id; 147 struct selinfo ec_selp; 148 struct sigio * ec_sigio; 149 bool ec_async; 150 bool ec_revoked; 151 bool ec_blocked; 152 bool ec_selected; 153 154 LIST_ENTRY(evdev_client) ec_link; 155 156 struct input_event ec_buffer[]; 157 }; 158 159 #define EVDEV_CLIENT_LOCKQ(client) mtx_lock(&(client)->ec_buffer_mtx) 160 #define EVDEV_CLIENT_UNLOCKQ(client) mtx_unlock(&(client)->ec_buffer_mtx) 161 #define EVDEV_CLIENT_LOCKQ_ASSERT(client) \ 162 mtx_assert(&(client)->ec_buffer_mtx, MA_OWNED) 163 #define EVDEV_CLIENT_EMPTYQ(client) \ 164 ((client)->ec_buffer_head == (client)->ec_buffer_ready) 165 #define EVDEV_CLIENT_SIZEQ(client) \ 166 (((client)->ec_buffer_ready + (client)->ec_buffer_size - \ 167 (client)->ec_buffer_head) % (client)->ec_buffer_size) 168 169 /* Input device interface: */ 170 void evdev_send_event(struct evdev_dev *, uint16_t, uint16_t, int32_t); 171 int evdev_inject_event(struct evdev_dev *, uint16_t, uint16_t, int32_t); 172 int evdev_cdev_create(struct evdev_dev *); 173 int evdev_cdev_destroy(struct evdev_dev *); 174 bool evdev_event_supported(struct evdev_dev *, uint16_t); 175 void evdev_set_abs_bit(struct evdev_dev *, uint16_t); 176 void evdev_set_absinfo(struct evdev_dev *, uint16_t, struct input_absinfo *); 177 178 /* Client interface: */ 179 int evdev_register_client(struct evdev_dev *, struct evdev_client *); 180 void evdev_dispose_client(struct evdev_dev *, struct evdev_client *); 181 int evdev_grab_client(struct evdev_dev *, struct evdev_client *); 182 int evdev_release_client(struct evdev_dev *, struct evdev_client *); 183 void evdev_client_push(struct evdev_client *, uint16_t, uint16_t, int32_t); 184 void evdev_notify_event(struct evdev_client *); 185 void evdev_revoke_client(struct evdev_client *); 186 187 /* Multitouch related functions: */ 188 void evdev_mt_init(struct evdev_dev *); 189 void evdev_mt_free(struct evdev_dev *); 190 int32_t evdev_get_last_mt_slot(struct evdev_dev *); 191 void evdev_set_last_mt_slot(struct evdev_dev *, int32_t); 192 int32_t evdev_get_mt_value(struct evdev_dev *, int32_t, int16_t); 193 void evdev_set_mt_value(struct evdev_dev *, int32_t, int16_t, int32_t); 194 void evdev_send_mt_compat(struct evdev_dev *); 195 void evdev_send_mt_autorel(struct evdev_dev *); 196 197 /* Utility functions: */ 198 void evdev_client_dumpqueue(struct evdev_client *); 199 200 #endif /* _DEV_EVDEV_EVDEV_PRIVATE_H */ 201