Version:  2.0.40 2.2.26 2.4.37 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10

Linux/include/linux/input.h

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

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us