1 /* rc-main.c - Remote Controller core module
3 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
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.
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.
15 #include <media/rc-core.h>
16 #include <linux/atomic.h>
17 #include <linux/spinlock.h>
18 #include <linux/delay.h>
19 #include <linux/input.h>
20 #include <linux/leds.h>
21 #include <linux/slab.h>
22 #include <linux/idr.h>
23 #include <linux/device.h>
24 #include <linux/module.h>
25 #include "rc-core-priv.h"
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
30 #define RC_DEV_MAX 256
32 /* FIXME: IR_KEYPRESS_TIMEOUT should be protocol specific */
33 #define IR_KEYPRESS_TIMEOUT 250
35 /* Used to keep track of known keymaps */
36 static LIST_HEAD(rc_map_list
);
37 static DEFINE_SPINLOCK(rc_map_lock
);
38 static struct led_trigger
*led_feedback
;
40 /* Used to keep track of rc devices */
41 static DEFINE_IDA(rc_ida
);
43 static struct rc_map_list
*seek_rc_map(const char *name
)
45 struct rc_map_list
*map
= NULL
;
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
);
54 spin_unlock(&rc_map_lock
);
59 struct rc_map
*rc_map_get(const char *name
)
62 struct rc_map_list
*map
;
64 map
= seek_rc_map(name
);
67 int rc
= request_module("%s", name
);
69 printk(KERN_ERR
"Couldn't load IR keymap %s\n", name
);
72 msleep(20); /* Give some time for IR to register */
74 map
= seek_rc_map(name
);
78 printk(KERN_ERR
"IR keymap %s not found\n", name
);
82 printk(KERN_INFO
"Registered IR keymap %s\n", map
->map
.name
);
86 EXPORT_SYMBOL_GPL(rc_map_get
);
88 int rc_map_register(struct rc_map_list
*map
)
90 spin_lock(&rc_map_lock
);
91 list_add_tail(&map
->list
, &rc_map_list
);
92 spin_unlock(&rc_map_lock
);
95 EXPORT_SYMBOL_GPL(rc_map_register
);
97 void rc_map_unregister(struct rc_map_list
*map
)
99 spin_lock(&rc_map_lock
);
100 list_del(&map
->list
);
101 spin_unlock(&rc_map_lock
);
103 EXPORT_SYMBOL_GPL(rc_map_unregister
);
106 static struct rc_map_table empty
[] = {
107 { 0x2a, KEY_COFFEE
},
110 static struct rc_map_list empty_map
= {
113 .size
= ARRAY_SIZE(empty
),
114 .rc_type
= RC_TYPE_UNKNOWN
, /* Legacy IR type */
115 .name
= RC_MAP_EMPTY
,
120 * ir_create_table() - initializes a scancode table
121 * @rc_map: the rc_map to initialize
122 * @name: name to assign to the table
123 * @rc_type: ir type to assign to the new table
124 * @size: initial size of the table
125 * @return: zero on success or a negative error code
127 * This routine will initialize the rc_map and will allocate
128 * memory to hold at least the specified number of elements.
130 static int ir_create_table(struct rc_map
*rc_map
,
131 const char *name
, u64 rc_type
, size_t size
)
134 rc_map
->rc_type
= rc_type
;
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
);
137 rc_map
->scan
= kmalloc(rc_map
->alloc
, GFP_KERNEL
);
141 IR_dprintk(1, "Allocated space for %u keycode entries (%u bytes)\n",
142 rc_map
->size
, rc_map
->alloc
);
147 * ir_free_table() - frees memory allocated by a scancode table
148 * @rc_map: the table whose mappings need to be freed
150 * This routine will free memory alloctaed for key mappings used by given
153 static void ir_free_table(struct rc_map
*rc_map
)
161 * ir_resize_table() - resizes a scancode table if necessary
162 * @rc_map: the rc_map to resize
163 * @gfp_flags: gfp flags to use when allocating memory
164 * @return: zero on success or a negative error code
166 * This routine will shrink the rc_map if it has lots of
167 * unused entries and grow it if it is full.
169 static int ir_resize_table(struct rc_map
*rc_map
, gfp_t gfp_flags
)
171 unsigned int oldalloc
= rc_map
->alloc
;
172 unsigned int newalloc
= oldalloc
;
173 struct rc_map_table
*oldscan
= rc_map
->scan
;
174 struct rc_map_table
*newscan
;
176 if (rc_map
->size
== rc_map
->len
) {
177 /* All entries in use -> grow keytable */
178 if (rc_map
->alloc
>= IR_TAB_MAX_SIZE
)
182 IR_dprintk(1, "Growing table to %u bytes\n", newalloc
);
185 if ((rc_map
->len
* 3 < rc_map
->size
) && (oldalloc
> IR_TAB_MIN_SIZE
)) {
186 /* Less than 1/3 of entries in use -> shrink keytable */
188 IR_dprintk(1, "Shrinking table to %u bytes\n", newalloc
);
191 if (newalloc
== oldalloc
)
194 newscan
= kmalloc(newalloc
, gfp_flags
);
196 IR_dprintk(1, "Failed to kmalloc %u bytes\n", newalloc
);
200 memcpy(newscan
, rc_map
->scan
, rc_map
->len
* sizeof(struct rc_map_table
));
201 rc_map
->scan
= newscan
;
202 rc_map
->alloc
= newalloc
;
203 rc_map
->size
= rc_map
->alloc
/ sizeof(struct rc_map_table
);
209 * ir_update_mapping() - set a keycode in the scancode->keycode table
210 * @dev: the struct rc_dev device descriptor
211 * @rc_map: scancode table to be adjusted
212 * @index: index of the mapping that needs to be updated
213 * @keycode: the desired keycode
214 * @return: previous keycode assigned to the mapping
216 * This routine is used to update scancode->keycode mapping at given
219 static unsigned int ir_update_mapping(struct rc_dev
*dev
,
220 struct rc_map
*rc_map
,
222 unsigned int new_keycode
)
224 int old_keycode
= rc_map
->scan
[index
].keycode
;
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",
230 index
, rc_map
->scan
[index
].scancode
);
232 memmove(&rc_map
->scan
[index
], &rc_map
->scan
[index
+ 1],
233 (rc_map
->len
- index
) * sizeof(struct rc_map_table
));
235 IR_dprintk(1, "#%d: %s scan 0x%04x with key 0x%04x\n",
237 old_keycode
== KEY_RESERVED
? "New" : "Replacing",
238 rc_map
->scan
[index
].scancode
, new_keycode
);
239 rc_map
->scan
[index
].keycode
= new_keycode
;
240 __set_bit(new_keycode
, dev
->input_dev
->keybit
);
243 if (old_keycode
!= KEY_RESERVED
) {
244 /* A previous mapping was updated... */
245 __clear_bit(old_keycode
, dev
->input_dev
->keybit
);
246 /* ... but another scancode might use the same keycode */
247 for (i
= 0; i
< rc_map
->len
; i
++) {
248 if (rc_map
->scan
[i
].keycode
== old_keycode
) {
249 __set_bit(old_keycode
, dev
->input_dev
->keybit
);
254 /* Possibly shrink the keytable, failure is not a problem */
255 ir_resize_table(rc_map
, GFP_ATOMIC
);
262 * ir_establish_scancode() - set a keycode in the scancode->keycode table
263 * @dev: the struct rc_dev device descriptor
264 * @rc_map: scancode table to be searched
265 * @scancode: the desired scancode
266 * @resize: controls whether we allowed to resize the table to
267 * accommodate not yet present scancodes
268 * @return: index of the mapping containing scancode in question
269 * or -1U in case of failure.
271 * This routine is used to locate given scancode in rc_map.
272 * If scancode is not yet present the routine will allocate a new slot
275 static unsigned int ir_establish_scancode(struct rc_dev
*dev
,
276 struct rc_map
*rc_map
,
277 unsigned int scancode
,
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
287 * IR tables from other remotes. So, we support specifying a mask to
288 * indicate the valid bits of the scancodes.
290 if (dev
->scancode_mask
)
291 scancode
&= dev
->scancode_mask
;
293 /* First check if we already have a mapping for this ir command */
294 for (i
= 0; i
< rc_map
->len
; i
++) {
295 if (rc_map
->scan
[i
].scancode
== scancode
)
298 /* Keytable is sorted from lowest to highest scancode */
299 if (rc_map
->scan
[i
].scancode
>= scancode
)
303 /* No previous mapping found, we might need to grow the table */
304 if (rc_map
->size
== rc_map
->len
) {
305 if (!resize
|| ir_resize_table(rc_map
, GFP_ATOMIC
))
309 /* i is the proper index to insert our new keycode */
311 memmove(&rc_map
->scan
[i
+ 1], &rc_map
->scan
[i
],
312 (rc_map
->len
- i
) * sizeof(struct rc_map_table
));
313 rc_map
->scan
[i
].scancode
= scancode
;
314 rc_map
->scan
[i
].keycode
= KEY_RESERVED
;
321 * ir_setkeycode() - set a keycode in the scancode->keycode table
322 * @idev: the struct input_dev device descriptor
323 * @scancode: the desired scancode
325 * @return: -EINVAL if the keycode could not be inserted, otherwise zero.
327 * This routine is used to handle evdev EVIOCSKEY ioctl.
329 static int ir_setkeycode(struct input_dev
*idev
,
330 const struct input_keymap_entry
*ke
,
331 unsigned int *old_keycode
)
333 struct rc_dev
*rdev
= input_get_drvdata(idev
);
334 struct rc_map
*rc_map
= &rdev
->rc_map
;
336 unsigned int scancode
;
340 spin_lock_irqsave(&rc_map
->lock
, flags
);
342 if (ke
->flags
& INPUT_KEYMAP_BY_INDEX
) {
344 if (index
>= rc_map
->len
) {
349 retval
= input_scancode_to_scalar(ke
, &scancode
);
353 index
= ir_establish_scancode(rdev
, rc_map
, scancode
, true);
354 if (index
>= rc_map
->len
) {
360 *old_keycode
= ir_update_mapping(rdev
, rc_map
, index
, ke
->keycode
);
363 spin_unlock_irqrestore(&rc_map
->lock
, flags
);
368 * ir_setkeytable() - sets several entries in the scancode->keycode table
369 * @dev: the struct rc_dev device descriptor
370 * @to: the struct rc_map to copy entries to
371 * @from: the struct rc_map to copy entries from
372 * @return: -ENOMEM if all keycodes could not be inserted, otherwise zero.
374 * This routine is used to handle table initialization.
376 static int ir_setkeytable(struct rc_dev
*dev
,
377 const struct rc_map
*from
)
379 struct rc_map
*rc_map
= &dev
->rc_map
;
380 unsigned int i
, index
;
383 rc
= ir_create_table(rc_map
, from
->name
,
384 from
->rc_type
, from
->size
);
388 IR_dprintk(1, "Allocated space for %u keycode entries (%u bytes)\n",
389 rc_map
->size
, rc_map
->alloc
);
391 for (i
= 0; i
< from
->size
; i
++) {
392 index
= ir_establish_scancode(dev
, rc_map
,
393 from
->scan
[i
].scancode
, false);
394 if (index
>= rc_map
->len
) {
399 ir_update_mapping(dev
, rc_map
, index
,
400 from
->scan
[i
].keycode
);
404 ir_free_table(rc_map
);
410 * ir_lookup_by_scancode() - locate mapping by scancode
411 * @rc_map: the struct rc_map to search
412 * @scancode: scancode to look for in the table
413 * @return: index in the table, -1U if not found
415 * This routine performs binary search in RC keykeymap table for
418 static unsigned int ir_lookup_by_scancode(const struct rc_map
*rc_map
,
419 unsigned int scancode
)
422 int end
= rc_map
->len
- 1;
425 while (start
<= end
) {
426 mid
= (start
+ end
) / 2;
427 if (rc_map
->scan
[mid
].scancode
< scancode
)
429 else if (rc_map
->scan
[mid
].scancode
> scancode
)
439 * ir_getkeycode() - get a keycode from the scancode->keycode table
440 * @idev: the struct input_dev device descriptor
441 * @scancode: the desired scancode
442 * @keycode: used to return the keycode, if found, or KEY_RESERVED
443 * @return: always returns zero.
445 * This routine is used to handle evdev EVIOCGKEY ioctl.
447 static int ir_getkeycode(struct input_dev
*idev
,
448 struct input_keymap_entry
*ke
)
450 struct rc_dev
*rdev
= input_get_drvdata(idev
);
451 struct rc_map
*rc_map
= &rdev
->rc_map
;
452 struct rc_map_table
*entry
;
455 unsigned int scancode
;
458 spin_lock_irqsave(&rc_map
->lock
, flags
);
460 if (ke
->flags
& INPUT_KEYMAP_BY_INDEX
) {
463 retval
= input_scancode_to_scalar(ke
, &scancode
);
467 index
= ir_lookup_by_scancode(rc_map
, scancode
);
470 if (index
< rc_map
->len
) {
471 entry
= &rc_map
->scan
[index
];
474 ke
->keycode
= entry
->keycode
;
475 ke
->len
= sizeof(entry
->scancode
);
476 memcpy(ke
->scancode
, &entry
->scancode
, sizeof(entry
->scancode
));
478 } else if (!(ke
->flags
& INPUT_KEYMAP_BY_INDEX
)) {
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].
485 ke
->keycode
= KEY_RESERVED
;
494 spin_unlock_irqrestore(&rc_map
->lock
, flags
);
499 * rc_g_keycode_from_table() - gets the keycode that corresponds to a scancode
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
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.
508 u32
rc_g_keycode_from_table(struct rc_dev
*dev
, u32 scancode
)
510 struct rc_map
*rc_map
= &dev
->rc_map
;
511 unsigned int keycode
;
515 spin_lock_irqsave(&rc_map
->lock
, flags
);
517 index
= ir_lookup_by_scancode(rc_map
, scancode
);
518 keycode
= index
< rc_map
->len
?
519 rc_map
->scan
[index
].keycode
: KEY_RESERVED
;
521 spin_unlock_irqrestore(&rc_map
->lock
, flags
);
523 if (keycode
!= KEY_RESERVED
)
524 IR_dprintk(1, "%s: scancode 0x%04x keycode 0x%02x\n",
525 dev
->input_name
, scancode
, keycode
);
529 EXPORT_SYMBOL_GPL(rc_g_keycode_from_table
);
532 * ir_do_keyup() - internal function to signal the release of a keypress
533 * @dev: the struct rc_dev descriptor of the device
534 * @sync: whether or not to call input_sync
536 * This function is used internally to release a keypress, it must be
537 * called with keylock held.
539 static void ir_do_keyup(struct rc_dev
*dev
, bool sync
)
541 if (!dev
->keypressed
)
544 IR_dprintk(1, "keyup key 0x%04x\n", dev
->last_keycode
);
545 input_report_key(dev
->input_dev
, dev
->last_keycode
, 0);
546 led_trigger_event(led_feedback
, LED_OFF
);
548 input_sync(dev
->input_dev
);
549 dev
->keypressed
= false;
553 * rc_keyup() - signals the release of a keypress
554 * @dev: the struct rc_dev descriptor of the device
556 * This routine is used to signal that a key has been released on the
559 void rc_keyup(struct rc_dev
*dev
)
563 spin_lock_irqsave(&dev
->keylock
, flags
);
564 ir_do_keyup(dev
, true);
565 spin_unlock_irqrestore(&dev
->keylock
, flags
);
567 EXPORT_SYMBOL_GPL(rc_keyup
);
570 * ir_timer_keyup() - generates a keyup event after a timeout
571 * @cookie: a pointer to the struct rc_dev for the device
573 * This routine will generate a keyup event some time after a keydown event
574 * is generated when no further activity has been detected.
576 static void ir_timer_keyup(unsigned long cookie
)
578 struct rc_dev
*dev
= (struct rc_dev
*)cookie
;
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.
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.
591 spin_lock_irqsave(&dev
->keylock
, flags
);
592 if (time_is_before_eq_jiffies(dev
->keyup_jiffies
))
593 ir_do_keyup(dev
, true);
594 spin_unlock_irqrestore(&dev
->keylock
, flags
);
598 * rc_repeat() - signals that a key is still pressed
599 * @dev: the struct rc_dev descriptor of the device
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
605 void rc_repeat(struct rc_dev
*dev
)
609 spin_lock_irqsave(&dev
->keylock
, flags
);
611 input_event(dev
->input_dev
, EV_MSC
, MSC_SCAN
, dev
->last_scancode
);
612 input_sync(dev
->input_dev
);
614 if (!dev
->keypressed
)
617 dev
->keyup_jiffies
= jiffies
+ msecs_to_jiffies(IR_KEYPRESS_TIMEOUT
);
618 mod_timer(&dev
->timer_keyup
, dev
->keyup_jiffies
);
621 spin_unlock_irqrestore(&dev
->keylock
, flags
);
623 EXPORT_SYMBOL_GPL(rc_repeat
);
626 * ir_do_keydown() - internal function to process a keypress
627 * @dev: the struct rc_dev descriptor of the device
628 * @protocol: the protocol of the keypress
629 * @scancode: the scancode of the keypress
630 * @keycode: the keycode of the keypress
631 * @toggle: the toggle value of the keypress
633 * This function is used internally to register a keypress, it must be
634 * called with keylock held.
636 static void ir_do_keydown(struct rc_dev
*dev
, enum rc_type protocol
,
637 u32 scancode
, u32 keycode
, u8 toggle
)
639 bool new_event
= (!dev
->keypressed
||
640 dev
->last_protocol
!= protocol
||
641 dev
->last_scancode
!= scancode
||
642 dev
->last_toggle
!= toggle
);
644 if (new_event
&& dev
->keypressed
)
645 ir_do_keyup(dev
, false);
647 input_event(dev
->input_dev
, EV_MSC
, MSC_SCAN
, scancode
);
649 if (new_event
&& keycode
!= KEY_RESERVED
) {
650 /* Register a keypress */
651 dev
->keypressed
= true;
652 dev
->last_protocol
= protocol
;
653 dev
->last_scancode
= scancode
;
654 dev
->last_toggle
= toggle
;
655 dev
->last_keycode
= keycode
;
657 IR_dprintk(1, "%s: key down event, "
658 "key 0x%04x, protocol 0x%04x, scancode 0x%08x\n",
659 dev
->input_name
, keycode
, protocol
, scancode
);
660 input_report_key(dev
->input_dev
, keycode
, 1);
662 led_trigger_event(led_feedback
, LED_FULL
);
665 input_sync(dev
->input_dev
);
669 * rc_keydown() - generates input event for a key press
670 * @dev: the struct rc_dev descriptor of the device
671 * @protocol: the protocol for the keypress
672 * @scancode: the scancode for the keypress
673 * @toggle: the toggle value (protocol dependent, if the protocol doesn't
674 * support toggle values, this should be set to zero)
676 * This routine is used to signal that a key has been pressed on the
679 void rc_keydown(struct rc_dev
*dev
, enum rc_type protocol
, u32 scancode
, u8 toggle
)
682 u32 keycode
= rc_g_keycode_from_table(dev
, scancode
);
684 spin_lock_irqsave(&dev
->keylock
, flags
);
685 ir_do_keydown(dev
, protocol
, scancode
, keycode
, toggle
);
687 if (dev
->keypressed
) {
688 dev
->keyup_jiffies
= jiffies
+ msecs_to_jiffies(IR_KEYPRESS_TIMEOUT
);
689 mod_timer(&dev
->timer_keyup
, dev
->keyup_jiffies
);
691 spin_unlock_irqrestore(&dev
->keylock
, flags
);
693 EXPORT_SYMBOL_GPL(rc_keydown
);
696 * rc_keydown_notimeout() - generates input event for a key press without
697 * an automatic keyup event at a later time
698 * @dev: the struct rc_dev descriptor of the device
699 * @protocol: the protocol for the keypress
700 * @scancode: the scancode for the keypress
701 * @toggle: the toggle value (protocol dependent, if the protocol doesn't
702 * support toggle values, this should be set to zero)
704 * This routine is used to signal that a key has been pressed on the
705 * remote control. The driver must manually call rc_keyup() at a later stage.
707 void rc_keydown_notimeout(struct rc_dev
*dev
, enum rc_type protocol
,
708 u32 scancode
, u8 toggle
)
711 u32 keycode
= rc_g_keycode_from_table(dev
, scancode
);
713 spin_lock_irqsave(&dev
->keylock
, flags
);
714 ir_do_keydown(dev
, protocol
, scancode
, keycode
, toggle
);
715 spin_unlock_irqrestore(&dev
->keylock
, flags
);
717 EXPORT_SYMBOL_GPL(rc_keydown_notimeout
);
719 int rc_open(struct rc_dev
*rdev
)
726 mutex_lock(&rdev
->lock
);
728 if (!rdev
->users
++ && rdev
->open
!= NULL
)
729 rval
= rdev
->open(rdev
);
734 mutex_unlock(&rdev
->lock
);
738 EXPORT_SYMBOL_GPL(rc_open
);
740 static int ir_open(struct input_dev
*idev
)
742 struct rc_dev
*rdev
= input_get_drvdata(idev
);
744 return rc_open(rdev
);
747 void rc_close(struct rc_dev
*rdev
)
750 mutex_lock(&rdev
->lock
);
752 if (!--rdev
->users
&& rdev
->close
!= NULL
)
755 mutex_unlock(&rdev
->lock
);
758 EXPORT_SYMBOL_GPL(rc_close
);
760 static void ir_close(struct input_dev
*idev
)
762 struct rc_dev
*rdev
= input_get_drvdata(idev
);
766 /* class for /sys/class/rc */
767 static char *rc_devnode(struct device
*dev
, umode_t
*mode
)
769 return kasprintf(GFP_KERNEL
, "rc/%s", dev_name(dev
));
772 static struct class rc_class
= {
774 .devnode
= rc_devnode
,
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.
782 static const struct {
785 const char *module_name
;
787 { RC_BIT_NONE
, "none", NULL
},
788 { RC_BIT_OTHER
, "other", NULL
},
789 { RC_BIT_UNKNOWN
, "unknown", NULL
},
791 RC_BIT_RC5X
, "rc-5", "ir-rc5-decoder" },
792 { RC_BIT_NEC
, "nec", "ir-nec-decoder" },
797 RC_BIT_RC6_MCE
, "rc-6", "ir-rc6-decoder" },
798 { RC_BIT_JVC
, "jvc", "ir-jvc-decoder" },
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" },
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.
815 struct rc_filter_attribute
{
816 struct device_attribute attr
;
817 enum rc_filter_type type
;
820 #define to_rc_filter_attr(a) container_of(a, struct rc_filter_attribute, attr)
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), \
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), \
834 static bool lirc_is_present(void)
836 #if defined(CONFIG_LIRC_MODULE)
839 mutex_lock(&module_mutex
);
840 lirc
= find_module("lirc_dev");
841 mutex_unlock(&module_mutex
);
843 return lirc
? true : false;
844 #elif defined(CONFIG_LIRC)
852 * show_protocols() - shows the current/wakeup IR protocol(s)
853 * @device: the device descriptor
854 * @mattr: the device attribute struct
855 * @buf: a pointer to the output buffer
857 * This routine is a callback routine for input read the IR protocol type(s).
858 * it is trigged by reading /sys/class/rc/rc?/[wakeup_]protocols.
859 * It returns the protocol names of supported protocols.
860 * Enabled protocols are printed in brackets.
862 * dev->lock is taken to guard against races between device
863 * registration, store_protocols and show_protocols.
865 static ssize_t
show_protocols(struct device
*device
,
866 struct device_attribute
*mattr
, char *buf
)
868 struct rc_dev
*dev
= to_rc_dev(device
);
869 struct rc_filter_attribute
*fattr
= to_rc_filter_attr(mattr
);
870 u64 allowed
, enabled
;
874 /* Device is being removed */
878 if (!atomic_read(&dev
->initialized
))
881 mutex_lock(&dev
->lock
);
883 if (fattr
->type
== RC_FILTER_NORMAL
) {
884 enabled
= dev
->enabled_protocols
;
885 allowed
= dev
->allowed_protocols
;
886 if (dev
->raw
&& !allowed
)
887 allowed
= ir_raw_get_allowed_protocols();
889 enabled
= dev
->enabled_wakeup_protocols
;
890 allowed
= dev
->allowed_wakeup_protocols
;
893 mutex_unlock(&dev
->lock
);
895 IR_dprintk(1, "%s: allowed - 0x%llx, enabled - 0x%llx\n",
896 __func__
, (long long)allowed
, (long long)enabled
);
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
);
904 if (allowed
& proto_names
[i
].type
)
905 allowed
&= ~proto_names
[i
].type
;
908 if (dev
->driver_type
== RC_DRIVER_IR_RAW
&& lirc_is_present())
909 tmp
+= sprintf(tmp
, "[lirc] ");
915 return tmp
+ 1 - buf
;
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
923 * Writing "+proto" will add a protocol to the protocol mask.
924 * Writing "-proto" will remove a protocol from protocol mask.
925 * Writing "proto" will enable only "proto".
926 * Writing "none" will disable all protocols.
927 * Returns the number of changes performed or a negative error code.
929 static int parse_protocol_change(u64
*protocols
, const char *buf
)
933 bool enable
, disable
;
937 while ((tmp
= strsep((char **)&buf
, " \n")) != NULL
) {
945 } else if (*tmp
== '-') {
954 for (i
= 0; i
< ARRAY_SIZE(proto_names
); i
++) {
955 if (!strcasecmp(tmp
, proto_names
[i
].name
)) {
956 mask
= proto_names
[i
].type
;
961 if (i
== ARRAY_SIZE(proto_names
)) {
962 if (!strcasecmp(tmp
, "lirc"))
965 IR_dprintk(1, "Unknown protocol: '%s'\n", tmp
);
981 IR_dprintk(1, "Protocol not specified\n");
988 static void ir_raw_load_modules(u64
*protocols
)
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
))
999 available
= ir_raw_get_allowed_protocols();
1000 if (!(*protocols
& proto_names
[i
].type
& ~available
))
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
;
1010 ret
= request_module("%s", proto_names
[i
].module_name
);
1012 pr_err("Couldn't load IR protocol module %s\n",
1013 proto_names
[i
].module_name
);
1014 *protocols
&= ~proto_names
[i
].type
;
1018 available
= ir_raw_get_allowed_protocols();
1019 if (!(*protocols
& proto_names
[i
].type
& ~available
))
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
;
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
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.
1042 * dev->lock is taken to guard against races between device
1043 * registration, store_protocols and show_protocols.
1045 static ssize_t
store_protocols(struct device
*device
,
1046 struct device_attribute
*mattr
,
1047 const char *buf
, size_t len
)
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
;
1058 /* Device is being removed */
1062 if (!atomic_read(&dev
->initialized
))
1063 return -ERESTARTSYS
;
1065 if (fattr
->type
== RC_FILTER_NORMAL
) {
1066 IR_dprintk(1, "Normal protocol change requested\n");
1067 current_protocols
= &dev
->enabled_protocols
;
1068 change_protocol
= dev
->change_protocol
;
1069 filter
= &dev
->scancode_filter
;
1070 set_filter
= dev
->s_filter
;
1072 IR_dprintk(1, "Wakeup protocol change requested\n");
1073 current_protocols
= &dev
->enabled_wakeup_protocols
;
1074 change_protocol
= dev
->change_wakeup_protocol
;
1075 filter
= &dev
->scancode_wakeup_filter
;
1076 set_filter
= dev
->s_wakeup_filter
;
1079 if (!change_protocol
) {
1080 IR_dprintk(1, "Protocol switching not supported\n");
1084 mutex_lock(&dev
->lock
);
1086 old_protocols
= *current_protocols
;
1087 new_protocols
= old_protocols
;
1088 rc
= parse_protocol_change(&new_protocols
, buf
);
1092 rc
= change_protocol(dev
, &new_protocols
);
1094 IR_dprintk(1, "Error setting protocols to 0x%llx\n",
1095 (long long)new_protocols
);
1099 if (dev
->driver_type
== RC_DRIVER_IR_RAW
)
1100 ir_raw_load_modules(&new_protocols
);
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
);
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).
1112 * Try setting the same filter with the new protocol (if any).
1113 * Fall back to clearing the filter.
1115 if (set_filter
&& filter
->mask
) {
1117 rc
= set_filter(dev
, filter
);
1124 set_filter(dev
, filter
);
1131 mutex_unlock(&dev
->lock
);
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
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.
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.
1149 * dev->lock is taken to guard against races between device registration,
1150 * store_filter and show_filter.
1152 static ssize_t
show_filter(struct device
*device
,
1153 struct device_attribute
*attr
,
1156 struct rc_dev
*dev
= to_rc_dev(device
);
1157 struct rc_filter_attribute
*fattr
= to_rc_filter_attr(attr
);
1158 struct rc_scancode_filter
*filter
;
1161 /* Device is being removed */
1165 if (!atomic_read(&dev
->initialized
))
1166 return -ERESTARTSYS
;
1168 mutex_lock(&dev
->lock
);
1170 if (fattr
->type
== RC_FILTER_NORMAL
)
1171 filter
= &dev
->scancode_filter
;
1173 filter
= &dev
->scancode_wakeup_filter
;
1179 mutex_unlock(&dev
->lock
);
1181 return sprintf(buf
, "%#x\n", val
);
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
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
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.
1200 * dev->lock is taken to guard against races between device registration,
1201 * store_filter and show_filter.
1203 static ssize_t
store_filter(struct device
*device
,
1204 struct device_attribute
*attr
,
1205 const char *buf
, size_t len
)
1207 struct rc_dev
*dev
= to_rc_dev(device
);
1208 struct rc_filter_attribute
*fattr
= to_rc_filter_attr(attr
);
1209 struct rc_scancode_filter new_filter
, *filter
;
1212 int (*set_filter
)(struct rc_dev
*dev
, struct rc_scancode_filter
*filter
);
1213 u64
*enabled_protocols
;
1215 /* Device is being removed */
1219 if (!atomic_read(&dev
->initialized
))
1220 return -ERESTARTSYS
;
1222 ret
= kstrtoul(buf
, 0, &val
);
1226 if (fattr
->type
== RC_FILTER_NORMAL
) {
1227 set_filter
= dev
->s_filter
;
1228 enabled_protocols
= &dev
->enabled_protocols
;
1229 filter
= &dev
->scancode_filter
;
1231 set_filter
= dev
->s_wakeup_filter
;
1232 enabled_protocols
= &dev
->enabled_wakeup_protocols
;
1233 filter
= &dev
->scancode_wakeup_filter
;
1239 mutex_lock(&dev
->lock
);
1241 new_filter
= *filter
;
1243 new_filter
.mask
= val
;
1245 new_filter
.data
= val
;
1247 if (!*enabled_protocols
&& val
) {
1248 /* refuse to set a filter unless a protocol is enabled */
1253 ret
= set_filter(dev
, &new_filter
);
1257 *filter
= new_filter
;
1260 mutex_unlock(&dev
->lock
);
1261 return (ret
< 0) ? ret
: len
;
1264 static void rc_dev_release(struct device
*device
)
1266 struct rc_dev
*dev
= to_rc_dev(device
);
1271 #define ADD_HOTPLUG_VAR(fmt, val...) \
1273 int err = add_uevent_var(env, fmt, val); \
1278 static int rc_dev_uevent(struct device
*device
, struct kobj_uevent_env
*env
)
1280 struct rc_dev
*dev
= to_rc_dev(device
);
1282 if (dev
->rc_map
.name
)
1283 ADD_HOTPLUG_VAR("NAME=%s", dev
->rc_map
.name
);
1284 if (dev
->driver_name
)
1285 ADD_HOTPLUG_VAR("DRV_NAME=%s", dev
->driver_name
);
1291 * Static device attribute struct with the sysfs attributes for IR's
1293 static RC_PROTO_ATTR(protocols
, S_IRUGO
| S_IWUSR
,
1294 show_protocols
, store_protocols
, RC_FILTER_NORMAL
);
1295 static RC_PROTO_ATTR(wakeup_protocols
, S_IRUGO
| S_IWUSR
,
1296 show_protocols
, store_protocols
, RC_FILTER_WAKEUP
);
1297 static RC_FILTER_ATTR(filter
, S_IRUGO
|S_IWUSR
,
1298 show_filter
, store_filter
, RC_FILTER_NORMAL
, false);
1299 static RC_FILTER_ATTR(filter_mask
, S_IRUGO
|S_IWUSR
,
1300 show_filter
, store_filter
, RC_FILTER_NORMAL
, true);
1301 static RC_FILTER_ATTR(wakeup_filter
, S_IRUGO
|S_IWUSR
,
1302 show_filter
, store_filter
, RC_FILTER_WAKEUP
, false);
1303 static RC_FILTER_ATTR(wakeup_filter_mask
, S_IRUGO
|S_IWUSR
,
1304 show_filter
, store_filter
, RC_FILTER_WAKEUP
, true);
1306 static struct attribute
*rc_dev_protocol_attrs
[] = {
1307 &dev_attr_protocols
.attr
.attr
,
1311 static struct attribute_group rc_dev_protocol_attr_grp
= {
1312 .attrs
= rc_dev_protocol_attrs
,
1315 static struct attribute
*rc_dev_wakeup_protocol_attrs
[] = {
1316 &dev_attr_wakeup_protocols
.attr
.attr
,
1320 static struct attribute_group rc_dev_wakeup_protocol_attr_grp
= {
1321 .attrs
= rc_dev_wakeup_protocol_attrs
,
1324 static struct attribute
*rc_dev_filter_attrs
[] = {
1325 &dev_attr_filter
.attr
.attr
,
1326 &dev_attr_filter_mask
.attr
.attr
,
1330 static struct attribute_group rc_dev_filter_attr_grp
= {
1331 .attrs
= rc_dev_filter_attrs
,
1334 static struct attribute
*rc_dev_wakeup_filter_attrs
[] = {
1335 &dev_attr_wakeup_filter
.attr
.attr
,
1336 &dev_attr_wakeup_filter_mask
.attr
.attr
,
1340 static struct attribute_group rc_dev_wakeup_filter_attr_grp
= {
1341 .attrs
= rc_dev_wakeup_filter_attrs
,
1344 static struct device_type rc_dev_type
= {
1345 .release
= rc_dev_release
,
1346 .uevent
= rc_dev_uevent
,
1349 struct rc_dev
*rc_allocate_device(void)
1353 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1357 dev
->input_dev
= input_allocate_device();
1358 if (!dev
->input_dev
) {
1363 dev
->input_dev
->getkeycode
= ir_getkeycode
;
1364 dev
->input_dev
->setkeycode
= ir_setkeycode
;
1365 input_set_drvdata(dev
->input_dev
, dev
);
1367 spin_lock_init(&dev
->rc_map
.lock
);
1368 spin_lock_init(&dev
->keylock
);
1369 mutex_init(&dev
->lock
);
1370 setup_timer(&dev
->timer_keyup
, ir_timer_keyup
, (unsigned long)dev
);
1372 dev
->dev
.type
= &rc_dev_type
;
1373 dev
->dev
.class = &rc_class
;
1374 device_initialize(&dev
->dev
);
1376 __module_get(THIS_MODULE
);
1379 EXPORT_SYMBOL_GPL(rc_allocate_device
);
1381 void rc_free_device(struct rc_dev
*dev
)
1386 input_free_device(dev
->input_dev
);
1388 put_device(&dev
->dev
);
1390 /* kfree(dev) will be called by the callback function
1393 module_put(THIS_MODULE
);
1395 EXPORT_SYMBOL_GPL(rc_free_device
);
1397 int rc_register_device(struct rc_dev
*dev
)
1399 static bool raw_init
= false; /* raw decoders loaded? */
1400 struct rc_map
*rc_map
;
1406 if (!dev
|| !dev
->map_name
)
1409 rc_map
= rc_map_get(dev
->map_name
);
1411 rc_map
= rc_map_get(RC_MAP_EMPTY
);
1412 if (!rc_map
|| !rc_map
->scan
|| rc_map
->size
== 0)
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
);
1420 dev
->input_dev
->open
= ir_open
;
1422 dev
->input_dev
->close
= ir_close
;
1424 minor
= ida_simple_get(&rc_ida
, 0, RC_DEV_MAX
, GFP_KERNEL
);
1429 dev_set_name(&dev
->dev
, "rc%u", dev
->minor
);
1430 dev_set_drvdata(&dev
->dev
, dev
);
1431 atomic_set(&dev
->initialized
, 0);
1433 dev
->dev
.groups
= dev
->sysfs_groups
;
1434 dev
->sysfs_groups
[attr
++] = &rc_dev_protocol_attr_grp
;
1436 dev
->sysfs_groups
[attr
++] = &rc_dev_filter_attr_grp
;
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
;
1443 rc
= device_add(&dev
->dev
);
1447 rc
= ir_setkeytable(dev
, rc_map
);
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
;
1457 * Default delay of 250ms is too short for some protocols, especially
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().
1462 dev
->input_dev
->rep
[REP_DELAY
] = 500;
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
1469 dev
->input_dev
->rep
[REP_PERIOD
] = 125;
1471 /* rc_open will be called here */
1472 rc
= input_register_device(dev
->input_dev
);
1476 path
= kobject_get_path(&dev
->dev
.kobj
, GFP_KERNEL
);
1477 dev_info(&dev
->dev
, "%s as %s\n",
1478 dev
->input_name
?: "Unspecified device", path
?: "N/A");
1481 if (dev
->driver_type
== RC_DRIVER_IR_RAW
) {
1483 request_module_nowait("ir-lirc-codec");
1486 rc
= ir_raw_event_register(dev
);
1491 if (dev
->change_protocol
) {
1492 u64 rc_type
= (1ll << rc_map
->rc_type
);
1493 rc
= dev
->change_protocol(dev
, &rc_type
);
1496 dev
->enabled_protocols
= rc_type
;
1499 /* Allow the RC sysfs nodes to be accessible */
1500 atomic_set(&dev
->initialized
, 1);
1502 IR_dprintk(1, "Registered rc%u (driver: %s, remote: %s, mode %s)\n",
1504 dev
->driver_name
? dev
->driver_name
: "unknown",
1505 rc_map
->name
? rc_map
->name
: "unknown",
1506 dev
->driver_type
== RC_DRIVER_IR_RAW
? "raw" : "cooked");
1511 if (dev
->driver_type
== RC_DRIVER_IR_RAW
)
1512 ir_raw_event_unregister(dev
);
1514 input_unregister_device(dev
->input_dev
);
1515 dev
->input_dev
= NULL
;
1517 ir_free_table(&dev
->rc_map
);
1519 device_del(&dev
->dev
);
1521 ida_simple_remove(&rc_ida
, minor
);
1524 EXPORT_SYMBOL_GPL(rc_register_device
);
1526 void rc_unregister_device(struct rc_dev
*dev
)
1531 del_timer_sync(&dev
->timer_keyup
);
1533 if (dev
->driver_type
== RC_DRIVER_IR_RAW
)
1534 ir_raw_event_unregister(dev
);
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");
1540 input_unregister_device(dev
->input_dev
);
1541 dev
->input_dev
= NULL
;
1543 device_del(&dev
->dev
);
1545 ida_simple_remove(&rc_ida
, dev
->minor
);
1547 rc_free_device(dev
);
1550 EXPORT_SYMBOL_GPL(rc_unregister_device
);
1553 * Init/exit code for the module. Basically, creates/removes /sys/class/rc
1556 static int __init
rc_core_init(void)
1558 int rc
= class_register(&rc_class
);
1560 printk(KERN_ERR
"rc_core: unable to register rc class\n");
1564 led_trigger_register_simple("rc-feedback", &led_feedback
);
1565 rc_map_register(&empty_map
);
1570 static void __exit
rc_core_exit(void)
1572 class_unregister(&rc_class
);
1573 led_trigger_unregister_simple(led_feedback
);
1574 rc_map_unregister(&empty_map
);
1577 subsys_initcall(rc_core_init
);
1578 module_exit(rc_core_exit
);
1580 int rc_core_debug
; /* ir_debug level (0,1,2) */
1581 EXPORT_SYMBOL_GPL(rc_core_debug
);
1582 module_param_named(debug
, rc_core_debug
, int, 0644);
1584 MODULE_AUTHOR("Mauro Carvalho Chehab");
1585 MODULE_LICENSE("GPL");