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/hrtimer.h>
  27 #include <linux/input.h>
  28 #include <linux/pci.h>
  29 #include <linux/slab.h>
  30 #include <linux/module.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 hrtimer timer;
  53         u32 gpio_addr;
  54         u32 last_gpio;
  55         u32 mask_keycode;
  56         u32 mask_keydown;
  57         u32 mask_keyup;
  58 };
  59
  60 static int ir_debug;
  61 module_param(ir_debug, int, 0644);      /* debug level [IR] */
  62 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
  63
  64 #define ir_dprintk(fmt, arg...) if (ir_debug) \
  65         printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
  66
  67 /* ---------------------------------------------------------------------- */
  68
  69 static void cx88_ir_handle_key(struct cx88_IR *ir)
  70 {
  71         struct cx88_core *core = ir->core;
  72         u32 gpio, data, auxgpio;
  73
  74         /* read gpio value */
  75         gpio = cx_read(ir->gpio_addr);
  76         switch (core->boardnr) {
  77         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
  78                 /* This board apparently uses a combination of 2 GPIO
  79                    to represent the keys. Additionally, the second GPIO
  80                    can be used for parity.
  81
  82                    Example:
  83
  84                    for key "5"
  85                         gpio = 0x758, auxgpio = 0xe5 or 0xf5
  86                    for key "Power"
  87                         gpio = 0x758, auxgpio = 0xed or 0xfd
  88                  */
  89
  90                 auxgpio = cx_read(MO_GP1_IO);
  91                 /* Take out the parity part */
  92                 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
  93                 break;
  94         case CX88_BOARD_WINFAST_DTV1000:
  95         case CX88_BOARD_WINFAST_DTV1800H:
  96         case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
  97                 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
  98                 auxgpio = gpio;
  99                 break;
 100         default:
 101                 auxgpio = gpio;
 102         }
 103         if (ir->polling) {
 104                 if (ir->last_gpio == auxgpio)
 105                         return;
 106                 ir->last_gpio = auxgpio;
 107         }
 108
 109         /* extract data */
 110         data = ir_extract_bits(gpio, ir->mask_keycode);
 111         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
 112                    gpio, data,
 113                    ir->polling ? "poll" : "irq",
 114                    (gpio & ir->mask_keydown) ? " down" : "",
 115                    (gpio & ir->mask_keyup) ? " up" : "");
 116
 117         if (ir->core->boardnr == CX88_BOARD_NORWOOD_MICRO) {
 118                 u32 gpio_key = cx_read(MO_GP0_IO);
 119
 120                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
 121
 122                 ir_input_keydown(ir->input, &ir->ir, data);
 123                 ir_input_nokey(ir->input, &ir->ir);
 124
 125         } else if (ir->mask_keydown) {
 126                 /* bit set on keydown */
 127                 if (gpio & ir->mask_keydown) {
 128                         ir_input_keydown(ir->input, &ir->ir, data);
 129                 } else {
 130                         ir_input_nokey(ir->input, &ir->ir);
 131                 }
 132
 133         } else if (ir->mask_keyup) {
 134                 /* bit cleared on keydown */
 135                 if (0 == (gpio & ir->mask_keyup)) {
 136                         ir_input_keydown(ir->input, &ir->ir, data);
 137                 } else {
 138                         ir_input_nokey(ir->input, &ir->ir);
 139                 }
 140
 141         } else {
 142                 /* can't distinguish keydown/up :-/ */
 143                 ir_input_keydown(ir->input, &ir->ir, data);
 144                 ir_input_nokey(ir->input, &ir->ir);
 145         }
 146 }
 147
 148 static enum hrtimer_restart cx88_ir_work(struct hrtimer *timer)
 149 {
 150         unsigned long missed;
 151         struct cx88_IR *ir = container_of(timer, struct cx88_IR, timer);
 152
 153         cx88_ir_handle_key(ir);
 154         missed = hrtimer_forward_now(&ir->timer,
 155                                      ktime_set(0, ir->polling * 1000000));
 156         if (missed > 1)
 157                 ir_dprintk("Missed ticks %ld\n", missed - 1);
 158
 159         return HRTIMER_RESTART;
 160 }
 161
 162 void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
 163 {
 164         if (ir->polling) {
 165                 hrtimer_init(&ir->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 166                 ir->timer.function = cx88_ir_work;
 167                 hrtimer_start(&ir->timer,
 168                               ktime_set(0, ir->polling * 1000000),
 169                               HRTIMER_MODE_REL);
 170         }
 171         if (ir->sampling) {
 172                 core->pci_irqmask |= PCI_INT_IR_SMPINT;
 173                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
 174                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
 175         }
 176 }
 177
 178 void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
 179 {
 180         if (ir->sampling) {
 181                 cx_write(MO_DDSCFG_IO, 0x0);
 182                 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
 183         }
 184
 185         if (ir->polling)
 186                 hrtimer_cancel(&ir->timer);
 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         struct ir_scancode_table *ir_codes = NULL;
 196         u64 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->boardnr) {
 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_table;
 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_table;
 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         case CX88_BOARD_HAUPPAUGE_HVR4000:
 229         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 230         case CX88_BOARD_PCHDTV_HD3000:
 231         case CX88_BOARD_PCHDTV_HD5500:
 232         case CX88_BOARD_HAUPPAUGE_IRONLY:
 233                 ir_codes = &ir_codes_hauppauge_new_table;
 234                 ir_type = IR_TYPE_RC5;
 235                 ir->sampling = 1;
 236                 break;
 237         case CX88_BOARD_WINFAST_DTV2000H:
 238         case CX88_BOARD_WINFAST_DTV2000H_J:
 239         case CX88_BOARD_WINFAST_DTV1800H:
 240                 ir_codes = &ir_codes_winfast_table;
 241                 ir->gpio_addr = MO_GP0_IO;
 242                 ir->mask_keycode = 0x8f8;
 243                 ir->mask_keyup = 0x100;
 244                 ir->polling = 50; /* ms */
 245                 break;
 246         case CX88_BOARD_WINFAST2000XP_EXPERT:
 247         case CX88_BOARD_WINFAST_DTV1000:
 248         case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
 249                 ir_codes = &ir_codes_winfast_table;
 250                 ir->gpio_addr = MO_GP0_IO;
 251                 ir->mask_keycode = 0x8f8;
 252                 ir->mask_keyup = 0x100;
 253                 ir->polling = 1; /* ms */
 254                 break;
 255         case CX88_BOARD_IODATA_GVBCTV7E:
 256                 ir_codes = &ir_codes_iodata_bctv7e_table;
 257                 ir->gpio_addr = MO_GP0_IO;
 258                 ir->mask_keycode = 0xfd;
 259                 ir->mask_keydown = 0x02;
 260                 ir->polling = 5; /* ms */
 261                 break;
 262         case CX88_BOARD_PROLINK_PLAYTVPVR:
 263         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
 264                 ir_codes = &ir_codes_pixelview_table;
 265                 ir->gpio_addr = MO_GP1_IO;
 266                 ir->mask_keycode = 0x1f;
 267                 ir->mask_keyup = 0x80;
 268                 ir->polling = 1; /* ms */
 269                 break;
 270         case CX88_BOARD_PROLINK_PV_8000GT:
 271         case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
 272                 ir_codes = &ir_codes_pixelview_new_table;
 273                 ir->gpio_addr = MO_GP1_IO;
 274                 ir->mask_keycode = 0x3f;
 275                 ir->mask_keyup = 0x80;
 276                 ir->polling = 1; /* ms */
 277                 break;
 278         case CX88_BOARD_KWORLD_LTV883:
 279                 ir_codes = &ir_codes_pixelview_table;
 280                 ir->gpio_addr = MO_GP1_IO;
 281                 ir->mask_keycode = 0x1f;
 282                 ir->mask_keyup = 0x60;
 283                 ir->polling = 1; /* ms */
 284                 break;
 285         case CX88_BOARD_ADSTECH_DVB_T_PCI:
 286                 ir_codes = &ir_codes_adstech_dvb_t_pci_table;
 287                 ir->gpio_addr = MO_GP1_IO;
 288                 ir->mask_keycode = 0xbf;
 289                 ir->mask_keyup = 0x40;
 290                 ir->polling = 50; /* ms */
 291                 break;
 292         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
 293                 ir_codes = &ir_codes_msi_tvanywhere_table;
 294                 ir->gpio_addr = MO_GP1_IO;
 295                 ir->mask_keycode = 0x1f;
 296                 ir->mask_keyup = 0x40;
 297                 ir->polling = 1; /* ms */
 298                 break;
 299         case CX88_BOARD_AVERTV_303:
 300         case CX88_BOARD_AVERTV_STUDIO_303:
 301                 ir_codes         = &ir_codes_avertv_303_table;
 302                 ir->gpio_addr    = MO_GP2_IO;
 303                 ir->mask_keycode = 0xfb;
 304                 ir->mask_keydown = 0x02;
 305                 ir->polling      = 50; /* ms */
 306                 break;
 307         case CX88_BOARD_OMICOM_SS4_PCI:
 308         case CX88_BOARD_SATTRADE_ST4200:
 309         case CX88_BOARD_TBS_8920:
 310         case CX88_BOARD_TBS_8910:
 311         case CX88_BOARD_PROF_7300:
 312         case CX88_BOARD_PROF_7301:
 313         case CX88_BOARD_PROF_6200:
 314                 ir_codes = &ir_codes_tbs_nec_table;
 315                 ir_type = IR_TYPE_PD;
 316                 ir->sampling = 0xff00; /* address */
 317                 break;
 318         case CX88_BOARD_TEVII_S460:
 319         case CX88_BOARD_TEVII_S420:
 320                 ir_codes = &ir_codes_tevii_nec_table;
 321                 ir_type = IR_TYPE_PD;
 322                 ir->sampling = 0xff00; /* address */
 323                 break;
 324         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 325                 ir_codes         = &ir_codes_dntv_live_dvbt_pro_table;
 326                 ir_type          = IR_TYPE_PD;
 327                 ir->sampling     = 0xff00; /* address */
 328                 break;
 329         case CX88_BOARD_NORWOOD_MICRO:
 330                 ir_codes         = &ir_codes_norwood_table;
 331                 ir->gpio_addr    = MO_GP1_IO;
 332                 ir->mask_keycode = 0x0e;
 333                 ir->mask_keyup   = 0x80;
 334                 ir->polling      = 50; /* ms */
 335                 break;
 336         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
 337                 ir_codes         = &ir_codes_npgtech_table;
 338                 ir->gpio_addr    = MO_GP0_IO;
 339                 ir->mask_keycode = 0xfa;
 340                 ir->polling      = 50; /* ms */
 341                 break;
 342         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 343                 ir_codes         = &ir_codes_pinnacle_pctv_hd_table;
 344                 ir_type          = IR_TYPE_RC5;
 345                 ir->sampling     = 1;
 346                 break;
 347         case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
 348                 ir_codes         = &ir_codes_powercolor_real_angel_table;
 349                 ir->gpio_addr    = MO_GP2_IO;
 350                 ir->mask_keycode = 0x7e;
 351                 ir->polling      = 100; /* ms */
 352                 break;
 353         }
 354
 355         if (NULL == ir_codes) {
 356                 err = -ENODEV;
 357                 goto err_out_free;
 358         }
 359
 360         /* init input device */
 361         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
 362         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 363
 364         err = ir_input_init(input_dev, &ir->ir, ir_type);
 365         if (err < 0)
 366                 goto err_out_free;
 367
 368         input_dev->name = ir->name;
 369         input_dev->phys = ir->phys;
 370         input_dev->id.bustype = BUS_PCI;
 371         input_dev->id.version = 1;
 372         if (pci->subsystem_vendor) {
 373                 input_dev->id.vendor = pci->subsystem_vendor;
 374                 input_dev->id.product = pci->subsystem_device;
 375         } else {
 376                 input_dev->id.vendor = pci->vendor;
 377                 input_dev->id.product = pci->device;
 378         }
 379         input_dev->dev.parent = &pci->dev;
 380         /* record handles to ourself */
 381         ir->core = core;
 382         core->ir = ir;
 383
 384         cx88_ir_start(core, ir);
 385
 386         /* all done */
 387         err = ir_input_register(ir->input, ir_codes, NULL);
 388         if (err)
 389                 goto err_out_stop;
 390
 391         return 0;
 392
 393  err_out_stop:
 394         cx88_ir_stop(core, ir);
 395         core->ir = NULL;
 396  err_out_free:
 397         kfree(ir);
 398         return err;
 399 }
 400
 401 int cx88_ir_fini(struct cx88_core *core)
 402 {
 403         struct cx88_IR *ir = core->ir;
 404
 405         /* skip detach on non attached boards */
 406         if (NULL == ir)
 407                 return 0;
 408
 409         cx88_ir_stop(core, ir);
 410         ir_input_unregister(ir->input);
 411         kfree(ir);
 412
 413         /* done */
 414         core->ir = NULL;
 415         return 0;
 416 }
 417
 418 /* ---------------------------------------------------------------------- */
 419
 420 void cx88_ir_irq(struct cx88_core *core)
 421 {
 422         struct cx88_IR *ir = core->ir;
 423         u32 samples, ircode;
 424         int i, start, range, toggle, dev, code;
 425
 426         if (NULL == ir)
 427                 return;
 428         if (!ir->sampling)
 429                 return;
 430
 431         samples = cx_read(MO_SAMPLE_IO);
 432         if (0 != samples && 0xffffffff != samples) {
 433                 /* record sample data */
 434                 if (ir->scount < ARRAY_SIZE(ir->samples))
 435                         ir->samples[ir->scount++] = samples;
 436                 return;
 437         }
 438         if (!ir->scount) {
 439                 /* nothing to sample */
 440                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
 441                         ir_input_nokey(ir->input, &ir->ir);
 442                 return;
 443         }
 444
 445         /* have a complete sample */
 446         if (ir->scount < ARRAY_SIZE(ir->samples))
 447                 ir->samples[ir->scount++] = samples;
 448         for (i = 0; i < ir->scount; i++)
 449                 ir->samples[i] = ~ir->samples[i];
 450         if (ir_debug)
 451                 ir_dump_samples(ir->samples, ir->scount);
 452
 453         /* decode it */
 454         switch (core->boardnr) {
 455         case CX88_BOARD_TEVII_S460:
 456         case CX88_BOARD_TEVII_S420:
 457         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 458         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 459         case CX88_BOARD_OMICOM_SS4_PCI:
 460         case CX88_BOARD_SATTRADE_ST4200:
 461         case CX88_BOARD_TBS_8920:
 462         case CX88_BOARD_TBS_8910:
 463         case CX88_BOARD_PROF_7300:
 464         case CX88_BOARD_PROF_7301:
 465         case CX88_BOARD_PROF_6200:
 466                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
 467
 468                 if (ircode == 0xffffffff) { /* decoding error */
 469                         ir_dprintk("pulse distance decoding error\n");
 470                         break;
 471                 }
 472
 473                 ir_dprintk("pulse distance decoded: %x\n", ircode);
 474
 475                 if (ircode == 0) { /* key still pressed */
 476                         ir_dprintk("pulse distance decoded repeat code\n");
 477                         ir->release = jiffies + msecs_to_jiffies(120);
 478                         break;
 479                 }
 480
 481                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
 482                         ir_dprintk("pulse distance decoded wrong address\n");
 483                         break;
 484                 }
 485
 486                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
 487                         ir_dprintk("pulse distance decoded wrong check sum\n");
 488                         break;
 489                 }
 490
 491                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
 492
 493                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f);
 494                 ir->release = jiffies + msecs_to_jiffies(120);
 495                 break;
 496         case CX88_BOARD_HAUPPAUGE:
 497         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 498         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 499         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 500         case CX88_BOARD_HAUPPAUGE_HVR1100:
 501         case CX88_BOARD_HAUPPAUGE_HVR3000:
 502         case CX88_BOARD_HAUPPAUGE_HVR4000:
 503         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 504         case CX88_BOARD_PCHDTV_HD3000:
 505         case CX88_BOARD_PCHDTV_HD5500:
 506         case CX88_BOARD_HAUPPAUGE_IRONLY:
 507                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 508                 ir_dprintk("biphase decoded: %x\n", ircode);
 509                 /*
 510                  * RC5 has an extension bit which adds a new range
 511                  * of available codes, this is detected here. Also
 512                  * hauppauge remotes (black/silver) always use
 513                  * specific device ids. If we do not filter the
 514                  * device ids then messages destined for devices
 515                  * such as TVs (id=0) will get through to the
 516                  * device causing mis-fired events.
 517                  */
 518                 /* split rc5 data block ... */
 519                 start = (ircode & 0x2000) >> 13;
 520                 range = (ircode & 0x1000) >> 12;
 521                 toggle= (ircode & 0x0800) >> 11;
 522                 dev   = (ircode & 0x07c0) >> 6;
 523                 code  = (ircode & 0x003f) | ((range << 6) ^ 0x0040);
 524                 if( start != 1)
 525                         /* no key pressed */
 526                         break;
 527                 if ( dev != 0x1e && dev != 0x1f )
 528                         /* not a hauppauge remote */
 529                         break;
 530                 ir_input_keydown(ir->input, &ir->ir, code);
 531                 ir->release = jiffies + msecs_to_jiffies(120);
 532                 break;
 533         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 534                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 535                 ir_dprintk("biphase decoded: %x\n", ircode);
 536                 if ((ircode & 0xfffff000) != 0x3000)
 537                         break;
 538                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f);
 539                 ir->release = jiffies + msecs_to_jiffies(120);
 540                 break;
 541         }
 542
 543         ir->scount = 0;
 544         return;
 545 }
 546
 547 /* ---------------------------------------------------------------------- */
 548
 549 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 550 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 551 MODULE_LICENSE("GPL");
 552 /*
 553  * Local variables:
 554  * c-basic-offset: 8
 555  * End:
 556  */