Pileus Git - ~andy/linux/blob - 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-core.h>
  34 #include <media/ir-common.h>
  35
  36 #define MODULE_NAME "cx88xx"
  37
  38 /* ---------------------------------------------------------------------- */
  39
  40 struct cx88_IR {
  41         struct cx88_core *core;
  42         struct input_dev *input;
  43         struct ir_dev_props props;
  44
  45         int users;
  46
  47         char name[32];
  48         char phys[32];
  49
  50         /* sample from gpio pin 16 */
  51         u32 sampling;
  52
  53         /* poll external decoder */
  54         int polling;
  55         struct hrtimer timer;
  56         u32 gpio_addr;
  57         u32 last_gpio;
  58         u32 mask_keycode;
  59         u32 mask_keydown;
  60         u32 mask_keyup;
  61 };
  62
  63 static unsigned ir_samplerate = 4;
  64 module_param(ir_samplerate, uint, 0444);
  65 MODULE_PARM_DESC(ir_samplerate, "IR samplerate in kHz, 1 - 20, default 4");
  66
  67 static int ir_debug;
  68 module_param(ir_debug, int, 0644);      /* debug level [IR] */
  69 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
  70
  71 #define ir_dprintk(fmt, arg...) if (ir_debug) \
  72         printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
  73
  74 /* ---------------------------------------------------------------------- */
  75
  76 static void cx88_ir_handle_key(struct cx88_IR *ir)
  77 {
  78         struct cx88_core *core = ir->core;
  79         u32 gpio, data, auxgpio;
  80
  81         /* read gpio value */
  82         gpio = cx_read(ir->gpio_addr);
  83         switch (core->boardnr) {
  84         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
  85                 /* This board apparently uses a combination of 2 GPIO
  86                    to represent the keys. Additionally, the second GPIO
  87                    can be used for parity.
  88
  89                    Example:
  90
  91                    for key "5"
  92                         gpio = 0x758, auxgpio = 0xe5 or 0xf5
  93                    for key "Power"
  94                         gpio = 0x758, auxgpio = 0xed or 0xfd
  95                  */
  96
  97                 auxgpio = cx_read(MO_GP1_IO);
  98                 /* Take out the parity part */
  99                 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
 100                 break;
 101         case CX88_BOARD_WINFAST_DTV1000:
 102         case CX88_BOARD_WINFAST_DTV1800H:
 103         case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
 104                 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
 105                 auxgpio = gpio;
 106                 break;
 107         default:
 108                 auxgpio = gpio;
 109         }
 110         if (ir->polling) {
 111                 if (ir->last_gpio == auxgpio)
 112                         return;
 113                 ir->last_gpio = auxgpio;
 114         }
 115
 116         /* extract data */
 117         data = ir_extract_bits(gpio, ir->mask_keycode);
 118         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
 119                    gpio, data,
 120                    ir->polling ? "poll" : "irq",
 121                    (gpio & ir->mask_keydown) ? " down" : "",
 122                    (gpio & ir->mask_keyup) ? " up" : "");
 123
 124         if (ir->core->boardnr == CX88_BOARD_NORWOOD_MICRO) {
 125                 u32 gpio_key = cx_read(MO_GP0_IO);
 126
 127                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
 128
 129                 ir_keydown(ir->input, data, 0);
 130
 131         } else if (ir->mask_keydown) {
 132                 /* bit set on keydown */
 133                 if (gpio & ir->mask_keydown)
 134                         ir_keydown_notimeout(ir->input, data, 0);
 135                 else
 136                         ir_keyup(ir->input);
 137
 138         } else if (ir->mask_keyup) {
 139                 /* bit cleared on keydown */
 140                 if (0 == (gpio & ir->mask_keyup))
 141                         ir_keydown_notimeout(ir->input, data, 0);
 142                 else
 143                         ir_keyup(ir->input);
 144
 145         } else {
 146                 /* can't distinguish keydown/up :-/ */
 147                 ir_keydown_notimeout(ir->input, data, 0);
 148                 ir_keyup(ir->input);
 149         }
 150 }
 151
 152 static enum hrtimer_restart cx88_ir_work(struct hrtimer *timer)
 153 {
 154         unsigned long missed;
 155         struct cx88_IR *ir = container_of(timer, struct cx88_IR, timer);
 156
 157         cx88_ir_handle_key(ir);
 158         missed = hrtimer_forward_now(&ir->timer,
 159                                      ktime_set(0, ir->polling * 1000000));
 160         if (missed > 1)
 161                 ir_dprintk("Missed ticks %ld\n", missed - 1);
 162
 163         return HRTIMER_RESTART;
 164 }
 165
 166 static int __cx88_ir_start(void *priv)
 167 {
 168         struct cx88_core *core = priv;
 169         struct cx88_IR *ir;
 170
 171         if (!core || !core->ir)
 172                 return -EINVAL;
 173
 174         ir = core->ir;
 175
 176         if (ir->polling) {
 177                 hrtimer_init(&ir->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 178                 ir->timer.function = cx88_ir_work;
 179                 hrtimer_start(&ir->timer,
 180                               ktime_set(0, ir->polling * 1000000),
 181                               HRTIMER_MODE_REL);
 182         }
 183         if (ir->sampling) {
 184                 core->pci_irqmask |= PCI_INT_IR_SMPINT;
 185                 cx_write(MO_DDS_IO, 0x33F286 * ir_samplerate); /* samplerate */
 186                 cx_write(MO_DDSCFG_IO, 0x5); /* enable */
 187         }
 188         return 0;
 189 }
 190
 191 static void __cx88_ir_stop(void *priv)
 192 {
 193         struct cx88_core *core = priv;
 194         struct cx88_IR *ir;
 195
 196         if (!core || !core->ir)
 197                 return;
 198
 199         ir = core->ir;
 200         if (ir->sampling) {
 201                 cx_write(MO_DDSCFG_IO, 0x0);
 202                 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
 203         }
 204
 205         if (ir->polling)
 206                 hrtimer_cancel(&ir->timer);
 207 }
 208
 209 int cx88_ir_start(struct cx88_core *core)
 210 {
 211         if (core->ir->users)
 212                 return __cx88_ir_start(core);
 213
 214         return 0;
 215 }
 216
 217 void cx88_ir_stop(struct cx88_core *core)
 218 {
 219         if (core->ir->users)
 220                 __cx88_ir_stop(core);
 221 }
 222
 223 static int cx88_ir_open(void *priv)
 224 {
 225         struct cx88_core *core = priv;
 226
 227         core->ir->users++;
 228         return __cx88_ir_start(core);
 229 }
 230
 231 static void cx88_ir_close(void *priv)
 232 {
 233         struct cx88_core *core = priv;
 234
 235         core->ir->users--;
 236         if (!core->ir->users)
 237                 __cx88_ir_stop(core);
 238 }
 239
 240 /* ---------------------------------------------------------------------- */
 241
 242 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
 243 {
 244         struct cx88_IR *ir;
 245         struct input_dev *input_dev;
 246         char *ir_codes = NULL;
 247         u64 ir_type = IR_TYPE_OTHER;
 248         int err = -ENOMEM;
 249         u32 hardware_mask = 0;  /* For devices with a hardware mask, when
 250                                  * used with a full-code IR table
 251                                  */
 252
 253         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 254         input_dev = input_allocate_device();
 255         if (!ir || !input_dev)
 256                 goto err_out_free;
 257
 258         ir->input = input_dev;
 259
 260         /* detect & configure */
 261         switch (core->boardnr) {
 262         case CX88_BOARD_DNTV_LIVE_DVB_T:
 263         case CX88_BOARD_KWORLD_DVB_T:
 264         case CX88_BOARD_KWORLD_DVB_T_CX22702:
 265                 ir_codes = RC_MAP_DNTV_LIVE_DVB_T;
 266                 ir->gpio_addr = MO_GP1_IO;
 267                 ir->mask_keycode = 0x1f;
 268                 ir->mask_keyup = 0x60;
 269                 ir->polling = 50; /* ms */
 270                 break;
 271         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
 272                 ir_codes = RC_MAP_CINERGY_1400;
 273                 ir->sampling = 0xeb04; /* address */
 274                 break;
 275         case CX88_BOARD_HAUPPAUGE:
 276         case CX88_BOARD_HAUPPAUGE_DVB_T1:
 277         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
 278         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
 279         case CX88_BOARD_HAUPPAUGE_HVR1100:
 280         case CX88_BOARD_HAUPPAUGE_HVR3000:
 281         case CX88_BOARD_HAUPPAUGE_HVR4000:
 282         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
 283         case CX88_BOARD_PCHDTV_HD3000:
 284         case CX88_BOARD_PCHDTV_HD5500:
 285         case CX88_BOARD_HAUPPAUGE_IRONLY:
 286                 ir_codes = RC_MAP_HAUPPAUGE_NEW;
 287                 ir->sampling = 1;
 288                 break;
 289         case CX88_BOARD_WINFAST_DTV2000H:
 290         case CX88_BOARD_WINFAST_DTV2000H_J:
 291         case CX88_BOARD_WINFAST_DTV1800H:
 292                 ir_codes = RC_MAP_WINFAST;
 293                 ir->gpio_addr = MO_GP0_IO;
 294                 ir->mask_keycode = 0x8f8;
 295                 ir->mask_keyup = 0x100;
 296                 ir->polling = 50; /* ms */
 297                 break;
 298         case CX88_BOARD_WINFAST2000XP_EXPERT:
 299         case CX88_BOARD_WINFAST_DTV1000:
 300         case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
 301                 ir_codes = RC_MAP_WINFAST;
 302                 ir->gpio_addr = MO_GP0_IO;
 303                 ir->mask_keycode = 0x8f8;
 304                 ir->mask_keyup = 0x100;
 305                 ir->polling = 1; /* ms */
 306                 break;
 307         case CX88_BOARD_IODATA_GVBCTV7E:
 308                 ir_codes = RC_MAP_IODATA_BCTV7E;
 309                 ir->gpio_addr = MO_GP0_IO;
 310                 ir->mask_keycode = 0xfd;
 311                 ir->mask_keydown = 0x02;
 312                 ir->polling = 5; /* ms */
 313                 break;
 314         case CX88_BOARD_PROLINK_PLAYTVPVR:
 315         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
 316                 /*
 317                  * It seems that this hardware is paired with NEC extended
 318                  * address 0x866b. So, unfortunately, its usage with other
 319                  * IR's with different address won't work. Still, there are
 320                  * other IR's from the same manufacturer that works, like the
 321                  * 002-T mini RC, provided with newer PV hardware
 322                  */
 323                 ir_codes = RC_MAP_PIXELVIEW_MK12;
 324                 ir->gpio_addr = MO_GP1_IO;
 325                 ir->mask_keyup = 0x80;
 326                 ir->polling = 10; /* ms */
 327                 hardware_mask = 0x3f;   /* Hardware returns only 6 bits from command part */
 328                 break;
 329         case CX88_BOARD_PROLINK_PV_8000GT:
 330         case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
 331                 ir_codes = RC_MAP_PIXELVIEW_NEW;
 332                 ir->gpio_addr = MO_GP1_IO;
 333                 ir->mask_keycode = 0x3f;
 334                 ir->mask_keyup = 0x80;
 335                 ir->polling = 1; /* ms */
 336                 break;
 337         case CX88_BOARD_KWORLD_LTV883:
 338                 ir_codes = RC_MAP_PIXELVIEW;
 339                 ir->gpio_addr = MO_GP1_IO;
 340                 ir->mask_keycode = 0x1f;
 341                 ir->mask_keyup = 0x60;
 342                 ir->polling = 1; /* ms */
 343                 break;
 344         case CX88_BOARD_ADSTECH_DVB_T_PCI:
 345                 ir_codes = RC_MAP_ADSTECH_DVB_T_PCI;
 346                 ir->gpio_addr = MO_GP1_IO;
 347                 ir->mask_keycode = 0xbf;
 348                 ir->mask_keyup = 0x40;
 349                 ir->polling = 50; /* ms */
 350                 break;
 351         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
 352                 ir_codes = RC_MAP_MSI_TVANYWHERE;
 353                 ir->gpio_addr = MO_GP1_IO;
 354                 ir->mask_keycode = 0x1f;
 355                 ir->mask_keyup = 0x40;
 356                 ir->polling = 1; /* ms */
 357                 break;
 358         case CX88_BOARD_AVERTV_303:
 359         case CX88_BOARD_AVERTV_STUDIO_303:
 360                 ir_codes         = RC_MAP_AVERTV_303;
 361                 ir->gpio_addr    = MO_GP2_IO;
 362                 ir->mask_keycode = 0xfb;
 363                 ir->mask_keydown = 0x02;
 364                 ir->polling      = 50; /* ms */
 365                 break;
 366         case CX88_BOARD_OMICOM_SS4_PCI:
 367         case CX88_BOARD_SATTRADE_ST4200:
 368         case CX88_BOARD_TBS_8920:
 369         case CX88_BOARD_TBS_8910:
 370         case CX88_BOARD_PROF_7300:
 371         case CX88_BOARD_PROF_7301:
 372         case CX88_BOARD_PROF_6200:
 373                 ir_codes = RC_MAP_TBS_NEC;
 374                 ir->sampling = 0xff00; /* address */
 375                 break;
 376         case CX88_BOARD_TEVII_S460:
 377         case CX88_BOARD_TEVII_S420:
 378                 ir_codes = RC_MAP_TEVII_NEC;
 379                 ir->sampling = 0xff00; /* address */
 380                 break;
 381         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
 382                 ir_codes         = RC_MAP_DNTV_LIVE_DVBT_PRO;
 383                 ir->sampling     = 0xff00; /* address */
 384                 break;
 385         case CX88_BOARD_NORWOOD_MICRO:
 386                 ir_codes         = RC_MAP_NORWOOD;
 387                 ir->gpio_addr    = MO_GP1_IO;
 388                 ir->mask_keycode = 0x0e;
 389                 ir->mask_keyup   = 0x80;
 390                 ir->polling      = 50; /* ms */
 391                 break;
 392         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
 393                 ir_codes         = RC_MAP_NPGTECH;
 394                 ir->gpio_addr    = MO_GP0_IO;
 395                 ir->mask_keycode = 0xfa;
 396                 ir->polling      = 50; /* ms */
 397                 break;
 398         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
 399                 ir_codes         = RC_MAP_PINNACLE_PCTV_HD;
 400                 ir->sampling     = 1;
 401                 break;
 402         case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
 403                 ir_codes         = RC_MAP_POWERCOLOR_REAL_ANGEL;
 404                 ir->gpio_addr    = MO_GP2_IO;
 405                 ir->mask_keycode = 0x7e;
 406                 ir->polling      = 100; /* ms */
 407                 break;
 408         case CX88_BOARD_TWINHAN_VP1027_DVBS:
 409                 ir_codes         = RC_MAP_TWINHAN_VP1027_DVBS;
 410                 ir_type          = IR_TYPE_NEC;
 411                 ir->sampling     = 0xff00; /* address */
 412                 break;
 413         }
 414
 415         if (!ir_codes) {
 416                 err = -ENODEV;
 417                 goto err_out_free;
 418         }
 419
 420         /*
 421          * The usage of mask_keycode were very convenient, due to several
 422          * reasons. Among others, the scancode tables were using the scancode
 423          * as the index elements. So, the less bits it was used, the smaller
 424          * the table were stored. After the input changes, the better is to use
 425          * the full scancodes, since it allows replacing the IR remote by
 426          * another one. Unfortunately, there are still some hardware, like
 427          * Pixelview Ultra Pro, where only part of the scancode is sent via
 428          * GPIO. So, there's no way to get the full scancode. Due to that,
 429          * hardware_mask were introduced here: it represents those hardware
 430          * that has such limits.
 431          */
 432         if (hardware_mask && !ir->mask_keycode)
 433                 ir->mask_keycode = hardware_mask;
 434
 435         /* init input device */
 436         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
 437         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
 438
 439         input_dev->name = ir->name;
 440         input_dev->phys = ir->phys;
 441         input_dev->id.bustype = BUS_PCI;
 442         input_dev->id.version = 1;
 443         if (pci->subsystem_vendor) {
 444                 input_dev->id.vendor = pci->subsystem_vendor;
 445                 input_dev->id.product = pci->subsystem_device;
 446         } else {
 447                 input_dev->id.vendor = pci->vendor;
 448                 input_dev->id.product = pci->device;
 449         }
 450         input_dev->dev.parent = &pci->dev;
 451         /* record handles to ourself */
 452         ir->core = core;
 453         core->ir = ir;
 454
 455         if (ir->sampling) {
 456                 ir_type = IR_TYPE_ALL;
 457                 ir->props.driver_type = RC_DRIVER_IR_RAW;
 458                 ir->props.timeout = 10 * 1000 * 1000; /* 10 ms */
 459         } else
 460                 ir->props.driver_type = RC_DRIVER_SCANCODE;
 461
 462         ir->props.priv = core;
 463         ir->props.open = cx88_ir_open;
 464         ir->props.close = cx88_ir_close;
 465         ir->props.scanmask = hardware_mask;
 466         ir->props.allowed_protos = ir_type;
 467
 468         /* all done */
 469         err = ir_input_register(ir->input, ir_codes, &ir->props, MODULE_NAME);
 470         if (err)
 471                 goto err_out_free;
 472
 473         return 0;
 474
 475  err_out_free:
 476         core->ir = NULL;
 477         kfree(ir);
 478         return err;
 479 }
 480
 481 int cx88_ir_fini(struct cx88_core *core)
 482 {
 483         struct cx88_IR *ir = core->ir;
 484
 485         /* skip detach on non attached boards */
 486         if (NULL == ir)
 487                 return 0;
 488
 489         cx88_ir_stop(core);
 490         ir_input_unregister(ir->input);
 491         kfree(ir);
 492
 493         /* done */
 494         core->ir = NULL;
 495         return 0;
 496 }
 497
 498 /* ---------------------------------------------------------------------- */
 499
 500 void cx88_ir_irq(struct cx88_core *core)
 501 {
 502         struct cx88_IR *ir = core->ir;
 503         u32 samples;
 504         unsigned todo, bits;
 505         struct ir_raw_event ev;
 506         struct ir_input_dev *irdev;
 507
 508         if (!ir || !ir->sampling)
 509                 return;
 510
 511         /*
 512          * Samples are stored in a 32 bit register, oldest sample in
 513          * the msb. A set bit represents space and an unset bit
 514          * represents a pulse.
 515          */
 516         samples = cx_read(MO_SAMPLE_IO);
 517         irdev = input_get_drvdata(ir->input);
 518
 519         if (samples == 0xff && irdev->idle)
 520                 return;
 521
 522         init_ir_raw_event(&ev);
 523         for (todo = 32; todo > 0; todo -= bits) {
 524                 ev.pulse = samples & 0x80000000 ? false : true;
 525                 bits = min(todo, 32U - fls(ev.pulse ? samples : ~samples));
 526                 ev.duration = (bits * NSEC_PER_SEC) / (1000 * ir_samplerate);
 527                 ir_raw_event_store_with_filter(ir->input, &ev);
 528                 samples <<= bits;
 529         }
 530         ir_raw_event_handle(ir->input);
 531 }
 532
 533 void cx88_i2c_init_ir(struct cx88_core *core)
 534 {
 535         struct i2c_board_info info;
 536         const unsigned short addr_list[] = {
 537                 0x18, 0x6b, 0x71,
 538                 I2C_CLIENT_END
 539         };
 540         const unsigned short *addrp;
 541         /* Instantiate the IR receiver device, if present */
 542         if (0 != core->i2c_rc)
 543                 return;
 544
 545         memset(&info, 0, sizeof(struct i2c_board_info));
 546         strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
 547
 548         /*
 549          * We can't call i2c_new_probed_device() because it uses
 550          * quick writes for probing and at least some RC receiver
 551          * devices only reply to reads.
 552          * Also, Hauppauge XVR needs to be specified, as address 0x71
 553          * conflicts with another remote type used with saa7134
 554          */
 555         for (addrp = addr_list; *addrp != I2C_CLIENT_END; addrp++) {
 556                 info.platform_data = NULL;
 557                 memset(&core->init_data, 0, sizeof(core->init_data));
 558
 559                 if (*addrp == 0x71) {
 560                         /* Hauppauge XVR */
 561                         core->init_data.name = "cx88 Hauppauge XVR remote";
 562                         core->init_data.ir_codes = RC_MAP_HAUPPAUGE_NEW;
 563                         core->init_data.type = IR_TYPE_RC5;
 564                         core->init_data.internal_get_key_func = IR_KBD_GET_KEY_HAUP_XVR;
 565
 566                         info.platform_data = &core->init_data;
 567                 }
 568                 if (i2c_smbus_xfer(&core->i2c_adap, *addrp, 0,
 569                                         I2C_SMBUS_READ, 0,
 570                                         I2C_SMBUS_QUICK, NULL) >= 0) {
 571                         info.addr = *addrp;
 572                         i2c_new_device(&core->i2c_adap, &info);
 573                         break;
 574                 }
 575         }
 576 }
 577
 578 /* ---------------------------------------------------------------------- */
 579
 580 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
 581 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
 582 MODULE_LICENSE("GPL");