sys/dev/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/epoch.h>
  34 #include <sys/kbio.h>
  35 #include <dev/evdev/input.h>
  36 #include <dev/kbd/kbdreg.h>
  37
  38 #define NAMELEN         80
  39
  40 struct evdev_dev;
  41
  42 typedef int (evdev_open_t)(struct evdev_dev *);
  43 typedef int (evdev_close_t)(struct evdev_dev *);
  44 typedef void (evdev_event_t)(struct evdev_dev *, uint16_t, uint16_t, int32_t);
  45 typedef void (evdev_keycode_t)(struct evdev_dev *,
  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 preferred 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_EXT_EPOCH    0x03    /* evdev_push_* is allways called with
  92                                          * input (global) epoch entered */
  93 #define EVDEV_FLAG_MT_KEEPID    0x04    /* Do not reassign tracking ID */
  94 #define EVDEV_FLAG_MT_TRACK     0x05    /* Assign touch to slot by evdev */
  95 #define EVDEV_FLAG_MAX          0x1F
  96 #define EVDEV_FLAG_CNT          (EVDEV_FLAG_MAX + 1)
  97
  98 struct evdev_methods
  99 {
 100         evdev_open_t            *ev_open;
 101         evdev_close_t           *ev_close;
 102         evdev_event_t           *ev_event;
 103         evdev_keycode_t         *ev_get_keycode;
 104         evdev_keycode_t         *ev_set_keycode;
 105 };
 106
 107 union evdev_mt_slot {
 108         int32_t         val[MT_CNT];
 109         struct {
 110                 int32_t maj;            /* ABS_MT_TOUCH_MAJOR */
 111                 int32_t min;            /* ABS_MT_TOUCH_MINOR */
 112                 int32_t w_maj;          /* ABS_MT_WIDTH_MAJOR */
 113                 int32_t w_min;          /* ABS_MT_WIDTH_MINOR */
 114                 int32_t ori;            /* ABS_MT_ORIENTATION */
 115                 int32_t x;              /* ABS_MT_POSITION_X */
 116                 int32_t y;              /* ABS_MT_POSITION_Y */
 117                 int32_t type;           /* ABS_MT_TOOL_TYPE */
 118                 int32_t blob_id;        /* ABS_MT_BLOB_ID */
 119                 int32_t id;             /* ABS_MT_TRACKING_ID */
 120                 int32_t p;              /* ABS_MT_PRESSURE */
 121                 int32_t dist;           /* ABS_MT_DISTANCE */
 122                 int32_t tool_x;         /* ABS_MT_TOOL_X */
 123                 int32_t tool_y;         /* ABS_MT_TOOL_Y */
 124         };
 125 };
 126 _Static_assert(offsetof(union evdev_mt_slot, tool_y) ==
 127     offsetof(union evdev_mt_slot, val[ABS_MT_INDEX(ABS_MT_TOOL_Y)]),
 128     "evdev_mt_slot array members does not match their structure aliases");
 129
 130 /* Input device interface: */
 131 struct evdev_dev *evdev_alloc(void);
 132 void evdev_free(struct evdev_dev *);
 133 void evdev_set_name(struct evdev_dev *, const char *);
 134 void evdev_set_id(struct evdev_dev *, uint16_t, uint16_t, uint16_t, uint16_t);
 135 void evdev_set_phys(struct evdev_dev *, const char *);
 136 void evdev_set_serial(struct evdev_dev *, const char *);
 137 void evdev_set_methods(struct evdev_dev *, void *,
 138     const struct evdev_methods *);
 139 int evdev_register(struct evdev_dev *);
 140 int evdev_register_mtx(struct evdev_dev *, struct mtx *);
 141 int evdev_unregister(struct evdev_dev *);
 142 int evdev_push_event(struct evdev_dev *, uint16_t, uint16_t, int32_t);
 143 void evdev_support_prop(struct evdev_dev *, uint16_t);
 144 void evdev_support_event(struct evdev_dev *, uint16_t);
 145 void evdev_support_key(struct evdev_dev *, uint16_t);
 146 void evdev_support_rel(struct evdev_dev *, uint16_t);
 147 void evdev_support_abs(struct evdev_dev *, uint16_t, int32_t, int32_t, int32_t,
 148    int32_t, int32_t);
 149 void evdev_support_msc(struct evdev_dev *, uint16_t);
 150 void evdev_support_led(struct evdev_dev *, uint16_t);
 151 void evdev_support_snd(struct evdev_dev *, uint16_t);
 152 void evdev_support_sw(struct evdev_dev *, uint16_t);
 153 void evdev_set_repeat_params(struct evdev_dev *, uint16_t, int);
 154 int evdev_set_report_size(struct evdev_dev *, size_t);
 155 void evdev_set_flag(struct evdev_dev *, uint16_t);
 156 void *evdev_get_softc(struct evdev_dev *);
 157
 158 /* Multitouch related functions: */
 159 int evdev_mt_id_to_slot(struct evdev_dev *, int32_t);
 160 int evdev_mt_push_slot(struct evdev_dev *, int, union evdev_mt_slot *);
 161 int evdev_mt_push_frame(struct evdev_dev *, union evdev_mt_slot *, int);
 162 void evdev_mt_match_frame(struct evdev_dev *, union evdev_mt_slot *, int);
 163 union evdev_mt_slot *evdev_mt_get_match_slots(struct evdev_dev *);
 164 void evdev_mt_push_autorel(struct evdev_dev *);
 165
 166 /* Utility functions: */
 167 uint16_t evdev_hid2key(int);
 168 void evdev_support_all_known_keys(struct evdev_dev *);
 169 uint16_t evdev_scancode2key(int *, int);
 170 void evdev_push_mouse_btn(struct evdev_dev *, int);
 171 void evdev_push_leds(struct evdev_dev *, int);
 172 void evdev_push_repeats(struct evdev_dev *, keyboard_t *);
 173 void evdev_support_nfingers(struct evdev_dev *, int);
 174 void evdev_push_nfingers(struct evdev_dev *, int);
 175
 176 /* Event reporting shortcuts: */
 177 static __inline int
 178 evdev_sync(struct evdev_dev *evdev)
 179 {
 180
 181         return (evdev_push_event(evdev, EV_SYN, SYN_REPORT, 1));
 182 }
 183
 184 static __inline int
 185 evdev_mt_sync(struct evdev_dev *evdev)
 186 {
 187
 188         return (evdev_push_event(evdev, EV_SYN, SYN_MT_REPORT, 1));
 189 }
 190
 191 static __inline int
 192 evdev_push_key(struct evdev_dev *evdev, uint16_t code, int32_t value)
 193 {
 194
 195         return (evdev_push_event(evdev, EV_KEY, code, value != 0));
 196 }
 197
 198 static __inline int
 199 evdev_push_rel(struct evdev_dev *evdev, uint16_t code, int32_t value)
 200 {
 201
 202         return (evdev_push_event(evdev, EV_REL, code, value));
 203 }
 204
 205 static __inline int
 206 evdev_push_abs(struct evdev_dev *evdev, uint16_t code, int32_t value)
 207 {
 208
 209         return (evdev_push_event(evdev, EV_ABS, code, value));
 210 }
 211
 212 static __inline int
 213 evdev_push_msc(struct evdev_dev *evdev, uint16_t code, int32_t value)
 214 {
 215
 216         return (evdev_push_event(evdev, EV_MSC, code, value));
 217 }
 218
 219 static __inline int
 220 evdev_push_led(struct evdev_dev *evdev, uint16_t code, int32_t value)
 221 {
 222
 223         return (evdev_push_event(evdev, EV_LED, code, value != 0));
 224 }
 225
 226 static __inline int
 227 evdev_push_snd(struct evdev_dev *evdev, uint16_t code, int32_t value)
 228 {
 229
 230         return (evdev_push_event(evdev, EV_SND, code, value));
 231 }
 232
 233 static __inline int
 234 evdev_push_sw(struct evdev_dev *evdev, uint16_t code, int32_t value)
 235 {
 236
 237         return (evdev_push_event(evdev, EV_SW, code, value != 0));
 238 }
 239
 240 #endif  /* _DEV_EVDEV_EVDEV_H */