1 /* 2 * 3 * keyboard input driver for i2c IR remote controls 4 * 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> 21 * 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. 26 * 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. 31 * 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 35 * 36 */ 37 38 #include <asm/unaligned.h> 39 #include <linux/module.h> 40 #include <linux/init.h> 41 #include <linux/kernel.h> 42 #include <linux/string.h> 43 #include <linux/timer.h> 44 #include <linux/delay.h> 45 #include <linux/errno.h> 46 #include <linux/slab.h> 47 #include <linux/i2c.h> 48 #include <linux/workqueue.h> 49 50 #include <media/rc-core.h> 51 #include <media/i2c/ir-kbd-i2c.h> 52 53 /* ----------------------------------------------------------------------- */ 54 /* insmod parameters */ 55 56 static int debug; 57 module_param(debug, int, 0644); /* debug level (0,1,2) */ 58 59 60 #define MODULE_NAME "ir-kbd-i2c" 61 #define dprintk(level, fmt, arg...) if (debug >= level) \ 62 printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg) 63 64 /* ----------------------------------------------------------------------- */ 65 66 static int get_key_haup_common(struct IR_i2c *ir, enum rc_type *protocol, 67 u32 *scancode, u8 *ptoggle, int size) 68 { 69 unsigned char buf[6]; 70 int start, range, toggle, dev, code, ircode, vendor; 71 72 /* poll IR chip */ 73 if (size != i2c_master_recv(ir->c, buf, size)) 74 return -EIO; 75 76 if (buf[0] & 0x80) { 77 int offset = (size == 6) ? 3 : 0; 78 79 /* split rc5 data block ... */ 80 start = (buf[offset] >> 7) & 1; 81 range = (buf[offset] >> 6) & 1; 82 toggle = (buf[offset] >> 5) & 1; 83 dev = buf[offset] & 0x1f; 84 code = (buf[offset+1] >> 2) & 0x3f; 85 86 /* rc5 has two start bits 87 * the first bit must be one 88 * the second bit defines the command range: 89 * 1 = 0-63, 0 = 64 - 127 90 */ 91 if (!start) 92 /* no key pressed */ 93 return 0; 94 95 /* filter out invalid key presses */ 96 ircode = (start << 12) | (toggle << 11) | (dev << 6) | code; 97 if ((ircode & 0x1fff) == 0x1fff) 98 return 0; 99 100 if (!range) 101 code += 64; 102 103 dprintk(1, "ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n", 104 start, range, toggle, dev, code); 105 106 *protocol = RC_TYPE_RC5; 107 *scancode = RC_SCANCODE_RC5(dev, code); 108 *ptoggle = toggle; 109 110 return 1; 111 } else if (size == 6 && (buf[0] & 0x40)) { 112 code = buf[4]; 113 dev = buf[3]; 114 vendor = get_unaligned_be16(buf + 1); 115 116 if (vendor == 0x800f) { 117 *ptoggle = (dev & 0x80) != 0; 118 *protocol = RC_TYPE_RC6_MCE; 119 dev &= 0x7f; 120 dprintk(1, "ir hauppauge (rc6-mce): t%d vendor=%d dev=%d code=%d\n", 121 toggle, vendor, dev, code); 122 } else { 123 *ptoggle = 0; 124 *protocol = RC_TYPE_RC6_6A_32; 125 dprintk(1, "ir hauppauge (rc6-6a-32): vendor=%d dev=%d code=%d\n", 126 vendor, dev, code); 127 } 128 129 *scancode = RC_SCANCODE_RC6_6A(vendor, dev, code); 130 131 return 1; 132 } 133 134 return 0; 135 } 136 137 static int get_key_haup(struct IR_i2c *ir, enum rc_type *protocol, 138 u32 *scancode, u8 *toggle) 139 { 140 return get_key_haup_common(ir, protocol, scancode, toggle, 3); 141 } 142 143 static int get_key_haup_xvr(struct IR_i2c *ir, enum rc_type *protocol, 144 u32 *scancode, u8 *toggle) 145 { 146 int ret; 147 unsigned char buf[1] = { 0 }; 148 149 /* 150 * This is the same apparent "are you ready?" poll command observed 151 * watching Windows driver traffic and implemented in lirc_zilog. With 152 * this added, we get far saner remote behavior with z8 chips on usb 153 * connected devices, even with the default polling interval of 100ms. 154 */ 155 ret = i2c_master_send(ir->c, buf, 1); 156 if (ret != 1) 157 return (ret < 0) ? ret : -EINVAL; 158 159 return get_key_haup_common(ir, protocol, scancode, toggle, 6); 160 } 161 162 static int get_key_pixelview(struct IR_i2c *ir, enum rc_type *protocol, 163 u32 *scancode, u8 *toggle) 164 { 165 unsigned char b; 166 167 /* poll IR chip */ 168 if (1 != i2c_master_recv(ir->c, &b, 1)) { 169 dprintk(1,"read error\n"); 170 return -EIO; 171 } 172 173 *protocol = RC_TYPE_OTHER; 174 *scancode = b; 175 *toggle = 0; 176 return 1; 177 } 178 179 static int get_key_fusionhdtv(struct IR_i2c *ir, enum rc_type *protocol, 180 u32 *scancode, u8 *toggle) 181 { 182 unsigned char buf[4]; 183 184 /* poll IR chip */ 185 if (4 != i2c_master_recv(ir->c, buf, 4)) { 186 dprintk(1,"read error\n"); 187 return -EIO; 188 } 189 190 if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0) 191 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__, 192 buf[0], buf[1], buf[2], buf[3]); 193 194 /* no key pressed or signal from other ir remote */ 195 if(buf[0] != 0x1 || buf[1] != 0xfe) 196 return 0; 197 198 *protocol = RC_TYPE_UNKNOWN; 199 *scancode = buf[2]; 200 *toggle = 0; 201 return 1; 202 } 203 204 static int get_key_knc1(struct IR_i2c *ir, enum rc_type *protocol, 205 u32 *scancode, u8 *toggle) 206 { 207 unsigned char b; 208 209 /* poll IR chip */ 210 if (1 != i2c_master_recv(ir->c, &b, 1)) { 211 dprintk(1,"read error\n"); 212 return -EIO; 213 } 214 215 /* it seems that 0xFE indicates that a button is still hold 216 down, while 0xff indicates that no button is hold 217 down. 0xfe sequences are sometimes interrupted by 0xFF */ 218 219 dprintk(2,"key %02x\n", b); 220 221 if (b == 0xff) 222 return 0; 223 224 if (b == 0xfe) 225 /* keep old data */ 226 return 1; 227 228 *protocol = RC_TYPE_UNKNOWN; 229 *scancode = b; 230 *toggle = 0; 231 return 1; 232 } 233 234 static int get_key_avermedia_cardbus(struct IR_i2c *ir, enum rc_type *protocol, 235 u32 *scancode, u8 *toggle) 236 { 237 unsigned char subaddr, key, keygroup; 238 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, 239 .buf = &subaddr, .len = 1}, 240 { .addr = ir->c->addr, .flags = I2C_M_RD, 241 .buf = &key, .len = 1} }; 242 subaddr = 0x0d; 243 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) { 244 dprintk(1, "read error\n"); 245 return -EIO; 246 } 247 248 if (key == 0xff) 249 return 0; 250 251 subaddr = 0x0b; 252 msg[1].buf = &keygroup; 253 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) { 254 dprintk(1, "read error\n"); 255 return -EIO; 256 } 257 258 if (keygroup == 0xff) 259 return 0; 260 261 dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup); 262 if (keygroup < 2 || keygroup > 4) { 263 /* Only a warning */ 264 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n", 265 keygroup, key); 266 } 267 key |= (keygroup & 1) << 6; 268 269 *protocol = RC_TYPE_UNKNOWN; 270 *scancode = key; 271 if (ir->c->addr == 0x41) /* AVerMedia EM78P153 */ 272 *scancode |= keygroup << 8; 273 *toggle = 0; 274 return 1; 275 } 276 277 /* ----------------------------------------------------------------------- */ 278 279 static int ir_key_poll(struct IR_i2c *ir) 280 { 281 enum rc_type protocol; 282 u32 scancode; 283 u8 toggle; 284 int rc; 285 286 dprintk(3, "%s\n", __func__); 287 rc = ir->get_key(ir, &protocol, &scancode, &toggle); 288 if (rc < 0) { 289 dprintk(2,"error\n"); 290 return rc; 291 } 292 293 if (rc) { 294 dprintk(1, "%s: proto = 0x%04x, scancode = 0x%08x\n", 295 __func__, protocol, scancode); 296 rc_keydown(ir->rc, protocol, scancode, toggle); 297 } 298 return 0; 299 } 300 301 static void ir_work(struct work_struct *work) 302 { 303 int rc; 304 struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work); 305 306 rc = ir_key_poll(ir); 307 if (rc == -ENODEV) { 308 rc_unregister_device(ir->rc); 309 ir->rc = NULL; 310 return; 311 } 312 313 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval)); 314 } 315 316 /* ----------------------------------------------------------------------- */ 317 318 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id) 319 { 320 char *ir_codes = NULL; 321 const char *name = NULL; 322 u64 rc_type = RC_BIT_UNKNOWN; 323 struct IR_i2c *ir; 324 struct rc_dev *rc = NULL; 325 struct i2c_adapter *adap = client->adapter; 326 unsigned short addr = client->addr; 327 int err; 328 329 ir = devm_kzalloc(&client->dev, sizeof(*ir), GFP_KERNEL); 330 if (!ir) 331 return -ENOMEM; 332 333 ir->c = client; 334 ir->polling_interval = DEFAULT_POLLING_INTERVAL; 335 i2c_set_clientdata(client, ir); 336 337 switch(addr) { 338 case 0x64: 339 name = "Pixelview"; 340 ir->get_key = get_key_pixelview; 341 rc_type = RC_BIT_OTHER; 342 ir_codes = RC_MAP_EMPTY; 343 break; 344 case 0x18: 345 case 0x1f: 346 case 0x1a: 347 name = "Hauppauge"; 348 ir->get_key = get_key_haup; 349 rc_type = RC_BIT_RC5; 350 ir_codes = RC_MAP_HAUPPAUGE; 351 break; 352 case 0x30: 353 name = "KNC One"; 354 ir->get_key = get_key_knc1; 355 rc_type = RC_BIT_OTHER; 356 ir_codes = RC_MAP_EMPTY; 357 break; 358 case 0x6b: 359 name = "FusionHDTV"; 360 ir->get_key = get_key_fusionhdtv; 361 rc_type = RC_BIT_UNKNOWN; 362 ir_codes = RC_MAP_FUSIONHDTV_MCE; 363 break; 364 case 0x40: 365 name = "AVerMedia Cardbus remote"; 366 ir->get_key = get_key_avermedia_cardbus; 367 rc_type = RC_BIT_OTHER; 368 ir_codes = RC_MAP_AVERMEDIA_CARDBUS; 369 break; 370 case 0x41: 371 name = "AVerMedia EM78P153"; 372 ir->get_key = get_key_avermedia_cardbus; 373 rc_type = RC_BIT_OTHER; 374 /* RM-KV remote, seems to be same as RM-K6 */ 375 ir_codes = RC_MAP_AVERMEDIA_M733A_RM_K6; 376 break; 377 case 0x71: 378 name = "Hauppauge/Zilog Z8"; 379 ir->get_key = get_key_haup_xvr; 380 rc_type = RC_BIT_RC5 | RC_BIT_RC6_MCE | RC_BIT_RC6_6A_32; 381 ir_codes = RC_MAP_HAUPPAUGE; 382 break; 383 } 384 385 /* Let the caller override settings */ 386 if (client->dev.platform_data) { 387 const struct IR_i2c_init_data *init_data = 388 client->dev.platform_data; 389 390 ir_codes = init_data->ir_codes; 391 rc = init_data->rc_dev; 392 393 name = init_data->name; 394 if (init_data->type) 395 rc_type = init_data->type; 396 397 if (init_data->polling_interval) 398 ir->polling_interval = init_data->polling_interval; 399 400 switch (init_data->internal_get_key_func) { 401 case IR_KBD_GET_KEY_CUSTOM: 402 /* The bridge driver provided us its own function */ 403 ir->get_key = init_data->get_key; 404 break; 405 case IR_KBD_GET_KEY_PIXELVIEW: 406 ir->get_key = get_key_pixelview; 407 break; 408 case IR_KBD_GET_KEY_HAUP: 409 ir->get_key = get_key_haup; 410 break; 411 case IR_KBD_GET_KEY_KNC1: 412 ir->get_key = get_key_knc1; 413 break; 414 case IR_KBD_GET_KEY_FUSIONHDTV: 415 ir->get_key = get_key_fusionhdtv; 416 break; 417 case IR_KBD_GET_KEY_HAUP_XVR: 418 ir->get_key = get_key_haup_xvr; 419 break; 420 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS: 421 ir->get_key = get_key_avermedia_cardbus; 422 break; 423 } 424 } 425 426 if (!rc) { 427 /* 428 * If platform_data doesn't specify rc_dev, initialize it 429 * internally 430 */ 431 rc = rc_allocate_device(); 432 if (!rc) 433 return -ENOMEM; 434 } 435 ir->rc = rc; 436 437 /* Make sure we are all setup before going on */ 438 if (!name || !ir->get_key || !rc_type || !ir_codes) { 439 dprintk(1, ": Unsupported device at address 0x%02x\n", 440 addr); 441 err = -ENODEV; 442 goto err_out_free; 443 } 444 445 /* Sets name */ 446 snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name); 447 ir->ir_codes = ir_codes; 448 449 snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0", 450 dev_name(&adap->dev), 451 dev_name(&client->dev)); 452 453 /* 454 * Initialize input_dev fields 455 * It doesn't make sense to allow overriding them via platform_data 456 */ 457 rc->input_id.bustype = BUS_I2C; 458 rc->input_phys = ir->phys; 459 rc->input_name = ir->name; 460 461 /* 462 * Initialize the other fields of rc_dev 463 */ 464 rc->map_name = ir->ir_codes; 465 rc->allowed_protocols = rc_type; 466 rc->enabled_protocols = rc_type; 467 if (!rc->driver_name) 468 rc->driver_name = MODULE_NAME; 469 470 err = rc_register_device(rc); 471 if (err) 472 goto err_out_free; 473 474 printk(MODULE_NAME ": %s detected at %s [%s]\n", 475 ir->name, ir->phys, adap->name); 476 477 /* start polling via eventd */ 478 INIT_DELAYED_WORK(&ir->work, ir_work); 479 schedule_delayed_work(&ir->work, 0); 480 481 return 0; 482 483 err_out_free: 484 /* Only frees rc if it were allocated internally */ 485 rc_free_device(rc); 486 return err; 487 } 488 489 static int ir_remove(struct i2c_client *client) 490 { 491 struct IR_i2c *ir = i2c_get_clientdata(client); 492 493 /* kill outstanding polls */ 494 cancel_delayed_work_sync(&ir->work); 495 496 /* unregister device */ 497 rc_unregister_device(ir->rc); 498 499 /* free memory */ 500 return 0; 501 } 502 503 static const struct i2c_device_id ir_kbd_id[] = { 504 /* Generic entry for any IR receiver */ 505 { "ir_video", 0 }, 506 /* IR device specific entries should be added here */ 507 { "ir_rx_z8f0811_haup", 0 }, 508 { "ir_rx_z8f0811_hdpvr", 0 }, 509 { } 510 }; 511 512 static struct i2c_driver ir_kbd_driver = { 513 .driver = { 514 .name = "ir-kbd-i2c", 515 }, 516 .probe = ir_probe, 517 .remove = ir_remove, 518 .id_table = ir_kbd_id, 519 }; 520 521 module_i2c_driver(ir_kbd_driver); 522 523 /* ----------------------------------------------------------------------- */ 524 525 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller"); 526 MODULE_DESCRIPTION("input driver for i2c IR remote controls"); 527 MODULE_LICENSE("GPL"); 528