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  * @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,
  48  *      EV_REL, etc.)
  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
  60  *      events.
  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
  68  *      not sleep
  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
  72  *      software autorepeat
  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,
  78  *      resolution)
  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
  91  *      from it
  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.
 121  */
 122 struct input_dev {
 123         const char *name;
 124         const char *phys;
 125         const char *uniq;
 126         struct input_id id;
 127
 128         unsigned int flags;
 129
 130         unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
 131
 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)];
 141
 142         unsigned int hint_events_per_packet;
 143
 144         unsigned int keycodemax;
 145         unsigned int keycodesize;
 146         void *keycode;
 147
 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);
 153
 154         struct ff_device *ff;
 155
 156         unsigned int repeat_key;
 157         struct timer_list timer;
 158
 159         int rep[REP_CNT];
 160
 161         struct input_mt *mt;
 162
 163         struct input_absinfo *absinfo;
 164
 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)];
 169
 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);
 174
 175         struct input_handle __rcu *grab;
 176
 177         spinlock_t event_lock;
 178         struct mutex mutex;
 179
 180         unsigned int users;
 181         bool going_away;
 182
 183         struct device dev;
 184
 185         struct list_head        h_list;
 186         struct list_head        node;
 187
 188         unsigned int num_vals;
 189         unsigned int max_vals;
 190         struct input_value *vals;
 191
 192         bool devres_managed;
 193 };
 194 #define to_input_dev(d) container_of(d, struct input_dev, dev)
 195
 196 #define INPUTDEV_FLAGS_SYNTHETIC        0x000000001
 197
 198 /*
 199  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
 200  */
 201
 202 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
 203 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
 204 #endif
 205
 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"
 208 #endif
 209
 210 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
 211 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
 212 #endif
 213
 214 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
 215 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
 216 #endif
 217
 218 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
 219 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
 220 #endif
 221
 222 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
 223 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
 224 #endif
 225
 226 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
 227 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
 228 #endif
 229
 230 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
 231 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
 232 #endif
 233
 234 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
 235 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
 236 #endif
 237
 238 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
 239 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
 240 #endif
 241
 242 #define INPUT_DEVICE_ID_MATCH_DEVICE \
 243         (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
 244 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
 245         (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
 246
 247 struct input_handle;
 248
 249 /**
 250  * struct input_handler - implements one of interfaces for input devices
 251  * @private: driver-specific data
 252  * @event: event handler. This method is being called by input core with
 253  *      interrupts disabled and dev->event_lock spinlock held and so
 254  *      it may not sleep
 255  * @events: event sequence handler. This method is being called by
 256  *      input core with interrupts disabled and dev->event_lock
 257  *      spinlock held and so it may not sleep
 258  * @filter: similar to @event; separates normal event handlers from
 259  *      "filters".
 260  * @match: called after comparing device's id with handler's id_table
 261  *      to perform fine-grained matching between device and handler
 262  * @connect: called when attaching a handler to an input device
 263  * @disconnect: disconnects a handler from input device
 264  * @start: starts handler for given handle. This function is called by
 265  *      input core right after connect() method and also when a process
 266  *      that "grabbed" a device releases it
 267  * @legacy_minors: set to %true by drivers using legacy minor ranges
 268  * @minor: beginning of range of 32 legacy minors for devices this driver
 269  *      can provide
 270  * @name: name of the handler, to be shown in /proc/bus/input/handlers
 271  * @id_table: pointer to a table of input_device_ids this driver can
 272  *      handle
 273  * @h_list: list of input handles associated with the handler
 274  * @node: for placing the driver onto input_handler_list
 275  *
 276  * Input handlers attach to input devices and create input handles. There
 277  * are likely several handlers attached to any given input device at the
 278  * same time. All of them will get their copy of input event generated by
 279  * the device.
 280  *
 281  * The very same structure is used to implement input filters. Input core
 282  * allows filters to run first and will not pass event to regular handlers
 283  * if any of the filters indicate that the event should be filtered (by
 284  * returning %true from their filter() method).
 285  *
 286  * Note that input core serializes calls to connect() and disconnect()
 287  * methods.
 288  */
 289 struct input_handler {
 290
 291         void *private;
 292
 293         void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
 294         void (*events)(struct input_handle *handle,
 295                        const struct input_value *vals, unsigned int count);
 296         bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
 297         bool (*match)(struct input_handler *handler, struct input_dev *dev);
 298         int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
 299         void (*disconnect)(struct input_handle *handle);
 300         void (*start)(struct input_handle *handle);
 301
 302         bool legacy_minors;
 303         int minor;
 304         const char *name;
 305
 306         const struct input_device_id *id_table;
 307
 308         struct list_head        h_list;
 309         struct list_head        node;
 310 };
 311
 312 /**
 313  * struct input_handle - links input device with an input handler
 314  * @private: handler-specific data
 315  * @open: counter showing whether the handle is 'open', i.e. should deliver
 316  *      events from its device
 317  * @name: name given to the handle by handler that created it
 318  * @dev: input device the handle is attached to
 319  * @handler: handler that works with the device through this handle
 320  * @d_node: used to put the handle on device's list of attached handles
 321  * @h_node: used to put the handle on handler's list of handles from which
 322  *      it gets events
 323  */
 324 struct input_handle {
 325
 326         void *private;
 327
 328         int open;
 329         const char *name;
 330
 331         struct input_dev *dev;
 332         struct input_handler *handler;
 333
 334         struct list_head        d_node;
 335         struct list_head        h_node;
 336 };
 337
 338 struct input_dev __must_check *input_allocate_device(void);
 339 struct input_dev __must_check *devm_input_allocate_device(struct device *);
 340 void input_free_device(struct input_dev *dev);
 341
 342 static inline struct input_dev *input_get_device(struct input_dev *dev)
 343 {
 344         return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
 345 }
 346
 347 static inline void input_put_device(struct input_dev *dev)
 348 {
 349         if (dev)
 350                 put_device(&dev->dev);
 351 }
 352
 353 static inline void *input_get_drvdata(struct input_dev *dev)
 354 {
 355         return dev_get_drvdata(&dev->dev);
 356 }
 357
 358 static inline void input_set_drvdata(struct input_dev *dev, void *data)
 359 {
 360         dev_set_drvdata(&dev->dev, data);
 361 }
 362
 363 int __must_check input_register_device(struct input_dev *);
 364 void input_unregister_device(struct input_dev *);
 365
 366 void input_reset_device(struct input_dev *);
 367
 368 int __must_check input_register_handler(struct input_handler *);
 369 void input_unregister_handler(struct input_handler *);
 370
 371 int __must_check input_get_new_minor(int legacy_base, unsigned int legacy_num,
 372                                      bool allow_dynamic);
 373 void input_free_minor(unsigned int minor);
 374
 375 int input_handler_for_each_handle(struct input_handler *, void *data,
 376                                   int (*fn)(struct input_handle *, void *));
 377
 378 int input_register_handle(struct input_handle *);
 379 void input_unregister_handle(struct input_handle *);
 380
 381 int input_grab_device(struct input_handle *);
 382 void input_release_device(struct input_handle *);
 383
 384 int input_open_device(struct input_handle *);
 385 void input_close_device(struct input_handle *);
 386
 387 int input_flush_device(struct input_handle *handle, struct file *file);
 388
 389 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
 390 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
 391
 392 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
 393 {
 394         input_event(dev, EV_KEY, code, !!value);
 395 }
 396
 397 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
 398 {
 399         input_event(dev, EV_REL, code, value);
 400 }
 401
 402 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
 403 {
 404         input_event(dev, EV_ABS, code, value);
 405 }
 406
 407 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
 408 {
 409         input_event(dev, EV_FF_STATUS, code, value);
 410 }
 411
 412 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
 413 {
 414         input_event(dev, EV_SW, code, !!value);
 415 }
 416
 417 static inline void input_sync(struct input_dev *dev)
 418 {
 419         input_event(dev, EV_SYN, SYN_REPORT, 0);
 420 }
 421
 422 static inline void input_mt_sync(struct input_dev *dev)
 423 {
 424         input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
 425 }
 426
 427 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
 428
 429 /**
 430  * input_set_events_per_packet - tell handlers about the driver event rate
 431  * @dev: the input device used by the driver
 432  * @n_events: the average number of events between calls to input_sync()
 433  *
 434  * If the event rate sent from a device is unusually large, use this
 435  * function to set the expected event rate. This will allow handlers
 436  * to set up an appropriate buffer size for the event stream, in order
 437  * to minimize information loss.
 438  */
 439 static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
 440 {
 441         dev->hint_events_per_packet = n_events;
 442 }
 443
 444 void input_alloc_absinfo(struct input_dev *dev);
 445 void input_set_abs_params(struct input_dev *dev, unsigned int axis,
 446                           int min, int max, int fuzz, int flat);
 447
 448 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item)                    \
 449 static inline int input_abs_get_##_suffix(struct input_dev *dev,        \
 450                                           unsigned int axis)            \
 451 {                                                                       \
 452         return dev->absinfo ? dev->absinfo[axis]._item : 0;             \
 453 }                                                                       \
 454                                                                         \
 455 static inline void input_abs_set_##_suffix(struct input_dev *dev,       \
 456                                            unsigned int axis, int val)  \
 457 {                                                                       \
 458         input_alloc_absinfo(dev);                                       \
 459         if (dev->absinfo)                                               \
 460                 dev->absinfo[axis]._item = val;                         \
 461 }
 462
 463 INPUT_GENERATE_ABS_ACCESSORS(val, value)
 464 INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
 465 INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
 466 INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
 467 INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
 468 INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
 469
 470 int input_scancode_to_scalar(const struct input_keymap_entry *ke,
 471                              unsigned int *scancode);
 472
 473 int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
 474 int input_set_keycode(struct input_dev *dev,
 475                       const struct input_keymap_entry *ke);
 476
 477 void input_enable_softrepeat(struct input_dev *dev, int delay, int period);
 478
 479 extern struct class input_class;
 480
 481 /**
 482  * struct ff_device - force-feedback part of an input device
 483  * @upload: Called to upload an new effect into device
 484  * @erase: Called to erase an effect from device
 485  * @playback: Called to request device to start playing specified effect
 486  * @set_gain: Called to set specified gain
 487  * @set_autocenter: Called to auto-center device
 488  * @destroy: called by input core when parent input device is being
 489  *      destroyed
 490  * @private: driver-specific data, will be freed automatically
 491  * @ffbit: bitmap of force feedback capabilities truly supported by
 492  *      device (not emulated like ones in input_dev->ffbit)
 493  * @mutex: mutex for serializing access to the device
 494  * @max_effects: maximum number of effects supported by device
 495  * @effects: pointer to an array of effects currently loaded into device
 496  * @effect_owners: array of effect owners; when file handle owning
 497  *      an effect gets closed the effect is automatically erased
 498  *
 499  * Every force-feedback device must implement upload() and playback()
 500  * methods; erase() is optional. set_gain() and set_autocenter() need
 501  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
 502  * bits.
 503  *
 504  * Note that playback(), set_gain() and set_autocenter() are called with
 505  * dev->event_lock spinlock held and interrupts off and thus may not
 506  * sleep.
 507  */
 508 struct ff_device {
 509         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
 510                       struct ff_effect *old);
 511         int (*erase)(struct input_dev *dev, int effect_id);
 512
 513         int (*playback)(struct input_dev *dev, int effect_id, int value);
 514         void (*set_gain)(struct input_dev *dev, u16 gain);
 515         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
 516
 517         void (*destroy)(struct ff_device *);
 518
 519         void *private;
 520
 521         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
 522
 523         struct mutex mutex;
 524
 525         int max_effects;
 526         struct ff_effect *effects;
 527         struct file *effect_owners[];
 528 };
 529
 530 int input_ff_create(struct input_dev *dev, unsigned int max_effects);
 531 void input_ff_destroy(struct input_dev *dev);
 532
 533 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
 534
 535 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
 536 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
 537
 538 int input_ff_create_memless(struct input_dev *dev, void *data,
 539                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
 540
 541 #endif