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