sfc: Don't use enums as a bitmask.
[zen-stable.git] / drivers / media / video / cx88 / cx88-input.c
blobc820e2f53527333b6fe7a42961776deadb15c45a
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_TV2000_XP_GLOBAL:
104 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
105 auxgpio = gpio;
106 break;
107 default:
108 auxgpio = gpio;
110 if (ir->polling) {
111 if (ir->last_gpio == auxgpio)
112 return;
113 ir->last_gpio = auxgpio;
116 /* extract data */
117 data = ir_extract_bits(gpio, ir->mask_keycode);
118 ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
119 gpio, data,
120 ir->polling ? "poll" : "irq",
121 (gpio & ir->mask_keydown) ? " down" : "",
122 (gpio & ir->mask_keyup) ? " up" : "");
124 if (ir->core->boardnr == CX88_BOARD_NORWOOD_MICRO) {
125 u32 gpio_key = cx_read(MO_GP0_IO);
127 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
129 rc_keydown(ir->dev, data, 0);
131 } else if (ir->mask_keydown) {
132 /* bit set on keydown */
133 if (gpio & ir->mask_keydown)
134 rc_keydown_notimeout(ir->dev, data, 0);
135 else
136 rc_keyup(ir->dev);
138 } else if (ir->mask_keyup) {
139 /* bit cleared on keydown */
140 if (0 == (gpio & ir->mask_keyup))
141 rc_keydown_notimeout(ir->dev, data, 0);
142 else
143 rc_keyup(ir->dev);
145 } else {
146 /* can't distinguish keydown/up :-/ */
147 rc_keydown_notimeout(ir->dev, data, 0);
148 rc_keyup(ir->dev);
152 static enum hrtimer_restart cx88_ir_work(struct hrtimer *timer)
154 unsigned long missed;
155 struct cx88_IR *ir = container_of(timer, struct cx88_IR, timer);
157 cx88_ir_handle_key(ir);
158 missed = hrtimer_forward_now(&ir->timer,
159 ktime_set(0, ir->polling * 1000000));
160 if (missed > 1)
161 ir_dprintk("Missed ticks %ld\n", missed - 1);
163 return HRTIMER_RESTART;
166 static int __cx88_ir_start(void *priv)
168 struct cx88_core *core = priv;
169 struct cx88_IR *ir;
171 if (!core || !core->ir)
172 return -EINVAL;
174 ir = core->ir;
176 if (ir->polling) {
177 hrtimer_init(&ir->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
178 ir->timer.function = cx88_ir_work;
179 hrtimer_start(&ir->timer,
180 ktime_set(0, ir->polling * 1000000),
181 HRTIMER_MODE_REL);
183 if (ir->sampling) {
184 core->pci_irqmask |= PCI_INT_IR_SMPINT;
185 cx_write(MO_DDS_IO, 0x33F286 * ir_samplerate); /* samplerate */
186 cx_write(MO_DDSCFG_IO, 0x5); /* enable */
188 return 0;
191 static void __cx88_ir_stop(void *priv)
193 struct cx88_core *core = priv;
194 struct cx88_IR *ir;
196 if (!core || !core->ir)
197 return;
199 ir = core->ir;
200 if (ir->sampling) {
201 cx_write(MO_DDSCFG_IO, 0x0);
202 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
205 if (ir->polling)
206 hrtimer_cancel(&ir->timer);
209 int cx88_ir_start(struct cx88_core *core)
211 if (core->ir->users)
212 return __cx88_ir_start(core);
214 return 0;
217 void cx88_ir_stop(struct cx88_core *core)
219 if (core->ir->users)
220 __cx88_ir_stop(core);
223 static int cx88_ir_open(struct rc_dev *rc)
225 struct cx88_core *core = rc->priv;
227 core->ir->users++;
228 return __cx88_ir_start(core);
231 static void cx88_ir_close(struct rc_dev *rc)
233 struct cx88_core *core = rc->priv;
235 core->ir->users--;
236 if (!core->ir->users)
237 __cx88_ir_stop(core);
240 /* ---------------------------------------------------------------------- */
242 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
244 struct cx88_IR *ir;
245 struct rc_dev *dev;
246 char *ir_codes = NULL;
247 u64 rc_type = RC_TYPE_OTHER;
248 int err = -ENOMEM;
249 u32 hardware_mask = 0; /* For devices with a hardware mask, when
250 * used with a full-code IR table
253 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
254 dev = rc_allocate_device();
255 if (!ir || !dev)
256 goto err_out_free;
258 ir->dev = dev;
260 /* detect & configure */
261 switch (core->boardnr) {
262 case CX88_BOARD_DNTV_LIVE_DVB_T:
263 case CX88_BOARD_KWORLD_DVB_T:
264 case CX88_BOARD_KWORLD_DVB_T_CX22702:
265 ir_codes = RC_MAP_DNTV_LIVE_DVB_T;
266 ir->gpio_addr = MO_GP1_IO;
267 ir->mask_keycode = 0x1f;
268 ir->mask_keyup = 0x60;
269 ir->polling = 50; /* ms */
270 break;
271 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
272 ir_codes = RC_MAP_CINERGY_1400;
273 ir->sampling = 0xeb04; /* address */
274 break;
275 case CX88_BOARD_HAUPPAUGE:
276 case CX88_BOARD_HAUPPAUGE_DVB_T1:
277 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
278 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
279 case CX88_BOARD_HAUPPAUGE_HVR1100:
280 case CX88_BOARD_HAUPPAUGE_HVR3000:
281 case CX88_BOARD_HAUPPAUGE_HVR4000:
282 case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
283 case CX88_BOARD_PCHDTV_HD3000:
284 case CX88_BOARD_PCHDTV_HD5500:
285 case CX88_BOARD_HAUPPAUGE_IRONLY:
286 ir_codes = RC_MAP_HAUPPAUGE;
287 ir->sampling = 1;
288 break;
289 case CX88_BOARD_WINFAST_DTV2000H:
290 case CX88_BOARD_WINFAST_DTV2000H_J:
291 case CX88_BOARD_WINFAST_DTV1800H:
292 ir_codes = RC_MAP_WINFAST;
293 ir->gpio_addr = MO_GP0_IO;
294 ir->mask_keycode = 0x8f8;
295 ir->mask_keyup = 0x100;
296 ir->polling = 50; /* ms */
297 break;
298 case CX88_BOARD_WINFAST2000XP_EXPERT:
299 case CX88_BOARD_WINFAST_DTV1000:
300 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
301 ir_codes = RC_MAP_WINFAST;
302 ir->gpio_addr = MO_GP0_IO;
303 ir->mask_keycode = 0x8f8;
304 ir->mask_keyup = 0x100;
305 ir->polling = 1; /* ms */
306 break;
307 case CX88_BOARD_IODATA_GVBCTV7E:
308 ir_codes = RC_MAP_IODATA_BCTV7E;
309 ir->gpio_addr = MO_GP0_IO;
310 ir->mask_keycode = 0xfd;
311 ir->mask_keydown = 0x02;
312 ir->polling = 5; /* ms */
313 break;
314 case CX88_BOARD_PROLINK_PLAYTVPVR:
315 case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
317 * It seems that this hardware is paired with NEC extended
318 * address 0x866b. So, unfortunately, its usage with other
319 * IR's with different address won't work. Still, there are
320 * other IR's from the same manufacturer that works, like the
321 * 002-T mini RC, provided with newer PV hardware
323 ir_codes = RC_MAP_PIXELVIEW_MK12;
324 ir->gpio_addr = MO_GP1_IO;
325 ir->mask_keyup = 0x80;
326 ir->polling = 10; /* ms */
327 hardware_mask = 0x3f; /* Hardware returns only 6 bits from command part */
328 break;
329 case CX88_BOARD_PROLINK_PV_8000GT:
330 case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
331 ir_codes = RC_MAP_PIXELVIEW_NEW;
332 ir->gpio_addr = MO_GP1_IO;
333 ir->mask_keycode = 0x3f;
334 ir->mask_keyup = 0x80;
335 ir->polling = 1; /* ms */
336 break;
337 case CX88_BOARD_KWORLD_LTV883:
338 ir_codes = RC_MAP_PIXELVIEW;
339 ir->gpio_addr = MO_GP1_IO;
340 ir->mask_keycode = 0x1f;
341 ir->mask_keyup = 0x60;
342 ir->polling = 1; /* ms */
343 break;
344 case CX88_BOARD_ADSTECH_DVB_T_PCI:
345 ir_codes = RC_MAP_ADSTECH_DVB_T_PCI;
346 ir->gpio_addr = MO_GP1_IO;
347 ir->mask_keycode = 0xbf;
348 ir->mask_keyup = 0x40;
349 ir->polling = 50; /* ms */
350 break;
351 case CX88_BOARD_MSI_TVANYWHERE_MASTER:
352 ir_codes = RC_MAP_MSI_TVANYWHERE;
353 ir->gpio_addr = MO_GP1_IO;
354 ir->mask_keycode = 0x1f;
355 ir->mask_keyup = 0x40;
356 ir->polling = 1; /* ms */
357 break;
358 case CX88_BOARD_AVERTV_303:
359 case CX88_BOARD_AVERTV_STUDIO_303:
360 ir_codes = RC_MAP_AVERTV_303;
361 ir->gpio_addr = MO_GP2_IO;
362 ir->mask_keycode = 0xfb;
363 ir->mask_keydown = 0x02;
364 ir->polling = 50; /* ms */
365 break;
366 case CX88_BOARD_OMICOM_SS4_PCI:
367 case CX88_BOARD_SATTRADE_ST4200:
368 case CX88_BOARD_TBS_8920:
369 case CX88_BOARD_TBS_8910:
370 case CX88_BOARD_PROF_7300:
371 case CX88_BOARD_PROF_7301:
372 case CX88_BOARD_PROF_6200:
373 ir_codes = RC_MAP_TBS_NEC;
374 ir->sampling = 0xff00; /* address */
375 break;
376 case CX88_BOARD_TEVII_S464:
377 case CX88_BOARD_TEVII_S460:
378 case CX88_BOARD_TEVII_S420:
379 ir_codes = RC_MAP_TEVII_NEC;
380 ir->sampling = 0xff00; /* address */
381 break;
382 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
383 ir_codes = RC_MAP_DNTV_LIVE_DVBT_PRO;
384 ir->sampling = 0xff00; /* address */
385 break;
386 case CX88_BOARD_NORWOOD_MICRO:
387 ir_codes = RC_MAP_NORWOOD;
388 ir->gpio_addr = MO_GP1_IO;
389 ir->mask_keycode = 0x0e;
390 ir->mask_keyup = 0x80;
391 ir->polling = 50; /* ms */
392 break;
393 case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
394 ir_codes = RC_MAP_NPGTECH;
395 ir->gpio_addr = MO_GP0_IO;
396 ir->mask_keycode = 0xfa;
397 ir->polling = 50; /* ms */
398 break;
399 case CX88_BOARD_PINNACLE_PCTV_HD_800i:
400 ir_codes = RC_MAP_PINNACLE_PCTV_HD;
401 ir->sampling = 1;
402 break;
403 case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
404 ir_codes = RC_MAP_POWERCOLOR_REAL_ANGEL;
405 ir->gpio_addr = MO_GP2_IO;
406 ir->mask_keycode = 0x7e;
407 ir->polling = 100; /* ms */
408 break;
409 case CX88_BOARD_TWINHAN_VP1027_DVBS:
410 ir_codes = RC_MAP_TWINHAN_VP1027_DVBS;
411 rc_type = RC_TYPE_NEC;
412 ir->sampling = 0xff00; /* address */
413 break;
416 if (!ir_codes) {
417 err = -ENODEV;
418 goto err_out_free;
422 * The usage of mask_keycode were very convenient, due to several
423 * reasons. Among others, the scancode tables were using the scancode
424 * as the index elements. So, the less bits it was used, the smaller
425 * the table were stored. After the input changes, the better is to use
426 * the full scancodes, since it allows replacing the IR remote by
427 * another one. Unfortunately, there are still some hardware, like
428 * Pixelview Ultra Pro, where only part of the scancode is sent via
429 * GPIO. So, there's no way to get the full scancode. Due to that,
430 * hardware_mask were introduced here: it represents those hardware
431 * that has such limits.
433 if (hardware_mask && !ir->mask_keycode)
434 ir->mask_keycode = hardware_mask;
436 /* init input device */
437 snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
438 snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
440 dev->input_name = ir->name;
441 dev->input_phys = ir->phys;
442 dev->input_id.bustype = BUS_PCI;
443 dev->input_id.version = 1;
444 if (pci->subsystem_vendor) {
445 dev->input_id.vendor = pci->subsystem_vendor;
446 dev->input_id.product = pci->subsystem_device;
447 } else {
448 dev->input_id.vendor = pci->vendor;
449 dev->input_id.product = pci->device;
451 dev->dev.parent = &pci->dev;
452 dev->map_name = ir_codes;
453 dev->driver_name = MODULE_NAME;
454 dev->priv = core;
455 dev->open = cx88_ir_open;
456 dev->close = cx88_ir_close;
457 dev->scanmask = hardware_mask;
459 if (ir->sampling) {
460 dev->driver_type = RC_DRIVER_IR_RAW;
461 dev->timeout = 10 * 1000 * 1000; /* 10 ms */
462 } else {
463 dev->driver_type = RC_DRIVER_SCANCODE;
464 dev->allowed_protos = rc_type;
467 ir->core = core;
468 core->ir = ir;
470 /* all done */
471 err = rc_register_device(dev);
472 if (err)
473 goto err_out_free;
475 return 0;
477 err_out_free:
478 rc_free_device(dev);
479 core->ir = NULL;
480 kfree(ir);
481 return err;
484 int cx88_ir_fini(struct cx88_core *core)
486 struct cx88_IR *ir = core->ir;
488 /* skip detach on non attached boards */
489 if (NULL == ir)
490 return 0;
492 cx88_ir_stop(core);
493 rc_unregister_device(ir->dev);
494 kfree(ir);
496 /* done */
497 core->ir = NULL;
498 return 0;
501 /* ---------------------------------------------------------------------- */
503 void cx88_ir_irq(struct cx88_core *core)
505 struct cx88_IR *ir = core->ir;
506 u32 samples;
507 unsigned todo, bits;
508 struct ir_raw_event ev;
510 if (!ir || !ir->sampling)
511 return;
514 * Samples are stored in a 32 bit register, oldest sample in
515 * the msb. A set bit represents space and an unset bit
516 * represents a pulse.
518 samples = cx_read(MO_SAMPLE_IO);
520 if (samples == 0xff && ir->dev->idle)
521 return;
523 init_ir_raw_event(&ev);
524 for (todo = 32; todo > 0; todo -= bits) {
525 ev.pulse = samples & 0x80000000 ? false : true;
526 bits = min(todo, 32U - fls(ev.pulse ? samples : ~samples));
527 ev.duration = (bits * NSEC_PER_SEC) / (1000 * ir_samplerate);
528 ir_raw_event_store_with_filter(ir->dev, &ev);
529 samples <<= bits;
531 ir_raw_event_handle(ir->dev);
534 static int get_key_pvr2000(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
536 int flags, code;
538 /* poll IR chip */
539 flags = i2c_smbus_read_byte_data(ir->c, 0x10);
540 if (flags < 0) {
541 dprintk("read error\n");
542 return 0;
544 /* key pressed ? */
545 if (0 == (flags & 0x80))
546 return 0;
548 /* read actual key code */
549 code = i2c_smbus_read_byte_data(ir->c, 0x00);
550 if (code < 0) {
551 dprintk("read error\n");
552 return 0;
555 dprintk("IR Key/Flags: (0x%02x/0x%02x)\n",
556 code & 0xff, flags & 0xff);
558 *ir_key = code & 0xff;
559 *ir_raw = code;
560 return 1;
563 void cx88_i2c_init_ir(struct cx88_core *core)
565 struct i2c_board_info info;
566 const unsigned short default_addr_list[] = {
567 0x18, 0x6b, 0x71,
568 I2C_CLIENT_END
570 const unsigned short pvr2000_addr_list[] = {
571 0x18, 0x1a,
572 I2C_CLIENT_END
574 const unsigned short *addr_list = default_addr_list;
575 const unsigned short *addrp;
576 /* Instantiate the IR receiver device, if present */
577 if (0 != core->i2c_rc)
578 return;
580 memset(&info, 0, sizeof(struct i2c_board_info));
581 strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
583 switch (core->boardnr) {
584 case CX88_BOARD_LEADTEK_PVR2000:
585 addr_list = pvr2000_addr_list;
586 core->init_data.name = "cx88 Leadtek PVR 2000 remote";
587 core->init_data.type = RC_TYPE_UNKNOWN;
588 core->init_data.get_key = get_key_pvr2000;
589 core->init_data.ir_codes = RC_MAP_EMPTY;
590 break;
594 * We can't call i2c_new_probed_device() because it uses
595 * quick writes for probing and at least some RC receiver
596 * devices only reply to reads.
597 * Also, Hauppauge XVR needs to be specified, as address 0x71
598 * conflicts with another remote type used with saa7134
600 for (addrp = addr_list; *addrp != I2C_CLIENT_END; addrp++) {
601 info.platform_data = NULL;
602 memset(&core->init_data, 0, sizeof(core->init_data));
604 if (*addrp == 0x71) {
605 /* Hauppauge XVR */
606 core->init_data.name = "cx88 Hauppauge XVR remote";
607 core->init_data.ir_codes = RC_MAP_HAUPPAUGE;
608 core->init_data.type = RC_TYPE_RC5;
609 core->init_data.internal_get_key_func = IR_KBD_GET_KEY_HAUP_XVR;
611 info.platform_data = &core->init_data;
613 if (i2c_smbus_xfer(&core->i2c_adap, *addrp, 0,
614 I2C_SMBUS_READ, 0,
615 I2C_SMBUS_QUICK, NULL) >= 0) {
616 info.addr = *addrp;
617 i2c_new_device(&core->i2c_adap, &info);
618 break;
623 /* ---------------------------------------------------------------------- */
625 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
626 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
627 MODULE_LICENSE("GPL");