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.
34 #include <asm/unaligned.h>
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/kernel.h>
38 #include <linux/string.h>
39 #include <linux/timer.h>
40 #include <linux/delay.h>
41 #include <linux/errno.h>
42 #include <linux/slab.h>
43 #include <linux/i2c.h>
44 #include <linux/workqueue.h>
46 #include <media/rc-core.h>
47 #include <media/i2c/ir-kbd-i2c.h>
49 /* ----------------------------------------------------------------------- */
50 /* insmod parameters */
53 module_param(debug, int, 0644); /* debug level (0,1,2) */
56 #define MODULE_NAME "ir-kbd-i2c"
57 #define dprintk(level, fmt, arg...) if (debug >= level) \
58 printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg)
60 /* ----------------------------------------------------------------------- */
62 static int get_key_haup_common(struct IR_i2c *ir, enum rc_proto *protocol,
63 u32 *scancode, u8 *ptoggle, int size)
66 int start, range, toggle, dev, code, ircode, vendor;
69 if (size != i2c_master_recv(ir->c, buf, size))
73 int offset = (size == 6) ? 3 : 0;
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:
85 * 1 = 0-63, 0 = 64 - 127
91 /* filter out invalid key presses */
92 ircode = (start << 12) | (toggle << 11) | (dev << 6) | code;
93 if ((ircode & 0x1fff) == 0x1fff)
99 dprintk(1, "ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
100 start, range, toggle, dev, code);
102 *protocol = RC_PROTO_RC5;
103 *scancode = RC_SCANCODE_RC5(dev, code);
107 } else if (size == 6 && (buf[0] & 0x40)) {
110 vendor = get_unaligned_be16(buf + 1);
112 if (vendor == 0x800f) {
113 *ptoggle = (dev & 0x80) != 0;
114 *protocol = RC_PROTO_RC6_MCE;
116 dprintk(1, "ir hauppauge (rc6-mce): t%d vendor=%d dev=%d code=%d\n",
117 *ptoggle, vendor, dev, code);
120 *protocol = RC_PROTO_RC6_6A_32;
121 dprintk(1, "ir hauppauge (rc6-6a-32): vendor=%d dev=%d code=%d\n",
125 *scancode = RC_SCANCODE_RC6_6A(vendor, dev, code);
133 static int get_key_haup(struct IR_i2c *ir, enum rc_proto *protocol,
134 u32 *scancode, u8 *toggle)
136 return get_key_haup_common(ir, protocol, scancode, toggle, 3);
139 static int get_key_haup_xvr(struct IR_i2c *ir, enum rc_proto *protocol,
140 u32 *scancode, u8 *toggle)
143 unsigned char buf[1] = { 0 };
146 * This is the same apparent "are you ready?" poll command observed
147 * watching Windows driver traffic and implemented in lirc_zilog. With
148 * this added, we get far saner remote behavior with z8 chips on usb
149 * connected devices, even with the default polling interval of 100ms.
151 ret = i2c_master_send(ir->c, buf, 1);
153 return (ret < 0) ? ret : -EINVAL;
155 return get_key_haup_common(ir, protocol, scancode, toggle, 6);
158 static int get_key_pixelview(struct IR_i2c *ir, enum rc_proto *protocol,
159 u32 *scancode, u8 *toggle)
164 if (1 != i2c_master_recv(ir->c, &b, 1)) {
165 dprintk(1,"read error\n");
169 *protocol = RC_PROTO_OTHER;
175 static int get_key_fusionhdtv(struct IR_i2c *ir, enum rc_proto *protocol,
176 u32 *scancode, u8 *toggle)
178 unsigned char buf[4];
181 if (4 != i2c_master_recv(ir->c, buf, 4)) {
182 dprintk(1,"read error\n");
186 if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
187 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
188 buf[0], buf[1], buf[2], buf[3]);
190 /* no key pressed or signal from other ir remote */
191 if(buf[0] != 0x1 || buf[1] != 0xfe)
194 *protocol = RC_PROTO_UNKNOWN;
200 static int get_key_knc1(struct IR_i2c *ir, enum rc_proto *protocol,
201 u32 *scancode, u8 *toggle)
206 if (1 != i2c_master_recv(ir->c, &b, 1)) {
207 dprintk(1,"read error\n");
211 /* it seems that 0xFE indicates that a button is still hold
212 down, while 0xff indicates that no button is hold
213 down. 0xfe sequences are sometimes interrupted by 0xFF */
215 dprintk(2,"key %02x\n", b);
224 *protocol = RC_PROTO_UNKNOWN;
230 static int get_key_avermedia_cardbus(struct IR_i2c *ir, enum rc_proto *protocol,
231 u32 *scancode, u8 *toggle)
233 unsigned char subaddr, key, keygroup;
234 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
235 .buf = &subaddr, .len = 1},
236 { .addr = ir->c->addr, .flags = I2C_M_RD,
237 .buf = &key, .len = 1} };
239 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
240 dprintk(1, "read error\n");
248 msg[1].buf = &keygroup;
249 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
250 dprintk(1, "read error\n");
254 if (keygroup == 0xff)
257 dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
258 if (keygroup < 2 || keygroup > 4) {
260 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
263 key |= (keygroup & 1) << 6;
265 *protocol = RC_PROTO_UNKNOWN;
267 if (ir->c->addr == 0x41) /* AVerMedia EM78P153 */
268 *scancode |= keygroup << 8;
273 /* ----------------------------------------------------------------------- */
275 static int ir_key_poll(struct IR_i2c *ir)
277 enum rc_proto protocol;
282 dprintk(3, "%s\n", __func__);
283 rc = ir->get_key(ir, &protocol, &scancode, &toggle);
285 dprintk(2,"error\n");
290 dprintk(1, "%s: proto = 0x%04x, scancode = 0x%08x\n",
291 __func__, protocol, scancode);
292 rc_keydown(ir->rc, protocol, scancode, toggle);
297 static void ir_work(struct work_struct *work)
300 struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
302 rc = ir_key_poll(ir);
304 rc_unregister_device(ir->rc);
309 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
312 /* ----------------------------------------------------------------------- */
314 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
316 char *ir_codes = NULL;
317 const char *name = NULL;
318 u64 rc_proto = RC_PROTO_BIT_UNKNOWN;
320 struct rc_dev *rc = NULL;
321 struct i2c_adapter *adap = client->adapter;
322 unsigned short addr = client->addr;
325 ir = devm_kzalloc(&client->dev, sizeof(*ir), GFP_KERNEL);
330 ir->polling_interval = DEFAULT_POLLING_INTERVAL;
331 i2c_set_clientdata(client, ir);
336 ir->get_key = get_key_pixelview;
337 rc_proto = RC_PROTO_BIT_OTHER;
338 ir_codes = RC_MAP_EMPTY;
344 ir->get_key = get_key_haup;
345 rc_proto = RC_PROTO_BIT_RC5;
346 ir_codes = RC_MAP_HAUPPAUGE;
350 ir->get_key = get_key_knc1;
351 rc_proto = RC_PROTO_BIT_OTHER;
352 ir_codes = RC_MAP_EMPTY;
356 ir->get_key = get_key_fusionhdtv;
357 rc_proto = RC_PROTO_BIT_UNKNOWN;
358 ir_codes = RC_MAP_FUSIONHDTV_MCE;
361 name = "AVerMedia Cardbus remote";
362 ir->get_key = get_key_avermedia_cardbus;
363 rc_proto = RC_PROTO_BIT_OTHER;
364 ir_codes = RC_MAP_AVERMEDIA_CARDBUS;
367 name = "AVerMedia EM78P153";
368 ir->get_key = get_key_avermedia_cardbus;
369 rc_proto = RC_PROTO_BIT_OTHER;
370 /* RM-KV remote, seems to be same as RM-K6 */
371 ir_codes = RC_MAP_AVERMEDIA_M733A_RM_K6;
374 name = "Hauppauge/Zilog Z8";
375 ir->get_key = get_key_haup_xvr;
376 rc_proto = RC_PROTO_BIT_RC5 | RC_PROTO_BIT_RC6_MCE |
377 RC_PROTO_BIT_RC6_6A_32;
378 ir_codes = RC_MAP_HAUPPAUGE;
382 /* Let the caller override settings */
383 if (client->dev.platform_data) {
384 const struct IR_i2c_init_data *init_data =
385 client->dev.platform_data;
387 ir_codes = init_data->ir_codes;
388 rc = init_data->rc_dev;
390 name = init_data->name;
392 rc_proto = init_data->type;
394 if (init_data->polling_interval)
395 ir->polling_interval = init_data->polling_interval;
397 switch (init_data->internal_get_key_func) {
398 case IR_KBD_GET_KEY_CUSTOM:
399 /* The bridge driver provided us its own function */
400 ir->get_key = init_data->get_key;
402 case IR_KBD_GET_KEY_PIXELVIEW:
403 ir->get_key = get_key_pixelview;
405 case IR_KBD_GET_KEY_HAUP:
406 ir->get_key = get_key_haup;
408 case IR_KBD_GET_KEY_KNC1:
409 ir->get_key = get_key_knc1;
411 case IR_KBD_GET_KEY_FUSIONHDTV:
412 ir->get_key = get_key_fusionhdtv;
414 case IR_KBD_GET_KEY_HAUP_XVR:
415 ir->get_key = get_key_haup_xvr;
417 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
418 ir->get_key = get_key_avermedia_cardbus;
425 * If platform_data doesn't specify rc_dev, initialize it
428 rc = rc_allocate_device(RC_DRIVER_SCANCODE);
434 /* Make sure we are all setup before going on */
435 if (!name || !ir->get_key || !rc_proto || !ir_codes) {
436 dprintk(1, ": Unsupported device at address 0x%02x\n",
443 snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
444 ir->ir_codes = ir_codes;
446 snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
447 dev_name(&adap->dev),
448 dev_name(&client->dev));
451 * Initialize input_dev fields
452 * It doesn't make sense to allow overriding them via platform_data
454 rc->input_id.bustype = BUS_I2C;
455 rc->input_phys = ir->phys;
456 rc->device_name = ir->name;
459 * Initialize the other fields of rc_dev
461 rc->map_name = ir->ir_codes;
462 rc->allowed_protocols = rc_proto;
463 rc->enabled_protocols = rc_proto;
464 if (!rc->driver_name)
465 rc->driver_name = MODULE_NAME;
467 err = rc_register_device(rc);
471 printk(MODULE_NAME ": %s detected at %s [%s]\n",
472 ir->name, ir->phys, adap->name);
474 /* start polling via eventd */
475 INIT_DELAYED_WORK(&ir->work, ir_work);
476 schedule_delayed_work(&ir->work, 0);
481 /* Only frees rc if it were allocated internally */
486 static int ir_remove(struct i2c_client *client)
488 struct IR_i2c *ir = i2c_get_clientdata(client);
490 /* kill outstanding polls */
491 cancel_delayed_work_sync(&ir->work);
493 /* unregister device */
494 rc_unregister_device(ir->rc);
500 static const struct i2c_device_id ir_kbd_id[] = {
501 /* Generic entry for any IR receiver */
503 /* IR device specific entries should be added here */
504 { "ir_rx_z8f0811_haup", 0 },
505 { "ir_rx_z8f0811_hdpvr", 0 },
509 static struct i2c_driver ir_kbd_driver = {
511 .name = "ir-kbd-i2c",
515 .id_table = ir_kbd_id,
518 module_i2c_driver(ir_kbd_driver);
520 /* ----------------------------------------------------------------------- */
522 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
523 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
524 MODULE_LICENSE("GPL");