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 <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/i2c-id.h> 48#include <linux/workqueue.h> 49 50#include <media/ir-core.h> 51#include <media/ir-kbd-i2c.h> 52 53/* ----------------------------------------------------------------------- */ 54/* insmod parameters */ 55 56static int debug; 57module_param(debug, int, 0644); /* debug level (0,1,2) */ 58 59static int hauppauge; 60module_param(hauppauge, int, 0644); /* Choose Hauppauge remote */ 61MODULE_PARM_DESC(hauppauge, "Specify Hauppauge remote: 0=black, 1=grey (defaults to 0)"); 62 63 64#define MODULE_NAME "ir-kbd-i2c" 65#define dprintk(level, fmt, arg...) if (debug >= level) \ 66 printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg) 67 68/* ----------------------------------------------------------------------- */ 69 70static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw, 71 int size, int offset) 72{ 73 unsigned char buf[6]; 74 int start, range, toggle, dev, code, ircode; 75 76 /* poll IR chip */ 77 if (size != i2c_master_recv(ir->c, buf, size)) 78 return -EIO; 79 80 /* split rc5 data block ... */ 81 start = (buf[offset] >> 7) & 1; 82 range = (buf[offset] >> 6) & 1; 83 toggle = (buf[offset] >> 5) & 1; 84 dev = buf[offset] & 0x1f; 85 code = (buf[offset+1] >> 2) & 0x3f; 86 87 /* rc5 has two start bits 88 * the first bit must be one 89 * the second bit defines the command range (1 = 0-63, 0 = 64 - 127) 90 */ 91 if (!start) 92 /* no key pressed */ 93 return 0; 94 /* 95 * Hauppauge remotes (black/silver) always use 96 * specific device ids. If we do not filter the 97 * device ids then messages destined for devices 98 * such as TVs (id=0) will get through causing 99 * mis-fired events. 100 * 101 * We also filter out invalid key presses which 102 * produce annoying debug log entries. 103 */ 104 ircode= (start << 12) | (toggle << 11) | (dev << 6) | code; 105 if ((ircode & 0x1fff)==0x1fff) 106 /* invalid key press */ 107 return 0; 108 109 if (dev!=0x1e && dev!=0x1f) 110 /* not a hauppauge remote */ 111 return 0; 112 113 if (!range) 114 code += 64; 115 116 dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n", 117 start, range, toggle, dev, code); 118 119 /* return key */ 120 *ir_key = code; 121 *ir_raw = ircode; 122 return 1; 123} 124 125static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) 126{ 127 return get_key_haup_common (ir, ir_key, ir_raw, 3, 0); 128} 129 130static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) 131{ 132 return get_key_haup_common (ir, ir_key, ir_raw, 6, 3); 133} 134 135static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) 136{ 137 unsigned char b; 138 139 /* poll IR chip */ 140 if (1 != i2c_master_recv(ir->c, &b, 1)) { 141 dprintk(1,"read error\n"); 142 return -EIO; 143 } 144 *ir_key = b; 145 *ir_raw = b; 146 return 1; 147} 148 149static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) 150{ 151 unsigned char b; 152 153 /* poll IR chip */ 154 if (1 != i2c_master_recv(ir->c, &b, 1)) { 155 dprintk(1,"read error\n"); 156 return -EIO; 157 } 158 159 /* ignore 0xaa */ 160 if (b==0xaa) 161 return 0; 162 dprintk(2,"key %02x\n", b); 163 164 *ir_key = b; 165 *ir_raw = b; 166 return 1; 167} 168 169static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) 170{ 171 unsigned char buf[4]; 172 173 /* poll IR chip */ 174 if (4 != i2c_master_recv(ir->c, buf, 4)) { 175 dprintk(1,"read error\n"); 176 return -EIO; 177 } 178 179 if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0) 180 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__, 181 buf[0], buf[1], buf[2], buf[3]); 182 183 /* no key pressed or signal from other ir remote */ 184 if(buf[0] != 0x1 || buf[1] != 0xfe) 185 return 0; 186 187 *ir_key = buf[2]; 188 *ir_raw = (buf[2] << 8) | buf[3]; 189 190 return 1; 191} 192 193static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) 194{ 195 unsigned char b; 196 197 /* poll IR chip */ 198 if (1 != i2c_master_recv(ir->c, &b, 1)) { 199 dprintk(1,"read error\n"); 200 return -EIO; 201 } 202 203 /* it seems that 0xFE indicates that a button is still hold 204 down, while 0xff indicates that no button is hold 205 down. 0xfe sequences are sometimes interrupted by 0xFF */ 206 207 dprintk(2,"key %02x\n", b); 208 209 if (b == 0xff) 210 return 0; 211 212 if (b == 0xfe) 213 /* keep old data */ 214 return 1; 215 216 *ir_key = b; 217 *ir_raw = b; 218 return 1; 219} 220 221static int get_key_avermedia_cardbus(struct IR_i2c *ir, 222 u32 *ir_key, u32 *ir_raw) 223{ 224 unsigned char subaddr, key, keygroup; 225 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, 226 .buf = &subaddr, .len = 1}, 227 { .addr = ir->c->addr, .flags = I2C_M_RD, 228 .buf = &key, .len = 1} }; 229 subaddr = 0x0d; 230 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) { 231 dprintk(1, "read error\n"); 232 return -EIO; 233 } 234 235 if (key == 0xff) 236 return 0; 237 238 subaddr = 0x0b; 239 msg[1].buf = &keygroup; 240 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) { 241 dprintk(1, "read error\n"); 242 return -EIO; 243 } 244 245 if (keygroup == 0xff) 246 return 0; 247 248 dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup); 249 if (keygroup < 2 || keygroup > 3) { 250 /* Only a warning */ 251 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n", 252 keygroup, key); 253 } 254 key |= (keygroup & 1) << 6; 255 256 *ir_key = key; 257 *ir_raw = key; 258 return 1; 259} 260 261/* ----------------------------------------------------------------------- */ 262 263static void ir_key_poll(struct IR_i2c *ir) 264{ 265 static u32 ir_key, ir_raw; 266 int rc; 267 268 dprintk(2,"ir_poll_key\n"); 269 rc = ir->get_key(ir, &ir_key, &ir_raw); 270 if (rc < 0) { 271 dprintk(2,"error\n"); 272 return; 273 } 274 275 if (rc) 276 ir_keydown(ir->input, ir_key, 0); 277} 278 279static void ir_work(struct work_struct *work) 280{ 281 struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work); 282 int polling_interval = 100; 283 284 /* MSI TV@nywhere Plus requires more frequent polling 285 otherwise it will miss some keypresses */ 286 if (ir->c->adapter->id == I2C_HW_SAA7134 && ir->c->addr == 0x30) 287 polling_interval = 50; 288 289 ir_key_poll(ir); 290 schedule_delayed_work(&ir->work, msecs_to_jiffies(polling_interval)); 291} 292 293/* ----------------------------------------------------------------------- */ 294 295static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id) 296{ 297 char *ir_codes = NULL; 298 const char *name = NULL; 299 u64 ir_type = 0; 300 struct IR_i2c *ir; 301 struct input_dev *input_dev; 302 struct i2c_adapter *adap = client->adapter; 303 unsigned short addr = client->addr; 304 int err; 305 306 ir = kzalloc(sizeof(struct IR_i2c),GFP_KERNEL); 307 input_dev = input_allocate_device(); 308 if (!ir || !input_dev) { 309 err = -ENOMEM; 310 goto err_out_free; 311 } 312 313 ir->c = client; 314 ir->input = input_dev; 315 i2c_set_clientdata(client, ir); 316 317 switch(addr) { 318 case 0x64: 319 name = "Pixelview"; 320 ir->get_key = get_key_pixelview; 321 ir_type = IR_TYPE_OTHER; 322 ir_codes = RC_MAP_EMPTY; 323 break; 324 case 0x4b: 325 name = "PV951"; 326 ir->get_key = get_key_pv951; 327 ir_type = IR_TYPE_OTHER; 328 ir_codes = RC_MAP_PV951; 329 break; 330 case 0x18: 331 case 0x1f: 332 case 0x1a: 333 name = "Hauppauge"; 334 ir->get_key = get_key_haup; 335 ir_type = IR_TYPE_RC5; 336 if (hauppauge == 1) { 337 ir_codes = RC_MAP_HAUPPAUGE_NEW; 338 } else { 339 ir_codes = RC_MAP_RC5_TV; 340 } 341 break; 342 case 0x30: 343 name = "KNC One"; 344 ir->get_key = get_key_knc1; 345 ir_type = IR_TYPE_OTHER; 346 ir_codes = RC_MAP_EMPTY; 347 break; 348 case 0x6b: 349 name = "FusionHDTV"; 350 ir->get_key = get_key_fusionhdtv; 351 ir_type = IR_TYPE_RC5; 352 ir_codes = RC_MAP_FUSIONHDTV_MCE; 353 break; 354 case 0x0b: 355 case 0x47: 356 case 0x71: 357 if (adap->id == I2C_HW_B_CX2388x || 358 adap->id == I2C_HW_B_CX2341X) { 359 /* Handled by cx88-input */ 360 name = adap->id == I2C_HW_B_CX2341X ? "CX2341x remote" 361 : "CX2388x remote"; 362 ir_type = IR_TYPE_RC5; 363 ir->get_key = get_key_haup_xvr; 364 if (hauppauge == 1) { 365 ir_codes = RC_MAP_HAUPPAUGE_NEW; 366 } else { 367 ir_codes = RC_MAP_RC5_TV; 368 } 369 } else { 370 /* Handled by saa7134-input */ 371 name = "SAA713x remote"; 372 ir_type = IR_TYPE_OTHER; 373 } 374 break; 375 case 0x40: 376 name = "AVerMedia Cardbus remote"; 377 ir->get_key = get_key_avermedia_cardbus; 378 ir_type = IR_TYPE_OTHER; 379 ir_codes = RC_MAP_AVERMEDIA_CARDBUS; 380 break; 381 } 382 383 /* Let the caller override settings */ 384 if (client->dev.platform_data) { 385 const struct IR_i2c_init_data *init_data = 386 client->dev.platform_data; 387 388 ir_codes = init_data->ir_codes; 389 name = init_data->name; 390 if (init_data->type) 391 ir_type = init_data->type; 392 393 switch (init_data->internal_get_key_func) { 394 case IR_KBD_GET_KEY_CUSTOM: 395 /* The bridge driver provided us its own function */ 396 ir->get_key = init_data->get_key; 397 break; 398 case IR_KBD_GET_KEY_PIXELVIEW: 399 ir->get_key = get_key_pixelview; 400 break; 401 case IR_KBD_GET_KEY_PV951: 402 ir->get_key = get_key_pv951; 403 break; 404 case IR_KBD_GET_KEY_HAUP: 405 ir->get_key = get_key_haup; 406 break; 407 case IR_KBD_GET_KEY_KNC1: 408 ir->get_key = get_key_knc1; 409 break; 410 case IR_KBD_GET_KEY_FUSIONHDTV: 411 ir->get_key = get_key_fusionhdtv; 412 break; 413 case IR_KBD_GET_KEY_HAUP_XVR: 414 ir->get_key = get_key_haup_xvr; 415 break; 416 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS: 417 ir->get_key = get_key_avermedia_cardbus; 418 break; 419 } 420 } 421 422 /* Make sure we are all setup before going on */ 423 if (!name || !ir->get_key || !ir_type || !ir_codes) { 424 dprintk(1, ": Unsupported device at address 0x%02x\n", 425 addr); 426 err = -ENODEV; 427 goto err_out_free; 428 } 429 430 /* Sets name */ 431 snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name); 432 ir->ir_codes = ir_codes; 433 434 snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0", 435 dev_name(&adap->dev), 436 dev_name(&client->dev)); 437 438 /* init + register input device */ 439 ir->ir_type = ir_type; 440 input_dev->id.bustype = BUS_I2C; 441 input_dev->name = ir->name; 442 input_dev->phys = ir->phys; 443 444 err = ir_input_register(ir->input, ir->ir_codes, NULL, MODULE_NAME); 445 if (err) 446 goto err_out_free; 447 448 printk(MODULE_NAME ": %s detected at %s [%s]\n", 449 ir->input->name, ir->input->phys, adap->name); 450 451 /* start polling via eventd */ 452 INIT_DELAYED_WORK(&ir->work, ir_work); 453 schedule_delayed_work(&ir->work, 0); 454 455 return 0; 456 457 err_out_free: 458 kfree(ir); 459 return err; 460} 461 462static int ir_remove(struct i2c_client *client) 463{ 464 struct IR_i2c *ir = i2c_get_clientdata(client); 465 466 /* kill outstanding polls */ 467 cancel_delayed_work_sync(&ir->work); 468 469 /* unregister device */ 470 ir_input_unregister(ir->input); 471 472 /* free memory */ 473 kfree(ir); 474 return 0; 475} 476 477static const struct i2c_device_id ir_kbd_id[] = { 478 /* Generic entry for any IR receiver */ 479 { "ir_video", 0 }, 480 /* IR device specific entries should be added here */ 481 { "ir_rx_z8f0811_haup", 0 }, 482 { } 483}; 484 485static struct i2c_driver driver = { 486 .driver = { 487 .name = "ir-kbd-i2c", 488 }, 489 .probe = ir_probe, 490 .remove = ir_remove, 491 .id_table = ir_kbd_id, 492}; 493 494/* ----------------------------------------------------------------------- */ 495 496MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller"); 497MODULE_DESCRIPTION("input driver for i2c IR remote controls"); 498MODULE_LICENSE("GPL"); 499 500static int __init ir_init(void) 501{ 502 return i2c_add_driver(&driver); 503} 504 505static void __exit ir_fini(void) 506{ 507 i2c_del_driver(&driver); 508} 509 510module_init(ir_init); 511module_exit(ir_fini); 512 513/* 514 * Overrides for Emacs so that we follow Linus's tabbing style. 515 * --------------------------------------------------------------------------- 516 * Local variables: 517 * c-basic-offset: 8 518 * End: 519 */ 520