drivers/media/video/cx88/cx88-input.c

   1 /*
   2  *
   3  * Device driver for GPIO attached remote control interfaces
   4  * on Conexant 2388x based TV/DVB cards.
   5  *
   6  * Copyright (c) 2003 Pavel Machek
   7  * Copyright (c) 2004 Gerd Knorr
   8  * Copyright (c) 2004, 2005 Chris Pascoe
   9  *
  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.
  14  *
  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.
  19  *
  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
  23  */
  24
  25 #include <linux/init.h>
  26 #include <linux/delay.h>
  27 #include <linux/input.h>
  28 #include <linux/pci.h>
  29 #include <linux/module.h>
  30 #include <linux/moduleparam.h>
  31
  32 #include "cx88.h"
  33 #include <media/ir-common.h>
  34
  35 /* ---------------------------------------------------------------------- */
  36
  37 struct cx88_IR {
  38         struct cx88_core *core;
  39         struct input_dev *input;
  40         struct ir_input_state ir;
  41         char name[32];
  42         char phys[32];
  43
  44         /* sample from gpio pin 16 */
  45         u32 sampling;
  46         u32 samples[16];
  47         int scount;
  48         unsigned long release;
  49
  50         /* poll external decoder */
  51         int polling;
  52         struct work_struct work;
  53         struct timer_list timer;
  54         u32 gpio_addr;
  55         u32 last_gpio;
  56         u32 mask_keycode;
  57         u32 mask_keydown;
  58         u32 mask_keyup;
  59 };
  60
  61 static int ir_debug = 0;
  62 module_param(ir_debug, int, 0644);      /* debug level [IR] */
  63 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
  64
  65 #define ir_dprintk(fmt, arg...) if (ir_debug) \
  66         printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
  67
  68 /* ---------------------------------------------------------------------- */
  69
  70 static void cx88_ir_handle_key(struct cx88_IR *ir)
  71 {
  72         struct cx88_core *core = ir->core;
  73         u32 gpio, data, auxgpio;
  74
  75         /* read gpio value */
  76         gpio = cx_read(ir->gpio_addr);
  77         switch (core->board) {
  78         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
  79                 /* This board apparently uses a combination of 2 GPIO
  80                    to represent the keys. Additionally, the second GPIO
  81                    can be used for parity.
  82
  83                    Example:
  84
  85                    for key "5"
  86                         gpio = 0x758, auxgpio = 0xe5 or 0xf5
  87                    for key "Power"
  88                         gpio = 0x758, auxgpio = 0xed or 0xfd
  89                  */
  90
  91                 auxgpio = cx_read(MO_GP1_IO);
  92                 /* Take out the parity part */
  93                 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
  94                 break;
  95         case CX88_BOARD_WINFAST_DTV1000:
  96                 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
  97                 auxgpio = gpio;
  98                 break;
  99         default:
 100                 auxgpio = gpio;
 101         }
 102         if (ir->polling) {
 103                 if (ir->last_gpio == auxgpio)
 104                         return;
 105                 ir->last_gpio = auxgpio;
 106         }
 107
 108         /* extract data */
 109         data = ir_extract_bits(gpio, ir->mask_keycode);
 110         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
 111                    gpio, data,
 112                    ir->polling ? "poll" : "irq",
 113                    (gpio & ir->mask_keydown) ? " down" : "",
 114                    (gpio & ir->mask_keyup) ? " up" : "");
 115
 116         if (ir->core->board == CX88_BOARD_NORWOOD_MICRO) {
 117                 u32 gpio_key = cx_read(MO_GP0_IO);
 118
 119                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
 120
 121                 ir_input_keydown(ir->input, &ir->ir, data, data);
 122                 ir_input_nokey(ir->input, &ir->ir);
 123
 124         } else if (ir->mask_keydown) {
 125                 /* bit set on keydown */
 126                 if (gpio & ir->mask_keydown) {
 127                         ir_input_keydown(ir->input, &ir->ir, data, data);
 128                 } else {
 129                         ir_input_nokey(ir->input, &ir->ir);
 130                 }
 131
 132         } else if (ir->mask_keyup) {
 133                 /* bit cleared on keydown */
 134                 if (0 == (gpio & ir->mask_keyup)) {
 135                         ir_input_keydown(ir->input, &ir->ir, data, data);
 136                 } else {
 137                         ir_input_nokey(ir->input, &ir->ir);
 138                 }
 139
 140         } else {
 141                 /* can't distinguish keydown/up :-/ */
 142                 ir_input_keydown(ir->input, &ir->ir, data, data);
 143                 ir_input_nokey(ir->input, &ir->ir);
 144         }
 145 }
 146
 147 static void ir_timer(unsigned long data)
 148 {
 149         struct cx88_IR *ir = (struct cx88_IR *)data;
 150
 151         schedule_work(&ir->work);
 152 }
 153
 154 static void cx88_ir_work(struct work_struct *work)
 155 {
 156         struct cx88_IR *ir = container_of(work, struct cx88_IR, work);
 157
 158         cx88_ir_handle_key(ir);
 159         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
 160 }
 161
 162 static void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
 163 {
 164         if (ir->polling) {
 165                 setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
 166                 INIT_WORK(&ir->work, cx88_ir_work);
 167                 schedule_work(&ir->work);
 168         }
 169         if (ir->sampling) {
 170                 core->pci_irqmask |= (1 << 18); /* IR_SMP_INT */
 171                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
 172                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
 173         }
 174 }
 175
 176 static void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
 177 {
 178         if (ir->sampling) {
 179                 cx_write(MO_DDSCFG_IO, 0x0);
 180                 core->pci_irqmask &= ~(1 << 18);
 181         }
 182
 183         if (ir->polling) {
 184                 del_timer_sync(&ir->timer);
 185                 flush_scheduled_work();
 186         }
 187 }
 188
 189 /* ---------------------------------------------------------------------- */
 190
 191 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
 192 {
 193         struct cx88_IR *ir;
 194         struct input_dev *input_dev;
 195         IR_KEYTAB_TYPE *ir_codes = NULL;
 196         int ir_type = IR_TYPE_OTHER;
 197         int err = -ENOMEM;
 198
 199         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 200         input_dev = input_allocate_device();
 201         if (!ir || !input_dev)
 202                 goto err_out_free;
 203
 204         ir->input = input_dev;
 205
 206         /* detect & configure */
 207         switch (core->board) {
 208         case CX88_BOARD_DNTV_LIVE_DVB_T:
 209         case CX88_BOARD_KWORLD_DVB_T:
 210         case CX88_BOARD_KWORLD_DVB_T_CX22702:
 211                 ir_codes = ir_codes_dntv_live_dvb_t;
 212                 ir->gpio_addr = MO_GP1_IO;
 213                 ir->mask_keycode = 0x1f;
 214                 ir->mask_keyup = 0x60;
 215                 ir->polling = 50; /* ms */
 216                 break;
 217         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 218                 ir_codes = ir_codes_cinergy_1400;
 219                 ir_type = IR_TYPE_PD;
 220                 ir->sampling = 0xeb04; /* address */
 221                 break;
 222         case CX88_BOARD_HAUPPAUGE:
 223         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 224         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 225         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 226         case CX88_BOARD_HAUPPAUGE_HVR1100:
 227         case CX88_BOARD_HAUPPAUGE_HVR3000:
 228                 ir_codes = ir_codes_hauppauge_new;
 229                 ir_type = IR_TYPE_RC5;
 230                 ir->sampling = 1;
 231                 break;
 232         case CX88_BOARD_WINFAST_DTV2000H:
 233                 ir_codes = ir_codes_winfast;
 234                 ir->gpio_addr = MO_GP0_IO;
 235                 ir->mask_keycode = 0x8f8;
 236                 ir->mask_keyup = 0x100;
 237                 ir->polling = 50; /* ms */
 238                 break;
 239         case CX88_BOARD_WINFAST2000XP_EXPERT:
 240         case CX88_BOARD_WINFAST_DTV1000:
 241                 ir_codes = ir_codes_winfast;
 242                 ir->gpio_addr = MO_GP0_IO;
 243                 ir->mask_keycode = 0x8f8;
 244                 ir->mask_keyup = 0x100;
 245                 ir->polling = 1; /* ms */
 246                 break;
 247         case CX88_BOARD_IODATA_GVBCTV7E:
 248                 ir_codes = ir_codes_iodata_bctv7e;
 249                 ir->gpio_addr = MO_GP0_IO;
 250                 ir->mask_keycode = 0xfd;
 251                 ir->mask_keydown = 0x02;
 252                 ir->polling = 5; /* ms */
 253                 break;
 254         case CX88_BOARD_PROLINK_PLAYTVPVR:
 255         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
 256                 ir_codes = ir_codes_pixelview;
 257                 ir->gpio_addr = MO_GP1_IO;
 258                 ir->mask_keycode = 0x1f;
 259                 ir->mask_keyup = 0x80;
 260                 ir->polling = 1; /* ms */
 261                 break;
 262         case CX88_BOARD_KWORLD_LTV883:
 263                 ir_codes = ir_codes_pixelview;
 264                 ir->gpio_addr = MO_GP1_IO;
 265                 ir->mask_keycode = 0x1f;
 266                 ir->mask_keyup = 0x60;
 267                 ir->polling = 1; /* ms */
 268                 break;
 269         case CX88_BOARD_ADSTECH_DVB_T_PCI:
 270                 ir_codes = ir_codes_adstech_dvb_t_pci;
 271                 ir->gpio_addr = MO_GP1_IO;
 272                 ir->mask_keycode = 0xbf;
 273                 ir->mask_keyup = 0x40;
 274                 ir->polling = 50; /* ms */
 275                 break;
 276         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
 277                 ir_codes = ir_codes_msi_tvanywhere;
 278                 ir->gpio_addr = MO_GP1_IO;
 279                 ir->mask_keycode = 0x1f;
 280                 ir->mask_keyup = 0x40;
 281                 ir->polling = 1; /* ms */
 282                 break;
 283         case CX88_BOARD_AVERTV_303:
 284         case CX88_BOARD_AVERTV_STUDIO_303:
 285                 ir_codes         = ir_codes_avertv_303;
 286                 ir->gpio_addr    = MO_GP2_IO;
 287                 ir->mask_keycode = 0xfb;
 288                 ir->mask_keydown = 0x02;
 289                 ir->polling      = 50; /* ms */
 290                 break;
 291         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 292                 ir_codes = ir_codes_dntv_live_dvbt_pro;
 293                 ir_type = IR_TYPE_PD;
 294                 ir->sampling = 0xff00; /* address */
 295                 break;
 296         case CX88_BOARD_NORWOOD_MICRO:
 297                 ir_codes         = ir_codes_norwood;
 298                 ir->gpio_addr    = MO_GP1_IO;
 299                 ir->mask_keycode = 0x0e;
 300                 ir->mask_keyup   = 0x80;
 301                 ir->polling      = 50; /* ms */
 302                 break;
 303         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
 304                 ir_codes = ir_codes_npgtech;
 305                 ir->gpio_addr = MO_GP0_IO;
 306                 ir->mask_keycode = 0xfa;
 307                 ir->polling = 50; /* ms */
 308                 break;
 309         }
 310
 311         if (NULL == ir_codes) {
 312                 err = -ENODEV;
 313                 goto err_out_free;
 314         }
 315
 316         /* init input device */
 317         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)",
 318                  cx88_boards[core->board].name);
 319         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 320
 321         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
 322         input_dev->name = ir->name;
 323         input_dev->phys = ir->phys;
 324         input_dev->id.bustype = BUS_PCI;
 325         input_dev->id.version = 1;
 326         if (pci->subsystem_vendor) {
 327                 input_dev->id.vendor = pci->subsystem_vendor;
 328                 input_dev->id.product = pci->subsystem_device;
 329         } else {
 330                 input_dev->id.vendor = pci->vendor;
 331                 input_dev->id.product = pci->device;
 332         }
 333         input_dev->dev.parent = &pci->dev;
 334         /* record handles to ourself */
 335         ir->core = core;
 336         core->ir = ir;
 337
 338         cx88_ir_start(core, ir);
 339
 340         /* all done */
 341         err = input_register_device(ir->input);
 342         if (err)
 343                 goto err_out_stop;
 344
 345         return 0;
 346
 347  err_out_stop:
 348         cx88_ir_stop(core, ir);
 349         core->ir = NULL;
 350  err_out_free:
 351         input_free_device(input_dev);
 352         kfree(ir);
 353         return err;
 354 }
 355
 356 int cx88_ir_fini(struct cx88_core *core)
 357 {
 358         struct cx88_IR *ir = core->ir;
 359
 360         /* skip detach on non attached boards */
 361         if (NULL == ir)
 362                 return 0;
 363
 364         cx88_ir_stop(core, ir);
 365         input_unregister_device(ir->input);
 366         kfree(ir);
 367
 368         /* done */
 369         core->ir = NULL;
 370         return 0;
 371 }
 372
 373 /* ---------------------------------------------------------------------- */
 374
 375 void cx88_ir_irq(struct cx88_core *core)
 376 {
 377         struct cx88_IR *ir = core->ir;
 378         u32 samples, ircode;
 379         int i;
 380
 381         if (NULL == ir)
 382                 return;
 383         if (!ir->sampling)
 384                 return;
 385
 386         samples = cx_read(MO_SAMPLE_IO);
 387         if (0 != samples && 0xffffffff != samples) {
 388                 /* record sample data */
 389                 if (ir->scount < ARRAY_SIZE(ir->samples))
 390                         ir->samples[ir->scount++] = samples;
 391                 return;
 392         }
 393         if (!ir->scount) {
 394                 /* nothing to sample */
 395                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
 396                         ir_input_nokey(ir->input, &ir->ir);
 397                 return;
 398         }
 399
 400         /* have a complete sample */
 401         if (ir->scount < ARRAY_SIZE(ir->samples))
 402                 ir->samples[ir->scount++] = samples;
 403         for (i = 0; i < ir->scount; i++)
 404                 ir->samples[i] = ~ir->samples[i];
 405         if (ir_debug)
 406                 ir_dump_samples(ir->samples, ir->scount);
 407
 408         /* decode it */
 409         switch (core->board) {
 410         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 411         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 412                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
 413
 414                 if (ircode == 0xffffffff) { /* decoding error */
 415                         ir_dprintk("pulse distance decoding error\n");
 416                         break;
 417                 }
 418
 419                 ir_dprintk("pulse distance decoded: %x\n", ircode);
 420
 421                 if (ircode == 0) { /* key still pressed */
 422                         ir_dprintk("pulse distance decoded repeat code\n");
 423                         ir->release = jiffies + msecs_to_jiffies(120);
 424                         break;
 425                 }
 426
 427                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
 428                         ir_dprintk("pulse distance decoded wrong address\n");
 429                         break;
 430                 }
 431
 432                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
 433                         ir_dprintk("pulse distance decoded wrong check sum\n");
 434                         break;
 435                 }
 436
 437                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
 438
 439                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
 440                 ir->release = jiffies + msecs_to_jiffies(120);
 441                 break;
 442         case CX88_BOARD_HAUPPAUGE:
 443         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 444         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 445         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 446         case CX88_BOARD_HAUPPAUGE_HVR1100:
 447         case CX88_BOARD_HAUPPAUGE_HVR3000:
 448                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 449                 ir_dprintk("biphase decoded: %x\n", ircode);
 450                 if ((ircode & 0xfffff000) != 0x3000)
 451                         break;
 452                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
 453                 ir->release = jiffies + msecs_to_jiffies(120);
 454                 break;
 455         }
 456
 457         ir->scount = 0;
 458         return;
 459 }
 460
 461 /* ---------------------------------------------------------------------- */
 462
 463 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 464 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 465 MODULE_LICENSE("GPL");
 466 /*
 467  * Local variables:
 468  * c-basic-offset: 8
 469  * End:
 470  */