Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-btrfs-devel.git] / drivers / media / video / cx88 / cx88-input.c
blobe614201b5ed33b5994ec4528ece3574e7f90919d
1 /*
3 * Device driver for GPIO attached remote control interfaces
4 * on Conexant 2388x based TV/DVB cards.
6 * Copyright (c) 2003 Pavel Machek
7 * Copyright (c) 2004 Gerd Knorr
8 * Copyright (c) 2004, 2005 Chris Pascoe
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/init.h>
26 #include <linux/hrtimer.h>
27 #include <linux/pci.h>
28 #include <linux/slab.h>
29 #include <linux/module.h>
31 #include "cx88.h"
32 #include <media/rc-core.h>
34 #define MODULE_NAME "cx88xx"
36 /* ---------------------------------------------------------------------- */
38 struct cx88_IR {
39 struct cx88_core *core;
40 struct rc_dev *dev;
42 int users;
44 char name[32];
45 char phys[32];
47 /* sample from gpio pin 16 */
48 u32 sampling;
50 /* poll external decoder */
51 int polling;
52 struct hrtimer timer;
53 u32 gpio_addr;
54 u32 last_gpio;
55 u32 mask_keycode;
56 u32 mask_keydown;
57 u32 mask_keyup;
60 static unsigned ir_samplerate = 4;
61 module_param(ir_samplerate, uint, 0444);
62 MODULE_PARM_DESC(ir_samplerate, "IR samplerate in kHz, 1 - 20, default 4");
64 static int ir_debug;
65 module_param(ir_debug, int, 0644); /* debug level [IR] */
66 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
68 #define ir_dprintk(fmt, arg...) if (ir_debug) \
69 printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
71 #define dprintk(fmt, arg...) if (ir_debug) \
72 printk(KERN_DEBUG "cx88 IR: " fmt , ##arg)
74 /* ---------------------------------------------------------------------- */
76 static void cx88_ir_handle_key(struct cx88_IR *ir)
78 struct cx88_core *core = ir->core;
79 u32 gpio, data, auxgpio;
81 /* read gpio value */
82 gpio = cx_read(ir->gpio_addr);
83 switch (core->boardnr) {
84 case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
85 /* This board apparently uses a combination of 2 GPIO
86 to represent the keys. Additionally, the second GPIO
87 can be used for parity.
89 Example:
91 for key "5"
92 gpio = 0x758, auxgpio = 0xe5 or 0xf5
93 for key "Power"
94 gpio = 0x758, auxgpio = 0xed or 0xfd
97 auxgpio = cx_read(MO_GP1_IO);
98 /* Take out the parity part */
99 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
100 break;
101 case CX88_BOARD_WINFAST_DTV1000:
102 case CX88_BOARD_WINFAST_DTV1800H:
103 case CX88_BOARD_WINFAST_DTV1800H_XC4000:
104 case CX88_BOARD_WINFAST_DTV2000H_PLUS:
105 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
106 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
107 auxgpio = gpio;
108 break;
109 default:
110 auxgpio = gpio;
112 if (ir->polling) {
113 if (ir->last_gpio == auxgpio)
114 return;
115 ir->last_gpio = auxgpio;
118 /* extract data */
119 data = ir_extract_bits(gpio, ir->mask_keycode);
120 ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
121 gpio, data,
122 ir->polling ? "poll" : "irq",
123 (gpio & ir->mask_keydown) ? " down" : "",
124 (gpio & ir->mask_keyup) ? " up" : "");
126 if (ir->core->boardnr == CX88_BOARD_NORWOOD_MICRO) {
127 u32 gpio_key = cx_read(MO_GP0_IO);
129 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
131 rc_keydown(ir->dev, data, 0);
133 } else if (ir->mask_keydown) {
134 /* bit set on keydown */
135 if (gpio & ir->mask_keydown)
136 rc_keydown_notimeout(ir->dev, data, 0);
137 else
138 rc_keyup(ir->dev);
140 } else if (ir->mask_keyup) {
141 /* bit cleared on keydown */
142 if (0 == (gpio & ir->mask_keyup))
143 rc_keydown_notimeout(ir->dev, data, 0);
144 else
145 rc_keyup(ir->dev);
147 } else {
148 /* can't distinguish keydown/up :-/ */
149 rc_keydown_notimeout(ir->dev, data, 0);
150 rc_keyup(ir->dev);
154 static enum hrtimer_restart cx88_ir_work(struct hrtimer *timer)
156 unsigned long missed;
157 struct cx88_IR *ir = container_of(timer, struct cx88_IR, timer);
159 cx88_ir_handle_key(ir);
160 missed = hrtimer_forward_now(&ir->timer,
161 ktime_set(0, ir->polling * 1000000));
162 if (missed > 1)
163 ir_dprintk("Missed ticks %ld\n", missed - 1);
165 return HRTIMER_RESTART;
168 static int __cx88_ir_start(void *priv)
170 struct cx88_core *core = priv;
171 struct cx88_IR *ir;
173 if (!core || !core->ir)
174 return -EINVAL;
176 ir = core->ir;
178 if (ir->polling) {
179 hrtimer_init(&ir->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
180 ir->timer.function = cx88_ir_work;
181 hrtimer_start(&ir->timer,
182 ktime_set(0, ir->polling * 1000000),
183 HRTIMER_MODE_REL);
185 if (ir->sampling) {
186 core->pci_irqmask |= PCI_INT_IR_SMPINT;
187 cx_write(MO_DDS_IO, 0x33F286 * ir_samplerate); /* samplerate */
188 cx_write(MO_DDSCFG_IO, 0x5); /* enable */
190 return 0;
193 static void __cx88_ir_stop(void *priv)
195 struct cx88_core *core = priv;
196 struct cx88_IR *ir;
198 if (!core || !core->ir)
199 return;
201 ir = core->ir;
202 if (ir->sampling) {
203 cx_write(MO_DDSCFG_IO, 0x0);
204 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
207 if (ir->polling)
208 hrtimer_cancel(&ir->timer);
211 int cx88_ir_start(struct cx88_core *core)
213 if (core->ir->users)
214 return __cx88_ir_start(core);
216 return 0;
219 void cx88_ir_stop(struct cx88_core *core)
221 if (core->ir->users)
222 __cx88_ir_stop(core);
225 static int cx88_ir_open(struct rc_dev *rc)
227 struct cx88_core *core = rc->priv;
229 core->ir->users++;
230 return __cx88_ir_start(core);
233 static void cx88_ir_close(struct rc_dev *rc)
235 struct cx88_core *core = rc->priv;
237 core->ir->users--;
238 if (!core->ir->users)
239 __cx88_ir_stop(core);
242 /* ---------------------------------------------------------------------- */
244 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
246 struct cx88_IR *ir;
247 struct rc_dev *dev;
248 char *ir_codes = NULL;
249 u64 rc_type = RC_TYPE_OTHER;
250 int err = -ENOMEM;
251 u32 hardware_mask = 0; /* For devices with a hardware mask, when
252 * used with a full-code IR table
255 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
256 dev = rc_allocate_device();
257 if (!ir || !dev)
258 goto err_out_free;
260 ir->dev = dev;
262 /* detect & configure */
263 switch (core->boardnr) {
264 case CX88_BOARD_DNTV_LIVE_DVB_T:
265 case CX88_BOARD_KWORLD_DVB_T:
266 case CX88_BOARD_KWORLD_DVB_T_CX22702:
267 ir_codes = RC_MAP_DNTV_LIVE_DVB_T;
268 ir->gpio_addr = MO_GP1_IO;
269 ir->mask_keycode = 0x1f;
270 ir->mask_keyup = 0x60;
271 ir->polling = 50; /* ms */
272 break;
273 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
274 ir_codes = RC_MAP_CINERGY_1400;
275 ir->sampling = 0xeb04; /* address */
276 break;
277 case CX88_BOARD_HAUPPAUGE:
278 case CX88_BOARD_HAUPPAUGE_DVB_T1:
279 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
280 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
281 case CX88_BOARD_HAUPPAUGE_HVR1100:
282 case CX88_BOARD_HAUPPAUGE_HVR3000:
283 case CX88_BOARD_HAUPPAUGE_HVR4000:
284 case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
285 case CX88_BOARD_PCHDTV_HD3000:
286 case CX88_BOARD_PCHDTV_HD5500:
287 case CX88_BOARD_HAUPPAUGE_IRONLY:
288 ir_codes = RC_MAP_HAUPPAUGE;
289 ir->sampling = 1;
290 break;
291 case CX88_BOARD_WINFAST_DTV2000H:
292 case CX88_BOARD_WINFAST_DTV2000H_J:
293 case CX88_BOARD_WINFAST_DTV1800H:
294 case CX88_BOARD_WINFAST_DTV1800H_XC4000:
295 case CX88_BOARD_WINFAST_DTV2000H_PLUS:
296 ir_codes = RC_MAP_WINFAST;
297 ir->gpio_addr = MO_GP0_IO;
298 ir->mask_keycode = 0x8f8;
299 ir->mask_keyup = 0x100;
300 ir->polling = 50; /* ms */
301 break;
302 case CX88_BOARD_WINFAST2000XP_EXPERT:
303 case CX88_BOARD_WINFAST_DTV1000:
304 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
305 ir_codes = RC_MAP_WINFAST;
306 ir->gpio_addr = MO_GP0_IO;
307 ir->mask_keycode = 0x8f8;
308 ir->mask_keyup = 0x100;
309 ir->polling = 1; /* ms */
310 break;
311 case CX88_BOARD_IODATA_GVBCTV7E:
312 ir_codes = RC_MAP_IODATA_BCTV7E;
313 ir->gpio_addr = MO_GP0_IO;
314 ir->mask_keycode = 0xfd;
315 ir->mask_keydown = 0x02;
316 ir->polling = 5; /* ms */
317 break;
318 case CX88_BOARD_PROLINK_PLAYTVPVR:
319 case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
321 * It seems that this hardware is paired with NEC extended
322 * address 0x866b. So, unfortunately, its usage with other
323 * IR's with different address won't work. Still, there are
324 * other IR's from the same manufacturer that works, like the
325 * 002-T mini RC, provided with newer PV hardware
327 ir_codes = RC_MAP_PIXELVIEW_MK12;
328 ir->gpio_addr = MO_GP1_IO;
329 ir->mask_keyup = 0x80;
330 ir->polling = 10; /* ms */
331 hardware_mask = 0x3f; /* Hardware returns only 6 bits from command part */
332 break;
333 case CX88_BOARD_PROLINK_PV_8000GT:
334 case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
335 ir_codes = RC_MAP_PIXELVIEW_NEW;
336 ir->gpio_addr = MO_GP1_IO;
337 ir->mask_keycode = 0x3f;
338 ir->mask_keyup = 0x80;
339 ir->polling = 1; /* ms */
340 break;
341 case CX88_BOARD_KWORLD_LTV883:
342 ir_codes = RC_MAP_PIXELVIEW;
343 ir->gpio_addr = MO_GP1_IO;
344 ir->mask_keycode = 0x1f;
345 ir->mask_keyup = 0x60;
346 ir->polling = 1; /* ms */
347 break;
348 case CX88_BOARD_ADSTECH_DVB_T_PCI:
349 ir_codes = RC_MAP_ADSTECH_DVB_T_PCI;
350 ir->gpio_addr = MO_GP1_IO;
351 ir->mask_keycode = 0xbf;
352 ir->mask_keyup = 0x40;
353 ir->polling = 50; /* ms */
354 break;
355 case CX88_BOARD_MSI_TVANYWHERE_MASTER:
356 ir_codes = RC_MAP_MSI_TVANYWHERE;
357 ir->gpio_addr = MO_GP1_IO;
358 ir->mask_keycode = 0x1f;
359 ir->mask_keyup = 0x40;
360 ir->polling = 1; /* ms */
361 break;
362 case CX88_BOARD_AVERTV_303:
363 case CX88_BOARD_AVERTV_STUDIO_303:
364 ir_codes = RC_MAP_AVERTV_303;
365 ir->gpio_addr = MO_GP2_IO;
366 ir->mask_keycode = 0xfb;
367 ir->mask_keydown = 0x02;
368 ir->polling = 50; /* ms */
369 break;
370 case CX88_BOARD_OMICOM_SS4_PCI:
371 case CX88_BOARD_SATTRADE_ST4200:
372 case CX88_BOARD_TBS_8920:
373 case CX88_BOARD_TBS_8910:
374 case CX88_BOARD_PROF_7300:
375 case CX88_BOARD_PROF_7301:
376 case CX88_BOARD_PROF_6200:
377 ir_codes = RC_MAP_TBS_NEC;
378 ir->sampling = 0xff00; /* address */
379 break;
380 case CX88_BOARD_TEVII_S464:
381 case CX88_BOARD_TEVII_S460:
382 case CX88_BOARD_TEVII_S420:
383 ir_codes = RC_MAP_TEVII_NEC;
384 ir->sampling = 0xff00; /* address */
385 break;
386 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
387 ir_codes = RC_MAP_DNTV_LIVE_DVBT_PRO;
388 ir->sampling = 0xff00; /* address */
389 break;
390 case CX88_BOARD_NORWOOD_MICRO:
391 ir_codes = RC_MAP_NORWOOD;
392 ir->gpio_addr = MO_GP1_IO;
393 ir->mask_keycode = 0x0e;
394 ir->mask_keyup = 0x80;
395 ir->polling = 50; /* ms */
396 break;
397 case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
398 ir_codes = RC_MAP_NPGTECH;
399 ir->gpio_addr = MO_GP0_IO;
400 ir->mask_keycode = 0xfa;
401 ir->polling = 50; /* ms */
402 break;
403 case CX88_BOARD_PINNACLE_PCTV_HD_800i:
404 ir_codes = RC_MAP_PINNACLE_PCTV_HD;
405 ir->sampling = 1;
406 break;
407 case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
408 ir_codes = RC_MAP_POWERCOLOR_REAL_ANGEL;
409 ir->gpio_addr = MO_GP2_IO;
410 ir->mask_keycode = 0x7e;
411 ir->polling = 100; /* ms */
412 break;
413 case CX88_BOARD_TWINHAN_VP1027_DVBS:
414 ir_codes = RC_MAP_TWINHAN_VP1027_DVBS;
415 rc_type = RC_TYPE_NEC;
416 ir->sampling = 0xff00; /* address */
417 break;
420 if (!ir_codes) {
421 err = -ENODEV;
422 goto err_out_free;
426 * The usage of mask_keycode were very convenient, due to several
427 * reasons. Among others, the scancode tables were using the scancode
428 * as the index elements. So, the less bits it was used, the smaller
429 * the table were stored. After the input changes, the better is to use
430 * the full scancodes, since it allows replacing the IR remote by
431 * another one. Unfortunately, there are still some hardware, like
432 * Pixelview Ultra Pro, where only part of the scancode is sent via
433 * GPIO. So, there's no way to get the full scancode. Due to that,
434 * hardware_mask were introduced here: it represents those hardware
435 * that has such limits.
437 if (hardware_mask && !ir->mask_keycode)
438 ir->mask_keycode = hardware_mask;
440 /* init input device */
441 snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
442 snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
444 dev->input_name = ir->name;
445 dev->input_phys = ir->phys;
446 dev->input_id.bustype = BUS_PCI;
447 dev->input_id.version = 1;
448 if (pci->subsystem_vendor) {
449 dev->input_id.vendor = pci->subsystem_vendor;
450 dev->input_id.product = pci->subsystem_device;
451 } else {
452 dev->input_id.vendor = pci->vendor;
453 dev->input_id.product = pci->device;
455 dev->dev.parent = &pci->dev;
456 dev->map_name = ir_codes;
457 dev->driver_name = MODULE_NAME;
458 dev->priv = core;
459 dev->open = cx88_ir_open;
460 dev->close = cx88_ir_close;
461 dev->scanmask = hardware_mask;
463 if (ir->sampling) {
464 dev->driver_type = RC_DRIVER_IR_RAW;
465 dev->timeout = 10 * 1000 * 1000; /* 10 ms */
466 } else {
467 dev->driver_type = RC_DRIVER_SCANCODE;
468 dev->allowed_protos = rc_type;
471 ir->core = core;
472 core->ir = ir;
474 /* all done */
475 err = rc_register_device(dev);
476 if (err)
477 goto err_out_free;
479 return 0;
481 err_out_free:
482 rc_free_device(dev);
483 core->ir = NULL;
484 kfree(ir);
485 return err;
488 int cx88_ir_fini(struct cx88_core *core)
490 struct cx88_IR *ir = core->ir;
492 /* skip detach on non attached boards */
493 if (NULL == ir)
494 return 0;
496 cx88_ir_stop(core);
497 rc_unregister_device(ir->dev);
498 kfree(ir);
500 /* done */
501 core->ir = NULL;
502 return 0;
505 /* ---------------------------------------------------------------------- */
507 void cx88_ir_irq(struct cx88_core *core)
509 struct cx88_IR *ir = core->ir;
510 u32 samples;
511 unsigned todo, bits;
512 struct ir_raw_event ev;
514 if (!ir || !ir->sampling)
515 return;
518 * Samples are stored in a 32 bit register, oldest sample in
519 * the msb. A set bit represents space and an unset bit
520 * represents a pulse.
522 samples = cx_read(MO_SAMPLE_IO);
524 if (samples == 0xff && ir->dev->idle)
525 return;
527 init_ir_raw_event(&ev);
528 for (todo = 32; todo > 0; todo -= bits) {
529 ev.pulse = samples & 0x80000000 ? false : true;
530 bits = min(todo, 32U - fls(ev.pulse ? samples : ~samples));
531 ev.duration = (bits * (NSEC_PER_SEC / 1000)) / ir_samplerate;
532 ir_raw_event_store_with_filter(ir->dev, &ev);
533 samples <<= bits;
535 ir_raw_event_handle(ir->dev);
538 static int get_key_pvr2000(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
540 int flags, code;
542 /* poll IR chip */
543 flags = i2c_smbus_read_byte_data(ir->c, 0x10);
544 if (flags < 0) {
545 dprintk("read error\n");
546 return 0;
548 /* key pressed ? */
549 if (0 == (flags & 0x80))
550 return 0;
552 /* read actual key code */
553 code = i2c_smbus_read_byte_data(ir->c, 0x00);
554 if (code < 0) {
555 dprintk("read error\n");
556 return 0;
559 dprintk("IR Key/Flags: (0x%02x/0x%02x)\n",
560 code & 0xff, flags & 0xff);
562 *ir_key = code & 0xff;
563 *ir_raw = code;
564 return 1;
567 void cx88_i2c_init_ir(struct cx88_core *core)
569 struct i2c_board_info info;
570 const unsigned short default_addr_list[] = {
571 0x18, 0x6b, 0x71,
572 I2C_CLIENT_END
574 const unsigned short pvr2000_addr_list[] = {
575 0x18, 0x1a,
576 I2C_CLIENT_END
578 const unsigned short *addr_list = default_addr_list;
579 const unsigned short *addrp;
580 /* Instantiate the IR receiver device, if present */
581 if (0 != core->i2c_rc)
582 return;
584 memset(&info, 0, sizeof(struct i2c_board_info));
585 strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
587 switch (core->boardnr) {
588 case CX88_BOARD_LEADTEK_PVR2000:
589 addr_list = pvr2000_addr_list;
590 core->init_data.name = "cx88 Leadtek PVR 2000 remote";
591 core->init_data.type = RC_TYPE_UNKNOWN;
592 core->init_data.get_key = get_key_pvr2000;
593 core->init_data.ir_codes = RC_MAP_EMPTY;
594 break;
598 * We can't call i2c_new_probed_device() because it uses
599 * quick writes for probing and at least some RC receiver
600 * devices only reply to reads.
601 * Also, Hauppauge XVR needs to be specified, as address 0x71
602 * conflicts with another remote type used with saa7134
604 for (addrp = addr_list; *addrp != I2C_CLIENT_END; addrp++) {
605 info.platform_data = NULL;
606 memset(&core->init_data, 0, sizeof(core->init_data));
608 if (*addrp == 0x71) {
609 /* Hauppauge XVR */
610 core->init_data.name = "cx88 Hauppauge XVR remote";
611 core->init_data.ir_codes = RC_MAP_HAUPPAUGE;
612 core->init_data.type = RC_TYPE_RC5;
613 core->init_data.internal_get_key_func = IR_KBD_GET_KEY_HAUP_XVR;
615 info.platform_data = &core->init_data;
617 if (i2c_smbus_xfer(&core->i2c_adap, *addrp, 0,
618 I2C_SMBUS_READ, 0,
619 I2C_SMBUS_QUICK, NULL) >= 0) {
620 info.addr = *addrp;
621 i2c_new_device(&core->i2c_adap, &info);
622 break;
627 /* ---------------------------------------------------------------------- */
629 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
630 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
631 MODULE_LICENSE("GPL");