Merge tag 'pwm/for-4.8-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/thierry...
[deliverable/linux.git] / drivers / media / rc / rc-main.c
CommitLineData
829ba9fe 1/* rc-main.c - Remote Controller core module
ef53a115 2 *
37e59f87 3 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
446e4a64
MCC
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation version 2 of the License.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
ef53a115
MCC
13 */
14
6bda9644 15#include <media/rc-core.h>
078600f5 16#include <linux/atomic.h>
631493ec
MCC
17#include <linux/spinlock.h>
18#include <linux/delay.h>
882ead32 19#include <linux/input.h>
153a60bb 20#include <linux/leds.h>
5a0e3ad6 21#include <linux/slab.h>
fcb13097 22#include <linux/idr.h>
bc2a6c57 23#include <linux/device.h>
7a707b89 24#include <linux/module.h>
f62de675 25#include "rc-core-priv.h"
ef53a115 26
b3074c0a
DH
27/* Sizes are in bytes, 256 bytes allows for 32 entries on x64 */
28#define IR_TAB_MIN_SIZE 256
29#define IR_TAB_MAX_SIZE 8192
fcb13097 30#define RC_DEV_MAX 256
f6fc5049 31
a374fef4
DH
32/* FIXME: IR_KEYPRESS_TIMEOUT should be protocol specific */
33#define IR_KEYPRESS_TIMEOUT 250
34
4c7b355d 35/* Used to keep track of known keymaps */
631493ec
MCC
36static LIST_HEAD(rc_map_list);
37static DEFINE_SPINLOCK(rc_map_lock);
153a60bb 38static struct led_trigger *led_feedback;
631493ec 39
fcb13097
DH
40/* Used to keep track of rc devices */
41static DEFINE_IDA(rc_ida);
42
d100e659 43static struct rc_map_list *seek_rc_map(const char *name)
631493ec 44{
d100e659 45 struct rc_map_list *map = NULL;
631493ec
MCC
46
47 spin_lock(&rc_map_lock);
48 list_for_each_entry(map, &rc_map_list, list) {
49 if (!strcmp(name, map->map.name)) {
50 spin_unlock(&rc_map_lock);
51 return map;
52 }
53 }
54 spin_unlock(&rc_map_lock);
55
56 return NULL;
57}
58
d100e659 59struct rc_map *rc_map_get(const char *name)
631493ec
MCC
60{
61
d100e659 62 struct rc_map_list *map;
631493ec
MCC
63
64 map = seek_rc_map(name);
2ff56fad 65#ifdef CONFIG_MODULES
631493ec 66 if (!map) {
8ea5488a 67 int rc = request_module("%s", name);
631493ec
MCC
68 if (rc < 0) {
69 printk(KERN_ERR "Couldn't load IR keymap %s\n", name);
70 return NULL;
71 }
72 msleep(20); /* Give some time for IR to register */
73
74 map = seek_rc_map(name);
75 }
76#endif
77 if (!map) {
78 printk(KERN_ERR "IR keymap %s not found\n", name);
79 return NULL;
80 }
81
82 printk(KERN_INFO "Registered IR keymap %s\n", map->map.name);
83
84 return &map->map;
85}
d100e659 86EXPORT_SYMBOL_GPL(rc_map_get);
631493ec 87
d100e659 88int rc_map_register(struct rc_map_list *map)
631493ec
MCC
89{
90 spin_lock(&rc_map_lock);
91 list_add_tail(&map->list, &rc_map_list);
92 spin_unlock(&rc_map_lock);
93 return 0;
94}
d100e659 95EXPORT_SYMBOL_GPL(rc_map_register);
631493ec 96
d100e659 97void rc_map_unregister(struct rc_map_list *map)
631493ec
MCC
98{
99 spin_lock(&rc_map_lock);
100 list_del(&map->list);
101 spin_unlock(&rc_map_lock);
102}
d100e659 103EXPORT_SYMBOL_GPL(rc_map_unregister);
631493ec
MCC
104
105
2f4f58d6 106static struct rc_map_table empty[] = {
631493ec
MCC
107 { 0x2a, KEY_COFFEE },
108};
109
d100e659 110static struct rc_map_list empty_map = {
631493ec
MCC
111 .map = {
112 .scan = empty,
113 .size = ARRAY_SIZE(empty),
52b66144 114 .rc_type = RC_TYPE_UNKNOWN, /* Legacy IR type */
631493ec
MCC
115 .name = RC_MAP_EMPTY,
116 }
117};
118
9f470095
DT
119/**
120 * ir_create_table() - initializes a scancode table
b088ba65 121 * @rc_map: the rc_map to initialize
9f470095 122 * @name: name to assign to the table
52b66144 123 * @rc_type: ir type to assign to the new table
9f470095
DT
124 * @size: initial size of the table
125 * @return: zero on success or a negative error code
126 *
b088ba65 127 * This routine will initialize the rc_map and will allocate
d8b4b582 128 * memory to hold at least the specified number of elements.
9f470095 129 */
b088ba65 130static int ir_create_table(struct rc_map *rc_map,
52b66144 131 const char *name, u64 rc_type, size_t size)
9f470095 132{
d54fc3bb
HV
133 rc_map->name = kstrdup(name, GFP_KERNEL);
134 if (!rc_map->name)
135 return -ENOMEM;
b088ba65 136 rc_map->rc_type = rc_type;
2f4f58d6
MCC
137 rc_map->alloc = roundup_pow_of_two(size * sizeof(struct rc_map_table));
138 rc_map->size = rc_map->alloc / sizeof(struct rc_map_table);
b088ba65 139 rc_map->scan = kmalloc(rc_map->alloc, GFP_KERNEL);
d54fc3bb
HV
140 if (!rc_map->scan) {
141 kfree(rc_map->name);
142 rc_map->name = NULL;
9f470095 143 return -ENOMEM;
d54fc3bb 144 }
9f470095
DT
145
146 IR_dprintk(1, "Allocated space for %u keycode entries (%u bytes)\n",
b088ba65 147 rc_map->size, rc_map->alloc);
9f470095
DT
148 return 0;
149}
150
151/**
152 * ir_free_table() - frees memory allocated by a scancode table
b088ba65 153 * @rc_map: the table whose mappings need to be freed
9f470095
DT
154 *
155 * This routine will free memory alloctaed for key mappings used by given
156 * scancode table.
157 */
b088ba65 158static void ir_free_table(struct rc_map *rc_map)
9f470095 159{
b088ba65 160 rc_map->size = 0;
d54fc3bb 161 kfree(rc_map->name);
b088ba65
MCC
162 kfree(rc_map->scan);
163 rc_map->scan = NULL;
9f470095
DT
164}
165
7fee03e4 166/**
b3074c0a 167 * ir_resize_table() - resizes a scancode table if necessary
b088ba65 168 * @rc_map: the rc_map to resize
9f470095 169 * @gfp_flags: gfp flags to use when allocating memory
b3074c0a 170 * @return: zero on success or a negative error code
7fee03e4 171 *
b088ba65 172 * This routine will shrink the rc_map if it has lots of
b3074c0a 173 * unused entries and grow it if it is full.
7fee03e4 174 */
b088ba65 175static int ir_resize_table(struct rc_map *rc_map, gfp_t gfp_flags)
7fee03e4 176{
b088ba65 177 unsigned int oldalloc = rc_map->alloc;
b3074c0a 178 unsigned int newalloc = oldalloc;
2f4f58d6
MCC
179 struct rc_map_table *oldscan = rc_map->scan;
180 struct rc_map_table *newscan;
b3074c0a 181
b088ba65 182 if (rc_map->size == rc_map->len) {
b3074c0a 183 /* All entries in use -> grow keytable */
b088ba65 184 if (rc_map->alloc >= IR_TAB_MAX_SIZE)
b3074c0a 185 return -ENOMEM;
7fee03e4 186
b3074c0a
DH
187 newalloc *= 2;
188 IR_dprintk(1, "Growing table to %u bytes\n", newalloc);
189 }
7fee03e4 190
b088ba65 191 if ((rc_map->len * 3 < rc_map->size) && (oldalloc > IR_TAB_MIN_SIZE)) {
b3074c0a
DH
192 /* Less than 1/3 of entries in use -> shrink keytable */
193 newalloc /= 2;
194 IR_dprintk(1, "Shrinking table to %u bytes\n", newalloc);
195 }
7fee03e4 196
b3074c0a
DH
197 if (newalloc == oldalloc)
198 return 0;
7fee03e4 199
9f470095 200 newscan = kmalloc(newalloc, gfp_flags);
b3074c0a
DH
201 if (!newscan) {
202 IR_dprintk(1, "Failed to kmalloc %u bytes\n", newalloc);
203 return -ENOMEM;
204 }
7fee03e4 205
2f4f58d6 206 memcpy(newscan, rc_map->scan, rc_map->len * sizeof(struct rc_map_table));
b088ba65
MCC
207 rc_map->scan = newscan;
208 rc_map->alloc = newalloc;
2f4f58d6 209 rc_map->size = rc_map->alloc / sizeof(struct rc_map_table);
b3074c0a
DH
210 kfree(oldscan);
211 return 0;
7fee03e4
MCC
212}
213
f6fc5049 214/**
9f470095 215 * ir_update_mapping() - set a keycode in the scancode->keycode table
d8b4b582 216 * @dev: the struct rc_dev device descriptor
b088ba65 217 * @rc_map: scancode table to be adjusted
9f470095
DT
218 * @index: index of the mapping that needs to be updated
219 * @keycode: the desired keycode
220 * @return: previous keycode assigned to the mapping
221 *
d8b4b582 222 * This routine is used to update scancode->keycode mapping at given
9f470095
DT
223 * position.
224 */
d8b4b582 225static unsigned int ir_update_mapping(struct rc_dev *dev,
b088ba65 226 struct rc_map *rc_map,
9f470095
DT
227 unsigned int index,
228 unsigned int new_keycode)
229{
b088ba65 230 int old_keycode = rc_map->scan[index].keycode;
9f470095
DT
231 int i;
232
233 /* Did the user wish to remove the mapping? */
234 if (new_keycode == KEY_RESERVED || new_keycode == KEY_UNKNOWN) {
235 IR_dprintk(1, "#%d: Deleting scan 0x%04x\n",
b088ba65
MCC
236 index, rc_map->scan[index].scancode);
237 rc_map->len--;
238 memmove(&rc_map->scan[index], &rc_map->scan[index+ 1],
2f4f58d6 239 (rc_map->len - index) * sizeof(struct rc_map_table));
9f470095
DT
240 } else {
241 IR_dprintk(1, "#%d: %s scan 0x%04x with key 0x%04x\n",
242 index,
243 old_keycode == KEY_RESERVED ? "New" : "Replacing",
b088ba65
MCC
244 rc_map->scan[index].scancode, new_keycode);
245 rc_map->scan[index].keycode = new_keycode;
d8b4b582 246 __set_bit(new_keycode, dev->input_dev->keybit);
9f470095
DT
247 }
248
249 if (old_keycode != KEY_RESERVED) {
250 /* A previous mapping was updated... */
d8b4b582 251 __clear_bit(old_keycode, dev->input_dev->keybit);
9f470095 252 /* ... but another scancode might use the same keycode */
b088ba65
MCC
253 for (i = 0; i < rc_map->len; i++) {
254 if (rc_map->scan[i].keycode == old_keycode) {
d8b4b582 255 __set_bit(old_keycode, dev->input_dev->keybit);
9f470095
DT
256 break;
257 }
258 }
259
260 /* Possibly shrink the keytable, failure is not a problem */
b088ba65 261 ir_resize_table(rc_map, GFP_ATOMIC);
9f470095
DT
262 }
263
264 return old_keycode;
265}
266
267/**
4c7b355d 268 * ir_establish_scancode() - set a keycode in the scancode->keycode table
d8b4b582 269 * @dev: the struct rc_dev device descriptor
b088ba65 270 * @rc_map: scancode table to be searched
9f470095
DT
271 * @scancode: the desired scancode
272 * @resize: controls whether we allowed to resize the table to
25985edc 273 * accommodate not yet present scancodes
9f470095
DT
274 * @return: index of the mapping containing scancode in question
275 * or -1U in case of failure.
f6fc5049 276 *
b088ba65 277 * This routine is used to locate given scancode in rc_map.
9f470095
DT
278 * If scancode is not yet present the routine will allocate a new slot
279 * for it.
f6fc5049 280 */
d8b4b582 281static unsigned int ir_establish_scancode(struct rc_dev *dev,
b088ba65 282 struct rc_map *rc_map,
9f470095
DT
283 unsigned int scancode,
284 bool resize)
f6fc5049 285{
b3074c0a 286 unsigned int i;
9dfe4e83
MCC
287
288 /*
289 * Unfortunately, some hardware-based IR decoders don't provide
290 * all bits for the complete IR code. In general, they provide only
291 * the command part of the IR code. Yet, as it is possible to replace
292 * the provided IR with another one, it is needed to allow loading
d8b4b582
DH
293 * IR tables from other remotes. So, we support specifying a mask to
294 * indicate the valid bits of the scancodes.
9dfe4e83 295 */
9d2f1d3c
DH
296 if (dev->scancode_mask)
297 scancode &= dev->scancode_mask;
b3074c0a
DH
298
299 /* First check if we already have a mapping for this ir command */
b088ba65
MCC
300 for (i = 0; i < rc_map->len; i++) {
301 if (rc_map->scan[i].scancode == scancode)
9f470095
DT
302 return i;
303
b3074c0a 304 /* Keytable is sorted from lowest to highest scancode */
b088ba65 305 if (rc_map->scan[i].scancode >= scancode)
b3074c0a 306 break;
b3074c0a 307 }
f6fc5049 308
9f470095 309 /* No previous mapping found, we might need to grow the table */
b088ba65
MCC
310 if (rc_map->size == rc_map->len) {
311 if (!resize || ir_resize_table(rc_map, GFP_ATOMIC))
9f470095
DT
312 return -1U;
313 }
35438946 314
9f470095 315 /* i is the proper index to insert our new keycode */
b088ba65
MCC
316 if (i < rc_map->len)
317 memmove(&rc_map->scan[i + 1], &rc_map->scan[i],
2f4f58d6 318 (rc_map->len - i) * sizeof(struct rc_map_table));
b088ba65
MCC
319 rc_map->scan[i].scancode = scancode;
320 rc_map->scan[i].keycode = KEY_RESERVED;
321 rc_map->len++;
f6fc5049 322
9f470095 323 return i;
f6fc5049
MCC
324}
325
ef53a115 326/**
b3074c0a 327 * ir_setkeycode() - set a keycode in the scancode->keycode table
d8b4b582 328 * @idev: the struct input_dev device descriptor
ef53a115 329 * @scancode: the desired scancode
b3074c0a
DH
330 * @keycode: result
331 * @return: -EINVAL if the keycode could not be inserted, otherwise zero.
ef53a115 332 *
b3074c0a 333 * This routine is used to handle evdev EVIOCSKEY ioctl.
ef53a115 334 */
d8b4b582 335static int ir_setkeycode(struct input_dev *idev,
9f470095
DT
336 const struct input_keymap_entry *ke,
337 unsigned int *old_keycode)
ef53a115 338{
d8b4b582 339 struct rc_dev *rdev = input_get_drvdata(idev);
b088ba65 340 struct rc_map *rc_map = &rdev->rc_map;
9f470095
DT
341 unsigned int index;
342 unsigned int scancode;
dea8a39f 343 int retval = 0;
9f470095 344 unsigned long flags;
ef53a115 345
b088ba65 346 spin_lock_irqsave(&rc_map->lock, flags);
9f470095
DT
347
348 if (ke->flags & INPUT_KEYMAP_BY_INDEX) {
349 index = ke->index;
b088ba65 350 if (index >= rc_map->len) {
9f470095
DT
351 retval = -EINVAL;
352 goto out;
353 }
354 } else {
355 retval = input_scancode_to_scalar(ke, &scancode);
356 if (retval)
357 goto out;
358
b088ba65
MCC
359 index = ir_establish_scancode(rdev, rc_map, scancode, true);
360 if (index >= rc_map->len) {
9f470095
DT
361 retval = -ENOMEM;
362 goto out;
363 }
364 }
365
b088ba65 366 *old_keycode = ir_update_mapping(rdev, rc_map, index, ke->keycode);
9f470095
DT
367
368out:
b088ba65 369 spin_unlock_irqrestore(&rc_map->lock, flags);
9f470095 370 return retval;
e97f4677
MCC
371}
372
373/**
b3074c0a 374 * ir_setkeytable() - sets several entries in the scancode->keycode table
d8b4b582 375 * @dev: the struct rc_dev device descriptor
b088ba65
MCC
376 * @to: the struct rc_map to copy entries to
377 * @from: the struct rc_map to copy entries from
9f470095 378 * @return: -ENOMEM if all keycodes could not be inserted, otherwise zero.
e97f4677 379 *
b3074c0a 380 * This routine is used to handle table initialization.
e97f4677 381 */
d8b4b582 382static int ir_setkeytable(struct rc_dev *dev,
b088ba65 383 const struct rc_map *from)
e97f4677 384{
b088ba65 385 struct rc_map *rc_map = &dev->rc_map;
9f470095
DT
386 unsigned int i, index;
387 int rc;
388
b088ba65 389 rc = ir_create_table(rc_map, from->name,
52b66144 390 from->rc_type, from->size);
9f470095
DT
391 if (rc)
392 return rc;
393
394 IR_dprintk(1, "Allocated space for %u keycode entries (%u bytes)\n",
b088ba65 395 rc_map->size, rc_map->alloc);
e97f4677 396
b3074c0a 397 for (i = 0; i < from->size; i++) {
b088ba65 398 index = ir_establish_scancode(dev, rc_map,
9f470095 399 from->scan[i].scancode, false);
b088ba65 400 if (index >= rc_map->len) {
9f470095 401 rc = -ENOMEM;
b3074c0a 402 break;
9f470095
DT
403 }
404
b088ba65 405 ir_update_mapping(dev, rc_map, index,
9f470095 406 from->scan[i].keycode);
e97f4677 407 }
9f470095
DT
408
409 if (rc)
b088ba65 410 ir_free_table(rc_map);
9f470095 411
b3074c0a 412 return rc;
ef53a115
MCC
413}
414
9f470095
DT
415/**
416 * ir_lookup_by_scancode() - locate mapping by scancode
b088ba65 417 * @rc_map: the struct rc_map to search
9f470095
DT
418 * @scancode: scancode to look for in the table
419 * @return: index in the table, -1U if not found
420 *
421 * This routine performs binary search in RC keykeymap table for
422 * given scancode.
423 */
b088ba65 424static unsigned int ir_lookup_by_scancode(const struct rc_map *rc_map,
9f470095
DT
425 unsigned int scancode)
426{
0d07025e 427 int start = 0;
b088ba65 428 int end = rc_map->len - 1;
0d07025e 429 int mid;
9f470095
DT
430
431 while (start <= end) {
432 mid = (start + end) / 2;
b088ba65 433 if (rc_map->scan[mid].scancode < scancode)
9f470095 434 start = mid + 1;
b088ba65 435 else if (rc_map->scan[mid].scancode > scancode)
9f470095
DT
436 end = mid - 1;
437 else
438 return mid;
439 }
440
441 return -1U;
442}
443
ef53a115 444/**
b3074c0a 445 * ir_getkeycode() - get a keycode from the scancode->keycode table
d8b4b582 446 * @idev: the struct input_dev device descriptor
ef53a115 447 * @scancode: the desired scancode
b3074c0a
DH
448 * @keycode: used to return the keycode, if found, or KEY_RESERVED
449 * @return: always returns zero.
ef53a115 450 *
b3074c0a 451 * This routine is used to handle evdev EVIOCGKEY ioctl.
ef53a115 452 */
d8b4b582 453static int ir_getkeycode(struct input_dev *idev,
9f470095 454 struct input_keymap_entry *ke)
ef53a115 455{
d8b4b582 456 struct rc_dev *rdev = input_get_drvdata(idev);
b088ba65 457 struct rc_map *rc_map = &rdev->rc_map;
2f4f58d6 458 struct rc_map_table *entry;
9f470095
DT
459 unsigned long flags;
460 unsigned int index;
461 unsigned int scancode;
462 int retval;
ef53a115 463
b088ba65 464 spin_lock_irqsave(&rc_map->lock, flags);
9f470095
DT
465
466 if (ke->flags & INPUT_KEYMAP_BY_INDEX) {
467 index = ke->index;
468 } else {
469 retval = input_scancode_to_scalar(ke, &scancode);
470 if (retval)
471 goto out;
472
b088ba65 473 index = ir_lookup_by_scancode(rc_map, scancode);
9f470095
DT
474 }
475
54e74b87
DT
476 if (index < rc_map->len) {
477 entry = &rc_map->scan[index];
478
479 ke->index = index;
480 ke->keycode = entry->keycode;
481 ke->len = sizeof(entry->scancode);
482 memcpy(ke->scancode, &entry->scancode, sizeof(entry->scancode));
483
484 } else if (!(ke->flags & INPUT_KEYMAP_BY_INDEX)) {
485 /*
486 * We do not really know the valid range of scancodes
487 * so let's respond with KEY_RESERVED to anything we
488 * do not have mapping for [yet].
489 */
490 ke->index = index;
491 ke->keycode = KEY_RESERVED;
492 } else {
9f470095
DT
493 retval = -EINVAL;
494 goto out;
e97f4677
MCC
495 }
496
47c5ba53
DT
497 retval = 0;
498
9f470095 499out:
b088ba65 500 spin_unlock_irqrestore(&rc_map->lock, flags);
9f470095 501 return retval;
ef53a115
MCC
502}
503
504/**
ca86674b 505 * rc_g_keycode_from_table() - gets the keycode that corresponds to a scancode
d8b4b582
DH
506 * @dev: the struct rc_dev descriptor of the device
507 * @scancode: the scancode to look for
508 * @return: the corresponding keycode, or KEY_RESERVED
ef53a115 509 *
d8b4b582
DH
510 * This routine is used by drivers which need to convert a scancode to a
511 * keycode. Normally it should not be used since drivers should have no
512 * interest in keycodes.
ef53a115 513 */
ca86674b 514u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode)
ef53a115 515{
b088ba65 516 struct rc_map *rc_map = &dev->rc_map;
9f470095
DT
517 unsigned int keycode;
518 unsigned int index;
519 unsigned long flags;
520
b088ba65 521 spin_lock_irqsave(&rc_map->lock, flags);
9f470095 522
b088ba65
MCC
523 index = ir_lookup_by_scancode(rc_map, scancode);
524 keycode = index < rc_map->len ?
525 rc_map->scan[index].keycode : KEY_RESERVED;
9f470095 526
b088ba65 527 spin_unlock_irqrestore(&rc_map->lock, flags);
ef53a115 528
35438946
MCC
529 if (keycode != KEY_RESERVED)
530 IR_dprintk(1, "%s: scancode 0x%04x keycode 0x%02x\n",
d8b4b582 531 dev->input_name, scancode, keycode);
9f470095 532
b3074c0a 533 return keycode;
ef53a115 534}
ca86674b 535EXPORT_SYMBOL_GPL(rc_g_keycode_from_table);
ef53a115 536
6660de56 537/**
62c65031 538 * ir_do_keyup() - internal function to signal the release of a keypress
d8b4b582 539 * @dev: the struct rc_dev descriptor of the device
98c32bcd 540 * @sync: whether or not to call input_sync
6660de56 541 *
62c65031
DH
542 * This function is used internally to release a keypress, it must be
543 * called with keylock held.
a374fef4 544 */
98c32bcd 545static void ir_do_keyup(struct rc_dev *dev, bool sync)
a374fef4 546{
d8b4b582 547 if (!dev->keypressed)
a374fef4
DH
548 return;
549
d8b4b582
DH
550 IR_dprintk(1, "keyup key 0x%04x\n", dev->last_keycode);
551 input_report_key(dev->input_dev, dev->last_keycode, 0);
153a60bb 552 led_trigger_event(led_feedback, LED_OFF);
98c32bcd
JW
553 if (sync)
554 input_sync(dev->input_dev);
d8b4b582 555 dev->keypressed = false;
a374fef4 556}
62c65031
DH
557
558/**
ca86674b 559 * rc_keyup() - signals the release of a keypress
d8b4b582 560 * @dev: the struct rc_dev descriptor of the device
62c65031
DH
561 *
562 * This routine is used to signal that a key has been released on the
563 * remote control.
564 */
ca86674b 565void rc_keyup(struct rc_dev *dev)
62c65031
DH
566{
567 unsigned long flags;
62c65031 568
d8b4b582 569 spin_lock_irqsave(&dev->keylock, flags);
98c32bcd 570 ir_do_keyup(dev, true);
d8b4b582 571 spin_unlock_irqrestore(&dev->keylock, flags);
62c65031 572}
ca86674b 573EXPORT_SYMBOL_GPL(rc_keyup);
a374fef4
DH
574
575/**
576 * ir_timer_keyup() - generates a keyup event after a timeout
d8b4b582 577 * @cookie: a pointer to the struct rc_dev for the device
a374fef4
DH
578 *
579 * This routine will generate a keyup event some time after a keydown event
580 * is generated when no further activity has been detected.
6660de56 581 */
a374fef4 582static void ir_timer_keyup(unsigned long cookie)
6660de56 583{
d8b4b582 584 struct rc_dev *dev = (struct rc_dev *)cookie;
a374fef4
DH
585 unsigned long flags;
586
587 /*
588 * ir->keyup_jiffies is used to prevent a race condition if a
589 * hardware interrupt occurs at this point and the keyup timer
590 * event is moved further into the future as a result.
591 *
592 * The timer will then be reactivated and this function called
593 * again in the future. We need to exit gracefully in that case
594 * to allow the input subsystem to do its auto-repeat magic or
595 * a keyup event might follow immediately after the keydown.
596 */
d8b4b582
DH
597 spin_lock_irqsave(&dev->keylock, flags);
598 if (time_is_before_eq_jiffies(dev->keyup_jiffies))
98c32bcd 599 ir_do_keyup(dev, true);
d8b4b582 600 spin_unlock_irqrestore(&dev->keylock, flags);
a374fef4
DH
601}
602
603/**
ca86674b 604 * rc_repeat() - signals that a key is still pressed
d8b4b582 605 * @dev: the struct rc_dev descriptor of the device
a374fef4
DH
606 *
607 * This routine is used by IR decoders when a repeat message which does
608 * not include the necessary bits to reproduce the scancode has been
609 * received.
610 */
ca86674b 611void rc_repeat(struct rc_dev *dev)
a374fef4
DH
612{
613 unsigned long flags;
6660de56 614
d8b4b582 615 spin_lock_irqsave(&dev->keylock, flags);
a374fef4 616
d8b4b582 617 input_event(dev->input_dev, EV_MSC, MSC_SCAN, dev->last_scancode);
98c32bcd 618 input_sync(dev->input_dev);
ed4d3876 619
d8b4b582 620 if (!dev->keypressed)
a374fef4 621 goto out;
6660de56 622
d8b4b582
DH
623 dev->keyup_jiffies = jiffies + msecs_to_jiffies(IR_KEYPRESS_TIMEOUT);
624 mod_timer(&dev->timer_keyup, dev->keyup_jiffies);
a374fef4
DH
625
626out:
d8b4b582 627 spin_unlock_irqrestore(&dev->keylock, flags);
6660de56 628}
ca86674b 629EXPORT_SYMBOL_GPL(rc_repeat);
6660de56
MCC
630
631/**
62c65031 632 * ir_do_keydown() - internal function to process a keypress
d8b4b582 633 * @dev: the struct rc_dev descriptor of the device
120703f9 634 * @protocol: the protocol of the keypress
62c65031
DH
635 * @scancode: the scancode of the keypress
636 * @keycode: the keycode of the keypress
637 * @toggle: the toggle value of the keypress
6660de56 638 *
62c65031
DH
639 * This function is used internally to register a keypress, it must be
640 * called with keylock held.
6660de56 641 */
120703f9
DH
642static void ir_do_keydown(struct rc_dev *dev, enum rc_type protocol,
643 u32 scancode, u32 keycode, u8 toggle)
6660de56 644{
99b0f3c9 645 bool new_event = (!dev->keypressed ||
120703f9 646 dev->last_protocol != protocol ||
99b0f3c9 647 dev->last_scancode != scancode ||
120703f9 648 dev->last_toggle != toggle);
6660de56 649
98c32bcd
JW
650 if (new_event && dev->keypressed)
651 ir_do_keyup(dev, false);
6660de56 652
98c32bcd 653 input_event(dev->input_dev, EV_MSC, MSC_SCAN, scancode);
a374fef4 654
98c32bcd
JW
655 if (new_event && keycode != KEY_RESERVED) {
656 /* Register a keypress */
657 dev->keypressed = true;
120703f9 658 dev->last_protocol = protocol;
98c32bcd
JW
659 dev->last_scancode = scancode;
660 dev->last_toggle = toggle;
661 dev->last_keycode = keycode;
662
663 IR_dprintk(1, "%s: key down event, "
120703f9
DH
664 "key 0x%04x, protocol 0x%04x, scancode 0x%08x\n",
665 dev->input_name, keycode, protocol, scancode);
98c32bcd 666 input_report_key(dev->input_dev, keycode, 1);
70a2f912
JH
667
668 led_trigger_event(led_feedback, LED_FULL);
98c32bcd 669 }
ed4d3876 670
d8b4b582 671 input_sync(dev->input_dev);
62c65031 672}
6660de56 673
62c65031 674/**
ca86674b 675 * rc_keydown() - generates input event for a key press
d8b4b582 676 * @dev: the struct rc_dev descriptor of the device
120703f9
DH
677 * @protocol: the protocol for the keypress
678 * @scancode: the scancode for the keypress
62c65031
DH
679 * @toggle: the toggle value (protocol dependent, if the protocol doesn't
680 * support toggle values, this should be set to zero)
681 *
d8b4b582
DH
682 * This routine is used to signal that a key has been pressed on the
683 * remote control.
62c65031 684 */
120703f9 685void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle)
62c65031
DH
686{
687 unsigned long flags;
ca86674b 688 u32 keycode = rc_g_keycode_from_table(dev, scancode);
62c65031 689
d8b4b582 690 spin_lock_irqsave(&dev->keylock, flags);
120703f9 691 ir_do_keydown(dev, protocol, scancode, keycode, toggle);
62c65031 692
d8b4b582
DH
693 if (dev->keypressed) {
694 dev->keyup_jiffies = jiffies + msecs_to_jiffies(IR_KEYPRESS_TIMEOUT);
695 mod_timer(&dev->timer_keyup, dev->keyup_jiffies);
62c65031 696 }
d8b4b582 697 spin_unlock_irqrestore(&dev->keylock, flags);
6660de56 698}
ca86674b 699EXPORT_SYMBOL_GPL(rc_keydown);
6660de56 700
62c65031 701/**
ca86674b 702 * rc_keydown_notimeout() - generates input event for a key press without
62c65031 703 * an automatic keyup event at a later time
d8b4b582 704 * @dev: the struct rc_dev descriptor of the device
120703f9
DH
705 * @protocol: the protocol for the keypress
706 * @scancode: the scancode for the keypress
62c65031
DH
707 * @toggle: the toggle value (protocol dependent, if the protocol doesn't
708 * support toggle values, this should be set to zero)
709 *
d8b4b582 710 * This routine is used to signal that a key has been pressed on the
ca86674b 711 * remote control. The driver must manually call rc_keyup() at a later stage.
62c65031 712 */
120703f9
DH
713void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol,
714 u32 scancode, u8 toggle)
62c65031
DH
715{
716 unsigned long flags;
ca86674b 717 u32 keycode = rc_g_keycode_from_table(dev, scancode);
62c65031 718
d8b4b582 719 spin_lock_irqsave(&dev->keylock, flags);
120703f9 720 ir_do_keydown(dev, protocol, scancode, keycode, toggle);
d8b4b582 721 spin_unlock_irqrestore(&dev->keylock, flags);
62c65031 722}
ca86674b 723EXPORT_SYMBOL_GPL(rc_keydown_notimeout);
62c65031 724
8b2ff320
SK
725int rc_open(struct rc_dev *rdev)
726{
727 int rval = 0;
728
729 if (!rdev)
730 return -EINVAL;
731
732 mutex_lock(&rdev->lock);
c73bbaa4 733
f02dcdd1 734 if (!rdev->users++ && rdev->open != NULL)
8b2ff320
SK
735 rval = rdev->open(rdev);
736
737 if (rval)
738 rdev->users--;
739
740 mutex_unlock(&rdev->lock);
741
742 return rval;
743}
744EXPORT_SYMBOL_GPL(rc_open);
745
d8b4b582 746static int ir_open(struct input_dev *idev)
ef53a115 747{
d8b4b582 748 struct rc_dev *rdev = input_get_drvdata(idev);
75543cce 749
8b2ff320
SK
750 return rc_open(rdev);
751}
752
753void rc_close(struct rc_dev *rdev)
754{
755 if (rdev) {
756 mutex_lock(&rdev->lock);
757
81b7d14e 758 if (!--rdev->users && rdev->close != NULL)
8b2ff320
SK
759 rdev->close(rdev);
760
761 mutex_unlock(&rdev->lock);
762 }
ef53a115 763}
8b2ff320 764EXPORT_SYMBOL_GPL(rc_close);
d4b778d3 765
d8b4b582 766static void ir_close(struct input_dev *idev)
f6fc5049 767{
d8b4b582 768 struct rc_dev *rdev = input_get_drvdata(idev);
8b2ff320 769 rc_close(rdev);
f6fc5049 770}
f6fc5049 771
bc2a6c57 772/* class for /sys/class/rc */
40fc5325 773static char *rc_devnode(struct device *dev, umode_t *mode)
bc2a6c57
MCC
774{
775 return kasprintf(GFP_KERNEL, "rc/%s", dev_name(dev));
776}
777
40fc5325 778static struct class rc_class = {
bc2a6c57 779 .name = "rc",
40fc5325 780 .devnode = rc_devnode,
bc2a6c57
MCC
781};
782
c003ab1b
DH
783/*
784 * These are the protocol textual descriptions that are
785 * used by the sysfs protocols file. Note that the order
786 * of the entries is relevant.
787 */
53df8777 788static const struct {
bc2a6c57 789 u64 type;
53df8777 790 const char *name;
9f0bf366 791 const char *module_name;
bc2a6c57 792} proto_names[] = {
9f0bf366
HK
793 { RC_BIT_NONE, "none", NULL },
794 { RC_BIT_OTHER, "other", NULL },
795 { RC_BIT_UNKNOWN, "unknown", NULL },
c003ab1b 796 { RC_BIT_RC5 |
9f0bf366
HK
797 RC_BIT_RC5X, "rc-5", "ir-rc5-decoder" },
798 { RC_BIT_NEC, "nec", "ir-nec-decoder" },
c003ab1b
DH
799 { RC_BIT_RC6_0 |
800 RC_BIT_RC6_6A_20 |
801 RC_BIT_RC6_6A_24 |
802 RC_BIT_RC6_6A_32 |
9f0bf366
HK
803 RC_BIT_RC6_MCE, "rc-6", "ir-rc6-decoder" },
804 { RC_BIT_JVC, "jvc", "ir-jvc-decoder" },
c003ab1b
DH
805 { RC_BIT_SONY12 |
806 RC_BIT_SONY15 |
9f0bf366
HK
807 RC_BIT_SONY20, "sony", "ir-sony-decoder" },
808 { RC_BIT_RC5_SZ, "rc-5-sz", "ir-rc5-decoder" },
809 { RC_BIT_SANYO, "sanyo", "ir-sanyo-decoder" },
810 { RC_BIT_SHARP, "sharp", "ir-sharp-decoder" },
811 { RC_BIT_MCE_KBD, "mce_kbd", "ir-mce_kbd-decoder" },
812 { RC_BIT_XMP, "xmp", "ir-xmp-decoder" },
ff42c8aa 813 { RC_BIT_CEC, "cec", NULL },
bc2a6c57
MCC
814};
815
bc2a6c57 816/**
ab88c66d
JH
817 * struct rc_filter_attribute - Device attribute relating to a filter type.
818 * @attr: Device attribute.
819 * @type: Filter type.
820 * @mask: false for filter value, true for filter mask.
821 */
822struct rc_filter_attribute {
823 struct device_attribute attr;
824 enum rc_filter_type type;
825 bool mask;
826};
827#define to_rc_filter_attr(a) container_of(a, struct rc_filter_attribute, attr)
828
829#define RC_PROTO_ATTR(_name, _mode, _show, _store, _type) \
830 struct rc_filter_attribute dev_attr_##_name = { \
831 .attr = __ATTR(_name, _mode, _show, _store), \
832 .type = (_type), \
833 }
834#define RC_FILTER_ATTR(_name, _mode, _show, _store, _type, _mask) \
835 struct rc_filter_attribute dev_attr_##_name = { \
836 .attr = __ATTR(_name, _mode, _show, _store), \
837 .type = (_type), \
838 .mask = (_mask), \
839 }
840
dd6ff6a0
DH
841static bool lirc_is_present(void)
842{
843#if defined(CONFIG_LIRC_MODULE)
844 struct module *lirc;
845
846 mutex_lock(&module_mutex);
847 lirc = find_module("lirc_dev");
848 mutex_unlock(&module_mutex);
849
850 return lirc ? true : false;
851#elif defined(CONFIG_LIRC)
852 return true;
853#else
854 return false;
855#endif
856}
857
ab88c66d
JH
858/**
859 * show_protocols() - shows the current/wakeup IR protocol(s)
d8b4b582 860 * @device: the device descriptor
da6e162d 861 * @mattr: the device attribute struct
bc2a6c57
MCC
862 * @buf: a pointer to the output buffer
863 *
864 * This routine is a callback routine for input read the IR protocol type(s).
ab88c66d 865 * it is trigged by reading /sys/class/rc/rc?/[wakeup_]protocols.
bc2a6c57
MCC
866 * It returns the protocol names of supported protocols.
867 * Enabled protocols are printed in brackets.
08aeb7c9
JW
868 *
869 * dev->lock is taken to guard against races between device
870 * registration, store_protocols and show_protocols.
bc2a6c57 871 */
d8b4b582 872static ssize_t show_protocols(struct device *device,
bc2a6c57
MCC
873 struct device_attribute *mattr, char *buf)
874{
d8b4b582 875 struct rc_dev *dev = to_rc_dev(device);
ab88c66d 876 struct rc_filter_attribute *fattr = to_rc_filter_attr(mattr);
bc2a6c57
MCC
877 u64 allowed, enabled;
878 char *tmp = buf;
879 int i;
880
881 /* Device is being removed */
d8b4b582 882 if (!dev)
bc2a6c57
MCC
883 return -EINVAL;
884
078600f5
MCC
885 if (!atomic_read(&dev->initialized))
886 return -ERESTARTSYS;
887
08aeb7c9
JW
888 mutex_lock(&dev->lock);
889
da6e162d 890 if (fattr->type == RC_FILTER_NORMAL) {
c5540fbb 891 enabled = dev->enabled_protocols;
d24b69fc
MCC
892 allowed = dev->allowed_protocols;
893 if (dev->raw && !allowed)
da6e162d 894 allowed = ir_raw_get_allowed_protocols();
da6e162d 895 } else {
c5540fbb
DH
896 enabled = dev->enabled_wakeup_protocols;
897 allowed = dev->allowed_wakeup_protocols;
30ebc5e4 898 }
bc2a6c57 899
da6e162d
DH
900 mutex_unlock(&dev->lock);
901
902 IR_dprintk(1, "%s: allowed - 0x%llx, enabled - 0x%llx\n",
903 __func__, (long long)allowed, (long long)enabled);
bc2a6c57
MCC
904
905 for (i = 0; i < ARRAY_SIZE(proto_names); i++) {
906 if (allowed & enabled & proto_names[i].type)
907 tmp += sprintf(tmp, "[%s] ", proto_names[i].name);
908 else if (allowed & proto_names[i].type)
909 tmp += sprintf(tmp, "%s ", proto_names[i].name);
c003ab1b
DH
910
911 if (allowed & proto_names[i].type)
912 allowed &= ~proto_names[i].type;
bc2a6c57
MCC
913 }
914
dd6ff6a0 915 if (dev->driver_type == RC_DRIVER_IR_RAW && lirc_is_present())
275ddb40
DH
916 tmp += sprintf(tmp, "[lirc] ");
917
bc2a6c57
MCC
918 if (tmp != buf)
919 tmp--;
920 *tmp = '\n';
08aeb7c9 921
bc2a6c57
MCC
922 return tmp + 1 - buf;
923}
924
925/**
da6e162d
DH
926 * parse_protocol_change() - parses a protocol change request
927 * @protocols: pointer to the bitmask of current protocols
928 * @buf: pointer to the buffer with a list of changes
bc2a6c57 929 *
da6e162d
DH
930 * Writing "+proto" will add a protocol to the protocol mask.
931 * Writing "-proto" will remove a protocol from protocol mask.
bc2a6c57
MCC
932 * Writing "proto" will enable only "proto".
933 * Writing "none" will disable all protocols.
da6e162d 934 * Returns the number of changes performed or a negative error code.
bc2a6c57 935 */
da6e162d 936static int parse_protocol_change(u64 *protocols, const char *buf)
bc2a6c57 937{
bc2a6c57 938 const char *tmp;
da6e162d
DH
939 unsigned count = 0;
940 bool enable, disable;
bc2a6c57 941 u64 mask;
da6e162d 942 int i;
bc2a6c57 943
da6e162d 944 while ((tmp = strsep((char **)&buf, " \n")) != NULL) {
bc2a6c57
MCC
945 if (!*tmp)
946 break;
947
948 if (*tmp == '+') {
949 enable = true;
950 disable = false;
951 tmp++;
952 } else if (*tmp == '-') {
953 enable = false;
954 disable = true;
955 tmp++;
956 } else {
957 enable = false;
958 disable = false;
959 }
960
c003ab1b
DH
961 for (i = 0; i < ARRAY_SIZE(proto_names); i++) {
962 if (!strcasecmp(tmp, proto_names[i].name)) {
963 mask = proto_names[i].type;
964 break;
bc2a6c57 965 }
bc2a6c57
MCC
966 }
967
c003ab1b 968 if (i == ARRAY_SIZE(proto_names)) {
275ddb40
DH
969 if (!strcasecmp(tmp, "lirc"))
970 mask = 0;
971 else {
972 IR_dprintk(1, "Unknown protocol: '%s'\n", tmp);
973 return -EINVAL;
974 }
c003ab1b
DH
975 }
976
977 count++;
978
bc2a6c57 979 if (enable)
da6e162d 980 *protocols |= mask;
bc2a6c57 981 else if (disable)
da6e162d 982 *protocols &= ~mask;
bc2a6c57 983 else
da6e162d 984 *protocols = mask;
bc2a6c57
MCC
985 }
986
987 if (!count) {
988 IR_dprintk(1, "Protocol not specified\n");
da6e162d
DH
989 return -EINVAL;
990 }
991
992 return count;
993}
994
9f0bf366
HK
995static void ir_raw_load_modules(u64 *protocols)
996
997{
998 u64 available;
999 int i, ret;
1000
1001 for (i = 0; i < ARRAY_SIZE(proto_names); i++) {
1002 if (proto_names[i].type == RC_BIT_NONE ||
1003 proto_names[i].type & (RC_BIT_OTHER | RC_BIT_UNKNOWN))
1004 continue;
1005
1006 available = ir_raw_get_allowed_protocols();
1007 if (!(*protocols & proto_names[i].type & ~available))
1008 continue;
1009
1010 if (!proto_names[i].module_name) {
1011 pr_err("Can't enable IR protocol %s\n",
1012 proto_names[i].name);
1013 *protocols &= ~proto_names[i].type;
1014 continue;
1015 }
1016
1017 ret = request_module("%s", proto_names[i].module_name);
1018 if (ret < 0) {
1019 pr_err("Couldn't load IR protocol module %s\n",
1020 proto_names[i].module_name);
1021 *protocols &= ~proto_names[i].type;
1022 continue;
1023 }
1024 msleep(20);
1025 available = ir_raw_get_allowed_protocols();
1026 if (!(*protocols & proto_names[i].type & ~available))
1027 continue;
1028
1029 pr_err("Loaded IR protocol module %s, \
1030 but protocol %s still not available\n",
1031 proto_names[i].module_name,
1032 proto_names[i].name);
1033 *protocols &= ~proto_names[i].type;
1034 }
1035}
1036
da6e162d
DH
1037/**
1038 * store_protocols() - changes the current/wakeup IR protocol(s)
1039 * @device: the device descriptor
1040 * @mattr: the device attribute struct
1041 * @buf: a pointer to the input buffer
1042 * @len: length of the input buffer
1043 *
1044 * This routine is for changing the IR protocol type.
1045 * It is trigged by writing to /sys/class/rc/rc?/[wakeup_]protocols.
1046 * See parse_protocol_change() for the valid commands.
1047 * Returns @len on success or a negative error code.
1048 *
1049 * dev->lock is taken to guard against races between device
1050 * registration, store_protocols and show_protocols.
1051 */
1052static ssize_t store_protocols(struct device *device,
1053 struct device_attribute *mattr,
1054 const char *buf, size_t len)
1055{
1056 struct rc_dev *dev = to_rc_dev(device);
1057 struct rc_filter_attribute *fattr = to_rc_filter_attr(mattr);
1058 u64 *current_protocols;
1059 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
1060 struct rc_scancode_filter *filter;
1061 int (*set_filter)(struct rc_dev *dev, struct rc_scancode_filter *filter);
1062 u64 old_protocols, new_protocols;
1063 ssize_t rc;
1064
1065 /* Device is being removed */
1066 if (!dev)
1067 return -EINVAL;
1068
078600f5
MCC
1069 if (!atomic_read(&dev->initialized))
1070 return -ERESTARTSYS;
1071
da6e162d
DH
1072 if (fattr->type == RC_FILTER_NORMAL) {
1073 IR_dprintk(1, "Normal protocol change requested\n");
c5540fbb 1074 current_protocols = &dev->enabled_protocols;
da6e162d 1075 change_protocol = dev->change_protocol;
c5540fbb 1076 filter = &dev->scancode_filter;
da6e162d
DH
1077 set_filter = dev->s_filter;
1078 } else {
1079 IR_dprintk(1, "Wakeup protocol change requested\n");
c5540fbb 1080 current_protocols = &dev->enabled_wakeup_protocols;
da6e162d 1081 change_protocol = dev->change_wakeup_protocol;
c5540fbb 1082 filter = &dev->scancode_wakeup_filter;
da6e162d
DH
1083 set_filter = dev->s_wakeup_filter;
1084 }
1085
1086 if (!change_protocol) {
1087 IR_dprintk(1, "Protocol switching not supported\n");
1088 return -EINVAL;
1089 }
1090
1091 mutex_lock(&dev->lock);
1092
1093 old_protocols = *current_protocols;
1094 new_protocols = old_protocols;
1095 rc = parse_protocol_change(&new_protocols, buf);
1096 if (rc < 0)
1097 goto out;
1098
1099 rc = change_protocol(dev, &new_protocols);
1100 if (rc < 0) {
1101 IR_dprintk(1, "Error setting protocols to 0x%llx\n",
1102 (long long)new_protocols);
08aeb7c9 1103 goto out;
bc2a6c57
MCC
1104 }
1105
9f0bf366
HK
1106 if (dev->driver_type == RC_DRIVER_IR_RAW)
1107 ir_raw_load_modules(&new_protocols);
1108
983c5bd2
JH
1109 if (new_protocols != old_protocols) {
1110 *current_protocols = new_protocols;
1111 IR_dprintk(1, "Protocols changed to 0x%llx\n",
1112 (long long)new_protocols);
bc2a6c57
MCC
1113 }
1114
6bea25af 1115 /*
983c5bd2
JH
1116 * If a protocol change was attempted the filter may need updating, even
1117 * if the actual protocol mask hasn't changed (since the driver may have
1118 * cleared the filter).
6bea25af
JH
1119 * Try setting the same filter with the new protocol (if any).
1120 * Fall back to clearing the filter.
1121 */
da6e162d
DH
1122 if (set_filter && filter->mask) {
1123 if (new_protocols)
1124 rc = set_filter(dev, filter);
1125 else
1126 rc = -1;
6bea25af 1127
da6e162d
DH
1128 if (rc < 0) {
1129 filter->data = 0;
1130 filter->mask = 0;
1131 set_filter(dev, filter);
1132 }
6bea25af
JH
1133 }
1134
da6e162d 1135 rc = len;
08aeb7c9
JW
1136
1137out:
1138 mutex_unlock(&dev->lock);
da6e162d 1139 return rc;
bc2a6c57
MCC
1140}
1141
00942d1a
JH
1142/**
1143 * show_filter() - shows the current scancode filter value or mask
1144 * @device: the device descriptor
1145 * @attr: the device attribute struct
1146 * @buf: a pointer to the output buffer
1147 *
1148 * This routine is a callback routine to read a scancode filter value or mask.
1149 * It is trigged by reading /sys/class/rc/rc?/[wakeup_]filter[_mask].
1150 * It prints the current scancode filter value or mask of the appropriate filter
1151 * type in hexadecimal into @buf and returns the size of the buffer.
1152 *
1153 * Bits of the filter value corresponding to set bits in the filter mask are
1154 * compared against input scancodes and non-matching scancodes are discarded.
1155 *
1156 * dev->lock is taken to guard against races between device registration,
1157 * store_filter and show_filter.
1158 */
1159static ssize_t show_filter(struct device *device,
1160 struct device_attribute *attr,
1161 char *buf)
1162{
1163 struct rc_dev *dev = to_rc_dev(device);
1164 struct rc_filter_attribute *fattr = to_rc_filter_attr(attr);
da6e162d 1165 struct rc_scancode_filter *filter;
00942d1a
JH
1166 u32 val;
1167
1168 /* Device is being removed */
1169 if (!dev)
1170 return -EINVAL;
1171
078600f5
MCC
1172 if (!atomic_read(&dev->initialized))
1173 return -ERESTARTSYS;
1174
c73bbaa4 1175 mutex_lock(&dev->lock);
c73bbaa4 1176
da6e162d 1177 if (fattr->type == RC_FILTER_NORMAL)
c5540fbb 1178 filter = &dev->scancode_filter;
da6e162d 1179 else
c5540fbb 1180 filter = &dev->scancode_wakeup_filter;
da6e162d 1181
da6e162d
DH
1182 if (fattr->mask)
1183 val = filter->mask;
00942d1a 1184 else
da6e162d 1185 val = filter->data;
00942d1a
JH
1186 mutex_unlock(&dev->lock);
1187
1188 return sprintf(buf, "%#x\n", val);
1189}
1190
1191/**
1192 * store_filter() - changes the scancode filter value
1193 * @device: the device descriptor
1194 * @attr: the device attribute struct
1195 * @buf: a pointer to the input buffer
1196 * @len: length of the input buffer
1197 *
1198 * This routine is for changing a scancode filter value or mask.
1199 * It is trigged by writing to /sys/class/rc/rc?/[wakeup_]filter[_mask].
1200 * Returns -EINVAL if an invalid filter value for the current protocol was
1201 * specified or if scancode filtering is not supported by the driver, otherwise
1202 * returns @len.
1203 *
1204 * Bits of the filter value corresponding to set bits in the filter mask are
1205 * compared against input scancodes and non-matching scancodes are discarded.
1206 *
1207 * dev->lock is taken to guard against races between device registration,
1208 * store_filter and show_filter.
1209 */
1210static ssize_t store_filter(struct device *device,
1211 struct device_attribute *attr,
da6e162d 1212 const char *buf, size_t len)
00942d1a
JH
1213{
1214 struct rc_dev *dev = to_rc_dev(device);
1215 struct rc_filter_attribute *fattr = to_rc_filter_attr(attr);
da6e162d 1216 struct rc_scancode_filter new_filter, *filter;
00942d1a
JH
1217 int ret;
1218 unsigned long val;
23c843b5 1219 int (*set_filter)(struct rc_dev *dev, struct rc_scancode_filter *filter);
da6e162d 1220 u64 *enabled_protocols;
00942d1a
JH
1221
1222 /* Device is being removed */
1223 if (!dev)
1224 return -EINVAL;
1225
078600f5
MCC
1226 if (!atomic_read(&dev->initialized))
1227 return -ERESTARTSYS;
1228
00942d1a
JH
1229 ret = kstrtoul(buf, 0, &val);
1230 if (ret < 0)
1231 return ret;
1232
da6e162d
DH
1233 if (fattr->type == RC_FILTER_NORMAL) {
1234 set_filter = dev->s_filter;
c5540fbb
DH
1235 enabled_protocols = &dev->enabled_protocols;
1236 filter = &dev->scancode_filter;
da6e162d
DH
1237 } else {
1238 set_filter = dev->s_wakeup_filter;
c5540fbb
DH
1239 enabled_protocols = &dev->enabled_wakeup_protocols;
1240 filter = &dev->scancode_wakeup_filter;
da6e162d
DH
1241 }
1242
99b0f3c9
DH
1243 if (!set_filter)
1244 return -EINVAL;
00942d1a
JH
1245
1246 mutex_lock(&dev->lock);
1247
da6e162d 1248 new_filter = *filter;
00942d1a 1249 if (fattr->mask)
da6e162d 1250 new_filter.mask = val;
00942d1a 1251 else
da6e162d 1252 new_filter.data = val;
23c843b5 1253
da6e162d 1254 if (!*enabled_protocols && val) {
6bea25af
JH
1255 /* refuse to set a filter unless a protocol is enabled */
1256 ret = -EINVAL;
1257 goto unlock;
1258 }
23c843b5 1259
da6e162d 1260 ret = set_filter(dev, &new_filter);
99b0f3c9
DH
1261 if (ret < 0)
1262 goto unlock;
00942d1a 1263
da6e162d 1264 *filter = new_filter;
00942d1a
JH
1265
1266unlock:
1267 mutex_unlock(&dev->lock);
da6e162d 1268 return (ret < 0) ? ret : len;
00942d1a
JH
1269}
1270
d8b4b582
DH
1271static void rc_dev_release(struct device *device)
1272{
47cae1e1
MK
1273 struct rc_dev *dev = to_rc_dev(device);
1274
1275 kfree(dev);
d8b4b582
DH
1276}
1277
bc2a6c57
MCC
1278#define ADD_HOTPLUG_VAR(fmt, val...) \
1279 do { \
1280 int err = add_uevent_var(env, fmt, val); \
1281 if (err) \
1282 return err; \
1283 } while (0)
1284
1285static int rc_dev_uevent(struct device *device, struct kobj_uevent_env *env)
1286{
d8b4b582 1287 struct rc_dev *dev = to_rc_dev(device);
bc2a6c57 1288
b088ba65
MCC
1289 if (dev->rc_map.name)
1290 ADD_HOTPLUG_VAR("NAME=%s", dev->rc_map.name);
d8b4b582
DH
1291 if (dev->driver_name)
1292 ADD_HOTPLUG_VAR("DRV_NAME=%s", dev->driver_name);
bc2a6c57
MCC
1293
1294 return 0;
1295}
1296
1297/*
1298 * Static device attribute struct with the sysfs attributes for IR's
1299 */
ab88c66d
JH
1300static RC_PROTO_ATTR(protocols, S_IRUGO | S_IWUSR,
1301 show_protocols, store_protocols, RC_FILTER_NORMAL);
1302static RC_PROTO_ATTR(wakeup_protocols, S_IRUGO | S_IWUSR,
1303 show_protocols, store_protocols, RC_FILTER_WAKEUP);
00942d1a
JH
1304static RC_FILTER_ATTR(filter, S_IRUGO|S_IWUSR,
1305 show_filter, store_filter, RC_FILTER_NORMAL, false);
1306static RC_FILTER_ATTR(filter_mask, S_IRUGO|S_IWUSR,
1307 show_filter, store_filter, RC_FILTER_NORMAL, true);
1308static RC_FILTER_ATTR(wakeup_filter, S_IRUGO|S_IWUSR,
1309 show_filter, store_filter, RC_FILTER_WAKEUP, false);
1310static RC_FILTER_ATTR(wakeup_filter_mask, S_IRUGO|S_IWUSR,
1311 show_filter, store_filter, RC_FILTER_WAKEUP, true);
bc2a6c57 1312
99b0f3c9 1313static struct attribute *rc_dev_protocol_attrs[] = {
ab88c66d 1314 &dev_attr_protocols.attr.attr,
99b0f3c9
DH
1315 NULL,
1316};
1317
1318static struct attribute_group rc_dev_protocol_attr_grp = {
1319 .attrs = rc_dev_protocol_attrs,
1320};
1321
1322static struct attribute *rc_dev_wakeup_protocol_attrs[] = {
ab88c66d 1323 &dev_attr_wakeup_protocols.attr.attr,
99b0f3c9
DH
1324 NULL,
1325};
1326
1327static struct attribute_group rc_dev_wakeup_protocol_attr_grp = {
1328 .attrs = rc_dev_wakeup_protocol_attrs,
1329};
1330
1331static struct attribute *rc_dev_filter_attrs[] = {
00942d1a
JH
1332 &dev_attr_filter.attr.attr,
1333 &dev_attr_filter_mask.attr.attr,
bc2a6c57
MCC
1334 NULL,
1335};
1336
99b0f3c9
DH
1337static struct attribute_group rc_dev_filter_attr_grp = {
1338 .attrs = rc_dev_filter_attrs,
bc2a6c57
MCC
1339};
1340
99b0f3c9
DH
1341static struct attribute *rc_dev_wakeup_filter_attrs[] = {
1342 &dev_attr_wakeup_filter.attr.attr,
1343 &dev_attr_wakeup_filter_mask.attr.attr,
1344 NULL,
1345};
1346
1347static struct attribute_group rc_dev_wakeup_filter_attr_grp = {
1348 .attrs = rc_dev_wakeup_filter_attrs,
bc2a6c57
MCC
1349};
1350
1351static struct device_type rc_dev_type = {
d8b4b582 1352 .release = rc_dev_release,
bc2a6c57
MCC
1353 .uevent = rc_dev_uevent,
1354};
1355
d8b4b582 1356struct rc_dev *rc_allocate_device(void)
bc2a6c57 1357{
d8b4b582 1358 struct rc_dev *dev;
bc2a6c57 1359
d8b4b582
DH
1360 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1361 if (!dev)
1362 return NULL;
1363
1364 dev->input_dev = input_allocate_device();
1365 if (!dev->input_dev) {
1366 kfree(dev);
1367 return NULL;
1368 }
1369
aebd636b
DT
1370 dev->input_dev->getkeycode = ir_getkeycode;
1371 dev->input_dev->setkeycode = ir_setkeycode;
d8b4b582
DH
1372 input_set_drvdata(dev->input_dev, dev);
1373
b088ba65 1374 spin_lock_init(&dev->rc_map.lock);
d8b4b582 1375 spin_lock_init(&dev->keylock);
08aeb7c9 1376 mutex_init(&dev->lock);
d8b4b582 1377 setup_timer(&dev->timer_keyup, ir_timer_keyup, (unsigned long)dev);
bc2a6c57 1378
d8b4b582 1379 dev->dev.type = &rc_dev_type;
40fc5325 1380 dev->dev.class = &rc_class;
d8b4b582
DH
1381 device_initialize(&dev->dev);
1382
1383 __module_get(THIS_MODULE);
1384 return dev;
1385}
1386EXPORT_SYMBOL_GPL(rc_allocate_device);
1387
1388void rc_free_device(struct rc_dev *dev)
bc2a6c57 1389{
b05681b9
MCC
1390 if (!dev)
1391 return;
1392
3dd94f00 1393 input_free_device(dev->input_dev);
b05681b9
MCC
1394
1395 put_device(&dev->dev);
1396
47cae1e1
MK
1397 /* kfree(dev) will be called by the callback function
1398 rc_dev_release() */
1399
b05681b9 1400 module_put(THIS_MODULE);
d8b4b582
DH
1401}
1402EXPORT_SYMBOL_GPL(rc_free_device);
1403
1404int rc_register_device(struct rc_dev *dev)
1405{
5da6e984 1406 static bool raw_init = false; /* raw decoders loaded? */
b088ba65 1407 struct rc_map *rc_map;
bc2a6c57 1408 const char *path;
fcb13097
DH
1409 int attr = 0;
1410 int minor;
1411 int rc;
bc2a6c57 1412
d8b4b582
DH
1413 if (!dev || !dev->map_name)
1414 return -EINVAL;
bc2a6c57 1415
d100e659 1416 rc_map = rc_map_get(dev->map_name);
b088ba65 1417 if (!rc_map)
d100e659 1418 rc_map = rc_map_get(RC_MAP_EMPTY);
b088ba65 1419 if (!rc_map || !rc_map->scan || rc_map->size == 0)
d8b4b582
DH
1420 return -EINVAL;
1421
1422 set_bit(EV_KEY, dev->input_dev->evbit);
1423 set_bit(EV_REP, dev->input_dev->evbit);
1424 set_bit(EV_MSC, dev->input_dev->evbit);
1425 set_bit(MSC_SCAN, dev->input_dev->mscbit);
1426 if (dev->open)
1427 dev->input_dev->open = ir_open;
1428 if (dev->close)
1429 dev->input_dev->close = ir_close;
1430
fcb13097
DH
1431 minor = ida_simple_get(&rc_ida, 0, RC_DEV_MAX, GFP_KERNEL);
1432 if (minor < 0)
1433 return minor;
1434
1435 dev->minor = minor;
1436 dev_set_name(&dev->dev, "rc%u", dev->minor);
1437 dev_set_drvdata(&dev->dev, dev);
078600f5 1438 atomic_set(&dev->initialized, 0);
587d1b06 1439
99b0f3c9
DH
1440 dev->dev.groups = dev->sysfs_groups;
1441 dev->sysfs_groups[attr++] = &rc_dev_protocol_attr_grp;
1442 if (dev->s_filter)
120703f9 1443 dev->sysfs_groups[attr++] = &rc_dev_filter_attr_grp;
99b0f3c9
DH
1444 if (dev->s_wakeup_filter)
1445 dev->sysfs_groups[attr++] = &rc_dev_wakeup_filter_attr_grp;
1446 if (dev->change_wakeup_protocol)
1447 dev->sysfs_groups[attr++] = &rc_dev_wakeup_protocol_attr_grp;
1448 dev->sysfs_groups[attr++] = NULL;
1449
d8b4b582
DH
1450 rc = device_add(&dev->dev);
1451 if (rc)
08aeb7c9 1452 goto out_unlock;
bc2a6c57 1453
b088ba65 1454 rc = ir_setkeytable(dev, rc_map);
d8b4b582
DH
1455 if (rc)
1456 goto out_dev;
1457
1458 dev->input_dev->dev.parent = &dev->dev;
1459 memcpy(&dev->input_dev->id, &dev->input_id, sizeof(dev->input_id));
1460 dev->input_dev->phys = dev->input_phys;
1461 dev->input_dev->name = dev->input_name;
8b2ff320 1462
d8b4b582 1463 /*
25985edc 1464 * Default delay of 250ms is too short for some protocols, especially
d8b4b582
DH
1465 * since the timeout is currently set to 250ms. Increase it to 500ms,
1466 * to avoid wrong repetition of the keycodes. Note that this must be
1467 * set after the call to input_register_device().
1468 */
1469 dev->input_dev->rep[REP_DELAY] = 500;
1470
ca540c8b
MCC
1471 /*
1472 * As a repeat event on protocols like RC-5 and NEC take as long as
1473 * 110/114ms, using 33ms as a repeat period is not the right thing
1474 * to do.
1475 */
1476 dev->input_dev->rep[REP_PERIOD] = 125;
1477
078600f5
MCC
1478 /* rc_open will be called here */
1479 rc = input_register_device(dev->input_dev);
1480 if (rc)
1481 goto out_table;
1482
d8b4b582 1483 path = kobject_get_path(&dev->dev.kobj, GFP_KERNEL);
4dc0e908
HK
1484 dev_info(&dev->dev, "%s as %s\n",
1485 dev->input_name ?: "Unspecified device", path ?: "N/A");
bc2a6c57
MCC
1486 kfree(path);
1487
3a03b86f 1488 if (dev->driver_type == RC_DRIVER_IR_RAW) {
5da6e984 1489 if (!raw_init) {
c1500ba0 1490 request_module_nowait("ir-lirc-codec");
5da6e984
EG
1491 raw_init = true;
1492 }
d8b4b582
DH
1493 rc = ir_raw_event_register(dev);
1494 if (rc < 0)
1495 goto out_input;
1496 }
1497
1498 if (dev->change_protocol) {
fb9b1641 1499 u64 rc_type = (1ll << rc_map->rc_type);
c003ab1b 1500 rc = dev->change_protocol(dev, &rc_type);
d8b4b582
DH
1501 if (rc < 0)
1502 goto out_raw;
c5540fbb 1503 dev->enabled_protocols = rc_type;
d8b4b582
DH
1504 }
1505
078600f5 1506 /* Allow the RC sysfs nodes to be accessible */
078600f5 1507 atomic_set(&dev->initialized, 1);
0528f354 1508
fcb13097
DH
1509 IR_dprintk(1, "Registered rc%u (driver: %s, remote: %s, mode %s)\n",
1510 dev->minor,
d8b4b582 1511 dev->driver_name ? dev->driver_name : "unknown",
b088ba65 1512 rc_map->name ? rc_map->name : "unknown",
d8b4b582
DH
1513 dev->driver_type == RC_DRIVER_IR_RAW ? "raw" : "cooked");
1514
bc2a6c57 1515 return 0;
d8b4b582
DH
1516
1517out_raw:
1518 if (dev->driver_type == RC_DRIVER_IR_RAW)
1519 ir_raw_event_unregister(dev);
1520out_input:
1521 input_unregister_device(dev->input_dev);
1522 dev->input_dev = NULL;
1523out_table:
b088ba65 1524 ir_free_table(&dev->rc_map);
d8b4b582
DH
1525out_dev:
1526 device_del(&dev->dev);
08aeb7c9 1527out_unlock:
fcb13097 1528 ida_simple_remove(&rc_ida, minor);
d8b4b582 1529 return rc;
bc2a6c57 1530}
d8b4b582 1531EXPORT_SYMBOL_GPL(rc_register_device);
bc2a6c57 1532
d8b4b582 1533void rc_unregister_device(struct rc_dev *dev)
bc2a6c57 1534{
d8b4b582
DH
1535 if (!dev)
1536 return;
bc2a6c57 1537
d8b4b582 1538 del_timer_sync(&dev->timer_keyup);
bc2a6c57 1539
d8b4b582
DH
1540 if (dev->driver_type == RC_DRIVER_IR_RAW)
1541 ir_raw_event_unregister(dev);
1542
b05681b9
MCC
1543 /* Freeing the table should also call the stop callback */
1544 ir_free_table(&dev->rc_map);
1545 IR_dprintk(1, "Freed keycode table\n");
1546
d8b4b582
DH
1547 input_unregister_device(dev->input_dev);
1548 dev->input_dev = NULL;
1549
b05681b9 1550 device_del(&dev->dev);
d8b4b582 1551
fcb13097
DH
1552 ida_simple_remove(&rc_ida, dev->minor);
1553
b05681b9 1554 rc_free_device(dev);
bc2a6c57 1555}
b05681b9 1556
d8b4b582 1557EXPORT_SYMBOL_GPL(rc_unregister_device);
bc2a6c57
MCC
1558
1559/*
1560 * Init/exit code for the module. Basically, creates/removes /sys/class/rc
1561 */
1562
6bda9644 1563static int __init rc_core_init(void)
bc2a6c57 1564{
40fc5325 1565 int rc = class_register(&rc_class);
bc2a6c57 1566 if (rc) {
6bda9644 1567 printk(KERN_ERR "rc_core: unable to register rc class\n");
bc2a6c57
MCC
1568 return rc;
1569 }
1570
153a60bb 1571 led_trigger_register_simple("rc-feedback", &led_feedback);
d100e659 1572 rc_map_register(&empty_map);
bc2a6c57
MCC
1573
1574 return 0;
1575}
1576
6bda9644 1577static void __exit rc_core_exit(void)
bc2a6c57 1578{
40fc5325 1579 class_unregister(&rc_class);
153a60bb 1580 led_trigger_unregister_simple(led_feedback);
d100e659 1581 rc_map_unregister(&empty_map);
bc2a6c57
MCC
1582}
1583
e76d4ce4 1584subsys_initcall(rc_core_init);
6bda9644 1585module_exit(rc_core_exit);
bc2a6c57 1586
6bda9644
MCC
1587int rc_core_debug; /* ir_debug level (0,1,2) */
1588EXPORT_SYMBOL_GPL(rc_core_debug);
1589module_param_named(debug, rc_core_debug, int, 0644);
446e4a64 1590
37e59f87 1591MODULE_AUTHOR("Mauro Carvalho Chehab");
446e4a64 1592MODULE_LICENSE("GPL");
This page took 0.469401 seconds and 5 git commands to generate.