1 /* 2 * 3 * Copyright (c) 2003 Gerd Knorr 4 * Copyright (c) 2003 Pavel Machek 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 */ 16 17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 18 19 #include <linux/module.h> 20 #include <linux/init.h> 21 #include <linux/delay.h> 22 #include <linux/interrupt.h> 23 #include <linux/input.h> 24 #include <linux/slab.h> 25 26 #include "bttv.h" 27 #include "bttvp.h" 28 29 30 static int ir_debug; 31 module_param(ir_debug, int, 0644); 32 33 static int ir_rc5_remote_gap = 885; 34 module_param(ir_rc5_remote_gap, int, 0644); 35 36 #undef dprintk 37 #define dprintk(fmt, ...) \ 38 do { \ 39 if (ir_debug >= 1) \ 40 pr_info(fmt, ##__VA_ARGS__); \ 41 } while (0) 42 43 #define DEVNAME "bttv-input" 44 45 #define MODULE_NAME "bttv" 46 47 /* ---------------------------------------------------------------------- */ 48 49 static void ir_handle_key(struct bttv *btv) 50 { 51 struct bttv_ir *ir = btv->remote; 52 u32 gpio,data; 53 54 /* read gpio value */ 55 gpio = bttv_gpio_read(&btv->c); 56 if (ir->polling) { 57 if (ir->last_gpio == gpio) 58 return; 59 ir->last_gpio = gpio; 60 } 61 62 /* extract data */ 63 data = ir_extract_bits(gpio, ir->mask_keycode); 64 dprintk("irq gpio=0x%x code=%d | %s%s%s\n", 65 gpio, data, 66 ir->polling ? "poll" : "irq", 67 (gpio & ir->mask_keydown) ? " down" : "", 68 (gpio & ir->mask_keyup) ? " up" : ""); 69 70 if ((ir->mask_keydown && (gpio & ir->mask_keydown)) || 71 (ir->mask_keyup && !(gpio & ir->mask_keyup))) { 72 rc_keydown_notimeout(ir->dev, RC_PROTO_UNKNOWN, data, 0); 73 } else { 74 /* HACK: Probably, ir->mask_keydown is missing 75 for this board */ 76 if (btv->c.type == BTTV_BOARD_WINFAST2000) 77 rc_keydown_notimeout(ir->dev, RC_PROTO_UNKNOWN, data, 78 0); 79 80 rc_keyup(ir->dev); 81 } 82 } 83 84 static void ir_enltv_handle_key(struct bttv *btv) 85 { 86 struct bttv_ir *ir = btv->remote; 87 u32 gpio, data, keyup; 88 89 /* read gpio value */ 90 gpio = bttv_gpio_read(&btv->c); 91 92 /* extract data */ 93 data = ir_extract_bits(gpio, ir->mask_keycode); 94 95 /* Check if it is keyup */ 96 keyup = (gpio & ir->mask_keyup) ? 1 << 31 : 0; 97 98 if ((ir->last_gpio & 0x7f) != data) { 99 dprintk("gpio=0x%x code=%d | %s\n", 100 gpio, data, 101 (gpio & ir->mask_keyup) ? " up" : "up/down"); 102 103 rc_keydown_notimeout(ir->dev, RC_PROTO_UNKNOWN, data, 0); 104 if (keyup) 105 rc_keyup(ir->dev); 106 } else { 107 if ((ir->last_gpio & 1 << 31) == keyup) 108 return; 109 110 dprintk("(cnt) gpio=0x%x code=%d | %s\n", 111 gpio, data, 112 (gpio & ir->mask_keyup) ? " up" : "down"); 113 114 if (keyup) 115 rc_keyup(ir->dev); 116 else 117 rc_keydown_notimeout(ir->dev, RC_PROTO_UNKNOWN, data, 118 0); 119 } 120 121 ir->last_gpio = data | keyup; 122 } 123 124 static int bttv_rc5_irq(struct bttv *btv); 125 126 void bttv_input_irq(struct bttv *btv) 127 { 128 struct bttv_ir *ir = btv->remote; 129 130 if (ir->rc5_gpio) 131 bttv_rc5_irq(btv); 132 else if (!ir->polling) 133 ir_handle_key(btv); 134 } 135 136 static void bttv_input_timer(struct timer_list *t) 137 { 138 struct bttv_ir *ir = from_timer(ir, t, timer); 139 struct bttv *btv = ir->btv; 140 141 if (btv->c.type == BTTV_BOARD_ENLTV_FM_2) 142 ir_enltv_handle_key(btv); 143 else 144 ir_handle_key(btv); 145 mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling)); 146 } 147 148 /* 149 * FIXME: Nebula digi uses the legacy way to decode RC5, instead of relying 150 * on the rc-core way. As we need to be sure that both IRQ transitions are 151 * properly triggered, Better to touch it only with this hardware for 152 * testing. 153 */ 154 155 #define RC5_START(x) (((x) >> 12) & 0x03) 156 #define RC5_TOGGLE(x) (((x) >> 11) & 0x01) 157 #define RC5_ADDR(x) (((x) >> 6) & 0x1f) 158 #define RC5_INSTR(x) (((x) >> 0) & 0x3f) 159 160 /* decode raw bit pattern to RC5 code */ 161 static u32 bttv_rc5_decode(unsigned int code) 162 { 163 unsigned int org_code = code; 164 unsigned int pair; 165 unsigned int rc5 = 0; 166 int i; 167 168 for (i = 0; i < 14; ++i) { 169 pair = code & 0x3; 170 code >>= 2; 171 172 rc5 <<= 1; 173 switch (pair) { 174 case 0: 175 case 2: 176 break; 177 case 1: 178 rc5 |= 1; 179 break; 180 case 3: 181 dprintk("rc5_decode(%x) bad code\n", 182 org_code); 183 return 0; 184 } 185 } 186 dprintk("code=%x, rc5=%x, start=%x, toggle=%x, address=%x, instr=%x\n", 187 rc5, org_code, RC5_START(rc5), 188 RC5_TOGGLE(rc5), RC5_ADDR(rc5), RC5_INSTR(rc5)); 189 return rc5; 190 } 191 192 static void bttv_rc5_timer_end(struct timer_list *t) 193 { 194 struct bttv_ir *ir = from_timer(ir, t, timer); 195 ktime_t tv; 196 u32 gap, rc5, scancode; 197 u8 toggle, command, system; 198 199 /* get time */ 200 tv = ktime_get(); 201 202 gap = ktime_to_us(ktime_sub(tv, ir->base_time)); 203 /* avoid overflow with gap >1s */ 204 if (gap > USEC_PER_SEC) { 205 gap = 200000; 206 } 207 /* signal we're ready to start a new code */ 208 ir->active = false; 209 210 /* Allow some timer jitter (RC5 is ~24ms anyway so this is ok) */ 211 if (gap < 28000) { 212 dprintk("spurious timer_end\n"); 213 return; 214 } 215 216 if (ir->last_bit < 20) { 217 /* ignore spurious codes (caused by light/other remotes) */ 218 dprintk("short code: %x\n", ir->code); 219 return; 220 } 221 222 ir->code = (ir->code << ir->shift_by) | 1; 223 rc5 = bttv_rc5_decode(ir->code); 224 225 toggle = RC5_TOGGLE(rc5); 226 system = RC5_ADDR(rc5); 227 command = RC5_INSTR(rc5); 228 229 switch (RC5_START(rc5)) { 230 case 0x3: 231 break; 232 case 0x2: 233 command += 0x40; 234 break; 235 default: 236 return; 237 } 238 239 scancode = RC_SCANCODE_RC5(system, command); 240 rc_keydown(ir->dev, RC_PROTO_RC5, scancode, toggle); 241 dprintk("scancode %x, toggle %x\n", scancode, toggle); 242 } 243 244 static int bttv_rc5_irq(struct bttv *btv) 245 { 246 struct bttv_ir *ir = btv->remote; 247 ktime_t tv; 248 u32 gpio; 249 u32 gap; 250 unsigned long current_jiffies; 251 252 /* read gpio port */ 253 gpio = bttv_gpio_read(&btv->c); 254 255 /* get time of bit */ 256 current_jiffies = jiffies; 257 tv = ktime_get(); 258 259 gap = ktime_to_us(ktime_sub(tv, ir->base_time)); 260 /* avoid overflow with gap >1s */ 261 if (gap > USEC_PER_SEC) { 262 gap = 200000; 263 } 264 265 dprintk("RC5 IRQ: gap %d us for %s\n", 266 gap, (gpio & 0x20) ? "mark" : "space"); 267 268 /* remote IRQ? */ 269 if (!(gpio & 0x20)) 270 return 0; 271 272 /* active code => add bit */ 273 if (ir->active) { 274 /* only if in the code (otherwise spurious IRQ or timer 275 late) */ 276 if (ir->last_bit < 28) { 277 ir->last_bit = (gap - ir_rc5_remote_gap / 2) / 278 ir_rc5_remote_gap; 279 ir->code |= 1 << ir->last_bit; 280 } 281 /* starting new code */ 282 } else { 283 ir->active = true; 284 ir->code = 0; 285 ir->base_time = tv; 286 ir->last_bit = 0; 287 288 mod_timer(&ir->timer, current_jiffies + msecs_to_jiffies(30)); 289 } 290 291 /* toggle GPIO pin 4 to reset the irq */ 292 bttv_gpio_write(&btv->c, gpio & ~(1 << 4)); 293 bttv_gpio_write(&btv->c, gpio | (1 << 4)); 294 return 1; 295 } 296 297 /* ---------------------------------------------------------------------- */ 298 299 static void bttv_ir_start(struct bttv_ir *ir) 300 { 301 if (ir->polling) { 302 timer_setup(&ir->timer, bttv_input_timer, 0); 303 ir->timer.expires = jiffies + msecs_to_jiffies(1000); 304 add_timer(&ir->timer); 305 } else if (ir->rc5_gpio) { 306 /* set timer_end for code completion */ 307 timer_setup(&ir->timer, bttv_rc5_timer_end, 0); 308 ir->shift_by = 1; 309 ir->rc5_remote_gap = ir_rc5_remote_gap; 310 } 311 } 312 313 static void bttv_ir_stop(struct bttv *btv) 314 { 315 if (btv->remote->polling) 316 del_timer_sync(&btv->remote->timer); 317 318 if (btv->remote->rc5_gpio) { 319 u32 gpio; 320 321 del_timer_sync(&btv->remote->timer); 322 323 gpio = bttv_gpio_read(&btv->c); 324 bttv_gpio_write(&btv->c, gpio & ~(1 << 4)); 325 } 326 } 327 328 /* 329 * Get_key functions used by I2C remotes 330 */ 331 332 static int get_key_pv951(struct IR_i2c *ir, enum rc_proto *protocol, 333 u32 *scancode, u8 *toggle) 334 { 335 int rc; 336 unsigned char b; 337 338 /* poll IR chip */ 339 rc = i2c_master_recv(ir->c, &b, 1); 340 if (rc != 1) { 341 dprintk("read error\n"); 342 if (rc < 0) 343 return rc; 344 return -EIO; 345 } 346 347 /* ignore 0xaa */ 348 if (b==0xaa) 349 return 0; 350 dprintk("key %02x\n", b); 351 352 /* 353 * NOTE: 354 * lirc_i2c maps the pv951 code as: 355 * addr = 0x61D6 356 * cmd = bit_reverse (b) 357 * So, it seems that this device uses NEC extended 358 * I decided to not fix the table, due to two reasons: 359 * 1) Without the actual device, this is only a guess; 360 * 2) As the addr is not reported via I2C, nor can be changed, 361 * the device is bound to the vendor-provided RC. 362 */ 363 364 *protocol = RC_PROTO_UNKNOWN; 365 *scancode = b; 366 *toggle = 0; 367 return 1; 368 } 369 370 /* Instantiate the I2C IR receiver device, if present */ 371 void init_bttv_i2c_ir(struct bttv *btv) 372 { 373 const unsigned short addr_list[] = { 374 0x1a, 0x18, 0x64, 0x30, 0x71, 375 I2C_CLIENT_END 376 }; 377 struct i2c_board_info info; 378 struct i2c_client *i2c_dev; 379 380 if (0 != btv->i2c_rc) 381 return; 382 383 memset(&info, 0, sizeof(struct i2c_board_info)); 384 memset(&btv->init_data, 0, sizeof(btv->init_data)); 385 strlcpy(info.type, "ir_video", I2C_NAME_SIZE); 386 387 switch (btv->c.type) { 388 case BTTV_BOARD_PV951: 389 btv->init_data.name = "PV951"; 390 btv->init_data.get_key = get_key_pv951; 391 btv->init_data.ir_codes = RC_MAP_PV951; 392 info.addr = 0x4b; 393 break; 394 } 395 396 if (btv->init_data.name) { 397 info.platform_data = &btv->init_data; 398 i2c_dev = i2c_new_device(&btv->c.i2c_adap, &info); 399 } else { 400 /* 401 * The external IR receiver is at i2c address 0x34 (0x35 for 402 * reads). Future Hauppauge cards will have an internal 403 * receiver at 0x30 (0x31 for reads). In theory, both can be 404 * fitted, and Hauppauge suggest an external overrides an 405 * internal. 406 * That's why we probe 0x1a (~0x34) first. CB 407 */ 408 i2c_dev = i2c_new_probed_device(&btv->c.i2c_adap, &info, addr_list, NULL); 409 } 410 if (NULL == i2c_dev) 411 return; 412 413 #if defined(CONFIG_MODULES) && defined(MODULE) 414 request_module("ir-kbd-i2c"); 415 #endif 416 } 417 418 int bttv_input_init(struct bttv *btv) 419 { 420 struct bttv_ir *ir; 421 char *ir_codes = NULL; 422 struct rc_dev *rc; 423 int err = -ENOMEM; 424 425 if (!btv->has_remote) 426 return -ENODEV; 427 428 ir = kzalloc(sizeof(*ir),GFP_KERNEL); 429 rc = rc_allocate_device(RC_DRIVER_SCANCODE); 430 if (!ir || !rc) 431 goto err_out_free; 432 433 /* detect & configure */ 434 switch (btv->c.type) { 435 case BTTV_BOARD_AVERMEDIA: 436 case BTTV_BOARD_AVPHONE98: 437 case BTTV_BOARD_AVERMEDIA98: 438 ir_codes = RC_MAP_AVERMEDIA; 439 ir->mask_keycode = 0xf88000; 440 ir->mask_keydown = 0x010000; 441 ir->polling = 50; // ms 442 break; 443 444 case BTTV_BOARD_AVDVBT_761: 445 case BTTV_BOARD_AVDVBT_771: 446 ir_codes = RC_MAP_AVERMEDIA_DVBT; 447 ir->mask_keycode = 0x0f00c0; 448 ir->mask_keydown = 0x000020; 449 ir->polling = 50; // ms 450 break; 451 452 case BTTV_BOARD_PXELVWPLTVPAK: 453 ir_codes = RC_MAP_PIXELVIEW; 454 ir->mask_keycode = 0x003e00; 455 ir->mask_keyup = 0x010000; 456 ir->polling = 50; // ms 457 break; 458 case BTTV_BOARD_PV_M4900: 459 case BTTV_BOARD_PV_BT878P_9B: 460 case BTTV_BOARD_PV_BT878P_PLUS: 461 ir_codes = RC_MAP_PIXELVIEW; 462 ir->mask_keycode = 0x001f00; 463 ir->mask_keyup = 0x008000; 464 ir->polling = 50; // ms 465 break; 466 467 case BTTV_BOARD_WINFAST2000: 468 ir_codes = RC_MAP_WINFAST; 469 ir->mask_keycode = 0x1f8; 470 break; 471 case BTTV_BOARD_MAGICTVIEW061: 472 case BTTV_BOARD_MAGICTVIEW063: 473 ir_codes = RC_MAP_WINFAST; 474 ir->mask_keycode = 0x0008e000; 475 ir->mask_keydown = 0x00200000; 476 break; 477 case BTTV_BOARD_APAC_VIEWCOMP: 478 ir_codes = RC_MAP_APAC_VIEWCOMP; 479 ir->mask_keycode = 0x001f00; 480 ir->mask_keyup = 0x008000; 481 ir->polling = 50; // ms 482 break; 483 case BTTV_BOARD_ASKEY_CPH03X: 484 case BTTV_BOARD_CONCEPTRONIC_CTVFMI2: 485 case BTTV_BOARD_CONTVFMI: 486 case BTTV_BOARD_KWORLD_VSTREAM_XPERT: 487 ir_codes = RC_MAP_PIXELVIEW; 488 ir->mask_keycode = 0x001F00; 489 ir->mask_keyup = 0x006000; 490 ir->polling = 50; // ms 491 break; 492 case BTTV_BOARD_NEBULA_DIGITV: 493 ir_codes = RC_MAP_NEBULA; 494 ir->rc5_gpio = true; 495 break; 496 case BTTV_BOARD_MACHTV_MAGICTV: 497 ir_codes = RC_MAP_APAC_VIEWCOMP; 498 ir->mask_keycode = 0x001F00; 499 ir->mask_keyup = 0x004000; 500 ir->polling = 50; /* ms */ 501 break; 502 case BTTV_BOARD_KOZUMI_KTV_01C: 503 ir_codes = RC_MAP_PCTV_SEDNA; 504 ir->mask_keycode = 0x001f00; 505 ir->mask_keyup = 0x006000; 506 ir->polling = 50; /* ms */ 507 break; 508 case BTTV_BOARD_ENLTV_FM_2: 509 ir_codes = RC_MAP_ENCORE_ENLTV2; 510 ir->mask_keycode = 0x00fd00; 511 ir->mask_keyup = 0x000080; 512 ir->polling = 1; /* ms */ 513 ir->last_gpio = ir_extract_bits(bttv_gpio_read(&btv->c), 514 ir->mask_keycode); 515 break; 516 } 517 518 if (!ir_codes) { 519 dprintk("Ooops: IR config error [card=%d]\n", btv->c.type); 520 err = -ENODEV; 521 goto err_out_free; 522 } 523 524 if (ir->rc5_gpio) { 525 u32 gpio; 526 /* enable remote irq */ 527 bttv_gpio_inout(&btv->c, (1 << 4), 1 << 4); 528 gpio = bttv_gpio_read(&btv->c); 529 bttv_gpio_write(&btv->c, gpio & ~(1 << 4)); 530 bttv_gpio_write(&btv->c, gpio | (1 << 4)); 531 } else { 532 /* init hardware-specific stuff */ 533 bttv_gpio_inout(&btv->c, ir->mask_keycode | ir->mask_keydown, 0); 534 } 535 536 /* init input device */ 537 ir->dev = rc; 538 ir->btv = btv; 539 540 snprintf(ir->name, sizeof(ir->name), "bttv IR (card=%d)", 541 btv->c.type); 542 snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", 543 pci_name(btv->c.pci)); 544 545 rc->device_name = ir->name; 546 rc->input_phys = ir->phys; 547 rc->input_id.bustype = BUS_PCI; 548 rc->input_id.version = 1; 549 if (btv->c.pci->subsystem_vendor) { 550 rc->input_id.vendor = btv->c.pci->subsystem_vendor; 551 rc->input_id.product = btv->c.pci->subsystem_device; 552 } else { 553 rc->input_id.vendor = btv->c.pci->vendor; 554 rc->input_id.product = btv->c.pci->device; 555 } 556 rc->dev.parent = &btv->c.pci->dev; 557 rc->map_name = ir_codes; 558 rc->driver_name = MODULE_NAME; 559 560 btv->remote = ir; 561 bttv_ir_start(ir); 562 563 /* all done */ 564 err = rc_register_device(rc); 565 if (err) 566 goto err_out_stop; 567 568 return 0; 569 570 err_out_stop: 571 bttv_ir_stop(btv); 572 btv->remote = NULL; 573 err_out_free: 574 rc_free_device(rc); 575 kfree(ir); 576 return err; 577 } 578 579 void bttv_input_fini(struct bttv *btv) 580 { 581 if (btv->remote == NULL) 582 return; 583 584 bttv_ir_stop(btv); 585 rc_unregister_device(btv->remote->dev); 586 kfree(btv->remote); 587 btv->remote = NULL; 588 } 589