3 * keyboard input driver for i2c IR remote controls
5 * Copyright (c) 2000-2003 Gerd Knorr <kraxel@bytesex.org>
6 * modified for PixelView (BT878P+W/FM) by
7 * Michal Kochanowicz <mkochano@pld.org.pl>
8 * Christoph Bartelmus <lirc@bartelmus.de>
9 * modified for KNC ONE TV Station/Anubis Typhoon TView Tuner by
10 * Ulrich Mueller <ulrich.mueller42@web.de>
11 * modified for em2820 based USB TV tuners by
12 * Markus Rechberger <mrechberger@gmail.com>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/init.h>
33 #include <linux/kernel.h>
34 #include <linux/string.h>
35 #include <linux/timer.h>
36 #include <linux/delay.h>
37 #include <linux/errno.h>
38 #include <linux/slab.h>
39 #include <linux/i2c.h>
40 #include <linux/workqueue.h>
41 #include <asm/semaphore.h>
43 #include <media/ir-common.h>
44 #include <media/ir-kbd-i2c.h>
46 /* ----------------------------------------------------------------------- */
47 /* insmod parameters */
50 module_param(debug
, int, 0644); /* debug level (0,1,2) */
52 static int hauppauge
= 0;
53 module_param(hauppauge
, int, 0644); /* Choose Hauppauge remote */
54 MODULE_PARM_DESC(hauppauge
, "Specify Hauppauge remote: 0=black, 1=grey (defaults to 0)");
57 #define DEVNAME "ir-kbd-i2c"
58 #define dprintk(level, fmt, arg...) if (debug >= level) \
59 printk(KERN_DEBUG DEVNAME ": " fmt , ## arg)
61 /* ----------------------------------------------------------------------- */
63 static int get_key_haup(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
66 int start
, range
, toggle
, dev
, code
;
69 if (3 != i2c_master_recv(&ir
->c
,buf
,3))
72 /* split rc5 data block ... */
73 start
= (buf
[0] >> 7) & 1;
74 range
= (buf
[0] >> 6) & 1;
75 toggle
= (buf
[0] >> 5) & 1;
77 code
= (buf
[1] >> 2) & 0x3f;
79 /* rc5 has two start bits
80 * the first bit must be one
81 * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
90 dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
91 start
, range
, toggle
, dev
, code
);
95 *ir_raw
= (start
<< 12) | (toggle
<< 11) | (dev
<< 6) | code
;
99 static int get_key_pixelview(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
104 if (1 != i2c_master_recv(&ir
->c
,&b
,1)) {
105 dprintk(1,"read error\n");
113 static int get_key_pv951(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
118 if (1 != i2c_master_recv(&ir
->c
,&b
,1)) {
119 dprintk(1,"read error\n");
126 dprintk(2,"key %02x\n", b
);
133 static int get_key_knc1(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
138 if (1 != i2c_master_recv(&ir
->c
,&b
,1)) {
139 dprintk(1,"read error\n");
143 /* it seems that 0xFE indicates that a button is still hold
144 down, while 0xff indicates that no button is hold
145 down. 0xfe sequences are sometimes interrupted by 0xFF */
147 dprintk(2,"key %02x\n", b
);
161 /* Common (grey or coloured) pinnacle PCTV remote handling
164 static int get_key_pinnacle(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
,
165 int parity_offset
, int marker
, int code_modulo
)
168 unsigned int start
= 0,parity
= 0,code
= 0;
171 if (4 != i2c_master_recv(&ir
->c
,b
,4)) {
172 dprintk(2,"read error\n");
176 for (start
= 0; start
< ARRAY_SIZE(b
); start
++) {
177 if (b
[start
] == marker
) {
178 code
=b
[(start
+parity_offset
+1)%4];
179 parity
=b
[(start
+parity_offset
)%4];
188 if (ir
->old
== parity
)
193 /* drop special codes when a key is held down a long time for the grey controller
194 In this case, the second bit of the code is asserted */
195 if (marker
== 0xfe && (code
& 0x40))
203 dprintk(1,"Pinnacle PCTV key %02x\n", code
);
208 /* The grey pinnacle PCTV remote
210 * There are one issue with this remote:
211 * - I2c packet does not change when the same key is pressed quickly. The workaround
212 * is to hold down each key for about half a second, so that another code is generated
213 * in the i2c packet, and the function can distinguish key presses.
215 * Sylvain Pasche <sylvain.pasche@gmail.com>
217 int get_key_pinnacle_grey(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
220 return get_key_pinnacle(ir
, ir_key
, ir_raw
, 1, 0xfe, 0xff);
223 EXPORT_SYMBOL_GPL(get_key_pinnacle_grey
);
226 /* The new pinnacle PCTV remote (with the colored buttons)
228 * Ricardo Cerqueira <v4l@cerqueira.org>
230 int get_key_pinnacle_color(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
232 /* code_modulo parameter (0x88) is used to reduce code value to fit inside IR_KEYTAB_SIZE
234 * this is the only value that results in 42 unique
238 return get_key_pinnacle(ir
, ir_key
, ir_raw
, 2, 0x80, 0x88);
241 EXPORT_SYMBOL_GPL(get_key_pinnacle_color
);
243 /* ----------------------------------------------------------------------- */
245 static void ir_key_poll(struct IR_i2c
*ir
)
247 static u32 ir_key
, ir_raw
;
250 dprintk(2,"ir_poll_key\n");
251 rc
= ir
->get_key(ir
, &ir_key
, &ir_raw
);
253 dprintk(2,"error\n");
258 ir_input_nokey(ir
->input
, &ir
->ir
);
260 ir_input_keydown(ir
->input
, &ir
->ir
, ir_key
, ir_raw
);
264 static void ir_timer(unsigned long data
)
266 struct IR_i2c
*ir
= (struct IR_i2c
*)data
;
267 schedule_work(&ir
->work
);
270 static void ir_work(struct work_struct
*work
)
272 struct IR_i2c
*ir
= container_of(work
, struct IR_i2c
, work
);
274 mod_timer(&ir
->timer
, jiffies
+HZ
/10);
277 /* ----------------------------------------------------------------------- */
279 static int ir_attach(struct i2c_adapter
*adap
, int addr
,
280 unsigned short flags
, int kind
);
281 static int ir_detach(struct i2c_client
*client
);
282 static int ir_probe(struct i2c_adapter
*adap
);
284 static struct i2c_driver driver
= {
286 .name
= "ir-kbd-i2c",
288 .id
= I2C_DRIVERID_INFRARED
,
289 .attach_adapter
= ir_probe
,
290 .detach_client
= ir_detach
,
293 static struct i2c_client client_template
=
299 static int ir_attach(struct i2c_adapter
*adap
, int addr
,
300 unsigned short flags
, int kind
)
302 IR_KEYTAB_TYPE
*ir_codes
= NULL
;
306 struct input_dev
*input_dev
;
309 ir
= kzalloc(sizeof(struct IR_i2c
),GFP_KERNEL
);
310 input_dev
= input_allocate_device();
311 if (!ir
|| !input_dev
) {
316 ir
->c
= client_template
;
317 ir
->input
= input_dev
;
319 ir
->c
.adapter
= adap
;
322 i2c_set_clientdata(&ir
->c
, ir
);
327 ir
->get_key
= get_key_pixelview
;
328 ir_type
= IR_TYPE_OTHER
;
329 ir_codes
= ir_codes_empty
;
333 ir
->get_key
= get_key_pv951
;
334 ir_type
= IR_TYPE_OTHER
;
335 ir_codes
= ir_codes_pv951
;
340 ir
->get_key
= get_key_haup
;
341 ir_type
= IR_TYPE_RC5
;
342 if (hauppauge
== 1) {
343 ir_codes
= ir_codes_hauppauge_new
;
345 ir_codes
= ir_codes_rc5_tv
;
350 ir
->get_key
= get_key_knc1
;
351 ir_type
= IR_TYPE_OTHER
;
352 ir_codes
= ir_codes_empty
;
357 /* Handled by saa7134-input */
358 name
= "SAA713x remote";
359 ir_type
= IR_TYPE_OTHER
;
362 /* shouldn't happen */
363 printk(DEVNAME
": Huh? unknown i2c address (0x%02x)?\n", addr
);
369 snprintf(ir
->c
.name
, sizeof(ir
->c
.name
), "i2c IR (%s)", name
);
370 ir
->ir_codes
= ir_codes
;
372 /* register i2c device
373 * At device register, IR codes may be changed to be
376 err
= i2c_attach_client(&ir
->c
);
380 /* If IR not supported or disabled, unregisters driver */
381 if (ir
->get_key
== NULL
) {
386 /* Phys addr can only be set after attaching (for ir->c.dev.bus_id) */
387 snprintf(ir
->phys
, sizeof(ir
->phys
), "%s/%s/ir0",
388 ir
->c
.adapter
->dev
.bus_id
,
391 /* init + register input device */
392 ir_input_init(input_dev
, &ir
->ir
, ir_type
, ir
->ir_codes
);
393 input_dev
->id
.bustype
= BUS_I2C
;
394 input_dev
->name
= ir
->c
.name
;
395 input_dev
->phys
= ir
->phys
;
397 err
= input_register_device(ir
->input
);
401 printk(DEVNAME
": %s detected at %s [%s]\n",
402 ir
->input
->name
, ir
->input
->phys
, adap
->name
);
404 /* start polling via eventd */
405 INIT_WORK(&ir
->work
, ir_work
);
406 init_timer(&ir
->timer
);
407 ir
->timer
.function
= ir_timer
;
408 ir
->timer
.data
= (unsigned long)ir
;
409 schedule_work(&ir
->work
);
414 i2c_detach_client(&ir
->c
);
416 input_free_device(input_dev
);
421 static int ir_detach(struct i2c_client
*client
)
423 struct IR_i2c
*ir
= i2c_get_clientdata(client
);
425 /* kill outstanding polls */
426 del_timer_sync(&ir
->timer
);
427 flush_scheduled_work();
429 /* unregister devices */
430 input_unregister_device(ir
->input
);
431 i2c_detach_client(&ir
->c
);
438 static int ir_probe(struct i2c_adapter
*adap
)
441 /* The external IR receiver is at i2c address 0x34 (0x35 for
442 reads). Future Hauppauge cards will have an internal
443 receiver at 0x30 (0x31 for reads). In theory, both can be
444 fitted, and Hauppauge suggest an external overrides an
447 That's why we probe 0x1a (~0x34) first. CB
450 static const int probe_bttv
[] = { 0x1a, 0x18, 0x4b, 0x64, 0x30, -1};
451 static const int probe_saa7134
[] = { 0x7a, 0x47, 0x71, -1 };
452 static const int probe_em28XX
[] = { 0x30, 0x47, -1 };
453 const int *probe
= NULL
;
462 case I2C_HW_B_CX2341X
:
466 probe
= probe_saa7134
;
468 case I2C_HW_B_EM28XX
:
469 probe
= probe_em28XX
;
475 memset(&c
,0,sizeof(c
));
477 for (i
= 0; -1 != probe
[i
]; i
++) {
479 rc
= i2c_master_recv(&c
,&buf
,0);
480 dprintk(1,"probe 0x%02x @ %s: %s\n",
481 probe
[i
], adap
->name
,
482 (0 == rc
) ? "yes" : "no");
484 ir_attach(adap
,probe
[i
],0,0);
491 /* ----------------------------------------------------------------------- */
493 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
494 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
495 MODULE_LICENSE("GPL");
497 static int __init
ir_init(void)
499 return i2c_add_driver(&driver
);
502 static void __exit
ir_fini(void)
504 i2c_del_driver(&driver
);
507 module_init(ir_init
);
508 module_exit(ir_fini
);
511 * Overrides for Emacs so that we follow Linus's tabbing style.
512 * ---------------------------------------------------------------------------