Merge drm-fixes into drm-next.
[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);
c73bbaa4
MCC
726 if (!rdev->initialized) {
727 rval = -EINVAL;
728 goto unlock;
729 }
730
f02dcdd1 731 if (!rdev->users++ && rdev->open != NULL)
8b2ff320
SK
732 rval = rdev->open(rdev);
733
734 if (rval)
735 rdev->users--;
736
c73bbaa4 737unlock:
8b2ff320
SK
738 mutex_unlock(&rdev->lock);
739
740 return rval;
741}
742EXPORT_SYMBOL_GPL(rc_open);
743
d8b4b582 744static int ir_open(struct input_dev *idev)
ef53a115 745{
d8b4b582 746 struct rc_dev *rdev = input_get_drvdata(idev);
75543cce 747
8b2ff320
SK
748 return rc_open(rdev);
749}
750
751void rc_close(struct rc_dev *rdev)
752{
753 if (rdev) {
754 mutex_lock(&rdev->lock);
755
81b7d14e 756 if (!--rdev->users && rdev->close != NULL)
8b2ff320
SK
757 rdev->close(rdev);
758
759 mutex_unlock(&rdev->lock);
760 }
ef53a115 761}
8b2ff320 762EXPORT_SYMBOL_GPL(rc_close);
d4b778d3 763
d8b4b582 764static void ir_close(struct input_dev *idev)
f6fc5049 765{
d8b4b582 766 struct rc_dev *rdev = input_get_drvdata(idev);
8b2ff320 767 rc_close(rdev);
f6fc5049 768}
f6fc5049 769
bc2a6c57 770/* class for /sys/class/rc */
40fc5325 771static char *rc_devnode(struct device *dev, umode_t *mode)
bc2a6c57
MCC
772{
773 return kasprintf(GFP_KERNEL, "rc/%s", dev_name(dev));
774}
775
40fc5325 776static struct class rc_class = {
bc2a6c57 777 .name = "rc",
40fc5325 778 .devnode = rc_devnode,
bc2a6c57
MCC
779};
780
c003ab1b
DH
781/*
782 * These are the protocol textual descriptions that are
783 * used by the sysfs protocols file. Note that the order
784 * of the entries is relevant.
785 */
53df8777 786static const struct {
bc2a6c57 787 u64 type;
53df8777 788 const char *name;
9f0bf366 789 const char *module_name;
bc2a6c57 790} proto_names[] = {
9f0bf366
HK
791 { RC_BIT_NONE, "none", NULL },
792 { RC_BIT_OTHER, "other", NULL },
793 { RC_BIT_UNKNOWN, "unknown", NULL },
c003ab1b 794 { RC_BIT_RC5 |
9f0bf366
HK
795 RC_BIT_RC5X, "rc-5", "ir-rc5-decoder" },
796 { RC_BIT_NEC, "nec", "ir-nec-decoder" },
c003ab1b
DH
797 { RC_BIT_RC6_0 |
798 RC_BIT_RC6_6A_20 |
799 RC_BIT_RC6_6A_24 |
800 RC_BIT_RC6_6A_32 |
9f0bf366
HK
801 RC_BIT_RC6_MCE, "rc-6", "ir-rc6-decoder" },
802 { RC_BIT_JVC, "jvc", "ir-jvc-decoder" },
c003ab1b
DH
803 { RC_BIT_SONY12 |
804 RC_BIT_SONY15 |
9f0bf366
HK
805 RC_BIT_SONY20, "sony", "ir-sony-decoder" },
806 { RC_BIT_RC5_SZ, "rc-5-sz", "ir-rc5-decoder" },
807 { RC_BIT_SANYO, "sanyo", "ir-sanyo-decoder" },
808 { RC_BIT_SHARP, "sharp", "ir-sharp-decoder" },
809 { RC_BIT_MCE_KBD, "mce_kbd", "ir-mce_kbd-decoder" },
810 { RC_BIT_XMP, "xmp", "ir-xmp-decoder" },
bc2a6c57
MCC
811};
812
bc2a6c57 813/**
ab88c66d
JH
814 * struct rc_filter_attribute - Device attribute relating to a filter type.
815 * @attr: Device attribute.
816 * @type: Filter type.
817 * @mask: false for filter value, true for filter mask.
818 */
819struct rc_filter_attribute {
820 struct device_attribute attr;
821 enum rc_filter_type type;
822 bool mask;
823};
824#define to_rc_filter_attr(a) container_of(a, struct rc_filter_attribute, attr)
825
826#define RC_PROTO_ATTR(_name, _mode, _show, _store, _type) \
827 struct rc_filter_attribute dev_attr_##_name = { \
828 .attr = __ATTR(_name, _mode, _show, _store), \
829 .type = (_type), \
830 }
831#define RC_FILTER_ATTR(_name, _mode, _show, _store, _type, _mask) \
832 struct rc_filter_attribute dev_attr_##_name = { \
833 .attr = __ATTR(_name, _mode, _show, _store), \
834 .type = (_type), \
835 .mask = (_mask), \
836 }
837
dd6ff6a0
DH
838static bool lirc_is_present(void)
839{
840#if defined(CONFIG_LIRC_MODULE)
841 struct module *lirc;
842
843 mutex_lock(&module_mutex);
844 lirc = find_module("lirc_dev");
845 mutex_unlock(&module_mutex);
846
847 return lirc ? true : false;
848#elif defined(CONFIG_LIRC)
849 return true;
850#else
851 return false;
852#endif
853}
854
ab88c66d
JH
855/**
856 * show_protocols() - shows the current/wakeup IR protocol(s)
d8b4b582 857 * @device: the device descriptor
da6e162d 858 * @mattr: the device attribute struct
bc2a6c57
MCC
859 * @buf: a pointer to the output buffer
860 *
861 * This routine is a callback routine for input read the IR protocol type(s).
ab88c66d 862 * it is trigged by reading /sys/class/rc/rc?/[wakeup_]protocols.
bc2a6c57
MCC
863 * It returns the protocol names of supported protocols.
864 * Enabled protocols are printed in brackets.
08aeb7c9
JW
865 *
866 * dev->lock is taken to guard against races between device
867 * registration, store_protocols and show_protocols.
bc2a6c57 868 */
d8b4b582 869static ssize_t show_protocols(struct device *device,
bc2a6c57
MCC
870 struct device_attribute *mattr, char *buf)
871{
d8b4b582 872 struct rc_dev *dev = to_rc_dev(device);
ab88c66d 873 struct rc_filter_attribute *fattr = to_rc_filter_attr(mattr);
bc2a6c57
MCC
874 u64 allowed, enabled;
875 char *tmp = buf;
876 int i;
877
878 /* Device is being removed */
d8b4b582 879 if (!dev)
bc2a6c57
MCC
880 return -EINVAL;
881
08aeb7c9 882 mutex_lock(&dev->lock);
c73bbaa4
MCC
883 if (!dev->initialized) {
884 mutex_unlock(&dev->lock);
885 return -EINVAL;
886 }
08aeb7c9 887
da6e162d 888 if (fattr->type == RC_FILTER_NORMAL) {
c5540fbb 889 enabled = dev->enabled_protocols;
d24b69fc
MCC
890 allowed = dev->allowed_protocols;
891 if (dev->raw && !allowed)
da6e162d 892 allowed = ir_raw_get_allowed_protocols();
da6e162d 893 } else {
c5540fbb
DH
894 enabled = dev->enabled_wakeup_protocols;
895 allowed = dev->allowed_wakeup_protocols;
30ebc5e4 896 }
bc2a6c57 897
da6e162d
DH
898 mutex_unlock(&dev->lock);
899
900 IR_dprintk(1, "%s: allowed - 0x%llx, enabled - 0x%llx\n",
901 __func__, (long long)allowed, (long long)enabled);
bc2a6c57
MCC
902
903 for (i = 0; i < ARRAY_SIZE(proto_names); i++) {
904 if (allowed & enabled & proto_names[i].type)
905 tmp += sprintf(tmp, "[%s] ", proto_names[i].name);
906 else if (allowed & proto_names[i].type)
907 tmp += sprintf(tmp, "%s ", proto_names[i].name);
c003ab1b
DH
908
909 if (allowed & proto_names[i].type)
910 allowed &= ~proto_names[i].type;
bc2a6c57
MCC
911 }
912
dd6ff6a0 913 if (dev->driver_type == RC_DRIVER_IR_RAW && lirc_is_present())
275ddb40
DH
914 tmp += sprintf(tmp, "[lirc] ");
915
bc2a6c57
MCC
916 if (tmp != buf)
917 tmp--;
918 *tmp = '\n';
08aeb7c9 919
bc2a6c57
MCC
920 return tmp + 1 - buf;
921}
922
923/**
da6e162d
DH
924 * parse_protocol_change() - parses a protocol change request
925 * @protocols: pointer to the bitmask of current protocols
926 * @buf: pointer to the buffer with a list of changes
bc2a6c57 927 *
da6e162d
DH
928 * Writing "+proto" will add a protocol to the protocol mask.
929 * Writing "-proto" will remove a protocol from protocol mask.
bc2a6c57
MCC
930 * Writing "proto" will enable only "proto".
931 * Writing "none" will disable all protocols.
da6e162d 932 * Returns the number of changes performed or a negative error code.
bc2a6c57 933 */
da6e162d 934static int parse_protocol_change(u64 *protocols, const char *buf)
bc2a6c57 935{
bc2a6c57 936 const char *tmp;
da6e162d
DH
937 unsigned count = 0;
938 bool enable, disable;
bc2a6c57 939 u64 mask;
da6e162d 940 int i;
bc2a6c57 941
da6e162d 942 while ((tmp = strsep((char **)&buf, " \n")) != NULL) {
bc2a6c57
MCC
943 if (!*tmp)
944 break;
945
946 if (*tmp == '+') {
947 enable = true;
948 disable = false;
949 tmp++;
950 } else if (*tmp == '-') {
951 enable = false;
952 disable = true;
953 tmp++;
954 } else {
955 enable = false;
956 disable = false;
957 }
958
c003ab1b
DH
959 for (i = 0; i < ARRAY_SIZE(proto_names); i++) {
960 if (!strcasecmp(tmp, proto_names[i].name)) {
961 mask = proto_names[i].type;
962 break;
bc2a6c57 963 }
bc2a6c57
MCC
964 }
965
c003ab1b 966 if (i == ARRAY_SIZE(proto_names)) {
275ddb40
DH
967 if (!strcasecmp(tmp, "lirc"))
968 mask = 0;
969 else {
970 IR_dprintk(1, "Unknown protocol: '%s'\n", tmp);
971 return -EINVAL;
972 }
c003ab1b
DH
973 }
974
975 count++;
976
bc2a6c57 977 if (enable)
da6e162d 978 *protocols |= mask;
bc2a6c57 979 else if (disable)
da6e162d 980 *protocols &= ~mask;
bc2a6c57 981 else
da6e162d 982 *protocols = mask;
bc2a6c57
MCC
983 }
984
985 if (!count) {
986 IR_dprintk(1, "Protocol not specified\n");
da6e162d
DH
987 return -EINVAL;
988 }
989
990 return count;
991}
992
9f0bf366
HK
993static void ir_raw_load_modules(u64 *protocols)
994
995{
996 u64 available;
997 int i, ret;
998
999 for (i = 0; i < ARRAY_SIZE(proto_names); i++) {
1000 if (proto_names[i].type == RC_BIT_NONE ||
1001 proto_names[i].type & (RC_BIT_OTHER | RC_BIT_UNKNOWN))
1002 continue;
1003
1004 available = ir_raw_get_allowed_protocols();
1005 if (!(*protocols & proto_names[i].type & ~available))
1006 continue;
1007
1008 if (!proto_names[i].module_name) {
1009 pr_err("Can't enable IR protocol %s\n",
1010 proto_names[i].name);
1011 *protocols &= ~proto_names[i].type;
1012 continue;
1013 }
1014
1015 ret = request_module("%s", proto_names[i].module_name);
1016 if (ret < 0) {
1017 pr_err("Couldn't load IR protocol module %s\n",
1018 proto_names[i].module_name);
1019 *protocols &= ~proto_names[i].type;
1020 continue;
1021 }
1022 msleep(20);
1023 available = ir_raw_get_allowed_protocols();
1024 if (!(*protocols & proto_names[i].type & ~available))
1025 continue;
1026
1027 pr_err("Loaded IR protocol module %s, \
1028 but protocol %s still not available\n",
1029 proto_names[i].module_name,
1030 proto_names[i].name);
1031 *protocols &= ~proto_names[i].type;
1032 }
1033}
1034
da6e162d
DH
1035/**
1036 * store_protocols() - changes the current/wakeup IR protocol(s)
1037 * @device: the device descriptor
1038 * @mattr: the device attribute struct
1039 * @buf: a pointer to the input buffer
1040 * @len: length of the input buffer
1041 *
1042 * This routine is for changing the IR protocol type.
1043 * It is trigged by writing to /sys/class/rc/rc?/[wakeup_]protocols.
1044 * See parse_protocol_change() for the valid commands.
1045 * Returns @len on success or a negative error code.
1046 *
1047 * dev->lock is taken to guard against races between device
1048 * registration, store_protocols and show_protocols.
1049 */
1050static ssize_t store_protocols(struct device *device,
1051 struct device_attribute *mattr,
1052 const char *buf, size_t len)
1053{
1054 struct rc_dev *dev = to_rc_dev(device);
1055 struct rc_filter_attribute *fattr = to_rc_filter_attr(mattr);
1056 u64 *current_protocols;
1057 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
1058 struct rc_scancode_filter *filter;
1059 int (*set_filter)(struct rc_dev *dev, struct rc_scancode_filter *filter);
1060 u64 old_protocols, new_protocols;
1061 ssize_t rc;
1062
1063 /* Device is being removed */
1064 if (!dev)
1065 return -EINVAL;
1066
1067 if (fattr->type == RC_FILTER_NORMAL) {
1068 IR_dprintk(1, "Normal protocol change requested\n");
c5540fbb 1069 current_protocols = &dev->enabled_protocols;
da6e162d 1070 change_protocol = dev->change_protocol;
c5540fbb 1071 filter = &dev->scancode_filter;
da6e162d
DH
1072 set_filter = dev->s_filter;
1073 } else {
1074 IR_dprintk(1, "Wakeup protocol change requested\n");
c5540fbb 1075 current_protocols = &dev->enabled_wakeup_protocols;
da6e162d 1076 change_protocol = dev->change_wakeup_protocol;
c5540fbb 1077 filter = &dev->scancode_wakeup_filter;
da6e162d
DH
1078 set_filter = dev->s_wakeup_filter;
1079 }
1080
1081 if (!change_protocol) {
1082 IR_dprintk(1, "Protocol switching not supported\n");
1083 return -EINVAL;
1084 }
1085
1086 mutex_lock(&dev->lock);
c73bbaa4
MCC
1087 if (!dev->initialized) {
1088 rc = -EINVAL;
1089 goto out;
1090 }
da6e162d
DH
1091
1092 old_protocols = *current_protocols;
1093 new_protocols = old_protocols;
1094 rc = parse_protocol_change(&new_protocols, buf);
1095 if (rc < 0)
1096 goto out;
1097
1098 rc = change_protocol(dev, &new_protocols);
1099 if (rc < 0) {
1100 IR_dprintk(1, "Error setting protocols to 0x%llx\n",
1101 (long long)new_protocols);
08aeb7c9 1102 goto out;
bc2a6c57
MCC
1103 }
1104
9f0bf366
HK
1105 if (dev->driver_type == RC_DRIVER_IR_RAW)
1106 ir_raw_load_modules(&new_protocols);
1107
983c5bd2
JH
1108 if (new_protocols != old_protocols) {
1109 *current_protocols = new_protocols;
1110 IR_dprintk(1, "Protocols changed to 0x%llx\n",
1111 (long long)new_protocols);
bc2a6c57
MCC
1112 }
1113
6bea25af 1114 /*
983c5bd2
JH
1115 * If a protocol change was attempted the filter may need updating, even
1116 * if the actual protocol mask hasn't changed (since the driver may have
1117 * cleared the filter).
6bea25af
JH
1118 * Try setting the same filter with the new protocol (if any).
1119 * Fall back to clearing the filter.
1120 */
da6e162d
DH
1121 if (set_filter && filter->mask) {
1122 if (new_protocols)
1123 rc = set_filter(dev, filter);
1124 else
1125 rc = -1;
6bea25af 1126
da6e162d
DH
1127 if (rc < 0) {
1128 filter->data = 0;
1129 filter->mask = 0;
1130 set_filter(dev, filter);
1131 }
6bea25af
JH
1132 }
1133
da6e162d 1134 rc = len;
08aeb7c9
JW
1135
1136out:
1137 mutex_unlock(&dev->lock);
da6e162d 1138 return rc;
bc2a6c57
MCC
1139}
1140
00942d1a
JH
1141/**
1142 * show_filter() - shows the current scancode filter value or mask
1143 * @device: the device descriptor
1144 * @attr: the device attribute struct
1145 * @buf: a pointer to the output buffer
1146 *
1147 * This routine is a callback routine to read a scancode filter value or mask.
1148 * It is trigged by reading /sys/class/rc/rc?/[wakeup_]filter[_mask].
1149 * It prints the current scancode filter value or mask of the appropriate filter
1150 * type in hexadecimal into @buf and returns the size of the buffer.
1151 *
1152 * Bits of the filter value corresponding to set bits in the filter mask are
1153 * compared against input scancodes and non-matching scancodes are discarded.
1154 *
1155 * dev->lock is taken to guard against races between device registration,
1156 * store_filter and show_filter.
1157 */
1158static ssize_t show_filter(struct device *device,
1159 struct device_attribute *attr,
1160 char *buf)
1161{
1162 struct rc_dev *dev = to_rc_dev(device);
1163 struct rc_filter_attribute *fattr = to_rc_filter_attr(attr);
da6e162d 1164 struct rc_scancode_filter *filter;
00942d1a
JH
1165 u32 val;
1166
1167 /* Device is being removed */
1168 if (!dev)
1169 return -EINVAL;
1170
c73bbaa4
MCC
1171 mutex_lock(&dev->lock);
1172 if (!dev->initialized) {
1173 mutex_unlock(&dev->lock);
1174 return -EINVAL;
1175 }
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
1226 ret = kstrtoul(buf, 0, &val);
1227 if (ret < 0)
1228 return ret;
1229
da6e162d
DH
1230 if (fattr->type == RC_FILTER_NORMAL) {
1231 set_filter = dev->s_filter;
c5540fbb
DH
1232 enabled_protocols = &dev->enabled_protocols;
1233 filter = &dev->scancode_filter;
da6e162d
DH
1234 } else {
1235 set_filter = dev->s_wakeup_filter;
c5540fbb
DH
1236 enabled_protocols = &dev->enabled_wakeup_protocols;
1237 filter = &dev->scancode_wakeup_filter;
da6e162d
DH
1238 }
1239
99b0f3c9
DH
1240 if (!set_filter)
1241 return -EINVAL;
00942d1a
JH
1242
1243 mutex_lock(&dev->lock);
c73bbaa4
MCC
1244 if (!dev->initialized) {
1245 ret = -EINVAL;
1246 goto unlock;
1247 }
00942d1a 1248
da6e162d 1249 new_filter = *filter;
00942d1a 1250 if (fattr->mask)
da6e162d 1251 new_filter.mask = val;
00942d1a 1252 else
da6e162d 1253 new_filter.data = val;
23c843b5 1254
da6e162d 1255 if (!*enabled_protocols && val) {
6bea25af
JH
1256 /* refuse to set a filter unless a protocol is enabled */
1257 ret = -EINVAL;
1258 goto unlock;
1259 }
23c843b5 1260
da6e162d 1261 ret = set_filter(dev, &new_filter);
99b0f3c9
DH
1262 if (ret < 0)
1263 goto unlock;
00942d1a 1264
da6e162d 1265 *filter = new_filter;
00942d1a
JH
1266
1267unlock:
1268 mutex_unlock(&dev->lock);
da6e162d 1269 return (ret < 0) ? ret : len;
00942d1a
JH
1270}
1271
d8b4b582
DH
1272static void rc_dev_release(struct device *device)
1273{
d8b4b582
DH
1274}
1275
bc2a6c57
MCC
1276#define ADD_HOTPLUG_VAR(fmt, val...) \
1277 do { \
1278 int err = add_uevent_var(env, fmt, val); \
1279 if (err) \
1280 return err; \
1281 } while (0)
1282
1283static int rc_dev_uevent(struct device *device, struct kobj_uevent_env *env)
1284{
d8b4b582 1285 struct rc_dev *dev = to_rc_dev(device);
bc2a6c57 1286
b088ba65
MCC
1287 if (dev->rc_map.name)
1288 ADD_HOTPLUG_VAR("NAME=%s", dev->rc_map.name);
d8b4b582
DH
1289 if (dev->driver_name)
1290 ADD_HOTPLUG_VAR("DRV_NAME=%s", dev->driver_name);
bc2a6c57
MCC
1291
1292 return 0;
1293}
1294
1295/*
1296 * Static device attribute struct with the sysfs attributes for IR's
1297 */
ab88c66d
JH
1298static RC_PROTO_ATTR(protocols, S_IRUGO | S_IWUSR,
1299 show_protocols, store_protocols, RC_FILTER_NORMAL);
1300static RC_PROTO_ATTR(wakeup_protocols, S_IRUGO | S_IWUSR,
1301 show_protocols, store_protocols, RC_FILTER_WAKEUP);
00942d1a
JH
1302static RC_FILTER_ATTR(filter, S_IRUGO|S_IWUSR,
1303 show_filter, store_filter, RC_FILTER_NORMAL, false);
1304static RC_FILTER_ATTR(filter_mask, S_IRUGO|S_IWUSR,
1305 show_filter, store_filter, RC_FILTER_NORMAL, true);
1306static RC_FILTER_ATTR(wakeup_filter, S_IRUGO|S_IWUSR,
1307 show_filter, store_filter, RC_FILTER_WAKEUP, false);
1308static RC_FILTER_ATTR(wakeup_filter_mask, S_IRUGO|S_IWUSR,
1309 show_filter, store_filter, RC_FILTER_WAKEUP, true);
bc2a6c57 1310
99b0f3c9 1311static struct attribute *rc_dev_protocol_attrs[] = {
ab88c66d 1312 &dev_attr_protocols.attr.attr,
99b0f3c9
DH
1313 NULL,
1314};
1315
1316static struct attribute_group rc_dev_protocol_attr_grp = {
1317 .attrs = rc_dev_protocol_attrs,
1318};
1319
1320static struct attribute *rc_dev_wakeup_protocol_attrs[] = {
ab88c66d 1321 &dev_attr_wakeup_protocols.attr.attr,
99b0f3c9
DH
1322 NULL,
1323};
1324
1325static struct attribute_group rc_dev_wakeup_protocol_attr_grp = {
1326 .attrs = rc_dev_wakeup_protocol_attrs,
1327};
1328
1329static struct attribute *rc_dev_filter_attrs[] = {
00942d1a
JH
1330 &dev_attr_filter.attr.attr,
1331 &dev_attr_filter_mask.attr.attr,
bc2a6c57
MCC
1332 NULL,
1333};
1334
99b0f3c9
DH
1335static struct attribute_group rc_dev_filter_attr_grp = {
1336 .attrs = rc_dev_filter_attrs,
bc2a6c57
MCC
1337};
1338
99b0f3c9
DH
1339static struct attribute *rc_dev_wakeup_filter_attrs[] = {
1340 &dev_attr_wakeup_filter.attr.attr,
1341 &dev_attr_wakeup_filter_mask.attr.attr,
1342 NULL,
1343};
1344
1345static struct attribute_group rc_dev_wakeup_filter_attr_grp = {
1346 .attrs = rc_dev_wakeup_filter_attrs,
bc2a6c57
MCC
1347};
1348
1349static struct device_type rc_dev_type = {
d8b4b582 1350 .release = rc_dev_release,
bc2a6c57
MCC
1351 .uevent = rc_dev_uevent,
1352};
1353
d8b4b582 1354struct rc_dev *rc_allocate_device(void)
bc2a6c57 1355{
d8b4b582 1356 struct rc_dev *dev;
bc2a6c57 1357
d8b4b582
DH
1358 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1359 if (!dev)
1360 return NULL;
1361
1362 dev->input_dev = input_allocate_device();
1363 if (!dev->input_dev) {
1364 kfree(dev);
1365 return NULL;
1366 }
1367
aebd636b
DT
1368 dev->input_dev->getkeycode = ir_getkeycode;
1369 dev->input_dev->setkeycode = ir_setkeycode;
d8b4b582
DH
1370 input_set_drvdata(dev->input_dev, dev);
1371
b088ba65 1372 spin_lock_init(&dev->rc_map.lock);
d8b4b582 1373 spin_lock_init(&dev->keylock);
08aeb7c9 1374 mutex_init(&dev->lock);
d8b4b582 1375 setup_timer(&dev->timer_keyup, ir_timer_keyup, (unsigned long)dev);
bc2a6c57 1376
d8b4b582 1377 dev->dev.type = &rc_dev_type;
40fc5325 1378 dev->dev.class = &rc_class;
d8b4b582
DH
1379 device_initialize(&dev->dev);
1380
1381 __module_get(THIS_MODULE);
1382 return dev;
1383}
1384EXPORT_SYMBOL_GPL(rc_allocate_device);
1385
1386void rc_free_device(struct rc_dev *dev)
bc2a6c57 1387{
b05681b9
MCC
1388 if (!dev)
1389 return;
1390
3dd94f00 1391 input_free_device(dev->input_dev);
b05681b9
MCC
1392
1393 put_device(&dev->dev);
1394
1395 kfree(dev);
1396 module_put(THIS_MODULE);
d8b4b582
DH
1397}
1398EXPORT_SYMBOL_GPL(rc_free_device);
1399
1400int rc_register_device(struct rc_dev *dev)
1401{
5da6e984 1402 static bool raw_init = false; /* raw decoders loaded? */
b088ba65 1403 struct rc_map *rc_map;
bc2a6c57 1404 const char *path;
fcb13097
DH
1405 int attr = 0;
1406 int minor;
1407 int rc;
bc2a6c57 1408
d8b4b582
DH
1409 if (!dev || !dev->map_name)
1410 return -EINVAL;
bc2a6c57 1411
d100e659 1412 rc_map = rc_map_get(dev->map_name);
b088ba65 1413 if (!rc_map)
d100e659 1414 rc_map = rc_map_get(RC_MAP_EMPTY);
b088ba65 1415 if (!rc_map || !rc_map->scan || rc_map->size == 0)
d8b4b582
DH
1416 return -EINVAL;
1417
1418 set_bit(EV_KEY, dev->input_dev->evbit);
1419 set_bit(EV_REP, dev->input_dev->evbit);
1420 set_bit(EV_MSC, dev->input_dev->evbit);
1421 set_bit(MSC_SCAN, dev->input_dev->mscbit);
1422 if (dev->open)
1423 dev->input_dev->open = ir_open;
1424 if (dev->close)
1425 dev->input_dev->close = ir_close;
1426
fcb13097
DH
1427 minor = ida_simple_get(&rc_ida, 0, RC_DEV_MAX, GFP_KERNEL);
1428 if (minor < 0)
1429 return minor;
1430
1431 dev->minor = minor;
1432 dev_set_name(&dev->dev, "rc%u", dev->minor);
1433 dev_set_drvdata(&dev->dev, dev);
587d1b06 1434
99b0f3c9
DH
1435 dev->dev.groups = dev->sysfs_groups;
1436 dev->sysfs_groups[attr++] = &rc_dev_protocol_attr_grp;
1437 if (dev->s_filter)
120703f9 1438 dev->sysfs_groups[attr++] = &rc_dev_filter_attr_grp;
99b0f3c9
DH
1439 if (dev->s_wakeup_filter)
1440 dev->sysfs_groups[attr++] = &rc_dev_wakeup_filter_attr_grp;
1441 if (dev->change_wakeup_protocol)
1442 dev->sysfs_groups[attr++] = &rc_dev_wakeup_protocol_attr_grp;
1443 dev->sysfs_groups[attr++] = NULL;
1444
d8b4b582
DH
1445 rc = device_add(&dev->dev);
1446 if (rc)
08aeb7c9 1447 goto out_unlock;
bc2a6c57 1448
b088ba65 1449 rc = ir_setkeytable(dev, rc_map);
d8b4b582
DH
1450 if (rc)
1451 goto out_dev;
1452
1453 dev->input_dev->dev.parent = &dev->dev;
1454 memcpy(&dev->input_dev->id, &dev->input_id, sizeof(dev->input_id));
1455 dev->input_dev->phys = dev->input_phys;
1456 dev->input_dev->name = dev->input_name;
8b2ff320 1457
d8b4b582
DH
1458 rc = input_register_device(dev->input_dev);
1459 if (rc)
1460 goto out_table;
bc2a6c57 1461
d8b4b582 1462 /*
25985edc 1463 * Default delay of 250ms is too short for some protocols, especially
d8b4b582
DH
1464 * since the timeout is currently set to 250ms. Increase it to 500ms,
1465 * to avoid wrong repetition of the keycodes. Note that this must be
1466 * set after the call to input_register_device().
1467 */
1468 dev->input_dev->rep[REP_DELAY] = 500;
1469
ca540c8b
MCC
1470 /*
1471 * As a repeat event on protocols like RC-5 and NEC take as long as
1472 * 110/114ms, using 33ms as a repeat period is not the right thing
1473 * to do.
1474 */
1475 dev->input_dev->rep[REP_PERIOD] = 125;
1476
d8b4b582 1477 path = kobject_get_path(&dev->dev.kobj, GFP_KERNEL);
4dc0e908
HK
1478 dev_info(&dev->dev, "%s as %s\n",
1479 dev->input_name ?: "Unspecified device", path ?: "N/A");
bc2a6c57
MCC
1480 kfree(path);
1481
3a03b86f 1482 if (dev->driver_type == RC_DRIVER_IR_RAW) {
5da6e984 1483 if (!raw_init) {
c1500ba0 1484 request_module_nowait("ir-lirc-codec");
5da6e984
EG
1485 raw_init = true;
1486 }
d8b4b582
DH
1487 rc = ir_raw_event_register(dev);
1488 if (rc < 0)
1489 goto out_input;
1490 }
1491
1492 if (dev->change_protocol) {
fb9b1641 1493 u64 rc_type = (1ll << rc_map->rc_type);
c003ab1b 1494 rc = dev->change_protocol(dev, &rc_type);
d8b4b582
DH
1495 if (rc < 0)
1496 goto out_raw;
c5540fbb 1497 dev->enabled_protocols = rc_type;
d8b4b582
DH
1498 }
1499
c73bbaa4
MCC
1500 mutex_lock(&dev->lock);
1501 dev->initialized = true;
0528f354
DC
1502 mutex_unlock(&dev->lock);
1503
fcb13097
DH
1504 IR_dprintk(1, "Registered rc%u (driver: %s, remote: %s, mode %s)\n",
1505 dev->minor,
d8b4b582 1506 dev->driver_name ? dev->driver_name : "unknown",
b088ba65 1507 rc_map->name ? rc_map->name : "unknown",
d8b4b582
DH
1508 dev->driver_type == RC_DRIVER_IR_RAW ? "raw" : "cooked");
1509
bc2a6c57 1510 return 0;
d8b4b582
DH
1511
1512out_raw:
1513 if (dev->driver_type == RC_DRIVER_IR_RAW)
1514 ir_raw_event_unregister(dev);
1515out_input:
1516 input_unregister_device(dev->input_dev);
1517 dev->input_dev = NULL;
1518out_table:
b088ba65 1519 ir_free_table(&dev->rc_map);
d8b4b582
DH
1520out_dev:
1521 device_del(&dev->dev);
08aeb7c9 1522out_unlock:
fcb13097 1523 ida_simple_remove(&rc_ida, minor);
d8b4b582 1524 return rc;
bc2a6c57 1525}
d8b4b582 1526EXPORT_SYMBOL_GPL(rc_register_device);
bc2a6c57 1527
d8b4b582 1528void rc_unregister_device(struct rc_dev *dev)
bc2a6c57 1529{
d8b4b582
DH
1530 if (!dev)
1531 return;
bc2a6c57 1532
d8b4b582 1533 del_timer_sync(&dev->timer_keyup);
bc2a6c57 1534
d8b4b582
DH
1535 if (dev->driver_type == RC_DRIVER_IR_RAW)
1536 ir_raw_event_unregister(dev);
1537
b05681b9
MCC
1538 /* Freeing the table should also call the stop callback */
1539 ir_free_table(&dev->rc_map);
1540 IR_dprintk(1, "Freed keycode table\n");
1541
d8b4b582
DH
1542 input_unregister_device(dev->input_dev);
1543 dev->input_dev = NULL;
1544
b05681b9 1545 device_del(&dev->dev);
d8b4b582 1546
fcb13097
DH
1547 ida_simple_remove(&rc_ida, dev->minor);
1548
b05681b9 1549 rc_free_device(dev);
bc2a6c57 1550}
b05681b9 1551
d8b4b582 1552EXPORT_SYMBOL_GPL(rc_unregister_device);
bc2a6c57
MCC
1553
1554/*
1555 * Init/exit code for the module. Basically, creates/removes /sys/class/rc
1556 */
1557
6bda9644 1558static int __init rc_core_init(void)
bc2a6c57 1559{
40fc5325 1560 int rc = class_register(&rc_class);
bc2a6c57 1561 if (rc) {
6bda9644 1562 printk(KERN_ERR "rc_core: unable to register rc class\n");
bc2a6c57
MCC
1563 return rc;
1564 }
1565
153a60bb 1566 led_trigger_register_simple("rc-feedback", &led_feedback);
d100e659 1567 rc_map_register(&empty_map);
bc2a6c57
MCC
1568
1569 return 0;
1570}
1571
6bda9644 1572static void __exit rc_core_exit(void)
bc2a6c57 1573{
40fc5325 1574 class_unregister(&rc_class);
153a60bb 1575 led_trigger_unregister_simple(led_feedback);
d100e659 1576 rc_map_unregister(&empty_map);
bc2a6c57
MCC
1577}
1578
e76d4ce4 1579subsys_initcall(rc_core_init);
6bda9644 1580module_exit(rc_core_exit);
bc2a6c57 1581
6bda9644
MCC
1582int rc_core_debug; /* ir_debug level (0,1,2) */
1583EXPORT_SYMBOL_GPL(rc_core_debug);
1584module_param_named(debug, rc_core_debug, int, 0644);
446e4a64 1585
37e59f87 1586MODULE_AUTHOR("Mauro Carvalho Chehab");
446e4a64 1587MODULE_LICENSE("GPL");
This page took 0.569871 seconds and 5 git commands to generate.