1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (c) 1999-2002 Vojtech Pavlik
4 */
5 #ifndef _INPUT_H
6 #define _INPUT_H
7
8 #include <linux/time.h>
9 #include <linux/list.h>
10 #include <linux/android_kabi.h>
11 #include <uapi/linux/input.h>
12 /* Implementation details, userspace should not care about these */
13 #define ABS_MT_FIRST ABS_MT_TOUCH_MAJOR
14 #define ABS_MT_LAST ABS_MT_TOOL_Y
15
16 /*
17 * In-kernel definitions.
18 */
19
20 #include <linux/device.h>
21 #include <linux/fs.h>
22 #include <linux/timer.h>
23 #include <linux/mod_devicetable.h>
24
25 struct input_dev_poller;
26
27 /**
28 * struct input_value - input value representation
29 * @type: type of value (EV_KEY, EV_ABS, etc)
30 * @code: the value code
31 * @value: the value
32 */
33 struct input_value {
34 __u16 type;
35 __u16 code;
36 __s32 value;
37 };
38
39 enum input_clock_type {
40 INPUT_CLK_REAL = 0,
41 INPUT_CLK_MONO,
42 INPUT_CLK_BOOT,
43 INPUT_CLK_MAX
44 };
45
46 /**
47 * struct input_dev - represents an input device
48 * @name: name of the device
49 * @phys: physical path to the device in the system hierarchy
50 * @uniq: unique identification code for the device (if device has it)
51 * @id: id of the device (struct input_id)
52 * @propbit: bitmap of device properties and quirks
53 * @evbit: bitmap of types of events supported by the device (EV_KEY,
54 * EV_REL, etc.)
55 * @keybit: bitmap of keys/buttons this device has
56 * @relbit: bitmap of relative axes for the device
57 * @absbit: bitmap of absolute axes for the device
58 * @mscbit: bitmap of miscellaneous events supported by the device
59 * @ledbit: bitmap of leds present on the device
60 * @sndbit: bitmap of sound effects supported by the device
61 * @ffbit: bitmap of force feedback effects supported by the device
62 * @swbit: bitmap of switches present on the device
63 * @hint_events_per_packet: average number of events generated by the
64 * device in a packet (between EV_SYN/SYN_REPORT events). Used by
65 * event handlers to estimate size of the buffer needed to hold
66 * events.
67 * @keycodemax: size of keycode table
68 * @keycodesize: size of elements in keycode table
69 * @keycode: map of scancodes to keycodes for this device
70 * @getkeycode: optional legacy method to retrieve current keymap.
71 * @setkeycode: optional method to alter current keymap, used to implement
72 * sparse keymaps. If not supplied default mechanism will be used.
73 * The method is being called while holding event_lock and thus must
74 * not sleep
75 * @ff: force feedback structure associated with the device if device
76 * supports force feedback effects
77 * @poller: poller structure associated with the device if device is
78 * set up to use polling mode
79 * @repeat_key: stores key code of the last key pressed; used to implement
80 * software autorepeat
81 * @timer: timer for software autorepeat
82 * @rep: current values for autorepeat parameters (delay, rate)
83 * @mt: pointer to multitouch state
84 * @absinfo: array of &struct input_absinfo elements holding information
85 * about absolute axes (current value, min, max, flat, fuzz,
86 * resolution)
87 * @key: reflects current state of device's keys/buttons
88 * @led: reflects current state of device's LEDs
89 * @snd: reflects current state of sound effects
90 * @sw: reflects current state of device's switches
91 * @open: this method is called when the very first user calls
92 * input_open_device(). The driver must prepare the device
93 * to start generating events (start polling thread,
94 * request an IRQ, submit URB, etc.)
95 * @close: this method is called when the very last user calls
96 * input_close_device().
97 * @flush: purges the device. Most commonly used to get rid of force
98 * feedback effects loaded into the device when disconnecting
99 * from it
100 * @event: event handler for events sent _to_ the device, like EV_LED
101 * or EV_SND. The device is expected to carry out the requested
102 * action (turn on a LED, play sound, etc.) The call is protected
103 * by @event_lock and must not sleep
104 * @grab: input handle that currently has the device grabbed (via
105 * EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
106 * recipient for all input events coming from the device
107 * @event_lock: this spinlock is taken when input core receives
108 * and processes a new event for the device (in input_event()).
109 * Code that accesses and/or modifies parameters of a device
110 * (such as keymap or absmin, absmax, absfuzz, etc.) after device
111 * has been registered with input core must take this lock.
112 * @mutex: serializes calls to open(), close() and flush() methods
113 * @users: stores number of users (input handlers) that opened this
114 * device. It is used by input_open_device() and input_close_device()
115 * to make sure that dev->open() is only called when the first
116 * user opens device and dev->close() is called when the very
117 * last user closes the device
118 * @going_away: marks devices that are in a middle of unregistering and
119 * causes input_open_device*() fail with -ENODEV.
120 * @dev: driver model's view of this device
121 * @h_list: list of input handles associated with the device. When
122 * accessing the list dev->mutex must be held
123 * @node: used to place the device onto input_dev_list
124 * @num_vals: number of values queued in the current frame
125 * @max_vals: maximum number of values queued in a frame
126 * @vals: array of values queued in the current frame
127 * @devres_managed: indicates that devices is managed with devres framework
128 * and needs not be explicitly unregistered or freed.
129 * @timestamp: storage for a timestamp set by input_set_timestamp called
130 * by a driver
131 */
132 struct input_dev {
133 const char *name;
134 const char *phys;
135 const char *uniq;
136 struct input_id id;
137
138 unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
139
140 unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
141 unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
142 unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
143 unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
144 unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
145 unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
146 unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
147 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
148 unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
149
150 unsigned int hint_events_per_packet;
151
152 unsigned int keycodemax;
153 unsigned int keycodesize;
154 void *keycode;
155
156 int (*setkeycode)(struct input_dev *dev,
157 const struct input_keymap_entry *ke,
158 unsigned int *old_keycode);
159 int (*getkeycode)(struct input_dev *dev,
160 struct input_keymap_entry *ke);
161
162 struct ff_device *ff;
163
164 struct input_dev_poller *poller;
165
166 unsigned int repeat_key;
167 struct timer_list timer;
168
169 int rep[REP_CNT];
170
171 struct input_mt *mt;
172
173 struct input_absinfo *absinfo;
174
175 unsigned long key[BITS_TO_LONGS(KEY_CNT)];
176 unsigned long led[BITS_TO_LONGS(LED_CNT)];
177 unsigned long snd[BITS_TO_LONGS(SND_CNT)];
178 unsigned long sw[BITS_TO_LONGS(SW_CNT)];
179
180 int (*open)(struct input_dev *dev);
181 void (*close)(struct input_dev *dev);
182 int (*flush)(struct input_dev *dev, struct file *file);
183 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
184
185 struct input_handle __rcu *grab;
186
187 spinlock_t event_lock;
188 struct mutex mutex;
189
190 unsigned int users;
191 bool going_away;
192
193 struct device dev;
194
195 struct list_head h_list;
196 struct list_head node;
197
198 unsigned int num_vals;
199 unsigned int max_vals;
200 struct input_value *vals;
201
202 bool devres_managed;
203
204 ktime_t timestamp[INPUT_CLK_MAX];
205
206 ANDROID_KABI_RESERVE(1);
207 ANDROID_KABI_RESERVE(2);
208 ANDROID_KABI_RESERVE(3);
209 ANDROID_KABI_RESERVE(4);
210 };
211 #define to_input_dev(d) container_of(d, struct input_dev, dev)
212
213 /*
214 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
215 */
216
217 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
218 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
219 #endif
220
221 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
222 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
223 #endif
224
225 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
226 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
227 #endif
228
229 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
230 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
231 #endif
232
233 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
234 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
235 #endif
236
237 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
238 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
239 #endif
240
241 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
242 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
243 #endif
244
245 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
246 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
247 #endif
248
249 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
250 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
251 #endif
252
253 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
254 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
255 #endif
256
257 #if INPUT_PROP_MAX != INPUT_DEVICE_ID_PROP_MAX
258 #error "INPUT_PROP_MAX and INPUT_DEVICE_ID_PROP_MAX do not match"
259 #endif
260
261 #define INPUT_DEVICE_ID_MATCH_DEVICE \
262 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
263 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
264 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
265
266 struct input_handle;
267
268 /**
269 * struct input_handler - implements one of interfaces for input devices
270 * @private: driver-specific data
271 * @event: event handler. This method is being called by input core with
272 * interrupts disabled and dev->event_lock spinlock held and so
273 * it may not sleep
274 * @events: event sequence handler. This method is being called by
275 * input core with interrupts disabled and dev->event_lock
276 * spinlock held and so it may not sleep
277 * @filter: similar to @event; separates normal event handlers from
278 * "filters".
279 * @match: called after comparing device's id with handler's id_table
280 * to perform fine-grained matching between device and handler
281 * @connect: called when attaching a handler to an input device
282 * @disconnect: disconnects a handler from input device
283 * @start: starts handler for given handle. This function is called by
284 * input core right after connect() method and also when a process
285 * that "grabbed" a device releases it
286 * @legacy_minors: set to %true by drivers using legacy minor ranges
287 * @minor: beginning of range of 32 legacy minors for devices this driver
288 * can provide
289 * @name: name of the handler, to be shown in /proc/bus/input/handlers
290 * @id_table: pointer to a table of input_device_ids this driver can
291 * handle
292 * @h_list: list of input handles associated with the handler
293 * @node: for placing the driver onto input_handler_list
294 *
295 * Input handlers attach to input devices and create input handles. There
296 * are likely several handlers attached to any given input device at the
297 * same time. All of them will get their copy of input event generated by
298 * the device.
299 *
300 * The very same structure is used to implement input filters. Input core
301 * allows filters to run first and will not pass event to regular handlers
302 * if any of the filters indicate that the event should be filtered (by
303 * returning %true from their filter() method).
304 *
305 * Note that input core serializes calls to connect() and disconnect()
306 * methods.
307 */
308 struct input_handler {
309
310 void *private;
311
312 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
313 void (*events)(struct input_handle *handle,
314 const struct input_value *vals, unsigned int count);
315 bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
316 bool (*match)(struct input_handler *handler, struct input_dev *dev);
317 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
318 void (*disconnect)(struct input_handle *handle);
319 void (*start)(struct input_handle *handle);
320
321 bool legacy_minors;
322 int minor;
323 const char *name;
324
325 const struct input_device_id *id_table;
326
327 struct list_head h_list;
328 struct list_head node;
329
330 ANDROID_KABI_RESERVE(1);
331 };
332
333 /**
334 * struct input_handle - links input device with an input handler
335 * @private: handler-specific data
336 * @open: counter showing whether the handle is 'open', i.e. should deliver
337 * events from its device
338 * @name: name given to the handle by handler that created it
339 * @dev: input device the handle is attached to
340 * @handler: handler that works with the device through this handle
341 * @d_node: used to put the handle on device's list of attached handles
342 * @h_node: used to put the handle on handler's list of handles from which
343 * it gets events
344 */
345 struct input_handle {
346
347 void *private;
348
349 int open;
350 const char *name;
351
352 struct input_dev *dev;
353 struct input_handler *handler;
354
355 struct list_head d_node;
356 struct list_head h_node;
357
358 ANDROID_KABI_RESERVE(1);
359 };
360
361 struct input_dev __must_check *input_allocate_device(void);
362 struct input_dev __must_check *devm_input_allocate_device(struct device *);
363 void input_free_device(struct input_dev *dev);
364
input_get_device(struct input_dev * dev)365 static inline struct input_dev *input_get_device(struct input_dev *dev)
366 {
367 return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
368 }
369
input_put_device(struct input_dev * dev)370 static inline void input_put_device(struct input_dev *dev)
371 {
372 if (dev)
373 put_device(&dev->dev);
374 }
375
input_get_drvdata(struct input_dev * dev)376 static inline void *input_get_drvdata(struct input_dev *dev)
377 {
378 return dev_get_drvdata(&dev->dev);
379 }
380
input_set_drvdata(struct input_dev * dev,void * data)381 static inline void input_set_drvdata(struct input_dev *dev, void *data)
382 {
383 dev_set_drvdata(&dev->dev, data);
384 }
385
386 int __must_check input_register_device(struct input_dev *);
387 void input_unregister_device(struct input_dev *);
388
389 void input_reset_device(struct input_dev *);
390
391 int input_setup_polling(struct input_dev *dev,
392 void (*poll_fn)(struct input_dev *dev));
393 void input_set_poll_interval(struct input_dev *dev, unsigned int interval);
394 void input_set_min_poll_interval(struct input_dev *dev, unsigned int interval);
395 void input_set_max_poll_interval(struct input_dev *dev, unsigned int interval);
396 int input_get_poll_interval(struct input_dev *dev);
397
398 int __must_check input_register_handler(struct input_handler *);
399 void input_unregister_handler(struct input_handler *);
400
401 int __must_check input_get_new_minor(int legacy_base, unsigned int legacy_num,
402 bool allow_dynamic);
403 void input_free_minor(unsigned int minor);
404
405 int input_handler_for_each_handle(struct input_handler *, void *data,
406 int (*fn)(struct input_handle *, void *));
407
408 int input_register_handle(struct input_handle *);
409 void input_unregister_handle(struct input_handle *);
410
411 int input_grab_device(struct input_handle *);
412 void input_release_device(struct input_handle *);
413
414 int input_open_device(struct input_handle *);
415 void input_close_device(struct input_handle *);
416
417 int input_flush_device(struct input_handle *handle, struct file *file);
418
419 void input_set_timestamp(struct input_dev *dev, ktime_t timestamp);
420 ktime_t *input_get_timestamp(struct input_dev *dev);
421
422 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
423 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
424
input_report_key(struct input_dev * dev,unsigned int code,int value)425 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
426 {
427 input_event(dev, EV_KEY, code, !!value);
428 }
429
input_report_rel(struct input_dev * dev,unsigned int code,int value)430 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
431 {
432 input_event(dev, EV_REL, code, value);
433 }
434
input_report_abs(struct input_dev * dev,unsigned int code,int value)435 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
436 {
437 input_event(dev, EV_ABS, code, value);
438 }
439
input_report_ff_status(struct input_dev * dev,unsigned int code,int value)440 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
441 {
442 input_event(dev, EV_FF_STATUS, code, value);
443 }
444
input_report_switch(struct input_dev * dev,unsigned int code,int value)445 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
446 {
447 input_event(dev, EV_SW, code, !!value);
448 }
449
input_sync(struct input_dev * dev)450 static inline void input_sync(struct input_dev *dev)
451 {
452 input_event(dev, EV_SYN, SYN_REPORT, 0);
453 }
454
input_mt_sync(struct input_dev * dev)455 static inline void input_mt_sync(struct input_dev *dev)
456 {
457 input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
458 }
459
460 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
461
462 /**
463 * input_set_events_per_packet - tell handlers about the driver event rate
464 * @dev: the input device used by the driver
465 * @n_events: the average number of events between calls to input_sync()
466 *
467 * If the event rate sent from a device is unusually large, use this
468 * function to set the expected event rate. This will allow handlers
469 * to set up an appropriate buffer size for the event stream, in order
470 * to minimize information loss.
471 */
input_set_events_per_packet(struct input_dev * dev,int n_events)472 static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
473 {
474 dev->hint_events_per_packet = n_events;
475 }
476
477 void input_alloc_absinfo(struct input_dev *dev);
478 void input_set_abs_params(struct input_dev *dev, unsigned int axis,
479 int min, int max, int fuzz, int flat);
480
481 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item) \
482 static inline int input_abs_get_##_suffix(struct input_dev *dev, \
483 unsigned int axis) \
484 { \
485 return dev->absinfo ? dev->absinfo[axis]._item : 0; \
486 } \
487 \
488 static inline void input_abs_set_##_suffix(struct input_dev *dev, \
489 unsigned int axis, int val) \
490 { \
491 input_alloc_absinfo(dev); \
492 if (dev->absinfo) \
493 dev->absinfo[axis]._item = val; \
494 }
495
496 INPUT_GENERATE_ABS_ACCESSORS(val, value)
497 INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
498 INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
499 INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
500 INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
501 INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
502
503 int input_scancode_to_scalar(const struct input_keymap_entry *ke,
504 unsigned int *scancode);
505
506 int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
507 int input_set_keycode(struct input_dev *dev,
508 const struct input_keymap_entry *ke);
509
510 bool input_match_device_id(const struct input_dev *dev,
511 const struct input_device_id *id);
512
513 void input_enable_softrepeat(struct input_dev *dev, int delay, int period);
514
515 extern struct class input_class;
516
517 /**
518 * struct ff_device - force-feedback part of an input device
519 * @upload: Called to upload an new effect into device
520 * @erase: Called to erase an effect from device
521 * @playback: Called to request device to start playing specified effect
522 * @set_gain: Called to set specified gain
523 * @set_autocenter: Called to auto-center device
524 * @destroy: called by input core when parent input device is being
525 * destroyed
526 * @private: driver-specific data, will be freed automatically
527 * @ffbit: bitmap of force feedback capabilities truly supported by
528 * device (not emulated like ones in input_dev->ffbit)
529 * @mutex: mutex for serializing access to the device
530 * @max_effects: maximum number of effects supported by device
531 * @effects: pointer to an array of effects currently loaded into device
532 * @effect_owners: array of effect owners; when file handle owning
533 * an effect gets closed the effect is automatically erased
534 *
535 * Every force-feedback device must implement upload() and playback()
536 * methods; erase() is optional. set_gain() and set_autocenter() need
537 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
538 * bits.
539 *
540 * Note that playback(), set_gain() and set_autocenter() are called with
541 * dev->event_lock spinlock held and interrupts off and thus may not
542 * sleep.
543 */
544 struct ff_device {
545 int (*upload)(struct input_dev *dev, struct ff_effect *effect,
546 struct ff_effect *old);
547 int (*erase)(struct input_dev *dev, int effect_id);
548
549 int (*playback)(struct input_dev *dev, int effect_id, int value);
550 void (*set_gain)(struct input_dev *dev, u16 gain);
551 void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
552
553 void (*destroy)(struct ff_device *);
554
555 void *private;
556
557 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
558
559 struct mutex mutex;
560
561 int max_effects;
562 struct ff_effect *effects;
563
564 ANDROID_KABI_RESERVE(1);
565
566 struct file *effect_owners[];
567 };
568
569 int input_ff_create(struct input_dev *dev, unsigned int max_effects);
570 void input_ff_destroy(struct input_dev *dev);
571
572 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
573
574 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
575 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
576 int input_ff_flush(struct input_dev *dev, struct file *file);
577
578 int input_ff_create_memless(struct input_dev *dev, void *data,
579 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
580
581 #endif
582