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