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;
  74
  75         /* read gpio value */
  76         gpio = cx_read(ir->gpio_addr);
  77         if (ir->polling) {
  78                 if (ir->last_gpio == gpio)
  79                         return;
  80                 ir->last_gpio = gpio;
  81         }
  82
  83         /* extract data */
  84         data = ir_extract_bits(gpio, ir->mask_keycode);
  85         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
  86                    gpio, data,
  87                    ir->polling ? "poll" : "irq",
  88                    (gpio & ir->mask_keydown) ? " down" : "",
  89                    (gpio & ir->mask_keyup) ? " up" : "");
  90
  91         if (ir->mask_keydown) {
  92                 /* bit set on keydown */
  93                 if (gpio & ir->mask_keydown) {
  94                         ir_input_keydown(ir->input, &ir->ir, data, data);
  95                 } else {
  96                         ir_input_nokey(ir->input, &ir->ir);
  97                 }
  98
  99         } else if (ir->mask_keyup) {
 100                 /* bit cleared on keydown */
 101                 if (0 == (gpio & ir->mask_keyup)) {
 102                         ir_input_keydown(ir->input, &ir->ir, data, data);
 103                 } else {
 104                         ir_input_nokey(ir->input, &ir->ir);
 105                 }
 106
 107         } else {
 108                 /* can't distinguish keydown/up :-/ */
 109                 ir_input_keydown(ir->input, &ir->ir, data, data);
 110                 ir_input_nokey(ir->input, &ir->ir);
 111         }
 112 }
 113
 114 static void ir_timer(unsigned long data)
 115 {
 116         struct cx88_IR *ir = (struct cx88_IR *)data;
 117
 118         schedule_work(&ir->work);
 119 }
 120
 121 static void cx88_ir_work(void *data)
 122 {
 123         struct cx88_IR *ir = data;
 124         unsigned long timeout;
 125
 126         cx88_ir_handle_key(ir);
 127         timeout = jiffies + (ir->polling * HZ / 1000);
 128         mod_timer(&ir->timer, timeout);
 129 }
 130
 131 /* ---------------------------------------------------------------------- */
 132
 133 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
 134 {
 135         struct cx88_IR *ir;
 136         struct input_dev *input_dev;
 137         IR_KEYTAB_TYPE *ir_codes = NULL;
 138         int ir_type = IR_TYPE_OTHER;
 139
 140         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 141         input_dev = input_allocate_device();
 142         if (!ir || !input_dev) {
 143                 kfree(ir);
 144                 input_free_device(input_dev);
 145                 return -ENOMEM;
 146         }
 147
 148         ir->input = input_dev;
 149
 150         /* detect & configure */
 151         switch (core->board) {
 152         case CX88_BOARD_DNTV_LIVE_DVB_T:
 153         case CX88_BOARD_KWORLD_DVB_T:
 154         case CX88_BOARD_KWORLD_DVB_T_CX22702:
 155                 ir_codes = ir_codes_dntv_live_dvb_t;
 156                 ir->gpio_addr = MO_GP1_IO;
 157                 ir->mask_keycode = 0x1f;
 158                 ir->mask_keyup = 0x60;
 159                 ir->polling = 50; /* ms */
 160                 break;
 161         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 162                 ir_codes = ir_codes_cinergy_1400;
 163                 ir_type = IR_TYPE_PD;
 164                 ir->sampling = 0xeb04; /* address */
 165                 break;
 166         case CX88_BOARD_HAUPPAUGE:
 167         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 168         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 169         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 170         case CX88_BOARD_HAUPPAUGE_HVR1100:
 171                 ir_codes = ir_codes_hauppauge_new;
 172                 ir_type = IR_TYPE_RC5;
 173                 ir->sampling = 1;
 174                 break;
 175         case CX88_BOARD_WINFAST2000XP_EXPERT:
 176                 ir_codes = ir_codes_winfast;
 177                 ir->gpio_addr = MO_GP0_IO;
 178                 ir->mask_keycode = 0x8f8;
 179                 ir->mask_keyup = 0x100;
 180                 ir->polling = 1; /* ms */
 181                 break;
 182         case CX88_BOARD_IODATA_GVBCTV7E:
 183                 ir_codes = ir_codes_iodata_bctv7e;
 184                 ir->gpio_addr = MO_GP0_IO;
 185                 ir->mask_keycode = 0xfd;
 186                 ir->mask_keydown = 0x02;
 187                 ir->polling = 5; /* ms */
 188                 break;
 189        case CX88_BOARD_PROLINK_PLAYTVPVR:
 190         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
 191                 ir_codes = ir_codes_pixelview;
 192                 ir->gpio_addr = MO_GP1_IO;
 193                 ir->mask_keycode = 0x1f;
 194                 ir->mask_keyup = 0x80;
 195                 ir->polling = 1; /* ms */
 196                 break;
 197         case CX88_BOARD_KWORLD_LTV883:
 198                 ir_codes = ir_codes_pixelview;
 199                 ir->gpio_addr = MO_GP1_IO;
 200                 ir->mask_keycode = 0x1f;
 201                 ir->mask_keyup = 0x60;
 202                 ir->polling = 1; /* ms */
 203                 break;
 204         case CX88_BOARD_ADSTECH_DVB_T_PCI:
 205                 ir_codes = ir_codes_adstech_dvb_t_pci;
 206                 ir->gpio_addr = MO_GP1_IO;
 207                 ir->mask_keycode = 0xbf;
 208                 ir->mask_keyup = 0x40;
 209                 ir->polling = 50; /* ms */
 210                 break;
 211         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
 212                 ir_codes = ir_codes_msi_tvanywhere;
 213                 ir->gpio_addr = MO_GP1_IO;
 214                 ir->mask_keycode = 0x1f;
 215                 ir->mask_keyup = 0x40;
 216                 ir->polling = 1; /* ms */
 217                 break;
 218         case CX88_BOARD_AVERTV_303:
 219         case CX88_BOARD_AVERTV_STUDIO_303:
 220                 ir_codes         = ir_codes_avertv_303;
 221                 ir->gpio_addr    = MO_GP2_IO;
 222                 ir->mask_keycode = 0xfb;
 223                 ir->mask_keydown = 0x02;
 224                 ir->polling      = 50; /* ms */
 225                 break;
 226         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 227                 ir_codes = ir_codes_dntv_live_dvbt_pro;
 228                 ir_type = IR_TYPE_PD;
 229                 ir->sampling = 0xff00; /* address */
 230                 break;
 231         }
 232
 233         if (NULL == ir_codes) {
 234                 kfree(ir);
 235                 input_free_device(input_dev);
 236                 return -ENODEV;
 237         }
 238
 239         /* init input device */
 240         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)",
 241                  cx88_boards[core->board].name);
 242         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 243
 244         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
 245         input_dev->name = ir->name;
 246         input_dev->phys = ir->phys;
 247         input_dev->id.bustype = BUS_PCI;
 248         input_dev->id.version = 1;
 249         if (pci->subsystem_vendor) {
 250                 input_dev->id.vendor = pci->subsystem_vendor;
 251                 input_dev->id.product = pci->subsystem_device;
 252         } else {
 253                 input_dev->id.vendor = pci->vendor;
 254                 input_dev->id.product = pci->device;
 255         }
 256         input_dev->cdev.dev = &pci->dev;
 257         /* record handles to ourself */
 258         ir->core = core;
 259         core->ir = ir;
 260
 261         if (ir->polling) {
 262                 INIT_WORK(&ir->work, cx88_ir_work, ir);
 263                 init_timer(&ir->timer);
 264                 ir->timer.function = ir_timer;
 265                 ir->timer.data = (unsigned long)ir;
 266                 schedule_work(&ir->work);
 267         }
 268         if (ir->sampling) {
 269                 core->pci_irqmask |= (1 << 18); /* IR_SMP_INT */
 270                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
 271                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
 272         }
 273
 274         /* all done */
 275         input_register_device(ir->input);
 276
 277         return 0;
 278 }
 279
 280 int cx88_ir_fini(struct cx88_core *core)
 281 {
 282         struct cx88_IR *ir = core->ir;
 283
 284         /* skip detach on non attached boards */
 285         if (NULL == ir)
 286                 return 0;
 287
 288         if (ir->sampling) {
 289                 cx_write(MO_DDSCFG_IO, 0x0);
 290                 core->pci_irqmask &= ~(1 << 18);
 291         }
 292         if (ir->polling) {
 293                 del_timer(&ir->timer);
 294                 flush_scheduled_work();
 295         }
 296
 297         input_unregister_device(ir->input);
 298         kfree(ir);
 299
 300         /* done */
 301         core->ir = NULL;
 302         return 0;
 303 }
 304
 305 /* ---------------------------------------------------------------------- */
 306
 307 void cx88_ir_irq(struct cx88_core *core)
 308 {
 309         struct cx88_IR *ir = core->ir;
 310         u32 samples, ircode;
 311         int i;
 312
 313         if (NULL == ir)
 314                 return;
 315         if (!ir->sampling)
 316                 return;
 317
 318         samples = cx_read(MO_SAMPLE_IO);
 319         if (0 != samples && 0xffffffff != samples) {
 320                 /* record sample data */
 321                 if (ir->scount < ARRAY_SIZE(ir->samples))
 322                         ir->samples[ir->scount++] = samples;
 323                 return;
 324         }
 325         if (!ir->scount) {
 326                 /* nothing to sample */
 327                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
 328                         ir_input_nokey(ir->input, &ir->ir);
 329                 return;
 330         }
 331
 332         /* have a complete sample */
 333         if (ir->scount < ARRAY_SIZE(ir->samples))
 334                 ir->samples[ir->scount++] = samples;
 335         for (i = 0; i < ir->scount; i++)
 336                 ir->samples[i] = ~ir->samples[i];
 337         if (ir_debug)
 338                 ir_dump_samples(ir->samples, ir->scount);
 339
 340         /* decode it */
 341         switch (core->board) {
 342         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 343         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 344                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
 345
 346                 if (ircode == 0xffffffff) { /* decoding error */
 347                         ir_dprintk("pulse distance decoding error\n");
 348                         break;
 349                 }
 350
 351                 ir_dprintk("pulse distance decoded: %x\n", ircode);
 352
 353                 if (ircode == 0) { /* key still pressed */
 354                         ir_dprintk("pulse distance decoded repeat code\n");
 355                         ir->release = jiffies + msecs_to_jiffies(120);
 356                         break;
 357                 }
 358
 359                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
 360                         ir_dprintk("pulse distance decoded wrong address\n");
 361                         break;
 362                 }
 363
 364                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
 365                         ir_dprintk("pulse distance decoded wrong check sum\n");
 366                         break;
 367                 }
 368
 369                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
 370
 371                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
 372                 ir->release = jiffies + msecs_to_jiffies(120);
 373                 break;
 374         case CX88_BOARD_HAUPPAUGE:
 375         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 376         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 377         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 378         case CX88_BOARD_HAUPPAUGE_HVR1100:
 379                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
 380                 ir_dprintk("biphase decoded: %x\n", ircode);
 381                 if ((ircode & 0xfffff000) != 0x3000)
 382                         break;
 383                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
 384                 ir->release = jiffies + msecs_to_jiffies(120);
 385                 break;
 386         }
 387
 388         ir->scount = 0;
 389         return;
 390 }
 391
 392 /* ---------------------------------------------------------------------- */
 393
 394 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 395 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 396 MODULE_LICENSE("GPL");
 397 /*
 398  * Local variables:
 399  * c-basic-offset: 8
 400  * End:
 401  */