]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/input.h
2 * Copyright (c) 1999-2002 Vojtech Pavlik
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
11 #include <linux/time.h>
12 #include <linux/list.h>
13 #include <uapi/linux/input.h>
14 /* Implementation details, userspace should not care about these */
15 #define ABS_MT_FIRST ABS_MT_TOUCH_MAJOR
16 #define ABS_MT_LAST ABS_MT_TOOL_Y
19 * In-kernel definitions.
22 #include <linux/device.h>
24 #include <linux/timer.h>
25 #include <linux/mod_devicetable.h>
28 * struct input_value - input value representation
29 * @type: type of value (EV_KEY, EV_ABS, etc)
30 * @code: the value code
40 * struct input_dev - represents an input device
41 * @name: name of the device
42 * @phys: physical path to the device in the system hierarchy
43 * @uniq: unique identification code for the device (if device has it)
44 * @id: id of the device (struct input_id)
45 * @flags: input device flags (SYNTHETIC, etc.)
46 * @propbit: bitmap of device properties and quirks
47 * @evbit: bitmap of types of events supported by the device (EV_KEY,
49 * @keybit: bitmap of keys/buttons this device has
50 * @relbit: bitmap of relative axes for the device
51 * @absbit: bitmap of absolute axes for the device
52 * @mscbit: bitmap of miscellaneous events supported by the device
53 * @ledbit: bitmap of leds present on the device
54 * @sndbit: bitmap of sound effects supported by the device
55 * @ffbit: bitmap of force feedback effects supported by the device
56 * @swbit: bitmap of switches present on the device
57 * @hint_events_per_packet: average number of events generated by the
58 * device in a packet (between EV_SYN/SYN_REPORT events). Used by
59 * event handlers to estimate size of the buffer needed to hold
61 * @keycodemax: size of keycode table
62 * @keycodesize: size of elements in keycode table
63 * @keycode: map of scancodes to keycodes for this device
64 * @getkeycode: optional legacy method to retrieve current keymap.
65 * @setkeycode: optional method to alter current keymap, used to implement
66 * sparse keymaps. If not supplied default mechanism will be used.
67 * The method is being called while holding event_lock and thus must
69 * @ff: force feedback structure associated with the device if device
70 * supports force feedback effects
71 * @repeat_key: stores key code of the last key pressed; used to implement
73 * @timer: timer for software autorepeat
74 * @rep: current values for autorepeat parameters (delay, rate)
75 * @mt: pointer to multitouch state
76 * @absinfo: array of &struct input_absinfo elements holding information
77 * about absolute axes (current value, min, max, flat, fuzz,
79 * @key: reflects current state of device's keys/buttons
80 * @led: reflects current state of device's LEDs
81 * @snd: reflects current state of sound effects
82 * @sw: reflects current state of device's switches
83 * @open: this method is called when the very first user calls
84 * input_open_device(). The driver must prepare the device
85 * to start generating events (start polling thread,
86 * request an IRQ, submit URB, etc.)
87 * @close: this method is called when the very last user calls
88 * input_close_device().
89 * @flush: purges the device. Most commonly used to get rid of force
90 * feedback effects loaded into the device when disconnecting
92 * @event: event handler for events sent _to_ the device, like EV_LED
93 * or EV_SND. The device is expected to carry out the requested
94 * action (turn on a LED, play sound, etc.) The call is protected
95 * by @event_lock and must not sleep
96 * @grab: input handle that currently has the device grabbed (via
97 * EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
98 * recipient for all input events coming from the device
99 * @event_lock: this spinlock is taken when input core receives
100 * and processes a new event for the device (in input_event()).
101 * Code that accesses and/or modifies parameters of a device
102 * (such as keymap or absmin, absmax, absfuzz, etc.) after device
103 * has been registered with input core must take this lock.
104 * @mutex: serializes calls to open(), close() and flush() methods
105 * @users: stores number of users (input handlers) that opened this
106 * device. It is used by input_open_device() and input_close_device()
107 * to make sure that dev->open() is only called when the first
108 * user opens device and dev->close() is called when the very
109 * last user closes the device
110 * @going_away: marks devices that are in a middle of unregistering and
111 * causes input_open_device*() fail with -ENODEV.
112 * @dev: driver model's view of this device
113 * @h_list: list of input handles associated with the device. When
114 * accessing the list dev->mutex must be held
115 * @node: used to place the device onto input_dev_list
116 * @num_vals: number of values queued in the current frame
117 * @max_vals: maximum number of values queued in a frame
118 * @vals: array of values queued in the current frame
119 * @devres_managed: indicates that devices is managed with devres framework
120 * and needs not be explicitly unregistered or freed.
130 unsigned long propbit
[BITS_TO_LONGS(INPUT_PROP_CNT
)];
132 unsigned long evbit
[BITS_TO_LONGS(EV_CNT
)];
133 unsigned long keybit
[BITS_TO_LONGS(KEY_CNT
)];
134 unsigned long relbit
[BITS_TO_LONGS(REL_CNT
)];
135 unsigned long absbit
[BITS_TO_LONGS(ABS_CNT
)];
136 unsigned long mscbit
[BITS_TO_LONGS(MSC_CNT
)];
137 unsigned long ledbit
[BITS_TO_LONGS(LED_CNT
)];
138 unsigned long sndbit
[BITS_TO_LONGS(SND_CNT
)];
139 unsigned long ffbit
[BITS_TO_LONGS(FF_CNT
)];
140 unsigned long swbit
[BITS_TO_LONGS(SW_CNT
)];
142 unsigned int hint_events_per_packet
;
144 unsigned int keycodemax
;
145 unsigned int keycodesize
;
148 int (*setkeycode
)(struct input_dev
*dev
,
149 const struct input_keymap_entry
*ke
,
150 unsigned int *old_keycode
);
151 int (*getkeycode
)(struct input_dev
*dev
,
152 struct input_keymap_entry
*ke
);
154 struct ff_device
*ff
;
156 unsigned int repeat_key
;
157 struct timer_list timer
;
163 struct input_absinfo
*absinfo
;
165 unsigned long key
[BITS_TO_LONGS(KEY_CNT
)];
166 unsigned long led
[BITS_TO_LONGS(LED_CNT
)];
167 unsigned long snd
[BITS_TO_LONGS(SND_CNT
)];
168 unsigned long sw
[BITS_TO_LONGS(SW_CNT
)];
170 int (*open
)(struct input_dev
*dev
);
171 void (*close
)(struct input_dev
*dev
);
172 int (*flush
)(struct input_dev
*dev
, struct file
*file
);
173 int (*event
)(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
175 struct input_handle __rcu
*grab
;
177 spinlock_t event_lock
;
185 struct list_head h_list
;
186 struct list_head node
;
188 unsigned int num_vals
;
189 unsigned int max_vals
;
190 struct input_value
*vals
;
194 #define to_input_dev(d) container_of(d, struct input_dev, dev)
196 #define INPUTDEV_FLAGS_SYNTHETIC 0x000000001
199 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
202 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
203 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
206 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
207 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
210 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
211 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
214 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
215 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
218 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
219 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
222 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
223 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
226 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
227 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
230 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
231 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
234 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
235 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
238 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
239 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
242 #if INPUT_PROP_MAX != INPUT_DEVICE_ID_PROP_MAX
243 #error "INPUT_PROP_MAX and INPUT_DEVICE_ID_PROP_MAX do not match"
246 #define INPUT_DEVICE_ID_MATCH_DEVICE \
247 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
248 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
249 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
254 * struct input_handler - implements one of interfaces for input devices
255 * @private: driver-specific data
256 * @event: event handler. This method is being called by input core with
257 * interrupts disabled and dev->event_lock spinlock held and so
259 * @events: event sequence handler. This method is being called by
260 * input core with interrupts disabled and dev->event_lock
261 * spinlock held and so it may not sleep
262 * @filter: similar to @event; separates normal event handlers from
264 * @match: called after comparing device's id with handler's id_table
265 * to perform fine-grained matching between device and handler
266 * @connect: called when attaching a handler to an input device
267 * @disconnect: disconnects a handler from input device
268 * @start: starts handler for given handle. This function is called by
269 * input core right after connect() method and also when a process
270 * that "grabbed" a device releases it
271 * @legacy_minors: set to %true by drivers using legacy minor ranges
272 * @minor: beginning of range of 32 legacy minors for devices this driver
274 * @name: name of the handler, to be shown in /proc/bus/input/handlers
275 * @id_table: pointer to a table of input_device_ids this driver can
277 * @h_list: list of input handles associated with the handler
278 * @node: for placing the driver onto input_handler_list
280 * Input handlers attach to input devices and create input handles. There
281 * are likely several handlers attached to any given input device at the
282 * same time. All of them will get their copy of input event generated by
285 * The very same structure is used to implement input filters. Input core
286 * allows filters to run first and will not pass event to regular handlers
287 * if any of the filters indicate that the event should be filtered (by
288 * returning %true from their filter() method).
290 * Note that input core serializes calls to connect() and disconnect()
293 struct input_handler
{
297 void (*event
)(struct input_handle
*handle
, unsigned int type
, unsigned int code
, int value
);
298 void (*events
)(struct input_handle
*handle
,
299 const struct input_value
*vals
, unsigned int count
);
300 bool (*filter
)(struct input_handle
*handle
, unsigned int type
, unsigned int code
, int value
);
301 bool (*match
)(struct input_handler
*handler
, struct input_dev
*dev
);
302 int (*connect
)(struct input_handler
*handler
, struct input_dev
*dev
, const struct input_device_id
*id
);
303 void (*disconnect
)(struct input_handle
*handle
);
304 void (*start
)(struct input_handle
*handle
);
310 const struct input_device_id
*id_table
;
312 struct list_head h_list
;
313 struct list_head node
;
317 * struct input_handle - links input device with an input handler
318 * @private: handler-specific data
319 * @open: counter showing whether the handle is 'open', i.e. should deliver
320 * events from its device
321 * @name: name given to the handle by handler that created it
322 * @dev: input device the handle is attached to
323 * @handler: handler that works with the device through this handle
324 * @d_node: used to put the handle on device's list of attached handles
325 * @h_node: used to put the handle on handler's list of handles from which
328 struct input_handle
{
335 struct input_dev
*dev
;
336 struct input_handler
*handler
;
338 struct list_head d_node
;
339 struct list_head h_node
;
342 struct input_dev __must_check
*input_allocate_device(void);
343 struct input_dev __must_check
*devm_input_allocate_device(struct device
*);
344 void input_free_device(struct input_dev
*dev
);
346 static inline struct input_dev
*input_get_device(struct input_dev
*dev
)
348 return dev
? to_input_dev(get_device(&dev
->dev
)) : NULL
;
351 static inline void input_put_device(struct input_dev
*dev
)
354 put_device(&dev
->dev
);
357 static inline void *input_get_drvdata(struct input_dev
*dev
)
359 return dev_get_drvdata(&dev
->dev
);
362 static inline void input_set_drvdata(struct input_dev
*dev
, void *data
)
364 dev_set_drvdata(&dev
->dev
, data
);
367 int __must_check
input_register_device(struct input_dev
*);
368 void input_unregister_device(struct input_dev
*);
370 void input_reset_device(struct input_dev
*);
372 int __must_check
input_register_handler(struct input_handler
*);
373 void input_unregister_handler(struct input_handler
*);
375 int __must_check
input_get_new_minor(int legacy_base
, unsigned int legacy_num
,
377 void input_free_minor(unsigned int minor
);
379 int input_handler_for_each_handle(struct input_handler
*, void *data
,
380 int (*fn
)(struct input_handle
*, void *));
382 int input_register_handle(struct input_handle
*);
383 void input_unregister_handle(struct input_handle
*);
385 int input_grab_device(struct input_handle
*);
386 void input_release_device(struct input_handle
*);
388 int input_open_device(struct input_handle
*);
389 void input_close_device(struct input_handle
*);
391 int input_flush_device(struct input_handle
*handle
, struct file
*file
);
393 void input_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
394 void input_inject_event(struct input_handle
*handle
, unsigned int type
, unsigned int code
, int value
);
396 static inline void input_report_key(struct input_dev
*dev
, unsigned int code
, int value
)
398 input_event(dev
, EV_KEY
, code
, !!value
);
401 static inline void input_report_rel(struct input_dev
*dev
, unsigned int code
, int value
)
403 input_event(dev
, EV_REL
, code
, value
);
406 static inline void input_report_abs(struct input_dev
*dev
, unsigned int code
, int value
)
408 input_event(dev
, EV_ABS
, code
, value
);
411 static inline void input_report_ff_status(struct input_dev
*dev
, unsigned int code
, int value
)
413 input_event(dev
, EV_FF_STATUS
, code
, value
);
416 static inline void input_report_switch(struct input_dev
*dev
, unsigned int code
, int value
)
418 input_event(dev
, EV_SW
, code
, !!value
);
421 static inline void input_sync(struct input_dev
*dev
)
423 input_event(dev
, EV_SYN
, SYN_REPORT
, 0);
426 static inline void input_mt_sync(struct input_dev
*dev
)
428 input_event(dev
, EV_SYN
, SYN_MT_REPORT
, 0);
431 void input_set_capability(struct input_dev
*dev
, unsigned int type
, unsigned int code
);
434 * input_set_events_per_packet - tell handlers about the driver event rate
435 * @dev: the input device used by the driver
436 * @n_events: the average number of events between calls to input_sync()
438 * If the event rate sent from a device is unusually large, use this
439 * function to set the expected event rate. This will allow handlers
440 * to set up an appropriate buffer size for the event stream, in order
441 * to minimize information loss.
443 static inline void input_set_events_per_packet(struct input_dev
*dev
, int n_events
)
445 dev
->hint_events_per_packet
= n_events
;
448 void input_alloc_absinfo(struct input_dev
*dev
);
449 void input_set_abs_params(struct input_dev
*dev
, unsigned int axis
,
450 int min
, int max
, int fuzz
, int flat
);
452 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item) \
453 static inline int input_abs_get_##_suffix(struct input_dev *dev, \
456 return dev->absinfo ? dev->absinfo[axis]._item : 0; \
459 static inline void input_abs_set_##_suffix(struct input_dev *dev, \
460 unsigned int axis, int val) \
462 input_alloc_absinfo(dev); \
464 dev->absinfo[axis]._item = val; \
467 INPUT_GENERATE_ABS_ACCESSORS(val
, value
)
468 INPUT_GENERATE_ABS_ACCESSORS(min
, minimum
)
469 INPUT_GENERATE_ABS_ACCESSORS(max
, maximum
)
470 INPUT_GENERATE_ABS_ACCESSORS(fuzz
, fuzz
)
471 INPUT_GENERATE_ABS_ACCESSORS(flat
, flat
)
472 INPUT_GENERATE_ABS_ACCESSORS(res
, resolution
)
474 int input_scancode_to_scalar(const struct input_keymap_entry
*ke
,
475 unsigned int *scancode
);
477 int input_get_keycode(struct input_dev
*dev
, struct input_keymap_entry
*ke
);
478 int input_set_keycode(struct input_dev
*dev
,
479 const struct input_keymap_entry
*ke
);
481 bool input_match_device_id(const struct input_dev
*dev
,
482 const struct input_device_id
*id
);
484 void input_enable_softrepeat(struct input_dev
*dev
, int delay
, int period
);
486 extern struct class input_class
;
489 * struct ff_device - force-feedback part of an input device
490 * @upload: Called to upload an new effect into device
491 * @erase: Called to erase an effect from device
492 * @playback: Called to request device to start playing specified effect
493 * @set_gain: Called to set specified gain
494 * @set_autocenter: Called to auto-center device
495 * @destroy: called by input core when parent input device is being
497 * @private: driver-specific data, will be freed automatically
498 * @ffbit: bitmap of force feedback capabilities truly supported by
499 * device (not emulated like ones in input_dev->ffbit)
500 * @mutex: mutex for serializing access to the device
501 * @max_effects: maximum number of effects supported by device
502 * @effects: pointer to an array of effects currently loaded into device
503 * @effect_owners: array of effect owners; when file handle owning
504 * an effect gets closed the effect is automatically erased
506 * Every force-feedback device must implement upload() and playback()
507 * methods; erase() is optional. set_gain() and set_autocenter() need
508 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
511 * Note that playback(), set_gain() and set_autocenter() are called with
512 * dev->event_lock spinlock held and interrupts off and thus may not
516 int (*upload
)(struct input_dev
*dev
, struct ff_effect
*effect
,
517 struct ff_effect
*old
);
518 int (*erase
)(struct input_dev
*dev
, int effect_id
);
520 int (*playback
)(struct input_dev
*dev
, int effect_id
, int value
);
521 void (*set_gain
)(struct input_dev
*dev
, u16 gain
);
522 void (*set_autocenter
)(struct input_dev
*dev
, u16 magnitude
);
524 void (*destroy
)(struct ff_device
*);
528 unsigned long ffbit
[BITS_TO_LONGS(FF_CNT
)];
533 struct ff_effect
*effects
;
534 struct file
*effect_owners
[];
537 int input_ff_create(struct input_dev
*dev
, unsigned int max_effects
);
538 void input_ff_destroy(struct input_dev
*dev
);
540 int input_ff_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
542 int input_ff_upload(struct input_dev
*dev
, struct ff_effect
*effect
, struct file
*file
);
543 int input_ff_erase(struct input_dev
*dev
, int effect_id
, struct file
*file
);
544 int input_ff_flush(struct input_dev
*dev
, struct file
*file
);
546 int input_ff_create_memless(struct input_dev
*dev
, void *data
,
547 int (*play_effect
)(struct input_dev
*, void *, struct ff_effect
*));