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