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