input.h

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