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