Merge branch 'next' into for-linus
[linux-2.6-block.git] / drivers / input / input.c
CommitLineData
1da177e4
LT
1/*
2 * The input core
3 *
4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 */
6
7/*
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published by
10 * the Free Software Foundation.
11 */
12
da0c4901
JP
13#define pr_fmt(fmt) KBUILD_BASENAME ": " fmt
14
1da177e4 15#include <linux/init.h>
ffd0db97 16#include <linux/types.h>
7f8d4cad 17#include <linux/idr.h>
47c78e89 18#include <linux/input/mt.h>
1da177e4 19#include <linux/module.h>
5a0e3ad6 20#include <linux/slab.h>
1da177e4
LT
21#include <linux/random.h>
22#include <linux/major.h>
23#include <linux/proc_fs.h>
a99bbaf5 24#include <linux/sched.h>
969b21cd 25#include <linux/seq_file.h>
1da177e4
LT
26#include <linux/poll.h>
27#include <linux/device.h>
e676c232 28#include <linux/mutex.h>
8006479c 29#include <linux/rcupdate.h>
15e184af 30#include "input-compat.h"
1da177e4
LT
31
32MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
33MODULE_DESCRIPTION("Input core");
34MODULE_LICENSE("GPL");
35
7f8d4cad
DT
36#define INPUT_MAX_CHAR_DEVICES 1024
37#define INPUT_FIRST_DYNAMIC_DEV 256
38static DEFINE_IDA(input_ida);
1da177e4
LT
39
40static LIST_HEAD(input_dev_list);
41static LIST_HEAD(input_handler_list);
42
8006479c
DT
43/*
44 * input_mutex protects access to both input_dev_list and input_handler_list.
45 * This also causes input_[un]register_device and input_[un]register_handler
46 * be mutually exclusive which simplifies locking in drivers implementing
47 * input handlers.
48 */
49static DEFINE_MUTEX(input_mutex);
50
4369c64c
HR
51static const struct input_value input_value_sync = { EV_SYN, SYN_REPORT, 1 };
52
8006479c
DT
53static inline int is_event_supported(unsigned int code,
54 unsigned long *bm, unsigned int max)
1da177e4 55{
8006479c
DT
56 return code <= max && test_bit(code, bm);
57}
1da177e4 58
8006479c
DT
59static int input_defuzz_abs_event(int value, int old_val, int fuzz)
60{
61 if (fuzz) {
62 if (value > old_val - fuzz / 2 && value < old_val + fuzz / 2)
63 return old_val;
1da177e4 64
8006479c
DT
65 if (value > old_val - fuzz && value < old_val + fuzz)
66 return (old_val * 3 + value) / 4;
1da177e4 67
8006479c
DT
68 if (value > old_val - fuzz * 2 && value < old_val + fuzz * 2)
69 return (old_val + value) / 2;
70 }
1da177e4 71
8006479c
DT
72 return value;
73}
1da177e4 74
352ac4bd
HR
75static void input_start_autorepeat(struct input_dev *dev, int code)
76{
77 if (test_bit(EV_REP, dev->evbit) &&
78 dev->rep[REP_PERIOD] && dev->rep[REP_DELAY] &&
79 dev->timer.data) {
80 dev->repeat_key = code;
81 mod_timer(&dev->timer,
82 jiffies + msecs_to_jiffies(dev->rep[REP_DELAY]));
83 }
84}
85
86static void input_stop_autorepeat(struct input_dev *dev)
87{
88 del_timer(&dev->timer);
89}
90
8006479c 91/*
ef7995f4
DT
92 * Pass event first through all filters and then, if event has not been
93 * filtered out, through all open handles. This function is called with
82ba56c2 94 * dev->event_lock held and interrupts disabled.
8006479c 95 */
4369c64c
HR
96static unsigned int input_to_handler(struct input_handle *handle,
97 struct input_value *vals, unsigned int count)
8006479c 98{
4369c64c
HR
99 struct input_handler *handler = handle->handler;
100 struct input_value *end = vals;
101 struct input_value *v;
82ba56c2 102
4369c64c
HR
103 for (v = vals; v != vals + count; v++) {
104 if (handler->filter &&
105 handler->filter(handle, v->type, v->code, v->value))
106 continue;
107 if (end != v)
108 *end = *v;
109 end++;
110 }
1da177e4 111
4369c64c
HR
112 count = end - vals;
113 if (!count)
114 return 0;
ef7995f4 115
4369c64c
HR
116 if (handler->events)
117 handler->events(handle, vals, count);
118 else if (handler->event)
119 for (v = vals; v != end; v++)
120 handler->event(handle, v->type, v->code, v->value);
ef7995f4 121
4369c64c
HR
122 return count;
123}
ef7995f4 124
4369c64c
HR
125/*
126 * Pass values first through all filters and then, if event has not been
127 * filtered out, through all open handles. This function is called with
128 * dev->event_lock held and interrupts disabled.
129 */
130static void input_pass_values(struct input_dev *dev,
131 struct input_value *vals, unsigned int count)
8006479c 132{
82ba56c2 133 struct input_handle *handle;
4369c64c 134 struct input_value *v;
ef7995f4 135
4369c64c
HR
136 if (!count)
137 return;
82ba56c2
DT
138
139 rcu_read_lock();
1da177e4 140
82ba56c2 141 handle = rcu_dereference(dev->grab);
4369c64c
HR
142 if (handle) {
143 count = input_to_handler(handle, vals, count);
144 } else {
145 list_for_each_entry_rcu(handle, &dev->h_list, d_node)
146 if (handle->open)
147 count = input_to_handler(handle, vals, count);
ef7995f4 148 }
ef7995f4 149
82ba56c2 150 rcu_read_unlock();
ef7995f4 151
4369c64c 152 add_input_randomness(vals->type, vals->code, vals->value);
ef7995f4 153
352ac4bd 154 /* trigger auto repeat for key events */
4369c64c
HR
155 for (v = vals; v != vals + count; v++) {
156 if (v->type == EV_KEY && v->value != 2) {
157 if (v->value)
158 input_start_autorepeat(dev, v->code);
159 else
160 input_stop_autorepeat(dev);
ef7995f4
DT
161 }
162 }
4369c64c 163}
ef7995f4 164
4369c64c
HR
165static void input_pass_event(struct input_dev *dev,
166 unsigned int type, unsigned int code, int value)
167{
168 struct input_value vals[] = { { type, code, value } };
169
170 input_pass_values(dev, vals, ARRAY_SIZE(vals));
8006479c 171}
1da177e4 172
8006479c
DT
173/*
174 * Generate software autorepeat event. Note that we take
175 * dev->event_lock here to avoid racing with input_event
176 * which may cause keys get "stuck".
177 */
178static void input_repeat_key(unsigned long data)
179{
180 struct input_dev *dev = (void *) data;
181 unsigned long flags;
1da177e4 182
8006479c 183 spin_lock_irqsave(&dev->event_lock, flags);
1da177e4 184
8006479c
DT
185 if (test_bit(dev->repeat_key, dev->key) &&
186 is_event_supported(dev->repeat_key, dev->keybit, KEY_MAX)) {
4369c64c
HR
187 struct input_value vals[] = {
188 { EV_KEY, dev->repeat_key, 2 },
189 input_value_sync
190 };
1da177e4 191
4369c64c 192 input_pass_values(dev, vals, ARRAY_SIZE(vals));
31581066 193
8006479c
DT
194 if (dev->rep[REP_PERIOD])
195 mod_timer(&dev->timer, jiffies +
196 msecs_to_jiffies(dev->rep[REP_PERIOD]));
197 }
31581066 198
8006479c
DT
199 spin_unlock_irqrestore(&dev->event_lock, flags);
200}
31581066 201
8006479c
DT
202#define INPUT_IGNORE_EVENT 0
203#define INPUT_PASS_TO_HANDLERS 1
204#define INPUT_PASS_TO_DEVICE 2
4369c64c
HR
205#define INPUT_SLOT 4
206#define INPUT_FLUSH 8
8006479c 207#define INPUT_PASS_TO_ALL (INPUT_PASS_TO_HANDLERS | INPUT_PASS_TO_DEVICE)
1da177e4 208
40d007e7
HR
209static int input_handle_abs_event(struct input_dev *dev,
210 unsigned int code, int *pval)
211{
8d18fba2 212 struct input_mt *mt = dev->mt;
40d007e7
HR
213 bool is_mt_event;
214 int *pold;
215
216 if (code == ABS_MT_SLOT) {
217 /*
218 * "Stage" the event; we'll flush it later, when we
144c0f88 219 * get actual touch data.
40d007e7 220 */
8d18fba2
HR
221 if (mt && *pval >= 0 && *pval < mt->num_slots)
222 mt->slot = *pval;
40d007e7
HR
223
224 return INPUT_IGNORE_EVENT;
225 }
226
b89529a1 227 is_mt_event = input_is_mt_value(code);
40d007e7
HR
228
229 if (!is_mt_event) {
d31b2865 230 pold = &dev->absinfo[code].value;
8d18fba2
HR
231 } else if (mt) {
232 pold = &mt->slots[mt->slot].abs[code - ABS_MT_FIRST];
40d007e7
HR
233 } else {
234 /*
144c0f88 235 * Bypass filtering for multi-touch events when
40d007e7
HR
236 * not employing slots.
237 */
238 pold = NULL;
239 }
240
241 if (pold) {
242 *pval = input_defuzz_abs_event(*pval, *pold,
d31b2865 243 dev->absinfo[code].fuzz);
40d007e7
HR
244 if (*pold == *pval)
245 return INPUT_IGNORE_EVENT;
246
247 *pold = *pval;
248 }
249
250 /* Flush pending "slot" event */
8d18fba2
HR
251 if (is_mt_event && mt && mt->slot != input_abs_get_val(dev, ABS_MT_SLOT)) {
252 input_abs_set_val(dev, ABS_MT_SLOT, mt->slot);
4369c64c 253 return INPUT_PASS_TO_HANDLERS | INPUT_SLOT;
40d007e7
HR
254 }
255
256 return INPUT_PASS_TO_HANDLERS;
257}
258
4369c64c 259static int input_get_disposition(struct input_dev *dev,
50c5d36d 260 unsigned int type, unsigned int code, int *pval)
8006479c
DT
261{
262 int disposition = INPUT_IGNORE_EVENT;
50c5d36d 263 int value = *pval;
1da177e4 264
8006479c 265 switch (type) {
1da177e4 266
8006479c
DT
267 case EV_SYN:
268 switch (code) {
269 case SYN_CONFIG:
270 disposition = INPUT_PASS_TO_ALL;
271 break;
1da177e4 272
8006479c 273 case SYN_REPORT:
4369c64c 274 disposition = INPUT_PASS_TO_HANDLERS | INPUT_FLUSH;
1da177e4 275 break;
5e5ee686 276 case SYN_MT_REPORT:
5e5ee686
HR
277 disposition = INPUT_PASS_TO_HANDLERS;
278 break;
8006479c
DT
279 }
280 break;
1da177e4 281
8006479c 282 case EV_KEY:
0672120a 283 if (is_event_supported(code, dev->keybit, KEY_MAX)) {
1da177e4 284
0672120a
HR
285 /* auto-repeat bypasses state updates */
286 if (value == 2) {
287 disposition = INPUT_PASS_TO_HANDLERS;
288 break;
8006479c 289 }
1da177e4 290
0672120a 291 if (!!test_bit(code, dev->key) != !!value) {
1da177e4 292
8006479c 293 __change_bit(code, dev->key);
0672120a 294 disposition = INPUT_PASS_TO_HANDLERS;
8006479c 295 }
8006479c
DT
296 }
297 break;
1da177e4 298
8006479c
DT
299 case EV_SW:
300 if (is_event_supported(code, dev->swbit, SW_MAX) &&
0672120a 301 !!test_bit(code, dev->sw) != !!value) {
1da177e4 302
8006479c
DT
303 __change_bit(code, dev->sw);
304 disposition = INPUT_PASS_TO_HANDLERS;
305 }
306 break;
1da177e4 307
8006479c 308 case EV_ABS:
40d007e7 309 if (is_event_supported(code, dev->absbit, ABS_MAX))
9ae4345a 310 disposition = input_handle_abs_event(dev, code, &value);
61994a61 311
8006479c 312 break;
1da177e4 313
8006479c
DT
314 case EV_REL:
315 if (is_event_supported(code, dev->relbit, REL_MAX) && value)
316 disposition = INPUT_PASS_TO_HANDLERS;
1da177e4 317
8006479c 318 break;
1e0afb28 319
8006479c
DT
320 case EV_MSC:
321 if (is_event_supported(code, dev->mscbit, MSC_MAX))
322 disposition = INPUT_PASS_TO_ALL;
1da177e4 323
8006479c 324 break;
1da177e4 325
8006479c
DT
326 case EV_LED:
327 if (is_event_supported(code, dev->ledbit, LED_MAX) &&
0672120a 328 !!test_bit(code, dev->led) != !!value) {
1da177e4 329
8006479c
DT
330 __change_bit(code, dev->led);
331 disposition = INPUT_PASS_TO_ALL;
332 }
333 break;
334
335 case EV_SND:
336 if (is_event_supported(code, dev->sndbit, SND_MAX)) {
1da177e4 337
8fdc1948 338 if (!!test_bit(code, dev->snd) != !!value)
8006479c
DT
339 __change_bit(code, dev->snd);
340 disposition = INPUT_PASS_TO_ALL;
341 }
342 break;
8fdc1948 343
8006479c
DT
344 case EV_REP:
345 if (code <= REP_MAX && value >= 0 && dev->rep[code] != value) {
346 dev->rep[code] = value;
347 disposition = INPUT_PASS_TO_ALL;
348 }
349 break;
1da177e4 350
8006479c
DT
351 case EV_FF:
352 if (value >= 0)
353 disposition = INPUT_PASS_TO_ALL;
354 break;
ed2fa4dd
RP
355
356 case EV_PWR:
357 disposition = INPUT_PASS_TO_ALL;
358 break;
8006479c 359 }
1da177e4 360
50c5d36d 361 *pval = value;
4369c64c
HR
362 return disposition;
363}
364
365static void input_handle_event(struct input_dev *dev,
366 unsigned int type, unsigned int code, int value)
367{
368 int disposition;
369
50c5d36d 370 disposition = input_get_disposition(dev, type, code, &value);
1da177e4 371
8006479c
DT
372 if ((disposition & INPUT_PASS_TO_DEVICE) && dev->event)
373 dev->event(dev, type, code, value);
1da177e4 374
4369c64c
HR
375 if (!dev->vals)
376 return;
377
378 if (disposition & INPUT_PASS_TO_HANDLERS) {
379 struct input_value *v;
380
381 if (disposition & INPUT_SLOT) {
382 v = &dev->vals[dev->num_vals++];
383 v->type = EV_ABS;
384 v->code = ABS_MT_SLOT;
385 v->value = dev->mt->slot;
386 }
387
388 v = &dev->vals[dev->num_vals++];
389 v->type = type;
390 v->code = code;
391 v->value = value;
392 }
393
394 if (disposition & INPUT_FLUSH) {
395 if (dev->num_vals >= 2)
396 input_pass_values(dev, dev->vals, dev->num_vals);
397 dev->num_vals = 0;
398 } else if (dev->num_vals >= dev->max_vals - 2) {
399 dev->vals[dev->num_vals++] = input_value_sync;
400 input_pass_values(dev, dev->vals, dev->num_vals);
401 dev->num_vals = 0;
402 }
403
8006479c 404}
1da177e4 405
8006479c
DT
406/**
407 * input_event() - report new input event
408 * @dev: device that generated the event
409 * @type: type of the event
410 * @code: event code
411 * @value: value of the event
412 *
413 * This function should be used by drivers implementing various input
df2d4637
DT
414 * devices to report input events. See also input_inject_event().
415 *
416 * NOTE: input_event() may be safely used right after input device was
417 * allocated with input_allocate_device(), even before it is registered
418 * with input_register_device(), but the event will not reach any of the
419 * input handlers. Such early invocation of input_event() may be used
420 * to 'seed' initial state of a switch or initial position of absolute
421 * axis, etc.
8006479c 422 */
8006479c
DT
423void input_event(struct input_dev *dev,
424 unsigned int type, unsigned int code, int value)
425{
426 unsigned long flags;
509ca1a9 427
8006479c 428 if (is_event_supported(type, dev->evbit, EV_MAX)) {
509ca1a9 429
8006479c 430 spin_lock_irqsave(&dev->event_lock, flags);
9ae4345a 431 input_handle_event(dev, type, code, value);
8006479c 432 spin_unlock_irqrestore(&dev->event_lock, flags);
1da177e4 433 }
1da177e4 434}
ca56fe07 435EXPORT_SYMBOL(input_event);
1da177e4 436
0e739d28
DT
437/**
438 * input_inject_event() - send input event from input handler
439 * @handle: input handle to send event through
440 * @type: type of the event
441 * @code: event code
442 * @value: value of the event
443 *
8006479c
DT
444 * Similar to input_event() but will ignore event if device is
445 * "grabbed" and handle injecting event is not the one that owns
446 * the device.
0e739d28 447 */
8006479c
DT
448void input_inject_event(struct input_handle *handle,
449 unsigned int type, unsigned int code, int value)
1da177e4 450{
8006479c
DT
451 struct input_dev *dev = handle->dev;
452 struct input_handle *grab;
453 unsigned long flags;
1da177e4 454
8006479c
DT
455 if (is_event_supported(type, dev->evbit, EV_MAX)) {
456 spin_lock_irqsave(&dev->event_lock, flags);
1da177e4 457
82ba56c2 458 rcu_read_lock();
8006479c
DT
459 grab = rcu_dereference(dev->grab);
460 if (!grab || grab == handle)
9ae4345a 461 input_handle_event(dev, type, code, value);
82ba56c2 462 rcu_read_unlock();
1da177e4 463
8006479c
DT
464 spin_unlock_irqrestore(&dev->event_lock, flags);
465 }
1da177e4 466}
8006479c 467EXPORT_SYMBOL(input_inject_event);
1da177e4 468
d31b2865
DM
469/**
470 * input_alloc_absinfo - allocates array of input_absinfo structs
471 * @dev: the input device emitting absolute events
472 *
473 * If the absinfo struct the caller asked for is already allocated, this
474 * functions will not do anything.
475 */
476void input_alloc_absinfo(struct input_dev *dev)
477{
478 if (!dev->absinfo)
479 dev->absinfo = kcalloc(ABS_CNT, sizeof(struct input_absinfo),
480 GFP_KERNEL);
481
482 WARN(!dev->absinfo, "%s(): kcalloc() failed?\n", __func__);
483}
484EXPORT_SYMBOL(input_alloc_absinfo);
485
486void input_set_abs_params(struct input_dev *dev, unsigned int axis,
487 int min, int max, int fuzz, int flat)
488{
489 struct input_absinfo *absinfo;
490
491 input_alloc_absinfo(dev);
492 if (!dev->absinfo)
493 return;
494
495 absinfo = &dev->absinfo[axis];
496 absinfo->minimum = min;
497 absinfo->maximum = max;
498 absinfo->fuzz = fuzz;
499 absinfo->flat = flat;
500
501 dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
502}
503EXPORT_SYMBOL(input_set_abs_params);
504
505
8006479c
DT
506/**
507 * input_grab_device - grabs device for exclusive use
508 * @handle: input handle that wants to own the device
509 *
510 * When a device is grabbed by an input handle all events generated by
511 * the device are delivered only to this handle. Also events injected
512 * by other input handles are ignored while device is grabbed.
513 */
1da177e4
LT
514int input_grab_device(struct input_handle *handle)
515{
8006479c
DT
516 struct input_dev *dev = handle->dev;
517 int retval;
1da177e4 518
8006479c
DT
519 retval = mutex_lock_interruptible(&dev->mutex);
520 if (retval)
521 return retval;
522
523 if (dev->grab) {
524 retval = -EBUSY;
525 goto out;
526 }
527
528 rcu_assign_pointer(dev->grab, handle);
8006479c
DT
529
530 out:
531 mutex_unlock(&dev->mutex);
532 return retval;
1da177e4 533}
ca56fe07 534EXPORT_SYMBOL(input_grab_device);
1da177e4 535
8006479c 536static void __input_release_device(struct input_handle *handle)
1da177e4 537{
a2b2ed2c 538 struct input_dev *dev = handle->dev;
adc4633c 539 struct input_handle *grabber;
c7e8dc6e 540
adc4633c
DT
541 grabber = rcu_dereference_protected(dev->grab,
542 lockdep_is_held(&dev->mutex));
543 if (grabber == handle) {
8006479c
DT
544 rcu_assign_pointer(dev->grab, NULL);
545 /* Make sure input_pass_event() notices that grab is gone */
82ba56c2 546 synchronize_rcu();
a2b2ed2c
AM
547
548 list_for_each_entry(handle, &dev->h_list, d_node)
8006479c 549 if (handle->open && handle->handler->start)
c7e8dc6e
DT
550 handle->handler->start(handle);
551 }
1da177e4 552}
8006479c
DT
553
554/**
555 * input_release_device - release previously grabbed device
556 * @handle: input handle that owns the device
557 *
558 * Releases previously grabbed device so that other input handles can
559 * start receiving input events. Upon release all handlers attached
560 * to the device have their start() method called so they have a change
561 * to synchronize device state with the rest of the system.
562 */
563void input_release_device(struct input_handle *handle)
564{
565 struct input_dev *dev = handle->dev;
566
567 mutex_lock(&dev->mutex);
568 __input_release_device(handle);
569 mutex_unlock(&dev->mutex);
570}
ca56fe07 571EXPORT_SYMBOL(input_release_device);
1da177e4 572
8006479c
DT
573/**
574 * input_open_device - open input device
575 * @handle: handle through which device is being accessed
576 *
577 * This function should be called by input handlers when they
578 * want to start receive events from given input device.
579 */
1da177e4
LT
580int input_open_device(struct input_handle *handle)
581{
0fbf87ca 582 struct input_dev *dev = handle->dev;
8006479c 583 int retval;
0fbf87ca 584
8006479c
DT
585 retval = mutex_lock_interruptible(&dev->mutex);
586 if (retval)
587 return retval;
588
589 if (dev->going_away) {
590 retval = -ENODEV;
591 goto out;
592 }
0fbf87ca 593
1da177e4 594 handle->open++;
0fbf87ca
DT
595
596 if (!dev->users++ && dev->open)
8006479c
DT
597 retval = dev->open(dev);
598
599 if (retval) {
600 dev->users--;
601 if (!--handle->open) {
602 /*
603 * Make sure we are not delivering any more events
604 * through this handle
605 */
82ba56c2 606 synchronize_rcu();
8006479c
DT
607 }
608 }
0fbf87ca 609
8006479c 610 out:
e676c232 611 mutex_unlock(&dev->mutex);
8006479c 612 return retval;
1da177e4 613}
ca56fe07 614EXPORT_SYMBOL(input_open_device);
1da177e4 615
8006479c 616int input_flush_device(struct input_handle *handle, struct file *file)
1da177e4 617{
8006479c
DT
618 struct input_dev *dev = handle->dev;
619 int retval;
1da177e4 620
8006479c
DT
621 retval = mutex_lock_interruptible(&dev->mutex);
622 if (retval)
623 return retval;
624
625 if (dev->flush)
626 retval = dev->flush(dev, file);
627
628 mutex_unlock(&dev->mutex);
629 return retval;
1da177e4 630}
ca56fe07 631EXPORT_SYMBOL(input_flush_device);
1da177e4 632
8006479c
DT
633/**
634 * input_close_device - close input device
635 * @handle: handle through which device is being accessed
636 *
637 * This function should be called by input handlers when they
638 * want to stop receive events from given input device.
639 */
1da177e4
LT
640void input_close_device(struct input_handle *handle)
641{
0fbf87ca
DT
642 struct input_dev *dev = handle->dev;
643
e676c232 644 mutex_lock(&dev->mutex);
0fbf87ca 645
8006479c
DT
646 __input_release_device(handle);
647
0fbf87ca
DT
648 if (!--dev->users && dev->close)
649 dev->close(dev);
8006479c
DT
650
651 if (!--handle->open) {
652 /*
82ba56c2 653 * synchronize_rcu() makes sure that input_pass_event()
8006479c
DT
654 * completed and that no more input events are delivered
655 * through this handle
656 */
82ba56c2 657 synchronize_rcu();
8006479c 658 }
0fbf87ca 659
e676c232 660 mutex_unlock(&dev->mutex);
1da177e4 661}
ca56fe07 662EXPORT_SYMBOL(input_close_device);
1da177e4 663
866d7d7b
ON
664/*
665 * Simulate keyup events for all keys that are marked as pressed.
666 * The function must be called with dev->event_lock held.
667 */
668static void input_dev_release_keys(struct input_dev *dev)
669{
670 int code;
671
672 if (is_event_supported(EV_KEY, dev->evbit, EV_MAX)) {
673 for (code = 0; code <= KEY_MAX; code++) {
674 if (is_event_supported(code, dev->keybit, KEY_MAX) &&
675 __test_and_clear_bit(code, dev->key)) {
9ae4345a 676 input_pass_event(dev, EV_KEY, code, 0);
866d7d7b
ON
677 }
678 }
9ae4345a 679 input_pass_event(dev, EV_SYN, SYN_REPORT, 1);
866d7d7b
ON
680 }
681}
682
8006479c
DT
683/*
684 * Prepare device for unregistering
685 */
686static void input_disconnect_device(struct input_dev *dev)
687{
688 struct input_handle *handle;
8006479c
DT
689
690 /*
691 * Mark device as going away. Note that we take dev->mutex here
692 * not to protect access to dev->going_away but rather to ensure
693 * that there are no threads in the middle of input_open_device()
694 */
695 mutex_lock(&dev->mutex);
ffd0db97 696 dev->going_away = true;
8006479c
DT
697 mutex_unlock(&dev->mutex);
698
699 spin_lock_irq(&dev->event_lock);
700
701 /*
702 * Simulate keyup events for all pressed keys so that handlers
703 * are not left with "stuck" keys. The driver may continue
704 * generate events even after we done here but they will not
705 * reach any handlers.
706 */
866d7d7b 707 input_dev_release_keys(dev);
8006479c
DT
708
709 list_for_each_entry(handle, &dev->h_list, d_node)
710 handle->open = 0;
711
712 spin_unlock_irq(&dev->event_lock);
713}
714
8613e4c2
MCC
715/**
716 * input_scancode_to_scalar() - converts scancode in &struct input_keymap_entry
717 * @ke: keymap entry containing scancode to be converted.
718 * @scancode: pointer to the location where converted scancode should
719 * be stored.
720 *
721 * This function is used to convert scancode stored in &struct keymap_entry
722 * into scalar form understood by legacy keymap handling methods. These
723 * methods expect scancodes to be represented as 'unsigned int'.
724 */
725int input_scancode_to_scalar(const struct input_keymap_entry *ke,
726 unsigned int *scancode)
727{
728 switch (ke->len) {
729 case 1:
730 *scancode = *((u8 *)ke->scancode);
731 break;
732
733 case 2:
734 *scancode = *((u16 *)ke->scancode);
735 break;
736
737 case 4:
738 *scancode = *((u32 *)ke->scancode);
739 break;
740
741 default:
742 return -EINVAL;
743 }
744
745 return 0;
746}
747EXPORT_SYMBOL(input_scancode_to_scalar);
748
749/*
750 * Those routines handle the default case where no [gs]etkeycode() is
751 * defined. In this case, an array indexed by the scancode is used.
752 */
753
754static unsigned int input_fetch_keycode(struct input_dev *dev,
755 unsigned int index)
c8e4c772
MR
756{
757 switch (dev->keycodesize) {
8613e4c2
MCC
758 case 1:
759 return ((u8 *)dev->keycode)[index];
c8e4c772 760
8613e4c2
MCC
761 case 2:
762 return ((u16 *)dev->keycode)[index];
c8e4c772 763
8613e4c2
MCC
764 default:
765 return ((u32 *)dev->keycode)[index];
c8e4c772
MR
766 }
767}
768
769static int input_default_getkeycode(struct input_dev *dev,
8613e4c2 770 struct input_keymap_entry *ke)
c8e4c772 771{
8613e4c2
MCC
772 unsigned int index;
773 int error;
774
c8e4c772
MR
775 if (!dev->keycodesize)
776 return -EINVAL;
777
8613e4c2
MCC
778 if (ke->flags & INPUT_KEYMAP_BY_INDEX)
779 index = ke->index;
780 else {
781 error = input_scancode_to_scalar(ke, &index);
782 if (error)
783 return error;
784 }
785
786 if (index >= dev->keycodemax)
c8e4c772
MR
787 return -EINVAL;
788
8613e4c2
MCC
789 ke->keycode = input_fetch_keycode(dev, index);
790 ke->index = index;
791 ke->len = sizeof(index);
792 memcpy(ke->scancode, &index, sizeof(index));
c8e4c772
MR
793
794 return 0;
795}
796
797static int input_default_setkeycode(struct input_dev *dev,
8613e4c2
MCC
798 const struct input_keymap_entry *ke,
799 unsigned int *old_keycode)
c8e4c772 800{
8613e4c2
MCC
801 unsigned int index;
802 int error;
c8e4c772
MR
803 int i;
804
8613e4c2 805 if (!dev->keycodesize)
c8e4c772
MR
806 return -EINVAL;
807
8613e4c2
MCC
808 if (ke->flags & INPUT_KEYMAP_BY_INDEX) {
809 index = ke->index;
810 } else {
811 error = input_scancode_to_scalar(ke, &index);
812 if (error)
813 return error;
814 }
815
816 if (index >= dev->keycodemax)
c8e4c772
MR
817 return -EINVAL;
818
de391d12 819 if (dev->keycodesize < sizeof(ke->keycode) &&
8613e4c2 820 (ke->keycode >> (dev->keycodesize * 8)))
c8e4c772
MR
821 return -EINVAL;
822
823 switch (dev->keycodesize) {
824 case 1: {
825 u8 *k = (u8 *)dev->keycode;
8613e4c2
MCC
826 *old_keycode = k[index];
827 k[index] = ke->keycode;
c8e4c772
MR
828 break;
829 }
830 case 2: {
831 u16 *k = (u16 *)dev->keycode;
8613e4c2
MCC
832 *old_keycode = k[index];
833 k[index] = ke->keycode;
c8e4c772
MR
834 break;
835 }
836 default: {
837 u32 *k = (u32 *)dev->keycode;
8613e4c2
MCC
838 *old_keycode = k[index];
839 k[index] = ke->keycode;
c8e4c772
MR
840 break;
841 }
842 }
843
8613e4c2
MCC
844 __clear_bit(*old_keycode, dev->keybit);
845 __set_bit(ke->keycode, dev->keybit);
c8e4c772
MR
846
847 for (i = 0; i < dev->keycodemax; i++) {
8613e4c2
MCC
848 if (input_fetch_keycode(dev, i) == *old_keycode) {
849 __set_bit(*old_keycode, dev->keybit);
c8e4c772
MR
850 break; /* Setting the bit twice is useless, so break */
851 }
852 }
853
854 return 0;
855}
856
f4f37c8e
DT
857/**
858 * input_get_keycode - retrieve keycode currently mapped to a given scancode
859 * @dev: input device which keymap is being queried
8613e4c2 860 * @ke: keymap entry
f4f37c8e
DT
861 *
862 * This function should be called by anyone interested in retrieving current
8613e4c2 863 * keymap. Presently evdev handlers use it.
f4f37c8e 864 */
8613e4c2 865int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke)
f4f37c8e 866{
2e2e3b96
DT
867 unsigned long flags;
868 int retval;
869
870 spin_lock_irqsave(&dev->event_lock, flags);
aebd636b 871 retval = dev->getkeycode(dev, ke);
8613e4c2 872 spin_unlock_irqrestore(&dev->event_lock, flags);
aebd636b 873
2e2e3b96 874 return retval;
f4f37c8e
DT
875}
876EXPORT_SYMBOL(input_get_keycode);
877
878/**
8613e4c2 879 * input_set_keycode - attribute a keycode to a given scancode
f4f37c8e 880 * @dev: input device which keymap is being updated
8613e4c2 881 * @ke: new keymap entry
f4f37c8e
DT
882 *
883 * This function should be called by anyone needing to update current
884 * keymap. Presently keyboard and evdev handlers use it.
885 */
58b93995 886int input_set_keycode(struct input_dev *dev,
8613e4c2 887 const struct input_keymap_entry *ke)
f4f37c8e
DT
888{
889 unsigned long flags;
fd6cf3dd 890 unsigned int old_keycode;
f4f37c8e
DT
891 int retval;
892
8613e4c2 893 if (ke->keycode > KEY_MAX)
f4f37c8e
DT
894 return -EINVAL;
895
896 spin_lock_irqsave(&dev->event_lock, flags);
897
aebd636b 898 retval = dev->setkeycode(dev, ke, &old_keycode);
f4f37c8e
DT
899 if (retval)
900 goto out;
901
4f93df40
DT
902 /* Make sure KEY_RESERVED did not get enabled. */
903 __clear_bit(KEY_RESERVED, dev->keybit);
904
f4f37c8e
DT
905 /*
906 * Simulate keyup event if keycode is not present
907 * in the keymap anymore
908 */
909 if (test_bit(EV_KEY, dev->evbit) &&
910 !is_event_supported(old_keycode, dev->keybit, KEY_MAX) &&
911 __test_and_clear_bit(old_keycode, dev->key)) {
4369c64c
HR
912 struct input_value vals[] = {
913 { EV_KEY, old_keycode, 0 },
914 input_value_sync
915 };
f4f37c8e 916
4369c64c 917 input_pass_values(dev, vals, ARRAY_SIZE(vals));
f4f37c8e
DT
918 }
919
920 out:
921 spin_unlock_irqrestore(&dev->event_lock, flags);
922
923 return retval;
924}
925EXPORT_SYMBOL(input_set_keycode);
c8e4c772 926
0b7024ac 927static const struct input_device_id *input_match_device(struct input_handler *handler,
66e66118 928 struct input_dev *dev)
1da177e4 929{
0b7024ac 930 const struct input_device_id *id;
1da177e4 931
0b7024ac 932 for (id = handler->id_table; id->flags || id->driver_info; id++) {
1da177e4
LT
933
934 if (id->flags & INPUT_DEVICE_ID_MATCH_BUS)
ddc5d341 935 if (id->bustype != dev->id.bustype)
1da177e4
LT
936 continue;
937
938 if (id->flags & INPUT_DEVICE_ID_MATCH_VENDOR)
ddc5d341 939 if (id->vendor != dev->id.vendor)
1da177e4
LT
940 continue;
941
942 if (id->flags & INPUT_DEVICE_ID_MATCH_PRODUCT)
ddc5d341 943 if (id->product != dev->id.product)
1da177e4
LT
944 continue;
945
946 if (id->flags & INPUT_DEVICE_ID_MATCH_VERSION)
ddc5d341 947 if (id->version != dev->id.version)
1da177e4
LT
948 continue;
949
c0bb1f97
DT
950 if (!bitmap_subset(id->evbit, dev->evbit, EV_MAX))
951 continue;
952
953 if (!bitmap_subset(id->keybit, dev->keybit, KEY_MAX))
954 continue;
955
956 if (!bitmap_subset(id->relbit, dev->relbit, REL_MAX))
957 continue;
958
959 if (!bitmap_subset(id->absbit, dev->absbit, ABS_MAX))
960 continue;
961
962 if (!bitmap_subset(id->mscbit, dev->mscbit, MSC_MAX))
963 continue;
964
965 if (!bitmap_subset(id->ledbit, dev->ledbit, LED_MAX))
966 continue;
967
968 if (!bitmap_subset(id->sndbit, dev->sndbit, SND_MAX))
969 continue;
970
971 if (!bitmap_subset(id->ffbit, dev->ffbit, FF_MAX))
972 continue;
973
974 if (!bitmap_subset(id->swbit, dev->swbit, SW_MAX))
975 continue;
1da177e4 976
0b7024ac
DT
977 if (!handler->match || handler->match(handler, dev))
978 return id;
1da177e4
LT
979 }
980
981 return NULL;
982}
983
5b2a0826
DT
984static int input_attach_handler(struct input_dev *dev, struct input_handler *handler)
985{
986 const struct input_device_id *id;
987 int error;
988
0b7024ac 989 id = input_match_device(handler, dev);
5b2a0826
DT
990 if (!id)
991 return -ENODEV;
992
993 error = handler->connect(handler, dev, id);
994 if (error && error != -ENODEV)
da0c4901
JP
995 pr_err("failed to attach handler %s to device %s, error: %d\n",
996 handler->name, kobject_name(&dev->dev.kobj), error);
5b2a0826
DT
997
998 return error;
999}
1000
15e184af
DT
1001#ifdef CONFIG_COMPAT
1002
1003static int input_bits_to_string(char *buf, int buf_size,
1004 unsigned long bits, bool skip_empty)
1005{
1006 int len = 0;
1007
1008 if (INPUT_COMPAT_TEST) {
1009 u32 dword = bits >> 32;
1010 if (dword || !skip_empty)
1011 len += snprintf(buf, buf_size, "%x ", dword);
1012
1013 dword = bits & 0xffffffffUL;
1014 if (dword || !skip_empty || len)
1015 len += snprintf(buf + len, max(buf_size - len, 0),
1016 "%x", dword);
1017 } else {
1018 if (bits || !skip_empty)
1019 len += snprintf(buf, buf_size, "%lx", bits);
1020 }
1021
1022 return len;
1023}
1024
1025#else /* !CONFIG_COMPAT */
1026
1027static int input_bits_to_string(char *buf, int buf_size,
1028 unsigned long bits, bool skip_empty)
1029{
1030 return bits || !skip_empty ?
1031 snprintf(buf, buf_size, "%lx", bits) : 0;
1032}
1033
1034#endif
5b2a0826 1035
f96b434d
DT
1036#ifdef CONFIG_PROC_FS
1037
1038static struct proc_dir_entry *proc_bus_input_dir;
1039static DECLARE_WAIT_QUEUE_HEAD(input_devices_poll_wait);
1040static int input_devices_state;
1041
1042static inline void input_wakeup_procfs_readers(void)
1043{
1044 input_devices_state++;
1045 wake_up(&input_devices_poll_wait);
1046}
1047
969b21cd 1048static unsigned int input_proc_devices_poll(struct file *file, poll_table *wait)
f96b434d 1049{
f96b434d 1050 poll_wait(file, &input_devices_poll_wait, wait);
fa886612
DT
1051 if (file->f_version != input_devices_state) {
1052 file->f_version = input_devices_state;
f96b434d 1053 return POLLIN | POLLRDNORM;
fa886612 1054 }
1e0afb28 1055
f96b434d
DT
1056 return 0;
1057}
1058
1572ca2a
DT
1059union input_seq_state {
1060 struct {
1061 unsigned short pos;
1062 bool mutex_acquired;
1063 };
1064 void *p;
1065};
1066
969b21cd
DT
1067static void *input_devices_seq_start(struct seq_file *seq, loff_t *pos)
1068{
1572ca2a
DT
1069 union input_seq_state *state = (union input_seq_state *)&seq->private;
1070 int error;
1071
1072 /* We need to fit into seq->private pointer */
1073 BUILD_BUG_ON(sizeof(union input_seq_state) != sizeof(seq->private));
1074
1075 error = mutex_lock_interruptible(&input_mutex);
1076 if (error) {
1077 state->mutex_acquired = false;
1078 return ERR_PTR(error);
1079 }
1080
1081 state->mutex_acquired = true;
f96b434d 1082
ad5d972c 1083 return seq_list_start(&input_dev_list, *pos);
969b21cd 1084}
051b2fea 1085
969b21cd
DT
1086static void *input_devices_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1087{
ad5d972c 1088 return seq_list_next(v, &input_dev_list, pos);
969b21cd 1089}
f96b434d 1090
1572ca2a 1091static void input_seq_stop(struct seq_file *seq, void *v)
969b21cd 1092{
1572ca2a
DT
1093 union input_seq_state *state = (union input_seq_state *)&seq->private;
1094
1095 if (state->mutex_acquired)
1096 mutex_unlock(&input_mutex);
969b21cd 1097}
f96b434d 1098
969b21cd
DT
1099static void input_seq_print_bitmap(struct seq_file *seq, const char *name,
1100 unsigned long *bitmap, int max)
1101{
1102 int i;
15e184af
DT
1103 bool skip_empty = true;
1104 char buf[18];
f96b434d 1105
969b21cd 1106 seq_printf(seq, "B: %s=", name);
15e184af
DT
1107
1108 for (i = BITS_TO_LONGS(max) - 1; i >= 0; i--) {
1109 if (input_bits_to_string(buf, sizeof(buf),
1110 bitmap[i], skip_empty)) {
1111 skip_empty = false;
1112 seq_printf(seq, "%s%s", buf, i > 0 ? " " : "");
1113 }
1114 }
1115
1116 /*
1117 * If no output was produced print a single 0.
1118 */
1119 if (skip_empty)
1120 seq_puts(seq, "0");
1121
969b21cd
DT
1122 seq_putc(seq, '\n');
1123}
f96b434d 1124
969b21cd
DT
1125static int input_devices_seq_show(struct seq_file *seq, void *v)
1126{
1127 struct input_dev *dev = container_of(v, struct input_dev, node);
9657d75c 1128 const char *path = kobject_get_path(&dev->dev.kobj, GFP_KERNEL);
969b21cd
DT
1129 struct input_handle *handle;
1130
1131 seq_printf(seq, "I: Bus=%04x Vendor=%04x Product=%04x Version=%04x\n",
1132 dev->id.bustype, dev->id.vendor, dev->id.product, dev->id.version);
1133
1134 seq_printf(seq, "N: Name=\"%s\"\n", dev->name ? dev->name : "");
1135 seq_printf(seq, "P: Phys=%s\n", dev->phys ? dev->phys : "");
1136 seq_printf(seq, "S: Sysfs=%s\n", path ? path : "");
15e03ae8 1137 seq_printf(seq, "U: Uniq=%s\n", dev->uniq ? dev->uniq : "");
969b21cd
DT
1138 seq_printf(seq, "H: Handlers=");
1139
1140 list_for_each_entry(handle, &dev->h_list, d_node)
1141 seq_printf(seq, "%s ", handle->name);
1142 seq_putc(seq, '\n');
1143
85b77200
HR
1144 input_seq_print_bitmap(seq, "PROP", dev->propbit, INPUT_PROP_MAX);
1145
969b21cd
DT
1146 input_seq_print_bitmap(seq, "EV", dev->evbit, EV_MAX);
1147 if (test_bit(EV_KEY, dev->evbit))
1148 input_seq_print_bitmap(seq, "KEY", dev->keybit, KEY_MAX);
1149 if (test_bit(EV_REL, dev->evbit))
1150 input_seq_print_bitmap(seq, "REL", dev->relbit, REL_MAX);
1151 if (test_bit(EV_ABS, dev->evbit))
1152 input_seq_print_bitmap(seq, "ABS", dev->absbit, ABS_MAX);
1153 if (test_bit(EV_MSC, dev->evbit))
1154 input_seq_print_bitmap(seq, "MSC", dev->mscbit, MSC_MAX);
1155 if (test_bit(EV_LED, dev->evbit))
1156 input_seq_print_bitmap(seq, "LED", dev->ledbit, LED_MAX);
1157 if (test_bit(EV_SND, dev->evbit))
1158 input_seq_print_bitmap(seq, "SND", dev->sndbit, SND_MAX);
1159 if (test_bit(EV_FF, dev->evbit))
1160 input_seq_print_bitmap(seq, "FF", dev->ffbit, FF_MAX);
1161 if (test_bit(EV_SW, dev->evbit))
1162 input_seq_print_bitmap(seq, "SW", dev->swbit, SW_MAX);
1163
1164 seq_putc(seq, '\n');
1165
1166 kfree(path);
1167 return 0;
f96b434d
DT
1168}
1169
cec69c37 1170static const struct seq_operations input_devices_seq_ops = {
969b21cd
DT
1171 .start = input_devices_seq_start,
1172 .next = input_devices_seq_next,
1572ca2a 1173 .stop = input_seq_stop,
969b21cd
DT
1174 .show = input_devices_seq_show,
1175};
1176
1177static int input_proc_devices_open(struct inode *inode, struct file *file)
f96b434d 1178{
969b21cd
DT
1179 return seq_open(file, &input_devices_seq_ops);
1180}
1181
2b8693c0 1182static const struct file_operations input_devices_fileops = {
969b21cd
DT
1183 .owner = THIS_MODULE,
1184 .open = input_proc_devices_open,
1185 .poll = input_proc_devices_poll,
1186 .read = seq_read,
1187 .llseek = seq_lseek,
1188 .release = seq_release,
1189};
1190
1191static void *input_handlers_seq_start(struct seq_file *seq, loff_t *pos)
1192{
1572ca2a
DT
1193 union input_seq_state *state = (union input_seq_state *)&seq->private;
1194 int error;
1195
1196 /* We need to fit into seq->private pointer */
1197 BUILD_BUG_ON(sizeof(union input_seq_state) != sizeof(seq->private));
1198
1199 error = mutex_lock_interruptible(&input_mutex);
1200 if (error) {
1201 state->mutex_acquired = false;
1202 return ERR_PTR(error);
1203 }
1204
1205 state->mutex_acquired = true;
1206 state->pos = *pos;
8006479c 1207
ad5d972c 1208 return seq_list_start(&input_handler_list, *pos);
969b21cd 1209}
f96b434d 1210
969b21cd
DT
1211static void *input_handlers_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1212{
1572ca2a 1213 union input_seq_state *state = (union input_seq_state *)&seq->private;
f96b434d 1214
1572ca2a
DT
1215 state->pos = *pos + 1;
1216 return seq_list_next(v, &input_handler_list, pos);
969b21cd
DT
1217}
1218
1219static int input_handlers_seq_show(struct seq_file *seq, void *v)
1220{
1221 struct input_handler *handler = container_of(v, struct input_handler, node);
1572ca2a 1222 union input_seq_state *state = (union input_seq_state *)&seq->private;
969b21cd 1223
1572ca2a 1224 seq_printf(seq, "N: Number=%u Name=%s", state->pos, handler->name);
ef7995f4
DT
1225 if (handler->filter)
1226 seq_puts(seq, " (filter)");
7f8d4cad 1227 if (handler->legacy_minors)
969b21cd
DT
1228 seq_printf(seq, " Minor=%d", handler->minor);
1229 seq_putc(seq, '\n');
1230
1231 return 0;
1232}
1572ca2a 1233
cec69c37 1234static const struct seq_operations input_handlers_seq_ops = {
969b21cd
DT
1235 .start = input_handlers_seq_start,
1236 .next = input_handlers_seq_next,
1572ca2a 1237 .stop = input_seq_stop,
969b21cd
DT
1238 .show = input_handlers_seq_show,
1239};
1240
1241static int input_proc_handlers_open(struct inode *inode, struct file *file)
1242{
1243 return seq_open(file, &input_handlers_seq_ops);
1244}
1245
2b8693c0 1246static const struct file_operations input_handlers_fileops = {
969b21cd
DT
1247 .owner = THIS_MODULE,
1248 .open = input_proc_handlers_open,
1249 .read = seq_read,
1250 .llseek = seq_lseek,
1251 .release = seq_release,
1252};
f96b434d
DT
1253
1254static int __init input_proc_init(void)
1255{
1256 struct proc_dir_entry *entry;
1257
9c37066d 1258 proc_bus_input_dir = proc_mkdir("bus/input", NULL);
f96b434d
DT
1259 if (!proc_bus_input_dir)
1260 return -ENOMEM;
1261
c7705f34
DL
1262 entry = proc_create("devices", 0, proc_bus_input_dir,
1263 &input_devices_fileops);
f96b434d
DT
1264 if (!entry)
1265 goto fail1;
1266
c7705f34
DL
1267 entry = proc_create("handlers", 0, proc_bus_input_dir,
1268 &input_handlers_fileops);
f96b434d
DT
1269 if (!entry)
1270 goto fail2;
1271
f96b434d
DT
1272 return 0;
1273
1274 fail2: remove_proc_entry("devices", proc_bus_input_dir);
9c37066d 1275 fail1: remove_proc_entry("bus/input", NULL);
f96b434d
DT
1276 return -ENOMEM;
1277}
1278
beffbdc2 1279static void input_proc_exit(void)
f96b434d
DT
1280{
1281 remove_proc_entry("devices", proc_bus_input_dir);
1282 remove_proc_entry("handlers", proc_bus_input_dir);
9c37066d 1283 remove_proc_entry("bus/input", NULL);
f96b434d
DT
1284}
1285
1286#else /* !CONFIG_PROC_FS */
1287static inline void input_wakeup_procfs_readers(void) { }
1288static inline int input_proc_init(void) { return 0; }
1289static inline void input_proc_exit(void) { }
1290#endif
1291
9657d75c
DT
1292#define INPUT_DEV_STRING_ATTR_SHOW(name) \
1293static ssize_t input_dev_show_##name(struct device *dev, \
1294 struct device_attribute *attr, \
1295 char *buf) \
1296{ \
1297 struct input_dev *input_dev = to_input_dev(dev); \
1298 \
1299 return scnprintf(buf, PAGE_SIZE, "%s\n", \
1300 input_dev->name ? input_dev->name : ""); \
1301} \
1302static DEVICE_ATTR(name, S_IRUGO, input_dev_show_##name, NULL)
5c1e9a6a
DT
1303
1304INPUT_DEV_STRING_ATTR_SHOW(name);
1305INPUT_DEV_STRING_ATTR_SHOW(phys);
1306INPUT_DEV_STRING_ATTR_SHOW(uniq);
1307
ac648a6a
DT
1308static int input_print_modalias_bits(char *buf, int size,
1309 char name, unsigned long *bm,
1310 unsigned int min_bit, unsigned int max_bit)
1d8f430c 1311{
ac648a6a 1312 int len = 0, i;
1d8f430c 1313
ac648a6a
DT
1314 len += snprintf(buf, max(size, 0), "%c", name);
1315 for (i = min_bit; i < max_bit; i++)
7b19ada2 1316 if (bm[BIT_WORD(i)] & BIT_MASK(i))
ac648a6a 1317 len += snprintf(buf + len, max(size - len, 0), "%X,", i);
1d8f430c
RR
1318 return len;
1319}
1320
2db66876
DT
1321static int input_print_modalias(char *buf, int size, struct input_dev *id,
1322 int add_cr)
1d8f430c 1323{
bd37e5a9 1324 int len;
1d8f430c 1325
ac648a6a
DT
1326 len = snprintf(buf, max(size, 0),
1327 "input:b%04Xv%04Xp%04Xe%04X-",
1328 id->id.bustype, id->id.vendor,
1329 id->id.product, id->id.version);
1330
1331 len += input_print_modalias_bits(buf + len, size - len,
1332 'e', id->evbit, 0, EV_MAX);
1333 len += input_print_modalias_bits(buf + len, size - len,
1334 'k', id->keybit, KEY_MIN_INTERESTING, KEY_MAX);
1335 len += input_print_modalias_bits(buf + len, size - len,
1336 'r', id->relbit, 0, REL_MAX);
1337 len += input_print_modalias_bits(buf + len, size - len,
1338 'a', id->absbit, 0, ABS_MAX);
1339 len += input_print_modalias_bits(buf + len, size - len,
1340 'm', id->mscbit, 0, MSC_MAX);
1341 len += input_print_modalias_bits(buf + len, size - len,
1342 'l', id->ledbit, 0, LED_MAX);
1343 len += input_print_modalias_bits(buf + len, size - len,
1344 's', id->sndbit, 0, SND_MAX);
1345 len += input_print_modalias_bits(buf + len, size - len,
1346 'f', id->ffbit, 0, FF_MAX);
1347 len += input_print_modalias_bits(buf + len, size - len,
1348 'w', id->swbit, 0, SW_MAX);
2db66876
DT
1349
1350 if (add_cr)
ac648a6a 1351 len += snprintf(buf + len, max(size - len, 0), "\n");
2db66876 1352
bd37e5a9
KS
1353 return len;
1354}
1355
9657d75c
DT
1356static ssize_t input_dev_show_modalias(struct device *dev,
1357 struct device_attribute *attr,
1358 char *buf)
bd37e5a9
KS
1359{
1360 struct input_dev *id = to_input_dev(dev);
1361 ssize_t len;
1362
2db66876
DT
1363 len = input_print_modalias(buf, PAGE_SIZE, id, 1);
1364
8a3cf456 1365 return min_t(int, len, PAGE_SIZE);
1d8f430c 1366}
9657d75c 1367static DEVICE_ATTR(modalias, S_IRUGO, input_dev_show_modalias, NULL);
1d8f430c 1368
85b77200
HR
1369static int input_print_bitmap(char *buf, int buf_size, unsigned long *bitmap,
1370 int max, int add_cr);
1371
1372static ssize_t input_dev_show_properties(struct device *dev,
1373 struct device_attribute *attr,
1374 char *buf)
1375{
1376 struct input_dev *input_dev = to_input_dev(dev);
1377 int len = input_print_bitmap(buf, PAGE_SIZE, input_dev->propbit,
1378 INPUT_PROP_MAX, true);
1379 return min_t(int, len, PAGE_SIZE);
1380}
1381static DEVICE_ATTR(properties, S_IRUGO, input_dev_show_properties, NULL);
1382
629b77a4 1383static struct attribute *input_dev_attrs[] = {
9657d75c
DT
1384 &dev_attr_name.attr,
1385 &dev_attr_phys.attr,
1386 &dev_attr_uniq.attr,
1387 &dev_attr_modalias.attr,
85b77200 1388 &dev_attr_properties.attr,
629b77a4
GKH
1389 NULL
1390};
1391
bd0ef235 1392static struct attribute_group input_dev_attr_group = {
629b77a4 1393 .attrs = input_dev_attrs,
5c1e9a6a
DT
1394};
1395
9657d75c
DT
1396#define INPUT_DEV_ID_ATTR(name) \
1397static ssize_t input_dev_show_id_##name(struct device *dev, \
1398 struct device_attribute *attr, \
1399 char *buf) \
1400{ \
1401 struct input_dev *input_dev = to_input_dev(dev); \
1402 return scnprintf(buf, PAGE_SIZE, "%04x\n", input_dev->id.name); \
1403} \
1404static DEVICE_ATTR(name, S_IRUGO, input_dev_show_id_##name, NULL)
5c1e9a6a
DT
1405
1406INPUT_DEV_ID_ATTR(bustype);
1407INPUT_DEV_ID_ATTR(vendor);
1408INPUT_DEV_ID_ATTR(product);
1409INPUT_DEV_ID_ATTR(version);
1410
1411static struct attribute *input_dev_id_attrs[] = {
9657d75c
DT
1412 &dev_attr_bustype.attr,
1413 &dev_attr_vendor.attr,
1414 &dev_attr_product.attr,
1415 &dev_attr_version.attr,
5c1e9a6a
DT
1416 NULL
1417};
1418
1419static struct attribute_group input_dev_id_attr_group = {
1420 .name = "id",
1421 .attrs = input_dev_id_attrs,
1422};
1423
969b21cd
DT
1424static int input_print_bitmap(char *buf, int buf_size, unsigned long *bitmap,
1425 int max, int add_cr)
1426{
1427 int i;
1428 int len = 0;
15e184af
DT
1429 bool skip_empty = true;
1430
1431 for (i = BITS_TO_LONGS(max) - 1; i >= 0; i--) {
1432 len += input_bits_to_string(buf + len, max(buf_size - len, 0),
1433 bitmap[i], skip_empty);
1434 if (len) {
1435 skip_empty = false;
1436 if (i > 0)
1437 len += snprintf(buf + len, max(buf_size - len, 0), " ");
1438 }
1439 }
969b21cd 1440
15e184af
DT
1441 /*
1442 * If no output was produced print a single 0.
1443 */
1444 if (len == 0)
1445 len = snprintf(buf, buf_size, "%d", 0);
969b21cd
DT
1446
1447 if (add_cr)
1448 len += snprintf(buf + len, max(buf_size - len, 0), "\n");
1449
1450 return len;
1451}
1452
9657d75c
DT
1453#define INPUT_DEV_CAP_ATTR(ev, bm) \
1454static ssize_t input_dev_show_cap_##bm(struct device *dev, \
1455 struct device_attribute *attr, \
1456 char *buf) \
1457{ \
1458 struct input_dev *input_dev = to_input_dev(dev); \
1459 int len = input_print_bitmap(buf, PAGE_SIZE, \
15e184af
DT
1460 input_dev->bm##bit, ev##_MAX, \
1461 true); \
9657d75c
DT
1462 return min_t(int, len, PAGE_SIZE); \
1463} \
1464static DEVICE_ATTR(bm, S_IRUGO, input_dev_show_cap_##bm, NULL)
5c1e9a6a
DT
1465
1466INPUT_DEV_CAP_ATTR(EV, ev);
1467INPUT_DEV_CAP_ATTR(KEY, key);
1468INPUT_DEV_CAP_ATTR(REL, rel);
1469INPUT_DEV_CAP_ATTR(ABS, abs);
1470INPUT_DEV_CAP_ATTR(MSC, msc);
1471INPUT_DEV_CAP_ATTR(LED, led);
1472INPUT_DEV_CAP_ATTR(SND, snd);
1473INPUT_DEV_CAP_ATTR(FF, ff);
1474INPUT_DEV_CAP_ATTR(SW, sw);
1475
1476static struct attribute *input_dev_caps_attrs[] = {
9657d75c
DT
1477 &dev_attr_ev.attr,
1478 &dev_attr_key.attr,
1479 &dev_attr_rel.attr,
1480 &dev_attr_abs.attr,
1481 &dev_attr_msc.attr,
1482 &dev_attr_led.attr,
1483 &dev_attr_snd.attr,
1484 &dev_attr_ff.attr,
1485 &dev_attr_sw.attr,
5c1e9a6a
DT
1486 NULL
1487};
1488
1489static struct attribute_group input_dev_caps_attr_group = {
1490 .name = "capabilities",
1491 .attrs = input_dev_caps_attrs,
1492};
1493
a4dbd674 1494static const struct attribute_group *input_dev_attr_groups[] = {
cb9def4d
DT
1495 &input_dev_attr_group,
1496 &input_dev_id_attr_group,
1497 &input_dev_caps_attr_group,
1498 NULL
1499};
1500
9657d75c 1501static void input_dev_release(struct device *device)
d19fbe8a 1502{
9657d75c 1503 struct input_dev *dev = to_input_dev(device);
d19fbe8a 1504
509ca1a9 1505 input_ff_destroy(dev);
40d007e7 1506 input_mt_destroy_slots(dev);
d31b2865 1507 kfree(dev->absinfo);
4369c64c 1508 kfree(dev->vals);
d19fbe8a 1509 kfree(dev);
509ca1a9 1510
d19fbe8a
DT
1511 module_put(THIS_MODULE);
1512}
1513
a7fadbe1 1514/*
312c004d 1515 * Input uevent interface - loading event handlers based on
a7fadbe1
DT
1516 * device bitfields.
1517 */
7eff2e7a 1518static int input_add_uevent_bm_var(struct kobj_uevent_env *env,
ac648a6a 1519 const char *name, unsigned long *bitmap, int max)
a7fadbe1 1520{
7eff2e7a 1521 int len;
a7fadbe1 1522
fcd3027a 1523 if (add_uevent_var(env, "%s", name))
a7fadbe1
DT
1524 return -ENOMEM;
1525
7eff2e7a
KS
1526 len = input_print_bitmap(&env->buf[env->buflen - 1],
1527 sizeof(env->buf) - env->buflen,
15e184af 1528 bitmap, max, false);
7eff2e7a 1529 if (len >= (sizeof(env->buf) - env->buflen))
a7fadbe1
DT
1530 return -ENOMEM;
1531
7eff2e7a 1532 env->buflen += len;
a7fadbe1
DT
1533 return 0;
1534}
1535
7eff2e7a 1536static int input_add_uevent_modalias_var(struct kobj_uevent_env *env,
ac648a6a
DT
1537 struct input_dev *dev)
1538{
7eff2e7a 1539 int len;
ac648a6a 1540
7eff2e7a 1541 if (add_uevent_var(env, "MODALIAS="))
ac648a6a
DT
1542 return -ENOMEM;
1543
7eff2e7a
KS
1544 len = input_print_modalias(&env->buf[env->buflen - 1],
1545 sizeof(env->buf) - env->buflen,
1546 dev, 0);
1547 if (len >= (sizeof(env->buf) - env->buflen))
ac648a6a
DT
1548 return -ENOMEM;
1549
7eff2e7a 1550 env->buflen += len;
ac648a6a
DT
1551 return 0;
1552}
1553
a7fadbe1
DT
1554#define INPUT_ADD_HOTPLUG_VAR(fmt, val...) \
1555 do { \
7eff2e7a 1556 int err = add_uevent_var(env, fmt, val); \
a7fadbe1
DT
1557 if (err) \
1558 return err; \
1559 } while (0)
1560
1561#define INPUT_ADD_HOTPLUG_BM_VAR(name, bm, max) \
1562 do { \
7eff2e7a 1563 int err = input_add_uevent_bm_var(env, name, bm, max); \
a7fadbe1
DT
1564 if (err) \
1565 return err; \
1566 } while (0)
1567
ac648a6a
DT
1568#define INPUT_ADD_HOTPLUG_MODALIAS_VAR(dev) \
1569 do { \
7eff2e7a 1570 int err = input_add_uevent_modalias_var(env, dev); \
ac648a6a
DT
1571 if (err) \
1572 return err; \
1573 } while (0)
1574
7eff2e7a 1575static int input_dev_uevent(struct device *device, struct kobj_uevent_env *env)
a7fadbe1 1576{
9657d75c 1577 struct input_dev *dev = to_input_dev(device);
a7fadbe1
DT
1578
1579 INPUT_ADD_HOTPLUG_VAR("PRODUCT=%x/%x/%x/%x",
1580 dev->id.bustype, dev->id.vendor,
1581 dev->id.product, dev->id.version);
1582 if (dev->name)
1583 INPUT_ADD_HOTPLUG_VAR("NAME=\"%s\"", dev->name);
1584 if (dev->phys)
1585 INPUT_ADD_HOTPLUG_VAR("PHYS=\"%s\"", dev->phys);
08de1f04 1586 if (dev->uniq)
a7fadbe1
DT
1587 INPUT_ADD_HOTPLUG_VAR("UNIQ=\"%s\"", dev->uniq);
1588
85b77200
HR
1589 INPUT_ADD_HOTPLUG_BM_VAR("PROP=", dev->propbit, INPUT_PROP_MAX);
1590
a7fadbe1
DT
1591 INPUT_ADD_HOTPLUG_BM_VAR("EV=", dev->evbit, EV_MAX);
1592 if (test_bit(EV_KEY, dev->evbit))
1593 INPUT_ADD_HOTPLUG_BM_VAR("KEY=", dev->keybit, KEY_MAX);
1594 if (test_bit(EV_REL, dev->evbit))
1595 INPUT_ADD_HOTPLUG_BM_VAR("REL=", dev->relbit, REL_MAX);
1596 if (test_bit(EV_ABS, dev->evbit))
1597 INPUT_ADD_HOTPLUG_BM_VAR("ABS=", dev->absbit, ABS_MAX);
1598 if (test_bit(EV_MSC, dev->evbit))
1599 INPUT_ADD_HOTPLUG_BM_VAR("MSC=", dev->mscbit, MSC_MAX);
1600 if (test_bit(EV_LED, dev->evbit))
1601 INPUT_ADD_HOTPLUG_BM_VAR("LED=", dev->ledbit, LED_MAX);
1602 if (test_bit(EV_SND, dev->evbit))
1603 INPUT_ADD_HOTPLUG_BM_VAR("SND=", dev->sndbit, SND_MAX);
1604 if (test_bit(EV_FF, dev->evbit))
1605 INPUT_ADD_HOTPLUG_BM_VAR("FF=", dev->ffbit, FF_MAX);
1606 if (test_bit(EV_SW, dev->evbit))
1607 INPUT_ADD_HOTPLUG_BM_VAR("SW=", dev->swbit, SW_MAX);
1608
ac648a6a 1609 INPUT_ADD_HOTPLUG_MODALIAS_VAR(dev);
a7fadbe1
DT
1610
1611 return 0;
1612}
1613
3cc96351
DT
1614#define INPUT_DO_TOGGLE(dev, type, bits, on) \
1615 do { \
1616 int i; \
1617 bool active; \
1618 \
1619 if (!test_bit(EV_##type, dev->evbit)) \
1620 break; \
1621 \
1622 for (i = 0; i < type##_MAX; i++) { \
1623 if (!test_bit(i, dev->bits##bit)) \
1624 continue; \
1625 \
1626 active = test_bit(i, dev->bits); \
1627 if (!active && !on) \
1628 continue; \
1629 \
1630 dev->event(dev, EV_##type, i, on ? active : 0); \
1631 } \
ffd0db97
DT
1632 } while (0)
1633
b50b5216 1634static void input_dev_toggle(struct input_dev *dev, bool activate)
ffd0db97
DT
1635{
1636 if (!dev->event)
1637 return;
1638
1639 INPUT_DO_TOGGLE(dev, LED, led, activate);
1640 INPUT_DO_TOGGLE(dev, SND, snd, activate);
1641
1642 if (activate && test_bit(EV_REP, dev->evbit)) {
1643 dev->event(dev, EV_REP, REP_PERIOD, dev->rep[REP_PERIOD]);
1644 dev->event(dev, EV_REP, REP_DELAY, dev->rep[REP_DELAY]);
1645 }
1646}
1647
b50b5216
DT
1648/**
1649 * input_reset_device() - reset/restore the state of input device
1650 * @dev: input device whose state needs to be reset
1651 *
1652 * This function tries to reset the state of an opened input device and
1653 * bring internal state and state if the hardware in sync with each other.
1654 * We mark all keys as released, restore LED state, repeat rate, etc.
1655 */
1656void input_reset_device(struct input_dev *dev)
1657{
768d9aa5 1658 unsigned long flags;
b50b5216 1659
768d9aa5
AM
1660 mutex_lock(&dev->mutex);
1661 spin_lock_irqsave(&dev->event_lock, flags);
b50b5216 1662
768d9aa5
AM
1663 input_dev_toggle(dev, true);
1664 input_dev_release_keys(dev);
b50b5216 1665
768d9aa5 1666 spin_unlock_irqrestore(&dev->event_lock, flags);
b50b5216
DT
1667 mutex_unlock(&dev->mutex);
1668}
1669EXPORT_SYMBOL(input_reset_device);
1670
768d9aa5 1671#ifdef CONFIG_PM_SLEEP
ffd0db97
DT
1672static int input_dev_suspend(struct device *dev)
1673{
1674 struct input_dev *input_dev = to_input_dev(dev);
1675
768d9aa5 1676 spin_lock_irq(&input_dev->event_lock);
b50b5216 1677
768d9aa5
AM
1678 /*
1679 * Keys that are pressed now are unlikely to be
1680 * still pressed when we resume.
1681 */
1682 input_dev_release_keys(input_dev);
b50b5216 1683
768d9aa5
AM
1684 /* Turn off LEDs and sounds, if any are active. */
1685 input_dev_toggle(input_dev, false);
1686
1687 spin_unlock_irq(&input_dev->event_lock);
ffd0db97
DT
1688
1689 return 0;
1690}
1691
1692static int input_dev_resume(struct device *dev)
1693{
1694 struct input_dev *input_dev = to_input_dev(dev);
1695
768d9aa5
AM
1696 spin_lock_irq(&input_dev->event_lock);
1697
1698 /* Restore state of LEDs and sounds, if any were active. */
1699 input_dev_toggle(input_dev, true);
1700
1701 spin_unlock_irq(&input_dev->event_lock);
1702
1703 return 0;
1704}
1705
1706static int input_dev_freeze(struct device *dev)
1707{
1708 struct input_dev *input_dev = to_input_dev(dev);
1709
1710 spin_lock_irq(&input_dev->event_lock);
1711
1712 /*
1713 * Keys that are pressed now are unlikely to be
1714 * still pressed when we resume.
1715 */
1716 input_dev_release_keys(input_dev);
1717
1718 spin_unlock_irq(&input_dev->event_lock);
1719
1720 return 0;
1721}
1722
1723static int input_dev_poweroff(struct device *dev)
1724{
1725 struct input_dev *input_dev = to_input_dev(dev);
1726
1727 spin_lock_irq(&input_dev->event_lock);
1728
1729 /* Turn off LEDs and sounds, if any are active. */
1730 input_dev_toggle(input_dev, false);
1731
1732 spin_unlock_irq(&input_dev->event_lock);
ffd0db97
DT
1733
1734 return 0;
1735}
1736
1737static const struct dev_pm_ops input_dev_pm_ops = {
1738 .suspend = input_dev_suspend,
1739 .resume = input_dev_resume,
768d9aa5
AM
1740 .freeze = input_dev_freeze,
1741 .poweroff = input_dev_poweroff,
ffd0db97
DT
1742 .restore = input_dev_resume,
1743};
1744#endif /* CONFIG_PM */
1745
9657d75c
DT
1746static struct device_type input_dev_type = {
1747 .groups = input_dev_attr_groups,
1748 .release = input_dev_release,
1749 .uevent = input_dev_uevent,
768d9aa5 1750#ifdef CONFIG_PM_SLEEP
ffd0db97
DT
1751 .pm = &input_dev_pm_ops,
1752#endif
9657d75c
DT
1753};
1754
2c9ede55 1755static char *input_devnode(struct device *dev, umode_t *mode)
aa5ed63e
KS
1756{
1757 return kasprintf(GFP_KERNEL, "input/%s", dev_name(dev));
1758}
1759
ea9f240b 1760struct class input_class = {
9657d75c 1761 .name = "input",
e454cea2 1762 .devnode = input_devnode,
d19fbe8a 1763};
ca56fe07 1764EXPORT_SYMBOL_GPL(input_class);
d19fbe8a 1765
1447190e
DT
1766/**
1767 * input_allocate_device - allocate memory for new input device
1768 *
2be975c6 1769 * Returns prepared struct input_dev or %NULL.
1447190e
DT
1770 *
1771 * NOTE: Use input_free_device() to free devices that have not been
1772 * registered; input_unregister_device() should be used for already
1773 * registered devices.
1774 */
d19fbe8a
DT
1775struct input_dev *input_allocate_device(void)
1776{
a60a71b0 1777 static atomic_t input_no = ATOMIC_INIT(0);
d19fbe8a
DT
1778 struct input_dev *dev;
1779
1780 dev = kzalloc(sizeof(struct input_dev), GFP_KERNEL);
1781 if (dev) {
9657d75c
DT
1782 dev->dev.type = &input_dev_type;
1783 dev->dev.class = &input_class;
1784 device_initialize(&dev->dev);
f60d2b11 1785 mutex_init(&dev->mutex);
8006479c 1786 spin_lock_init(&dev->event_lock);
a60a71b0 1787 init_timer(&dev->timer);
d19fbe8a
DT
1788 INIT_LIST_HEAD(&dev->h_list);
1789 INIT_LIST_HEAD(&dev->node);
655816e4 1790
a60a71b0
DH
1791 dev_set_name(&dev->dev, "input%ld",
1792 (unsigned long) atomic_inc_return(&input_no) - 1);
1793
655816e4 1794 __module_get(THIS_MODULE);
d19fbe8a
DT
1795 }
1796
1797 return dev;
1798}
ca56fe07 1799EXPORT_SYMBOL(input_allocate_device);
d19fbe8a 1800
2be975c6
DT
1801struct input_devres {
1802 struct input_dev *input;
1803};
1804
1805static int devm_input_device_match(struct device *dev, void *res, void *data)
1806{
1807 struct input_devres *devres = res;
1808
1809 return devres->input == data;
1810}
1811
1812static void devm_input_device_release(struct device *dev, void *res)
1813{
1814 struct input_devres *devres = res;
1815 struct input_dev *input = devres->input;
1816
1817 dev_dbg(dev, "%s: dropping reference to %s\n",
1818 __func__, dev_name(&input->dev));
1819 input_put_device(input);
1820}
1821
1822/**
1823 * devm_input_allocate_device - allocate managed input device
1824 * @dev: device owning the input device being created
1825 *
1826 * Returns prepared struct input_dev or %NULL.
1827 *
1828 * Managed input devices do not need to be explicitly unregistered or
1829 * freed as it will be done automatically when owner device unbinds from
1830 * its driver (or binding fails). Once managed input device is allocated,
1831 * it is ready to be set up and registered in the same fashion as regular
1832 * input device. There are no special devm_input_device_[un]register()
b666263b
DT
1833 * variants, regular ones work with both managed and unmanaged devices,
1834 * should you need them. In most cases however, managed input device need
1835 * not be explicitly unregistered or freed.
2be975c6
DT
1836 *
1837 * NOTE: the owner device is set up as parent of input device and users
1838 * should not override it.
1839 */
2be975c6
DT
1840struct input_dev *devm_input_allocate_device(struct device *dev)
1841{
1842 struct input_dev *input;
1843 struct input_devres *devres;
1844
1845 devres = devres_alloc(devm_input_device_release,
1846 sizeof(struct input_devres), GFP_KERNEL);
1847 if (!devres)
1848 return NULL;
1849
1850 input = input_allocate_device();
1851 if (!input) {
1852 devres_free(devres);
1853 return NULL;
1854 }
1855
1856 input->dev.parent = dev;
1857 input->devres_managed = true;
1858
1859 devres->input = input;
1860 devres_add(dev, devres);
1861
1862 return input;
1863}
1864EXPORT_SYMBOL(devm_input_allocate_device);
1865
1447190e
DT
1866/**
1867 * input_free_device - free memory occupied by input_dev structure
1868 * @dev: input device to free
1869 *
1870 * This function should only be used if input_register_device()
1871 * was not called yet or if it failed. Once device was registered
1872 * use input_unregister_device() and memory will be freed once last
8006479c 1873 * reference to the device is dropped.
1447190e
DT
1874 *
1875 * Device should be allocated by input_allocate_device().
1876 *
1877 * NOTE: If there are references to the input device then memory
1878 * will not be freed until last reference is dropped.
1879 */
f60d2b11
DT
1880void input_free_device(struct input_dev *dev)
1881{
2be975c6
DT
1882 if (dev) {
1883 if (dev->devres_managed)
1884 WARN_ON(devres_destroy(dev->dev.parent,
1885 devm_input_device_release,
1886 devm_input_device_match,
1887 dev));
f60d2b11 1888 input_put_device(dev);
2be975c6 1889 }
f60d2b11 1890}
ca56fe07 1891EXPORT_SYMBOL(input_free_device);
f60d2b11 1892
534565f2
DT
1893/**
1894 * input_set_capability - mark device as capable of a certain event
1895 * @dev: device that is capable of emitting or accepting event
1896 * @type: type of the event (EV_KEY, EV_REL, etc...)
1897 * @code: event code
1898 *
1899 * In addition to setting up corresponding bit in appropriate capability
1900 * bitmap the function also adjusts dev->evbit.
1901 */
1902void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code)
1903{
1904 switch (type) {
1905 case EV_KEY:
1906 __set_bit(code, dev->keybit);
1907 break;
1908
1909 case EV_REL:
1910 __set_bit(code, dev->relbit);
1911 break;
1912
1913 case EV_ABS:
28a2a2e1
DT
1914 input_alloc_absinfo(dev);
1915 if (!dev->absinfo)
1916 return;
1917
534565f2
DT
1918 __set_bit(code, dev->absbit);
1919 break;
1920
1921 case EV_MSC:
1922 __set_bit(code, dev->mscbit);
1923 break;
1924
1925 case EV_SW:
1926 __set_bit(code, dev->swbit);
1927 break;
1928
1929 case EV_LED:
1930 __set_bit(code, dev->ledbit);
1931 break;
1932
1933 case EV_SND:
1934 __set_bit(code, dev->sndbit);
1935 break;
1936
1937 case EV_FF:
1938 __set_bit(code, dev->ffbit);
1939 break;
1940
22d1c398
DB
1941 case EV_PWR:
1942 /* do nothing */
1943 break;
1944
534565f2 1945 default:
da0c4901
JP
1946 pr_err("input_set_capability: unknown type %u (code %u)\n",
1947 type, code);
534565f2
DT
1948 dump_stack();
1949 return;
1950 }
1951
1952 __set_bit(type, dev->evbit);
1953}
1954EXPORT_SYMBOL(input_set_capability);
1955
80b4895a
JB
1956static unsigned int input_estimate_events_per_packet(struct input_dev *dev)
1957{
1958 int mt_slots;
1959 int i;
1960 unsigned int events;
1961
8d18fba2
HR
1962 if (dev->mt) {
1963 mt_slots = dev->mt->num_slots;
80b4895a
JB
1964 } else if (test_bit(ABS_MT_TRACKING_ID, dev->absbit)) {
1965 mt_slots = dev->absinfo[ABS_MT_TRACKING_ID].maximum -
1966 dev->absinfo[ABS_MT_TRACKING_ID].minimum + 1,
8c127f07 1967 mt_slots = clamp(mt_slots, 2, 32);
80b4895a
JB
1968 } else if (test_bit(ABS_MT_POSITION_X, dev->absbit)) {
1969 mt_slots = 2;
1970 } else {
1971 mt_slots = 0;
1972 }
1973
1974 events = mt_slots + 1; /* count SYN_MT_REPORT and SYN_REPORT */
1975
1976 for (i = 0; i < ABS_CNT; i++) {
1977 if (test_bit(i, dev->absbit)) {
1978 if (input_is_mt_axis(i))
1979 events += mt_slots;
1980 else
1981 events++;
1982 }
1983 }
1984
1985 for (i = 0; i < REL_CNT; i++)
1986 if (test_bit(i, dev->relbit))
1987 events++;
1988
7c75bf99
HR
1989 /* Make room for KEY and MSC events */
1990 events += 7;
1991
80b4895a
JB
1992 return events;
1993}
1994
92a3a587
DT
1995#define INPUT_CLEANSE_BITMASK(dev, type, bits) \
1996 do { \
1997 if (!test_bit(EV_##type, dev->evbit)) \
1998 memset(dev->bits##bit, 0, \
1999 sizeof(dev->bits##bit)); \
2000 } while (0)
2001
2002static void input_cleanse_bitmasks(struct input_dev *dev)
2003{
2004 INPUT_CLEANSE_BITMASK(dev, KEY, key);
2005 INPUT_CLEANSE_BITMASK(dev, REL, rel);
2006 INPUT_CLEANSE_BITMASK(dev, ABS, abs);
2007 INPUT_CLEANSE_BITMASK(dev, MSC, msc);
2008 INPUT_CLEANSE_BITMASK(dev, LED, led);
2009 INPUT_CLEANSE_BITMASK(dev, SND, snd);
2010 INPUT_CLEANSE_BITMASK(dev, FF, ff);
2011 INPUT_CLEANSE_BITMASK(dev, SW, sw);
2012}
2013
2be975c6
DT
2014static void __input_unregister_device(struct input_dev *dev)
2015{
2016 struct input_handle *handle, *next;
2017
2018 input_disconnect_device(dev);
2019
2020 mutex_lock(&input_mutex);
2021
2022 list_for_each_entry_safe(handle, next, &dev->h_list, d_node)
2023 handle->handler->disconnect(handle);
2024 WARN_ON(!list_empty(&dev->h_list));
2025
2026 del_timer_sync(&dev->timer);
2027 list_del_init(&dev->node);
2028
2029 input_wakeup_procfs_readers();
2030
2031 mutex_unlock(&input_mutex);
2032
2033 device_del(&dev->dev);
2034}
2035
2036static void devm_input_device_unregister(struct device *dev, void *res)
2037{
2038 struct input_devres *devres = res;
2039 struct input_dev *input = devres->input;
2040
2041 dev_dbg(dev, "%s: unregistering device %s\n",
2042 __func__, dev_name(&input->dev));
2043 __input_unregister_device(input);
2044}
2045
8006479c
DT
2046/**
2047 * input_register_device - register device with input core
2048 * @dev: device to be registered
2049 *
2050 * This function registers device with input core. The device must be
2051 * allocated with input_allocate_device() and all it's capabilities
2052 * set up before registering.
2053 * If function fails the device must be freed with input_free_device().
2054 * Once device has been successfully registered it can be unregistered
2055 * with input_unregister_device(); input_free_device() should not be
2056 * called in this case.
b666263b
DT
2057 *
2058 * Note that this function is also used to register managed input devices
2059 * (ones allocated with devm_input_allocate_device()). Such managed input
2060 * devices need not be explicitly unregistered or freed, their tear down
2061 * is controlled by the devres infrastructure. It is also worth noting
2062 * that tear down of managed input devices is internally a 2-step process:
2063 * registered managed input device is first unregistered, but stays in
2064 * memory and can still handle input_event() calls (although events will
2065 * not be delivered anywhere). The freeing of managed input device will
2066 * happen later, when devres stack is unwound to the point where device
2067 * allocation was made.
8006479c 2068 */
5f945489 2069int input_register_device(struct input_dev *dev)
1da177e4 2070{
2be975c6 2071 struct input_devres *devres = NULL;
1da177e4 2072 struct input_handler *handler;
7c75bf99 2073 unsigned int packet_size;
bd0ef235
DT
2074 const char *path;
2075 int error;
1da177e4 2076
2be975c6
DT
2077 if (dev->devres_managed) {
2078 devres = devres_alloc(devm_input_device_unregister,
2079 sizeof(struct input_devres), GFP_KERNEL);
2080 if (!devres)
2081 return -ENOMEM;
2082
2083 devres->input = dev;
2084 }
2085
4f93df40 2086 /* Every input device generates EV_SYN/SYN_REPORT events. */
8006479c 2087 __set_bit(EV_SYN, dev->evbit);
0fbf87ca 2088
4f93df40
DT
2089 /* KEY_RESERVED is not supposed to be transmitted to userspace. */
2090 __clear_bit(KEY_RESERVED, dev->keybit);
2091
92a3a587
DT
2092 /* Make sure that bitmasks not mentioned in dev->evbit are clean. */
2093 input_cleanse_bitmasks(dev);
2094
7c75bf99
HR
2095 packet_size = input_estimate_events_per_packet(dev);
2096 if (dev->hint_events_per_packet < packet_size)
2097 dev->hint_events_per_packet = packet_size;
80b4895a 2098
95079b8a 2099 dev->max_vals = dev->hint_events_per_packet + 2;
4369c64c 2100 dev->vals = kcalloc(dev->max_vals, sizeof(*dev->vals), GFP_KERNEL);
2be975c6
DT
2101 if (!dev->vals) {
2102 error = -ENOMEM;
2103 goto err_devres_free;
2104 }
80b4895a 2105
1da177e4
LT
2106 /*
2107 * If delay and period are pre-set by the driver, then autorepeating
2108 * is handled by the driver itself and we don't do it in input.c.
2109 */
1da177e4
LT
2110 if (!dev->rep[REP_DELAY] && !dev->rep[REP_PERIOD]) {
2111 dev->timer.data = (long) dev;
2112 dev->timer.function = input_repeat_key;
2113 dev->rep[REP_DELAY] = 250;
2114 dev->rep[REP_PERIOD] = 33;
2115 }
2116
aebd636b
DT
2117 if (!dev->getkeycode)
2118 dev->getkeycode = input_default_getkeycode;
c8e4c772 2119
aebd636b
DT
2120 if (!dev->setkeycode)
2121 dev->setkeycode = input_default_setkeycode;
c8e4c772 2122
9657d75c 2123 error = device_add(&dev->dev);
bd0ef235 2124 if (error)
2be975c6 2125 goto err_free_vals;
bd0ef235 2126
9657d75c 2127 path = kobject_get_path(&dev->dev.kobj, GFP_KERNEL);
da0c4901
JP
2128 pr_info("%s as %s\n",
2129 dev->name ? dev->name : "Unspecified device",
2130 path ? path : "N/A");
bd0ef235 2131 kfree(path);
10204020 2132
8006479c 2133 error = mutex_lock_interruptible(&input_mutex);
2be975c6
DT
2134 if (error)
2135 goto err_device_del;
8006479c
DT
2136
2137 list_add_tail(&dev->node, &input_dev_list);
2138
1da177e4 2139 list_for_each_entry(handler, &input_handler_list, node)
5b2a0826 2140 input_attach_handler(dev, handler);
1da177e4 2141
f96b434d 2142 input_wakeup_procfs_readers();
5f945489 2143
8006479c
DT
2144 mutex_unlock(&input_mutex);
2145
2be975c6
DT
2146 if (dev->devres_managed) {
2147 dev_dbg(dev->dev.parent, "%s: registering %s with devres.\n",
2148 __func__, dev_name(&dev->dev));
2149 devres_add(dev->dev.parent, devres);
2150 }
5f945489 2151 return 0;
2be975c6
DT
2152
2153err_device_del:
2154 device_del(&dev->dev);
2155err_free_vals:
2156 kfree(dev->vals);
2157 dev->vals = NULL;
2158err_devres_free:
2159 devres_free(devres);
2160 return error;
1da177e4 2161}
ca56fe07 2162EXPORT_SYMBOL(input_register_device);
1da177e4 2163
8006479c
DT
2164/**
2165 * input_unregister_device - unregister previously registered device
2166 * @dev: device to be unregistered
2167 *
2168 * This function unregisters an input device. Once device is unregistered
2169 * the caller should not try to access it as it may get freed at any moment.
2170 */
1da177e4
LT
2171void input_unregister_device(struct input_dev *dev)
2172{
2be975c6
DT
2173 if (dev->devres_managed) {
2174 WARN_ON(devres_destroy(dev->dev.parent,
2175 devm_input_device_unregister,
2176 devm_input_device_match,
2177 dev));
2178 __input_unregister_device(dev);
2179 /*
2180 * We do not do input_put_device() here because it will be done
2181 * when 2nd devres fires up.
2182 */
2183 } else {
2184 __input_unregister_device(dev);
2185 input_put_device(dev);
2186 }
1da177e4 2187}
ca56fe07 2188EXPORT_SYMBOL(input_unregister_device);
1da177e4 2189
8006479c
DT
2190/**
2191 * input_register_handler - register a new input handler
2192 * @handler: handler to be registered
2193 *
2194 * This function registers a new input handler (interface) for input
2195 * devices in the system and attaches it to all input devices that
2196 * are compatible with the handler.
2197 */
4263cf0f 2198int input_register_handler(struct input_handler *handler)
1da177e4
LT
2199{
2200 struct input_dev *dev;
7f8d4cad 2201 int error;
8006479c 2202
7f8d4cad
DT
2203 error = mutex_lock_interruptible(&input_mutex);
2204 if (error)
2205 return error;
1da177e4 2206
1da177e4
LT
2207 INIT_LIST_HEAD(&handler->h_list);
2208
1da177e4
LT
2209 list_add_tail(&handler->node, &input_handler_list);
2210
2211 list_for_each_entry(dev, &input_dev_list, node)
5b2a0826 2212 input_attach_handler(dev, handler);
1da177e4 2213
f96b434d 2214 input_wakeup_procfs_readers();
8006479c 2215
8006479c 2216 mutex_unlock(&input_mutex);
7f8d4cad 2217 return 0;
1da177e4 2218}
ca56fe07 2219EXPORT_SYMBOL(input_register_handler);
1da177e4 2220
8006479c
DT
2221/**
2222 * input_unregister_handler - unregisters an input handler
2223 * @handler: handler to be unregistered
2224 *
2225 * This function disconnects a handler from its input devices and
2226 * removes it from lists of known handlers.
2227 */
1da177e4
LT
2228void input_unregister_handler(struct input_handler *handler)
2229{
5b2a0826 2230 struct input_handle *handle, *next;
1da177e4 2231
8006479c
DT
2232 mutex_lock(&input_mutex);
2233
5b2a0826 2234 list_for_each_entry_safe(handle, next, &handler->h_list, h_node)
1da177e4 2235 handler->disconnect(handle);
5b2a0826 2236 WARN_ON(!list_empty(&handler->h_list));
1da177e4
LT
2237
2238 list_del_init(&handler->node);
2239
f96b434d 2240 input_wakeup_procfs_readers();
8006479c
DT
2241
2242 mutex_unlock(&input_mutex);
1da177e4 2243}
ca56fe07 2244EXPORT_SYMBOL(input_unregister_handler);
1da177e4 2245
66d2a595
DT
2246/**
2247 * input_handler_for_each_handle - handle iterator
2248 * @handler: input handler to iterate
2249 * @data: data for the callback
2250 * @fn: function to be called for each handle
2251 *
2252 * Iterate over @bus's list of devices, and call @fn for each, passing
2253 * it @data and stop when @fn returns a non-zero value. The function is
2254 * using RCU to traverse the list and therefore may be usind in atonic
2255 * contexts. The @fn callback is invoked from RCU critical section and
2256 * thus must not sleep.
2257 */
2258int input_handler_for_each_handle(struct input_handler *handler, void *data,
2259 int (*fn)(struct input_handle *, void *))
2260{
2261 struct input_handle *handle;
2262 int retval = 0;
2263
2264 rcu_read_lock();
2265
2266 list_for_each_entry_rcu(handle, &handler->h_list, h_node) {
2267 retval = fn(handle, data);
2268 if (retval)
2269 break;
2270 }
2271
2272 rcu_read_unlock();
2273
2274 return retval;
2275}
2276EXPORT_SYMBOL(input_handler_for_each_handle);
2277
8006479c
DT
2278/**
2279 * input_register_handle - register a new input handle
2280 * @handle: handle to register
2281 *
2282 * This function puts a new input handle onto device's
2283 * and handler's lists so that events can flow through
2284 * it once it is opened using input_open_device().
2285 *
2286 * This function is supposed to be called from handler's
2287 * connect() method.
2288 */
5b2a0826
DT
2289int input_register_handle(struct input_handle *handle)
2290{
2291 struct input_handler *handler = handle->handler;
8006479c
DT
2292 struct input_dev *dev = handle->dev;
2293 int error;
2294
2295 /*
2296 * We take dev->mutex here to prevent race with
2297 * input_release_device().
2298 */
2299 error = mutex_lock_interruptible(&dev->mutex);
2300 if (error)
2301 return error;
ef7995f4
DT
2302
2303 /*
2304 * Filters go to the head of the list, normal handlers
2305 * to the tail.
2306 */
2307 if (handler->filter)
2308 list_add_rcu(&handle->d_node, &dev->h_list);
2309 else
2310 list_add_tail_rcu(&handle->d_node, &dev->h_list);
2311
8006479c 2312 mutex_unlock(&dev->mutex);
5b2a0826 2313
8006479c
DT
2314 /*
2315 * Since we are supposed to be called from ->connect()
2316 * which is mutually exclusive with ->disconnect()
2317 * we can't be racing with input_unregister_handle()
2318 * and so separate lock is not needed here.
2319 */
66d2a595 2320 list_add_tail_rcu(&handle->h_node, &handler->h_list);
5b2a0826
DT
2321
2322 if (handler->start)
2323 handler->start(handle);
2324
2325 return 0;
2326}
2327EXPORT_SYMBOL(input_register_handle);
2328
8006479c
DT
2329/**
2330 * input_unregister_handle - unregister an input handle
2331 * @handle: handle to unregister
2332 *
2333 * This function removes input handle from device's
2334 * and handler's lists.
2335 *
2336 * This function is supposed to be called from handler's
2337 * disconnect() method.
2338 */
5b2a0826
DT
2339void input_unregister_handle(struct input_handle *handle)
2340{
8006479c
DT
2341 struct input_dev *dev = handle->dev;
2342
66d2a595 2343 list_del_rcu(&handle->h_node);
8006479c
DT
2344
2345 /*
2346 * Take dev->mutex to prevent race with input_release_device().
2347 */
2348 mutex_lock(&dev->mutex);
2349 list_del_rcu(&handle->d_node);
2350 mutex_unlock(&dev->mutex);
66d2a595 2351
82ba56c2 2352 synchronize_rcu();
5b2a0826
DT
2353}
2354EXPORT_SYMBOL(input_unregister_handle);
2355
7f8d4cad
DT
2356/**
2357 * input_get_new_minor - allocates a new input minor number
2358 * @legacy_base: beginning or the legacy range to be searched
2359 * @legacy_num: size of legacy range
2360 * @allow_dynamic: whether we can also take ID from the dynamic range
2361 *
2362 * This function allocates a new device minor for from input major namespace.
2363 * Caller can request legacy minor by specifying @legacy_base and @legacy_num
2364 * parameters and whether ID can be allocated from dynamic range if there are
2365 * no free IDs in legacy range.
2366 */
2367int input_get_new_minor(int legacy_base, unsigned int legacy_num,
2368 bool allow_dynamic)
1da177e4 2369{
1da177e4 2370 /*
7f8d4cad
DT
2371 * This function should be called from input handler's ->connect()
2372 * methods, which are serialized with input_mutex, so no additional
2373 * locking is needed here.
1da177e4 2374 */
7f8d4cad
DT
2375 if (legacy_base >= 0) {
2376 int minor = ida_simple_get(&input_ida,
2377 legacy_base,
2378 legacy_base + legacy_num,
2379 GFP_KERNEL);
2380 if (minor >= 0 || !allow_dynamic)
2381 return minor;
1da177e4 2382 }
2f2177c8 2383
7f8d4cad
DT
2384 return ida_simple_get(&input_ida,
2385 INPUT_FIRST_DYNAMIC_DEV, INPUT_MAX_CHAR_DEVICES,
2386 GFP_KERNEL);
1da177e4 2387}
7f8d4cad 2388EXPORT_SYMBOL(input_get_new_minor);
1da177e4 2389
7f8d4cad
DT
2390/**
2391 * input_free_minor - release previously allocated minor
2392 * @minor: minor to be released
2393 *
2394 * This function releases previously allocated input minor so that it can be
2395 * reused later.
2396 */
2397void input_free_minor(unsigned int minor)
2398{
2399 ida_simple_remove(&input_ida, minor);
2400}
2401EXPORT_SYMBOL(input_free_minor);
1da177e4 2402
f96b434d 2403static int __init input_init(void)
1da177e4 2404{
f96b434d 2405 int err;
1da177e4 2406
ea9f240b 2407 err = class_register(&input_class);
d19fbe8a 2408 if (err) {
da0c4901 2409 pr_err("unable to register input_dev class\n");
d19fbe8a
DT
2410 return err;
2411 }
2412
f96b434d
DT
2413 err = input_proc_init();
2414 if (err)
b0fdfebb 2415 goto fail1;
1da177e4 2416
7f8d4cad
DT
2417 err = register_chrdev_region(MKDEV(INPUT_MAJOR, 0),
2418 INPUT_MAX_CHAR_DEVICES, "input");
f96b434d 2419 if (err) {
da0c4901 2420 pr_err("unable to register char major %d", INPUT_MAJOR);
b0fdfebb 2421 goto fail2;
1da177e4 2422 }
e334016f 2423
1da177e4 2424 return 0;
1da177e4 2425
b0fdfebb 2426 fail2: input_proc_exit();
ea9f240b 2427 fail1: class_unregister(&input_class);
f96b434d 2428 return err;
1da177e4
LT
2429}
2430
2431static void __exit input_exit(void)
2432{
f96b434d 2433 input_proc_exit();
7f8d4cad
DT
2434 unregister_chrdev_region(MKDEV(INPUT_MAJOR, 0),
2435 INPUT_MAX_CHAR_DEVICES);
ea9f240b 2436 class_unregister(&input_class);
1da177e4
LT
2437}
2438
2439subsys_initcall(input_init);
2440module_exit(input_exit);