3 * some common structs and functions to handle infrared remotes via
6 * (c) 2003 Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/string.h>
25 #include <linux/jiffies.h>
26 #include <media/ir-common.h>
28 /* -------------------------------------------------------------------------- */
30 MODULE_AUTHOR("Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]");
31 MODULE_LICENSE("GPL");
33 static int repeat = 1;
34 module_param(repeat, int, 0444);
35 MODULE_PARM_DESC(repeat,"auto-repeat for IR keys (default: on)");
37 static int debug; /* debug level (0,1,2) */
38 module_param(debug, int, 0644);
40 #define dprintk(level, fmt, arg...) if (debug >= level) \
41 printk(KERN_DEBUG fmt , ## arg)
43 /* -------------------------------------------------------------------------- */
45 static void ir_input_key_event(struct input_dev *dev, struct ir_input_state *ir)
47 if (KEY_RESERVED == ir->keycode) {
48 printk(KERN_INFO "%s: unknown key: key=0x%02x raw=0x%02x down=%d\n",
49 dev->name,ir->ir_key,ir->ir_raw,ir->keypressed);
52 dprintk(1,"%s: key event code=%d down=%d\n",
53 dev->name,ir->keycode,ir->keypressed);
54 input_report_key(dev,ir->keycode,ir->keypressed);
58 /* -------------------------------------------------------------------------- */
60 void ir_input_init(struct input_dev *dev, struct ir_input_state *ir,
61 int ir_type, struct ir_scancode_table *ir_codes)
65 ir->ir_type = ir_type;
67 memset(ir->ir_codes, 0, sizeof(ir->ir_codes));
70 * FIXME: This is a temporary workaround to use the new IR tables
71 * with the old approach. Later patches will replace this to a
76 for (i = 0; i < ir_codes->size; i++)
77 if (ir_codes->scan[i].scancode < IR_KEYTAB_SIZE)
78 ir->ir_codes[ir_codes->scan[i].scancode] = ir_codes->scan[i].keycode;
80 dev->keycode = ir->ir_codes;
81 dev->keycodesize = sizeof(IR_KEYTAB_TYPE);
82 dev->keycodemax = IR_KEYTAB_SIZE;
83 for (i = 0; i < IR_KEYTAB_SIZE; i++)
84 set_bit(ir->ir_codes[i], dev->keybit);
85 clear_bit(0, dev->keybit);
87 set_bit(EV_KEY, dev->evbit);
89 set_bit(EV_REP, dev->evbit);
91 EXPORT_SYMBOL_GPL(ir_input_init);
93 void ir_input_nokey(struct input_dev *dev, struct ir_input_state *ir)
97 ir_input_key_event(dev,ir);
100 EXPORT_SYMBOL_GPL(ir_input_nokey);
102 void ir_input_keydown(struct input_dev *dev, struct ir_input_state *ir,
103 u32 ir_key, u32 ir_raw)
105 u32 keycode = IR_KEYCODE(ir->ir_codes, ir_key);
107 if (ir->keypressed && ir->keycode != keycode) {
109 ir_input_key_event(dev,ir);
111 if (!ir->keypressed) {
114 ir->keycode = keycode;
116 ir_input_key_event(dev,ir);
119 EXPORT_SYMBOL_GPL(ir_input_keydown);
121 /* -------------------------------------------------------------------------- */
122 /* extract mask bits out of data and pack them into the result */
123 u32 ir_extract_bits(u32 data, u32 mask)
125 u32 vbit = 1, value = 0;
138 EXPORT_SYMBOL_GPL(ir_extract_bits);
140 static int inline getbit(u32 *samples, int bit)
142 return (samples[bit/32] & (1 << (31-(bit%32)))) ? 1 : 0;
145 /* sump raw samples for visual debugging ;) */
146 int ir_dump_samples(u32 *samples, int count)
150 printk(KERN_DEBUG "ir samples: ");
152 for (i = 0; i < count * 32; i++) {
153 bit = getbit(samples,i);
158 printk("%s", bit ? "#" : "_");
163 EXPORT_SYMBOL_GPL(ir_dump_samples);
165 /* decode raw samples, pulse distance coding used by NEC remotes */
166 int ir_decode_pulsedistance(u32 *samples, int count, int low, int high)
172 /* find start burst */
173 for (i = len = 0; i < count * 32; i++) {
174 bit = getbit(samples,i);
184 /* start burst to short */
188 /* find start silence */
189 for (len = 0; i < count * 32; i++) {
190 bit = getbit(samples,i);
198 /* silence to short */
205 value = 0; curBit = 1;
206 for (; i < count * 32; i++) {
207 bit = getbit(samples,i);
216 if (len > (low + high) /2)
230 EXPORT_SYMBOL_GPL(ir_decode_pulsedistance);
232 /* decode raw samples, biphase coding, used by rc5 for example */
233 int ir_decode_biphase(u32 *samples, int count, int low, int high)
235 int i,last,bit,len,flips;
238 /* find start bit (1) */
239 for (i = 0; i < 32; i++) {
240 bit = getbit(samples,i);
249 for (; i < count * 32; i++) {
255 bit = getbit(samples,i);
272 EXPORT_SYMBOL_GPL(ir_decode_biphase);
274 /* RC5 decoding stuff, moved from bttv-input.c to share it with
277 /* decode raw bit pattern to RC5 code */
278 static u32 ir_rc5_decode(unsigned int code)
280 unsigned int org_code = code;
282 unsigned int rc5 = 0;
285 for (i = 0; i < 14; ++i) {
298 dprintk(1, "ir-common: ir_rc5_decode(%x) bad code\n", org_code);
302 dprintk(1, "ir-common: code=%x, rc5=%x, start=%x, toggle=%x, address=%x, "
303 "instr=%x\n", rc5, org_code, RC5_START(rc5),
304 RC5_TOGGLE(rc5), RC5_ADDR(rc5), RC5_INSTR(rc5));
308 void ir_rc5_timer_end(unsigned long data)
310 struct card_ir *ir = (struct card_ir *)data;
312 unsigned long current_jiffies, timeout;
317 current_jiffies = jiffies;
318 do_gettimeofday(&tv);
320 /* avoid overflow with gap >1s */
321 if (tv.tv_sec - ir->base_time.tv_sec > 1) {
324 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
325 tv.tv_usec - ir->base_time.tv_usec;
328 /* signal we're ready to start a new code */
331 /* Allow some timer jitter (RC5 is ~24ms anyway so this is ok) */
333 dprintk(1, "ir-common: spurious timer_end\n");
337 if (ir->last_bit < 20) {
338 /* ignore spurious codes (caused by light/other remotes) */
339 dprintk(1, "ir-common: short code: %x\n", ir->code);
341 ir->code = (ir->code << ir->shift_by) | 1;
342 rc5 = ir_rc5_decode(ir->code);
344 /* two start bits? */
345 if (RC5_START(rc5) != ir->start) {
346 dprintk(1, "ir-common: rc5 start bits invalid: %u\n", RC5_START(rc5));
349 } else if (RC5_ADDR(rc5) == ir->addr) {
350 u32 toggle = RC5_TOGGLE(rc5);
351 u32 instr = RC5_INSTR(rc5);
353 /* Good code, decide if repeat/repress */
354 if (toggle != RC5_TOGGLE(ir->last_rc5) ||
355 instr != RC5_INSTR(ir->last_rc5)) {
356 dprintk(1, "ir-common: instruction %x, toggle %x\n", instr,
358 ir_input_nokey(ir->dev, &ir->ir);
359 ir_input_keydown(ir->dev, &ir->ir, instr,
363 /* Set/reset key-up timer */
364 timeout = current_jiffies +
365 msecs_to_jiffies(ir->rc5_key_timeout);
366 mod_timer(&ir->timer_keyup, timeout);
368 /* Save code for repeat test */
373 EXPORT_SYMBOL_GPL(ir_rc5_timer_end);
375 void ir_rc5_timer_keyup(unsigned long data)
377 struct card_ir *ir = (struct card_ir *)data;
379 dprintk(1, "ir-common: key released\n");
380 ir_input_nokey(ir->dev, &ir->ir);
382 EXPORT_SYMBOL_GPL(ir_rc5_timer_keyup);