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>
13 * modified for DViCO Fusion HDTV 5 RT GOLD by
14 * Chaogui Zhang <czhang1974@gmail.com>
15 * modified for MSI TV@nywhere Plus by
16 * Henry Wong <henry@stuffedcow.net>
17 * Mark Schultz <n9xmj@yahoo.com>
18 * Brian Rogers <brian_rogers@comcast.net>
19 * modified for AVerMedia Cardbus by
20 * Oldrich Jedlicka <oldium.pro@seznam.cz>
22 * This program is free software; you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation; either version 2 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program; if not, write to the Free Software
34 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/kernel.h>
41 #include <linux/string.h>
42 #include <linux/timer.h>
43 #include <linux/delay.h>
44 #include <linux/errno.h>
45 #include <linux/slab.h>
46 #include <linux/i2c.h>
47 #include <linux/workqueue.h>
49 #include <media/rc-core.h>
50 #include <media/ir-kbd-i2c.h>
52 /* ----------------------------------------------------------------------- */
53 /* insmod parameters */
56 module_param(debug, int, 0644); /* debug level (0,1,2) */
59 #define MODULE_NAME "ir-kbd-i2c"
60 #define dprintk(level, fmt, arg...) if (debug >= level) \
61 printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg)
63 /* ----------------------------------------------------------------------- */
65 static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
69 int start, range, toggle, dev, code, ircode;
72 if (size != i2c_master_recv(ir->c, buf, size))
75 /* split rc5 data block ... */
76 start = (buf[offset] >> 7) & 1;
77 range = (buf[offset] >> 6) & 1;
78 toggle = (buf[offset] >> 5) & 1;
79 dev = buf[offset] & 0x1f;
80 code = (buf[offset+1] >> 2) & 0x3f;
82 /* rc5 has two start bits
83 * the first bit must be one
84 * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
90 * Hauppauge remotes (black/silver) always use
91 * specific device ids. If we do not filter the
92 * device ids then messages destined for devices
93 * such as TVs (id=0) will get through causing
96 * We also filter out invalid key presses which
97 * produce annoying debug log entries.
99 ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
100 if ((ircode & 0x1fff)==0x1fff)
101 /* invalid key press */
107 dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
108 start, range, toggle, dev, code);
111 *ir_key = (dev << 8) | code;
116 static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
118 return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
121 static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
124 unsigned char buf[1] = { 0 };
127 * This is the same apparent "are you ready?" poll command observed
128 * watching Windows driver traffic and implemented in lirc_zilog. With
129 * this added, we get far saner remote behavior with z8 chips on usb
130 * connected devices, even with the default polling interval of 100ms.
132 ret = i2c_master_send(ir->c, buf, 1);
134 return (ret < 0) ? ret : -EINVAL;
136 return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
139 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
144 if (1 != i2c_master_recv(ir->c, &b, 1)) {
145 dprintk(1,"read error\n");
153 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
155 unsigned char buf[4];
158 if (4 != i2c_master_recv(ir->c, buf, 4)) {
159 dprintk(1,"read error\n");
163 if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
164 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
165 buf[0], buf[1], buf[2], buf[3]);
167 /* no key pressed or signal from other ir remote */
168 if(buf[0] != 0x1 || buf[1] != 0xfe)
172 *ir_raw = (buf[2] << 8) | buf[3];
177 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
182 if (1 != i2c_master_recv(ir->c, &b, 1)) {
183 dprintk(1,"read error\n");
187 /* it seems that 0xFE indicates that a button is still hold
188 down, while 0xff indicates that no button is hold
189 down. 0xfe sequences are sometimes interrupted by 0xFF */
191 dprintk(2,"key %02x\n", b);
205 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
206 u32 *ir_key, u32 *ir_raw)
208 unsigned char subaddr, key, keygroup;
209 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
210 .buf = &subaddr, .len = 1},
211 { .addr = ir->c->addr, .flags = I2C_M_RD,
212 .buf = &key, .len = 1} };
214 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
215 dprintk(1, "read error\n");
223 msg[1].buf = &keygroup;
224 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
225 dprintk(1, "read error\n");
229 if (keygroup == 0xff)
232 dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
233 if (keygroup < 2 || keygroup > 3) {
235 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
238 key |= (keygroup & 1) << 6;
245 /* ----------------------------------------------------------------------- */
247 static void ir_key_poll(struct IR_i2c *ir)
249 static u32 ir_key, ir_raw;
252 dprintk(3, "%s\n", __func__);
253 rc = ir->get_key(ir, &ir_key, &ir_raw);
255 dprintk(2,"error\n");
260 dprintk(1, "%s: keycode = 0x%04x\n", __func__, ir_key);
261 rc_keydown(ir->rc, ir_key, 0);
265 static void ir_work(struct work_struct *work)
267 struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
270 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
273 /* ----------------------------------------------------------------------- */
275 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
277 char *ir_codes = NULL;
278 const char *name = NULL;
279 u64 rc_type = RC_TYPE_UNKNOWN;
281 struct rc_dev *rc = NULL;
282 struct i2c_adapter *adap = client->adapter;
283 unsigned short addr = client->addr;
286 ir = kzalloc(sizeof(struct IR_i2c), GFP_KERNEL);
291 ir->polling_interval = DEFAULT_POLLING_INTERVAL;
292 i2c_set_clientdata(client, ir);
297 ir->get_key = get_key_pixelview;
298 rc_type = RC_TYPE_OTHER;
299 ir_codes = RC_MAP_EMPTY;
305 ir->get_key = get_key_haup;
306 rc_type = RC_TYPE_RC5;
307 ir_codes = RC_MAP_HAUPPAUGE;
311 ir->get_key = get_key_knc1;
312 rc_type = RC_TYPE_OTHER;
313 ir_codes = RC_MAP_EMPTY;
317 ir->get_key = get_key_fusionhdtv;
318 rc_type = RC_TYPE_RC5;
319 ir_codes = RC_MAP_FUSIONHDTV_MCE;
322 name = "AVerMedia Cardbus remote";
323 ir->get_key = get_key_avermedia_cardbus;
324 rc_type = RC_TYPE_OTHER;
325 ir_codes = RC_MAP_AVERMEDIA_CARDBUS;
328 name = "Hauppauge/Zilog Z8";
329 ir->get_key = get_key_haup_xvr;
330 rc_type = RC_TYPE_RC5;
331 ir_codes = RC_MAP_HAUPPAUGE;
335 /* Let the caller override settings */
336 if (client->dev.platform_data) {
337 const struct IR_i2c_init_data *init_data =
338 client->dev.platform_data;
340 ir_codes = init_data->ir_codes;
341 rc = init_data->rc_dev;
343 name = init_data->name;
345 rc_type = init_data->type;
347 if (init_data->polling_interval)
348 ir->polling_interval = init_data->polling_interval;
350 switch (init_data->internal_get_key_func) {
351 case IR_KBD_GET_KEY_CUSTOM:
352 /* The bridge driver provided us its own function */
353 ir->get_key = init_data->get_key;
355 case IR_KBD_GET_KEY_PIXELVIEW:
356 ir->get_key = get_key_pixelview;
358 case IR_KBD_GET_KEY_HAUP:
359 ir->get_key = get_key_haup;
361 case IR_KBD_GET_KEY_KNC1:
362 ir->get_key = get_key_knc1;
364 case IR_KBD_GET_KEY_FUSIONHDTV:
365 ir->get_key = get_key_fusionhdtv;
367 case IR_KBD_GET_KEY_HAUP_XVR:
368 ir->get_key = get_key_haup_xvr;
370 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
371 ir->get_key = get_key_avermedia_cardbus;
378 * If platform_data doesn't specify rc_dev, initilize it
381 rc = rc_allocate_device();
389 /* Make sure we are all setup before going on */
390 if (!name || !ir->get_key || !rc_type || !ir_codes) {
391 dprintk(1, ": Unsupported device at address 0x%02x\n",
398 snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
399 ir->ir_codes = ir_codes;
401 snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
402 dev_name(&adap->dev),
403 dev_name(&client->dev));
406 * Initialize input_dev fields
407 * It doesn't make sense to allow overriding them via platform_data
409 rc->input_id.bustype = BUS_I2C;
410 rc->input_phys = ir->phys;
411 rc->input_name = ir->name;
414 * Initialize the other fields of rc_dev
416 rc->map_name = ir->ir_codes;
417 rc->allowed_protos = rc_type;
418 if (!rc->driver_name)
419 rc->driver_name = MODULE_NAME;
421 err = rc_register_device(rc);
425 printk(MODULE_NAME ": %s detected at %s [%s]\n",
426 ir->name, ir->phys, adap->name);
428 /* start polling via eventd */
429 INIT_DELAYED_WORK(&ir->work, ir_work);
430 schedule_delayed_work(&ir->work, 0);
435 /* Only frees rc if it were allocated internally */
441 static int ir_remove(struct i2c_client *client)
443 struct IR_i2c *ir = i2c_get_clientdata(client);
445 /* kill outstanding polls */
446 cancel_delayed_work_sync(&ir->work);
448 /* unregister device */
449 rc_unregister_device(ir->rc);
456 static const struct i2c_device_id ir_kbd_id[] = {
457 /* Generic entry for any IR receiver */
459 /* IR device specific entries should be added here */
460 { "ir_rx_z8f0811_haup", 0 },
461 { "ir_rx_z8f0811_hdpvr", 0 },
465 static struct i2c_driver driver = {
467 .name = "ir-kbd-i2c",
471 .id_table = ir_kbd_id,
474 /* ----------------------------------------------------------------------- */
476 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
477 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
478 MODULE_LICENSE("GPL");
480 static int __init ir_init(void)
482 return i2c_add_driver(&driver);
485 static void __exit ir_fini(void)
487 i2c_del_driver(&driver);
490 module_init(ir_init);
491 module_exit(ir_fini);
494 * Overrides for Emacs so that we follow Linus's tabbing style.
495 * ---------------------------------------------------------------------------