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         case CX88_BOARD_WINFAST_DTV1800H:
  95         case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
  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->boardnr == 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 cx88_ir_work(struct work_struct *work)
 148 {
 149         struct cx88_IR *ir = container_of(work, struct cx88_IR, work.work);
 150
 151         cx88_ir_handle_key(ir);
 152         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
 153 }
 154
 155 void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
 156 {
 157         if (ir->polling) {
 158                 INIT_DELAYED_WORK(&ir->work, cx88_ir_work);
 159                 schedule_delayed_work(&ir->work, 0);
 160         }
 161         if (ir->sampling) {
 162                 core->pci_irqmask |= PCI_INT_IR_SMPINT;
 163                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
 164                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
 165         }
 166 }
 167
 168 void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
 169 {
 170         if (ir->sampling) {
 171                 cx_write(MO_DDSCFG_IO, 0x0);
 172                 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
 173         }
 174
 175         if (ir->polling)
 176                 cancel_delayed_work_sync(&ir->work);
 177 }
 178
 179 /* ---------------------------------------------------------------------- */
 180
 181 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
 182 {
 183         struct cx88_IR *ir;
 184         struct input_dev *input_dev;
 185         IR_KEYTAB_TYPE *ir_codes = NULL;
 186         int ir_type = IR_TYPE_OTHER;
 187         int err = -ENOMEM;
 188
 189         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 190         input_dev = input_allocate_device();
 191         if (!ir || !input_dev)
 192                 goto err_out_free;
 193
 194         ir->input = input_dev;
 195
 196         /* detect & configure */
 197         switch (core->boardnr) {
 198         case CX88_BOARD_DNTV_LIVE_DVB_T:
 199         case CX88_BOARD_KWORLD_DVB_T:
 200         case CX88_BOARD_KWORLD_DVB_T_CX22702:
 201                 ir_codes = ir_codes_dntv_live_dvb_t;
 202                 ir->gpio_addr = MO_GP1_IO;
 203                 ir->mask_keycode = 0x1f;
 204                 ir->mask_keyup = 0x60;
 205                 ir->polling = 50; /* ms */
 206                 break;
 207         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 208                 ir_codes = ir_codes_cinergy_1400;
 209                 ir_type = IR_TYPE_PD;
 210                 ir->sampling = 0xeb04; /* address */
 211                 break;
 212         case CX88_BOARD_HAUPPAUGE:
 213         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 214         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 215         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 216         case CX88_BOARD_HAUPPAUGE_HVR1100:
 217         case CX88_BOARD_HAUPPAUGE_HVR3000:
 218         case CX88_BOARD_HAUPPAUGE_HVR4000:
 219         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 220         case CX88_BOARD_PCHDTV_HD3000:
 221         case CX88_BOARD_PCHDTV_HD5500:
 222         case CX88_BOARD_HAUPPAUGE_IRONLY:
 223                 ir_codes = ir_codes_hauppauge_new;
 224                 ir_type = IR_TYPE_RC5;
 225                 ir->sampling = 1;
 226                 break;
 227         case CX88_BOARD_WINFAST_DTV2000H:
 228         case CX88_BOARD_WINFAST_DTV1800H:
 229                 ir_codes = ir_codes_winfast;
 230                 ir->gpio_addr = MO_GP0_IO;
 231                 ir->mask_keycode = 0x8f8;
 232                 ir->mask_keyup = 0x100;
 233                 ir->polling = 50; /* ms */
 234                 break;
 235         case CX88_BOARD_WINFAST2000XP_EXPERT:
 236         case CX88_BOARD_WINFAST_DTV1000:
 237         case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
 238                 ir_codes = ir_codes_winfast;
 239                 ir->gpio_addr = MO_GP0_IO;
 240                 ir->mask_keycode = 0x8f8;
 241                 ir->mask_keyup = 0x100;
 242                 ir->polling = 1; /* ms */
 243                 break;
 244         case CX88_BOARD_IODATA_GVBCTV7E:
 245                 ir_codes = ir_codes_iodata_bctv7e;
 246                 ir->gpio_addr = MO_GP0_IO;
 247                 ir->mask_keycode = 0xfd;
 248                 ir->mask_keydown = 0x02;
 249                 ir->polling = 5; /* ms */
 250                 break;
 251         case CX88_BOARD_PROLINK_PLAYTVPVR:
 252         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
 253                 ir_codes = ir_codes_pixelview;
 254                 ir->gpio_addr = MO_GP1_IO;
 255                 ir->mask_keycode = 0x1f;
 256                 ir->mask_keyup = 0x80;
 257                 ir->polling = 1; /* ms */
 258                 break;
 259         case CX88_BOARD_PROLINK_PV_8000GT:
 260         case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
 261                 ir_codes = ir_codes_pixelview_new;
 262                 ir->gpio_addr = MO_GP1_IO;
 263                 ir->mask_keycode = 0x3f;
 264                 ir->mask_keyup = 0x80;
 265                 ir->polling = 1; /* ms */
 266                 break;
 267         case CX88_BOARD_KWORLD_LTV883:
 268                 ir_codes = ir_codes_pixelview;
 269                 ir->gpio_addr = MO_GP1_IO;
 270                 ir->mask_keycode = 0x1f;
 271                 ir->mask_keyup = 0x60;
 272                 ir->polling = 1; /* ms */
 273                 break;
 274         case CX88_BOARD_ADSTECH_DVB_T_PCI:
 275                 ir_codes = ir_codes_adstech_dvb_t_pci;
 276                 ir->gpio_addr = MO_GP1_IO;
 277                 ir->mask_keycode = 0xbf;
 278                 ir->mask_keyup = 0x40;
 279                 ir->polling = 50; /* ms */
 280                 break;
 281         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
 282                 ir_codes = ir_codes_msi_tvanywhere;
 283                 ir->gpio_addr = MO_GP1_IO;
 284                 ir->mask_keycode = 0x1f;
 285                 ir->mask_keyup = 0x40;
 286                 ir->polling = 1; /* ms */
 287                 break;
 288         case CX88_BOARD_AVERTV_303:
 289         case CX88_BOARD_AVERTV_STUDIO_303:
 290                 ir_codes         = ir_codes_avertv_303;
 291                 ir->gpio_addr    = MO_GP2_IO;
 292                 ir->mask_keycode = 0xfb;
 293                 ir->mask_keydown = 0x02;
 294                 ir->polling      = 50; /* ms */
 295                 break;
 296         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 297                 ir_codes = ir_codes_dntv_live_dvbt_pro;
 298                 ir_type = IR_TYPE_PD;
 299                 ir->sampling = 0xff00; /* address */
 300                 break;
 301         case CX88_BOARD_NORWOOD_MICRO:
 302                 ir_codes         = ir_codes_norwood;
 303                 ir->gpio_addr    = MO_GP1_IO;
 304                 ir->mask_keycode = 0x0e;
 305                 ir->mask_keyup   = 0x80;
 306                 ir->polling      = 50; /* ms */
 307                 break;
 308         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
 309                 ir_codes = ir_codes_npgtech;
 310                 ir->gpio_addr = MO_GP0_IO;
 311                 ir->mask_keycode = 0xfa;
 312                 ir->polling = 50; /* ms */
 313                 break;
 314         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 315                 ir_codes = ir_codes_pinnacle_pctv_hd;
 316                 ir_type = IR_TYPE_RC5;
 317                 ir->sampling = 1;
 318                 break;
 319         case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
 320                 ir_codes = ir_codes_powercolor_real_angel;
 321                 ir->gpio_addr = MO_GP2_IO;
 322                 ir->mask_keycode = 0x7e;
 323                 ir->polling = 100; /* ms */
 324                 break;
 325         }
 326
 327         if (NULL == ir_codes) {
 328                 err = -ENODEV;
 329                 goto err_out_free;
 330         }
 331
 332         /* init input device */
 333         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
 334         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 335
 336         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
 337         input_dev->name = ir->name;
 338         input_dev->phys = ir->phys;
 339         input_dev->id.bustype = BUS_PCI;
 340         input_dev->id.version = 1;
 341         if (pci->subsystem_vendor) {
 342                 input_dev->id.vendor = pci->subsystem_vendor;
 343                 input_dev->id.product = pci->subsystem_device;
 344         } else {
 345                 input_dev->id.vendor = pci->vendor;
 346                 input_dev->id.product = pci->device;
 347         }
 348         input_dev->dev.parent = &pci->dev;
 349         /* record handles to ourself */
 350         ir->core = core;
 351         core->ir = ir;
 352
 353         cx88_ir_start(core, ir);
 354
 355         /* all done */
 356         err = input_register_device(ir->input);
 357         if (err)
 358                 goto err_out_stop;
 359
 360         return 0;
 361
 362  err_out_stop:
 363         cx88_ir_stop(core, ir);
 364         core->ir = NULL;
 365  err_out_free:
 366         input_free_device(input_dev);
 367         kfree(ir);
 368         return err;
 369 }
 370
 371 int cx88_ir_fini(struct cx88_core *core)
 372 {
 373         struct cx88_IR *ir = core->ir;
 374
 375         /* skip detach on non attached boards */
 376         if (NULL == ir)
 377                 return 0;
 378
 379         cx88_ir_stop(core, ir);
 380         input_unregister_device(ir->input);
 381         kfree(ir);
 382
 383         /* done */
 384         core->ir = NULL;
 385         return 0;
 386 }
 387
 388 /* ---------------------------------------------------------------------- */
 389
 390 void cx88_ir_irq(struct cx88_core *core)
 391 {
 392         struct cx88_IR *ir = core->ir;
 393         u32 samples, ircode;
 394         int i, start, range, toggle, dev, code;
 395
 396         if (NULL == ir)
 397                 return;
 398         if (!ir->sampling)
 399                 return;
 400
 401         samples = cx_read(MO_SAMPLE_IO);
 402         if (0 != samples && 0xffffffff != samples) {
 403                 /* record sample data */
 404                 if (ir->scount < ARRAY_SIZE(ir->samples))
 405                         ir->samples[ir->scount++] = samples;
 406                 return;
 407         }
 408         if (!ir->scount) {
 409                 /* nothing to sample */
 410                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
 411                         ir_input_nokey(ir->input, &ir->ir);
 412                 return;
 413         }
 414
 415         /* have a complete sample */
 416         if (ir->scount < ARRAY_SIZE(ir->samples))
 417                 ir->samples[ir->scount++] = samples;
 418         for (i = 0; i < ir->scount; i++)
 419                 ir->samples[i] = ~ir->samples[i];
 420         if (ir_debug)
 421                 ir_dump_samples(ir->samples, ir->scount);
 422
 423         /* decode it */
 424         switch (core->boardnr) {
 425         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 426         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 427                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
 428
 429                 if (ircode == 0xffffffff) { /* decoding error */
 430                         ir_dprintk("pulse distance decoding error\n");
 431                         break;
 432                 }
 433
 434                 ir_dprintk("pulse distance decoded: %x\n", ircode);
 435
 436                 if (ircode == 0) { /* key still pressed */
 437                         ir_dprintk("pulse distance decoded repeat code\n");
 438                         ir->release = jiffies + msecs_to_jiffies(120);
 439                         break;
 440                 }
 441
 442                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
 443                         ir_dprintk("pulse distance decoded wrong address\n");
 444                         break;
 445                 }
 446
 447                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
 448                         ir_dprintk("pulse distance decoded wrong check sum\n");
 449                         break;
 450                 }
 451
 452                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
 453
 454                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
 455                 ir->release = jiffies + msecs_to_jiffies(120);
 456                 break;
 457         case CX88_BOARD_HAUPPAUGE:
 458         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 459         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 460         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 461         case CX88_BOARD_HAUPPAUGE_HVR1100:
 462         case CX88_BOARD_HAUPPAUGE_HVR3000:
 463         case CX88_BOARD_HAUPPAUGE_HVR4000:
 464         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 465         case CX88_BOARD_PCHDTV_HD3000:
 466         case CX88_BOARD_PCHDTV_HD5500:
 467         case CX88_BOARD_HAUPPAUGE_IRONLY:
 468                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 469                 ir_dprintk("biphase decoded: %x\n", ircode);
 470                 /*
 471                  * RC5 has an extension bit which adds a new range
 472                  * of available codes, this is detected here. Also
 473                  * hauppauge remotes (black/silver) always use
 474                  * specific device ids. If we do not filter the
 475                  * device ids then messages destined for devices
 476                  * such as TVs (id=0) will get through to the
 477                  * device causing mis-fired events.
 478                  */
 479                 /* split rc5 data block ... */
 480                 start = (ircode & 0x2000) >> 13;
 481                 range = (ircode & 0x1000) >> 12;
 482                 toggle= (ircode & 0x0800) >> 11;
 483                 dev   = (ircode & 0x07c0) >> 6;
 484                 code  = (ircode & 0x003f) | ((range << 6) ^ 0x0040);
 485                 if( start != 1)
 486                         /* no key pressed */
 487                         break;
 488                 if ( dev != 0x1e && dev != 0x1f )
 489                         /* not a hauppauge remote */
 490                         break;
 491                 ir_input_keydown(ir->input, &ir->ir, code, ircode);
 492                 ir->release = jiffies + msecs_to_jiffies(120);
 493                 break;
 494         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 495                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 496                 ir_dprintk("biphase decoded: %x\n", ircode);
 497                 if ((ircode & 0xfffff000) != 0x3000)
 498                         break;
 499                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
 500                 ir->release = jiffies + msecs_to_jiffies(120);
 501                 break;
 502         }
 503
 504         ir->scount = 0;
 505         return;
 506 }
 507
 508 /* ---------------------------------------------------------------------- */
 509
 510 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 511 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 512 MODULE_LICENSE("GPL");
 513 /*
 514  * Local variables:
 515  * c-basic-offset: 8
 516  * End:
 517  */