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
  31 #include "cx88.h"
  32 #include <media/ir-common.h>
  33
  34 /* ---------------------------------------------------------------------- */
  35
  36 struct cx88_IR {
  37         struct cx88_core *core;
  38         struct input_dev *input;
  39         struct ir_input_state ir;
  40         char name[32];
  41         char phys[32];
  42
  43         /* sample from gpio pin 16 */
  44         u32 sampling;
  45         u32 samples[16];
  46         int scount;
  47         unsigned long release;
  48
  49         /* poll external decoder */
  50         int polling;
  51         struct delayed_work work;
  52         u32 gpio_addr;
  53         u32 last_gpio;
  54         u32 mask_keycode;
  55         u32 mask_keydown;
  56         u32 mask_keyup;
  57 };
  58
  59 static int ir_debug;
  60 module_param(ir_debug, int, 0644);      /* debug level [IR] */
  61 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
  62
  63 #define ir_dprintk(fmt, arg...) if (ir_debug) \
  64         printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
  65
  66 /* ---------------------------------------------------------------------- */
  67
  68 static void cx88_ir_handle_key(struct cx88_IR *ir)
  69 {
  70         struct cx88_core *core = ir->core;
  71         u32 gpio, data, auxgpio;
  72
  73         /* read gpio value */
  74         gpio = cx_read(ir->gpio_addr);
  75         switch (core->boardnr) {
  76         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
  77                 /* This board apparently uses a combination of 2 GPIO
  78                    to represent the keys. Additionally, the second GPIO
  79                    can be used for parity.
  80
  81                    Example:
  82
  83                    for key "5"
  84                         gpio = 0x758, auxgpio = 0xe5 or 0xf5
  85                    for key "Power"
  86                         gpio = 0x758, auxgpio = 0xed or 0xfd
  87                  */
  88
  89                 auxgpio = cx_read(MO_GP1_IO);
  90                 /* Take out the parity part */
  91                 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
  92                 break;
  93         case CX88_BOARD_WINFAST_DTV1000:
  94                 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
  95                 auxgpio = gpio;
  96                 break;
  97         default:
  98                 auxgpio = gpio;
  99         }
 100         if (ir->polling) {
 101                 if (ir->last_gpio == auxgpio)
 102                         return;
 103                 ir->last_gpio = auxgpio;
 104         }
 105
 106         /* extract data */
 107         data = ir_extract_bits(gpio, ir->mask_keycode);
 108         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
 109                    gpio, data,
 110                    ir->polling ? "poll" : "irq",
 111                    (gpio & ir->mask_keydown) ? " down" : "",
 112                    (gpio & ir->mask_keyup) ? " up" : "");
 113
 114         if (ir->core->boardnr == CX88_BOARD_NORWOOD_MICRO) {
 115                 u32 gpio_key = cx_read(MO_GP0_IO);
 116
 117                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
 118
 119                 ir_input_keydown(ir->input, &ir->ir, data, data);
 120                 ir_input_nokey(ir->input, &ir->ir);
 121
 122         } else if (ir->mask_keydown) {
 123                 /* bit set on keydown */
 124                 if (gpio & ir->mask_keydown) {
 125                         ir_input_keydown(ir->input, &ir->ir, data, data);
 126                 } else {
 127                         ir_input_nokey(ir->input, &ir->ir);
 128                 }
 129
 130         } else if (ir->mask_keyup) {
 131                 /* bit cleared on keydown */
 132                 if (0 == (gpio & ir->mask_keyup)) {
 133                         ir_input_keydown(ir->input, &ir->ir, data, data);
 134                 } else {
 135                         ir_input_nokey(ir->input, &ir->ir);
 136                 }
 137
 138         } else {
 139                 /* can't distinguish keydown/up :-/ */
 140                 ir_input_keydown(ir->input, &ir->ir, data, data);
 141                 ir_input_nokey(ir->input, &ir->ir);
 142         }
 143 }
 144
 145 static void cx88_ir_work(struct work_struct *work)
 146 {
 147         struct cx88_IR *ir = container_of(work, struct cx88_IR, work.work);
 148
 149         cx88_ir_handle_key(ir);
 150         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
 151 }
 152
 153 void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
 154 {
 155         if (ir->polling) {
 156                 INIT_DELAYED_WORK(&ir->work, cx88_ir_work);
 157                 schedule_delayed_work(&ir->work, 0);
 158         }
 159         if (ir->sampling) {
 160                 core->pci_irqmask |= PCI_INT_IR_SMPINT;
 161                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
 162                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
 163         }
 164 }
 165
 166 void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
 167 {
 168         if (ir->sampling) {
 169                 cx_write(MO_DDSCFG_IO, 0x0);
 170                 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
 171         }
 172
 173         if (ir->polling)
 174                 cancel_delayed_work_sync(&ir->work);
 175 }
 176
 177 /* ---------------------------------------------------------------------- */
 178
 179 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
 180 {
 181         struct cx88_IR *ir;
 182         struct input_dev *input_dev;
 183         IR_KEYTAB_TYPE *ir_codes = NULL;
 184         int ir_type = IR_TYPE_OTHER;
 185         int err = -ENOMEM;
 186
 187         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 188         input_dev = input_allocate_device();
 189         if (!ir || !input_dev)
 190                 goto err_out_free;
 191
 192         ir->input = input_dev;
 193
 194         /* detect & configure */
 195         switch (core->boardnr) {
 196         case CX88_BOARD_DNTV_LIVE_DVB_T:
 197         case CX88_BOARD_KWORLD_DVB_T:
 198         case CX88_BOARD_KWORLD_DVB_T_CX22702:
 199                 ir_codes = ir_codes_dntv_live_dvb_t;
 200                 ir->gpio_addr = MO_GP1_IO;
 201                 ir->mask_keycode = 0x1f;
 202                 ir->mask_keyup = 0x60;
 203                 ir->polling = 50; /* ms */
 204                 break;
 205         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 206                 ir_codes = ir_codes_cinergy_1400;
 207                 ir_type = IR_TYPE_PD;
 208                 ir->sampling = 0xeb04; /* address */
 209                 break;
 210         case CX88_BOARD_HAUPPAUGE:
 211         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 212         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 213         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 214         case CX88_BOARD_HAUPPAUGE_HVR1100:
 215         case CX88_BOARD_HAUPPAUGE_HVR3000:
 216         case CX88_BOARD_HAUPPAUGE_HVR4000:
 217         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 218         case CX88_BOARD_PCHDTV_HD3000:
 219         case CX88_BOARD_PCHDTV_HD5500:
 220                 ir_codes = ir_codes_hauppauge_new;
 221                 ir_type = IR_TYPE_RC5;
 222                 ir->sampling = 1;
 223                 break;
 224         case CX88_BOARD_WINFAST_DTV2000H:
 225                 ir_codes = ir_codes_winfast;
 226                 ir->gpio_addr = MO_GP0_IO;
 227                 ir->mask_keycode = 0x8f8;
 228                 ir->mask_keyup = 0x100;
 229                 ir->polling = 50; /* ms */
 230                 break;
 231         case CX88_BOARD_WINFAST2000XP_EXPERT:
 232         case CX88_BOARD_WINFAST_DTV1000:
 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 = 1; /* ms */
 238                 break;
 239         case CX88_BOARD_IODATA_GVBCTV7E:
 240                 ir_codes = ir_codes_iodata_bctv7e;
 241                 ir->gpio_addr = MO_GP0_IO;
 242                 ir->mask_keycode = 0xfd;
 243                 ir->mask_keydown = 0x02;
 244                 ir->polling = 5; /* ms */
 245                 break;
 246         case CX88_BOARD_PROLINK_PLAYTVPVR:
 247         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
 248                 ir_codes = ir_codes_pixelview;
 249                 ir->gpio_addr = MO_GP1_IO;
 250                 ir->mask_keycode = 0x1f;
 251                 ir->mask_keyup = 0x80;
 252                 ir->polling = 1; /* ms */
 253                 break;
 254         case CX88_BOARD_PROLINK_PV_8000GT:
 255         case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
 256                 ir_codes = ir_codes_pixelview_new;
 257                 ir->gpio_addr = MO_GP1_IO;
 258                 ir->mask_keycode = 0x3f;
 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         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 310                 ir_codes = ir_codes_pinnacle_pctv_hd;
 311                 ir_type = IR_TYPE_RC5;
 312                 ir->sampling = 1;
 313                 break;
 314         case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
 315                 ir_codes = ir_codes_powercolor_real_angel;
 316                 ir->gpio_addr = MO_GP2_IO;
 317                 ir->mask_keycode = 0x7e;
 318                 ir->polling = 100; /* ms */
 319                 break;
 320         }
 321
 322         if (NULL == ir_codes) {
 323                 err = -ENODEV;
 324                 goto err_out_free;
 325         }
 326
 327         /* init input device */
 328         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
 329         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 330
 331         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
 332         input_dev->name = ir->name;
 333         input_dev->phys = ir->phys;
 334         input_dev->id.bustype = BUS_PCI;
 335         input_dev->id.version = 1;
 336         if (pci->subsystem_vendor) {
 337                 input_dev->id.vendor = pci->subsystem_vendor;
 338                 input_dev->id.product = pci->subsystem_device;
 339         } else {
 340                 input_dev->id.vendor = pci->vendor;
 341                 input_dev->id.product = pci->device;
 342         }
 343         input_dev->dev.parent = &pci->dev;
 344         /* record handles to ourself */
 345         ir->core = core;
 346         core->ir = ir;
 347
 348         cx88_ir_start(core, ir);
 349
 350         /* all done */
 351         err = input_register_device(ir->input);
 352         if (err)
 353                 goto err_out_stop;
 354
 355         return 0;
 356
 357  err_out_stop:
 358         cx88_ir_stop(core, ir);
 359         core->ir = NULL;
 360  err_out_free:
 361         input_free_device(input_dev);
 362         kfree(ir);
 363         return err;
 364 }
 365
 366 int cx88_ir_fini(struct cx88_core *core)
 367 {
 368         struct cx88_IR *ir = core->ir;
 369
 370         /* skip detach on non attached boards */
 371         if (NULL == ir)
 372                 return 0;
 373
 374         cx88_ir_stop(core, ir);
 375         input_unregister_device(ir->input);
 376         kfree(ir);
 377
 378         /* done */
 379         core->ir = NULL;
 380         return 0;
 381 }
 382
 383 /* ---------------------------------------------------------------------- */
 384
 385 void cx88_ir_irq(struct cx88_core *core)
 386 {
 387         struct cx88_IR *ir = core->ir;
 388         u32 samples, ircode;
 389         int i, start, range, toggle, dev, code;
 390
 391         if (NULL == ir)
 392                 return;
 393         if (!ir->sampling)
 394                 return;
 395
 396         samples = cx_read(MO_SAMPLE_IO);
 397         if (0 != samples && 0xffffffff != samples) {
 398                 /* record sample data */
 399                 if (ir->scount < ARRAY_SIZE(ir->samples))
 400                         ir->samples[ir->scount++] = samples;
 401                 return;
 402         }
 403         if (!ir->scount) {
 404                 /* nothing to sample */
 405                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
 406                         ir_input_nokey(ir->input, &ir->ir);
 407                 return;
 408         }
 409
 410         /* have a complete sample */
 411         if (ir->scount < ARRAY_SIZE(ir->samples))
 412                 ir->samples[ir->scount++] = samples;
 413         for (i = 0; i < ir->scount; i++)
 414                 ir->samples[i] = ~ir->samples[i];
 415         if (ir_debug)
 416                 ir_dump_samples(ir->samples, ir->scount);
 417
 418         /* decode it */
 419         switch (core->boardnr) {
 420         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 421         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 422                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
 423
 424                 if (ircode == 0xffffffff) { /* decoding error */
 425                         ir_dprintk("pulse distance decoding error\n");
 426                         break;
 427                 }
 428
 429                 ir_dprintk("pulse distance decoded: %x\n", ircode);
 430
 431                 if (ircode == 0) { /* key still pressed */
 432                         ir_dprintk("pulse distance decoded repeat code\n");
 433                         ir->release = jiffies + msecs_to_jiffies(120);
 434                         break;
 435                 }
 436
 437                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
 438                         ir_dprintk("pulse distance decoded wrong address\n");
 439                         break;
 440                 }
 441
 442                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
 443                         ir_dprintk("pulse distance decoded wrong check sum\n");
 444                         break;
 445                 }
 446
 447                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
 448
 449                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
 450                 ir->release = jiffies + msecs_to_jiffies(120);
 451                 break;
 452         case CX88_BOARD_HAUPPAUGE:
 453         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 454         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 455         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 456         case CX88_BOARD_HAUPPAUGE_HVR1100:
 457         case CX88_BOARD_HAUPPAUGE_HVR3000:
 458         case CX88_BOARD_HAUPPAUGE_HVR4000:
 459         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 460         case CX88_BOARD_PCHDTV_HD3000:
 461         case CX88_BOARD_PCHDTV_HD5500:
 462                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 463                 ir_dprintk("biphase decoded: %x\n", ircode);
 464                 /*
 465                  * RC5 has an extension bit which adds a new range
 466                  * of available codes, this is detected here. Also
 467                  * hauppauge remotes (black/silver) always use
 468                  * specific device ids. If we do not filter the
 469                  * device ids then messages destined for devices
 470                  * such as TVs (id=0) will get through to the
 471                  * device causing mis-fired events.
 472                  */
 473                 /* split rc5 data block ... */
 474                 start = (ircode & 0x2000) >> 13;
 475                 range = (ircode & 0x1000) >> 12;
 476                 toggle= (ircode & 0x0800) >> 11;
 477                 dev   = (ircode & 0x07c0) >> 6;
 478                 code  = (ircode & 0x003f) | ((range << 6) ^ 0x0040);
 479                 if( start != 1)
 480                         /* no key pressed */
 481                         break;
 482                 if ( dev != 0x1e && dev != 0x1f )
 483                         /* not a hauppauge remote */
 484                         break;
 485                 ir_input_keydown(ir->input, &ir->ir, code, ircode);
 486                 ir->release = jiffies + msecs_to_jiffies(120);
 487                 break;
 488         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 489                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 490                 ir_dprintk("biphase decoded: %x\n", ircode);
 491                 if ((ircode & 0xfffff000) != 0x3000)
 492                         break;
 493                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
 494                 ir->release = jiffies + msecs_to_jiffies(120);
 495                 break;
 496         }
 497
 498         ir->scount = 0;
 499         return;
 500 }
 501
 502 /* ---------------------------------------------------------------------- */
 503
 504 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 505 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 506 MODULE_LICENSE("GPL");
 507 /*
 508  * Local variables:
 509  * c-basic-offset: 8
 510  * End:
 511  */