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         if (core->board == 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         } else if (core->board == CX88_BOARD_WINFAST_DTV1000) {
  94                 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
  95                 auxgpio = gpio;
  96         } else
  97                 auxgpio = gpio;
  98
  99         if (ir->polling) {
 100                 if (ir->last_gpio == auxgpio)
 101                         return;
 102                 ir->last_gpio = auxgpio;
 103         }
 104
 105         /* extract data */
 106         data = ir_extract_bits(gpio, ir->mask_keycode);
 107         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
 108                    gpio, data,
 109                    ir->polling ? "poll" : "irq",
 110                    (gpio & ir->mask_keydown) ? " down" : "",
 111                    (gpio & ir->mask_keyup) ? " up" : "");
 112
 113         if (ir->core->board == CX88_BOARD_NORWOOD_MICRO) {
 114                 u32 gpio_key = cx_read(MO_GP0_IO);
 115
 116                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
 117
 118                 ir_input_keydown(ir->input, &ir->ir, data, data);
 119                 ir_input_nokey(ir->input, &ir->ir);
 120
 121         } else if (ir->mask_keydown) {
 122                 /* bit set on keydown */
 123                 if (gpio & ir->mask_keydown) {
 124                         ir_input_keydown(ir->input, &ir->ir, data, data);
 125                 } else {
 126                         ir_input_nokey(ir->input, &ir->ir);
 127                 }
 128
 129         } else if (ir->mask_keyup) {
 130                 /* bit cleared on keydown */
 131                 if (0 == (gpio & ir->mask_keyup)) {
 132                         ir_input_keydown(ir->input, &ir->ir, data, data);
 133                 } else {
 134                         ir_input_nokey(ir->input, &ir->ir);
 135                 }
 136
 137         } else {
 138                 /* can't distinguish keydown/up :-/ */
 139                 ir_input_keydown(ir->input, &ir->ir, data, data);
 140                 ir_input_nokey(ir->input, &ir->ir);
 141         }
 142 }
 143
 144 static void ir_timer(unsigned long data)
 145 {
 146         struct cx88_IR *ir = (struct cx88_IR *)data;
 147
 148         schedule_work(&ir->work);
 149 }
 150
 151 static void cx88_ir_work(struct work_struct *work)
 152 {
 153         struct cx88_IR *ir = container_of(work, struct cx88_IR, work);
 154
 155         cx88_ir_handle_key(ir);
 156         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
 157 }
 158
 159 static void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
 160 {
 161         if (ir->polling) {
 162                 setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
 163                 INIT_WORK(&ir->work, cx88_ir_work);
 164                 schedule_work(&ir->work);
 165         }
 166         if (ir->sampling) {
 167                 core->pci_irqmask |= (1 << 18); /* IR_SMP_INT */
 168                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
 169                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
 170         }
 171 }
 172
 173 static void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
 174 {
 175         if (ir->sampling) {
 176                 cx_write(MO_DDSCFG_IO, 0x0);
 177                 core->pci_irqmask &= ~(1 << 18);
 178         }
 179
 180         if (ir->polling) {
 181                 del_timer_sync(&ir->timer);
 182                 flush_scheduled_work();
 183         }
 184 }
 185
 186 /* ---------------------------------------------------------------------- */
 187
 188 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
 189 {
 190         struct cx88_IR *ir;
 191         struct input_dev *input_dev;
 192         IR_KEYTAB_TYPE *ir_codes = NULL;
 193         int ir_type = IR_TYPE_OTHER;
 194         int err = -ENOMEM;
 195
 196         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 197         input_dev = input_allocate_device();
 198         if (!ir || !input_dev)
 199                 goto err_out_free;
 200
 201         ir->input = input_dev;
 202
 203         /* detect & configure */
 204         switch (core->board) {
 205         case CX88_BOARD_DNTV_LIVE_DVB_T:
 206         case CX88_BOARD_KWORLD_DVB_T:
 207         case CX88_BOARD_KWORLD_DVB_T_CX22702:
 208                 ir_codes = ir_codes_dntv_live_dvb_t;
 209                 ir->gpio_addr = MO_GP1_IO;
 210                 ir->mask_keycode = 0x1f;
 211                 ir->mask_keyup = 0x60;
 212                 ir->polling = 50; /* ms */
 213                 break;
 214         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 215                 ir_codes = ir_codes_cinergy_1400;
 216                 ir_type = IR_TYPE_PD;
 217                 ir->sampling = 0xeb04; /* address */
 218                 break;
 219         case CX88_BOARD_HAUPPAUGE:
 220         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 221         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 222         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 223         case CX88_BOARD_HAUPPAUGE_HVR1100:
 224         case CX88_BOARD_HAUPPAUGE_HVR3000:
 225                 ir_codes = ir_codes_hauppauge_new;
 226                 ir_type = IR_TYPE_RC5;
 227                 ir->sampling = 1;
 228                 break;
 229         case CX88_BOARD_WINFAST_DTV2000H:
 230                 ir_codes = ir_codes_winfast;
 231                 ir->gpio_addr = MO_GP0_IO;
 232                 ir->mask_keycode = 0x8f8;
 233                 ir->mask_keyup = 0x100;
 234                 ir->polling = 50; /* ms */
 235                 break;
 236         case CX88_BOARD_WINFAST2000XP_EXPERT:
 237         case CX88_BOARD_WINFAST_DTV1000:
 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_KWORLD_LTV883:
 260                 ir_codes = ir_codes_pixelview;
 261                 ir->gpio_addr = MO_GP1_IO;
 262                 ir->mask_keycode = 0x1f;
 263                 ir->mask_keyup = 0x60;
 264                 ir->polling = 1; /* ms */
 265                 break;
 266         case CX88_BOARD_ADSTECH_DVB_T_PCI:
 267                 ir_codes = ir_codes_adstech_dvb_t_pci;
 268                 ir->gpio_addr = MO_GP1_IO;
 269                 ir->mask_keycode = 0xbf;
 270                 ir->mask_keyup = 0x40;
 271                 ir->polling = 50; /* ms */
 272                 break;
 273         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
 274                 ir_codes = ir_codes_msi_tvanywhere;
 275                 ir->gpio_addr = MO_GP1_IO;
 276                 ir->mask_keycode = 0x1f;
 277                 ir->mask_keyup = 0x40;
 278                 ir->polling = 1; /* ms */
 279                 break;
 280         case CX88_BOARD_AVERTV_303:
 281         case CX88_BOARD_AVERTV_STUDIO_303:
 282                 ir_codes         = ir_codes_avertv_303;
 283                 ir->gpio_addr    = MO_GP2_IO;
 284                 ir->mask_keycode = 0xfb;
 285                 ir->mask_keydown = 0x02;
 286                 ir->polling      = 50; /* ms */
 287                 break;
 288         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 289                 ir_codes = ir_codes_dntv_live_dvbt_pro;
 290                 ir_type = IR_TYPE_PD;
 291                 ir->sampling = 0xff00; /* address */
 292                 break;
 293         case CX88_BOARD_NORWOOD_MICRO:
 294                 ir_codes         = ir_codes_norwood;
 295                 ir->gpio_addr    = MO_GP1_IO;
 296                 ir->mask_keycode = 0x0e;
 297                 ir->mask_keyup   = 0x80;
 298                 ir->polling      = 50; /* ms */
 299                 break;
 300         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
 301                 ir_codes = ir_codes_npgtech;
 302                 ir->gpio_addr = MO_GP0_IO;
 303                 ir->mask_keycode = 0xfa;
 304                 ir->polling = 50; /* ms */
 305                 break;
 306         }
 307
 308         if (NULL == ir_codes) {
 309                 err = -ENODEV;
 310                 goto err_out_free;
 311         }
 312
 313         /* init input device */
 314         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)",
 315                  cx88_boards[core->board].name);
 316         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 317
 318         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
 319         input_dev->name = ir->name;
 320         input_dev->phys = ir->phys;
 321         input_dev->id.bustype = BUS_PCI;
 322         input_dev->id.version = 1;
 323         if (pci->subsystem_vendor) {
 324                 input_dev->id.vendor = pci->subsystem_vendor;
 325                 input_dev->id.product = pci->subsystem_device;
 326         } else {
 327                 input_dev->id.vendor = pci->vendor;
 328                 input_dev->id.product = pci->device;
 329         }
 330         input_dev->dev.parent = &pci->dev;
 331         /* record handles to ourself */
 332         ir->core = core;
 333         core->ir = ir;
 334
 335         cx88_ir_start(core, ir);
 336
 337         /* all done */
 338         err = input_register_device(ir->input);
 339         if (err)
 340                 goto err_out_stop;
 341
 342         return 0;
 343
 344  err_out_stop:
 345         cx88_ir_stop(core, ir);
 346         core->ir = NULL;
 347  err_out_free:
 348         input_free_device(input_dev);
 349         kfree(ir);
 350         return err;
 351 }
 352
 353 int cx88_ir_fini(struct cx88_core *core)
 354 {
 355         struct cx88_IR *ir = core->ir;
 356
 357         /* skip detach on non attached boards */
 358         if (NULL == ir)
 359                 return 0;
 360
 361         cx88_ir_stop(core, ir);
 362         input_unregister_device(ir->input);
 363         kfree(ir);
 364
 365         /* done */
 366         core->ir = NULL;
 367         return 0;
 368 }
 369
 370 /* ---------------------------------------------------------------------- */
 371
 372 void cx88_ir_irq(struct cx88_core *core)
 373 {
 374         struct cx88_IR *ir = core->ir;
 375         u32 samples, ircode;
 376         int i;
 377
 378         if (NULL == ir)
 379                 return;
 380         if (!ir->sampling)
 381                 return;
 382
 383         samples = cx_read(MO_SAMPLE_IO);
 384         if (0 != samples && 0xffffffff != samples) {
 385                 /* record sample data */
 386                 if (ir->scount < ARRAY_SIZE(ir->samples))
 387                         ir->samples[ir->scount++] = samples;
 388                 return;
 389         }
 390         if (!ir->scount) {
 391                 /* nothing to sample */
 392                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
 393                         ir_input_nokey(ir->input, &ir->ir);
 394                 return;
 395         }
 396
 397         /* have a complete sample */
 398         if (ir->scount < ARRAY_SIZE(ir->samples))
 399                 ir->samples[ir->scount++] = samples;
 400         for (i = 0; i < ir->scount; i++)
 401                 ir->samples[i] = ~ir->samples[i];
 402         if (ir_debug)
 403                 ir_dump_samples(ir->samples, ir->scount);
 404
 405         /* decode it */
 406         switch (core->board) {
 407         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 408         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 409                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
 410
 411                 if (ircode == 0xffffffff) { /* decoding error */
 412                         ir_dprintk("pulse distance decoding error\n");
 413                         break;
 414                 }
 415
 416                 ir_dprintk("pulse distance decoded: %x\n", ircode);
 417
 418                 if (ircode == 0) { /* key still pressed */
 419                         ir_dprintk("pulse distance decoded repeat code\n");
 420                         ir->release = jiffies + msecs_to_jiffies(120);
 421                         break;
 422                 }
 423
 424                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
 425                         ir_dprintk("pulse distance decoded wrong address\n");
 426                         break;
 427                 }
 428
 429                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
 430                         ir_dprintk("pulse distance decoded wrong check sum\n");
 431                         break;
 432                 }
 433
 434                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
 435
 436                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
 437                 ir->release = jiffies + msecs_to_jiffies(120);
 438                 break;
 439         case CX88_BOARD_HAUPPAUGE:
 440         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 441         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 442         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 443         case CX88_BOARD_HAUPPAUGE_HVR1100:
 444         case CX88_BOARD_HAUPPAUGE_HVR3000:
 445                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 446                 ir_dprintk("biphase decoded: %x\n", ircode);
 447                 if ((ircode & 0xfffff000) != 0x3000)
 448                         break;
 449                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
 450                 ir->release = jiffies + msecs_to_jiffies(120);
 451                 break;
 452         }
 453
 454         ir->scount = 0;
 455         return;
 456 }
 457
 458 /* ---------------------------------------------------------------------- */
 459
 460 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 461 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 462 MODULE_LICENSE("GPL");
 463 /*
 464  * Local variables:
 465  * c-basic-offset: 8
 466  * End:
 467  */