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/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 *);
  42 typedef int (evdev_close_t)(struct evdev_dev *);
  43 typedef void (evdev_event_t)(struct evdev_dev *, uint16_t, uint16_t, int32_t);
  44 typedef void (evdev_keycode_t)(struct evdev_dev *,
  45     struct input_keymap_entry *);
  46
  47 /*
  48  * Keyboard and mouse events recipient mask.
  49  * evdev_rcpt_mask variable should be respected by keyboard and mouse drivers
  50  * that are able to send events through both evdev and sysmouse/kbdmux
  51  * interfaces so user can choose prefered one to not receive one event twice.
  52  */
  53 #define EVDEV_RCPT_SYSMOUSE     (1<<0)
  54 #define EVDEV_RCPT_KBDMUX       (1<<1)
  55 #define EVDEV_RCPT_HW_MOUSE     (1<<2)
  56 #define EVDEV_RCPT_HW_KBD       (1<<3)
  57 extern int evdev_rcpt_mask;
  58 /*
  59  * Sysmouse protocol does not support horizontal wheel movement reporting.
  60  * To overcome this limitation different drivers use different sysmouse proto
  61  * extensions. Set kern.evdev.sysmouse_t_axis to tell sysmouse evdev driver
  62  * which protocol extension is used.
  63  * 0 - do not extract horizontal wheel movement (default).
  64  * 1 - ums(4) horizontal wheel encoding. T-axis is mapped to buttons 6 and 7
  65  * 2 - psm(4) wheels encoding: z = 1,-1 - vert. wheel, z = 2,-2 - horiz. wheel
  66  */
  67 enum
  68 {
  69         EVDEV_SYSMOUSE_T_AXIS_NONE = 0,
  70         EVDEV_SYSMOUSE_T_AXIS_UMS = 1,
  71         EVDEV_SYSMOUSE_T_AXIS_PSM = 2,
  72 };
  73 extern int evdev_sysmouse_t_axis;
  74
  75 #define ABS_MT_FIRST    ABS_MT_TOUCH_MAJOR
  76 #define ABS_MT_LAST     ABS_MT_TOOL_Y
  77 #define ABS_IS_MT(x)    ((x) >= ABS_MT_FIRST && (x) <= ABS_MT_LAST)
  78 #define ABS_MT_INDEX(x) ((x) - ABS_MT_FIRST)
  79 #define MT_CNT          (ABS_MT_INDEX(ABS_MT_LAST) + 1)
  80 /* Multitouch protocol type A */
  81 #define MAX_MT_REPORTS  5
  82 /* Multitouch protocol type B interface */
  83 #define MAX_MT_SLOTS    16
  84
  85 #define EVDEV_FLAG_SOFTREPEAT   0x00    /* use evdev to repeat keys */
  86 #define EVDEV_FLAG_MT_STCOMPAT  0x01    /* autogenerate ST-compatible events
  87                                          * for MT protocol type B reports */
  88 #define EVDEV_FLAG_MT_AUTOREL   0x02    /* Autorelease MT-slots not listed in
  89                                          * current MT protocol type B report */
  90 #define EVDEV_FLAG_MAX          0x1F
  91 #define EVDEV_FLAG_CNT          (EVDEV_FLAG_MAX + 1)
  92
  93 struct evdev_methods
  94 {
  95         evdev_open_t            *ev_open;
  96         evdev_close_t           *ev_close;
  97         evdev_event_t           *ev_event;
  98         evdev_keycode_t         *ev_get_keycode;
  99         evdev_keycode_t         *ev_set_keycode;
 100 };
 101
 102 /* Input device interface: */
 103 struct evdev_dev *evdev_alloc(void);
 104 void evdev_free(struct evdev_dev *);
 105 void evdev_set_name(struct evdev_dev *, const char *);
 106 void evdev_set_id(struct evdev_dev *, uint16_t, uint16_t, uint16_t, uint16_t);
 107 void evdev_set_phys(struct evdev_dev *, const char *);
 108 void evdev_set_serial(struct evdev_dev *, const char *);
 109 void evdev_set_methods(struct evdev_dev *, void *,
 110     const struct evdev_methods *);
 111 int evdev_register(struct evdev_dev *);
 112 int evdev_register_mtx(struct evdev_dev *, struct mtx *);
 113 int evdev_unregister(struct evdev_dev *);
 114 int evdev_push_event(struct evdev_dev *, uint16_t, uint16_t, int32_t);
 115 void evdev_support_prop(struct evdev_dev *, uint16_t);
 116 void evdev_support_event(struct evdev_dev *, uint16_t);
 117 void evdev_support_key(struct evdev_dev *, uint16_t);
 118 void evdev_support_rel(struct evdev_dev *, uint16_t);
 119 void evdev_support_abs(struct evdev_dev *, uint16_t, int32_t, int32_t, int32_t,
 120    int32_t, int32_t, int32_t);
 121 void evdev_support_msc(struct evdev_dev *, uint16_t);
 122 void evdev_support_led(struct evdev_dev *, uint16_t);
 123 void evdev_support_snd(struct evdev_dev *, uint16_t);
 124 void evdev_support_sw(struct evdev_dev *, uint16_t);
 125 void evdev_set_repeat_params(struct evdev_dev *, uint16_t, int);
 126 int evdev_set_report_size(struct evdev_dev *, size_t);
 127 void evdev_set_flag(struct evdev_dev *, uint16_t);
 128 void *evdev_get_softc(struct evdev_dev *);
 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
 145 /* Event reporting shortcuts: */
 146 static __inline int
 147 evdev_sync(struct evdev_dev *evdev)
 148 {
 149
 150         return (evdev_push_event(evdev, EV_SYN, SYN_REPORT, 1));
 151 }
 152
 153 static __inline int
 154 evdev_mt_sync(struct evdev_dev *evdev)
 155 {
 156
 157         return (evdev_push_event(evdev, EV_SYN, SYN_MT_REPORT, 1));
 158 }
 159
 160 static __inline int
 161 evdev_push_key(struct evdev_dev *evdev, uint16_t code, int32_t value)
 162 {
 163
 164         return (evdev_push_event(evdev, EV_KEY, code, value != 0));
 165 }
 166
 167 static __inline int
 168 evdev_push_rel(struct evdev_dev *evdev, uint16_t code, int32_t value)
 169 {
 170
 171         return (evdev_push_event(evdev, EV_REL, code, value));
 172 }
 173
 174 static __inline int
 175 evdev_push_abs(struct evdev_dev *evdev, uint16_t code, int32_t value)
 176 {
 177
 178         return (evdev_push_event(evdev, EV_ABS, code, value));
 179 }
 180
 181 static __inline int
 182 evdev_push_msc(struct evdev_dev *evdev, uint16_t code, int32_t value)
 183 {
 184
 185         return (evdev_push_event(evdev, EV_MSC, code, value));
 186 }
 187
 188 static __inline int
 189 evdev_push_led(struct evdev_dev *evdev, uint16_t code, int32_t value)
 190 {
 191
 192         return (evdev_push_event(evdev, EV_LED, code, value != 0));
 193 }
 194
 195 static __inline int
 196 evdev_push_snd(struct evdev_dev *evdev, uint16_t code, int32_t value)
 197 {
 198
 199         return (evdev_push_event(evdev, EV_SND, code, value));
 200 }
 201
 202 static __inline int
 203 evdev_push_sw(struct evdev_dev *evdev, uint16_t code, int32_t value)
 204 {
 205
 206         return (evdev_push_event(evdev, EV_SW, code, value != 0));
 207 }
 208
 209 #endif  /* _DEV_EVDEV_EVDEV_H */