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