drivers/media/video/bt8xx/bttv-input.c

   1 /*
   2  *
   3  * Copyright (c) 2003 Gerd Knorr
   4  * Copyright (c) 2003 Pavel Machek
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/init.h>
  23 #include <linux/delay.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/input.h>
  26 #include <linux/slab.h>
  27
  28 #include "bttv.h"
  29 #include "bttvp.h"
  30
  31
  32 static int ir_debug;
  33 module_param(ir_debug, int, 0644);
  34
  35 static int ir_rc5_remote_gap = 885;
  36 module_param(ir_rc5_remote_gap, int, 0644);
  37
  38 #undef dprintk
  39 #define dprintk(arg...) do {    \
  40         if (ir_debug >= 1)      \
  41                 printk(arg);    \
  42 } while (0)
  43
  44 #define DEVNAME "bttv-input"
  45
  46 #define MODULE_NAME "bttv"
  47
  48 /* ---------------------------------------------------------------------- */
  49
  50 static void ir_handle_key(struct bttv *btv)
  51 {
  52         struct card_ir *ir = btv->remote;
  53         u32 gpio,data;
  54
  55         /* read gpio value */
  56         gpio = bttv_gpio_read(&btv->c);
  57         if (ir->polling) {
  58                 if (ir->last_gpio == gpio)
  59                         return;
  60                 ir->last_gpio = gpio;
  61         }
  62
  63         /* extract data */
  64         data = ir_extract_bits(gpio, ir->mask_keycode);
  65         dprintk(KERN_INFO DEVNAME ": irq gpio=0x%x code=%d | %s%s%s\n",
  66                 gpio, data,
  67                 ir->polling               ? "poll"  : "irq",
  68                 (gpio & ir->mask_keydown) ? " down" : "",
  69                 (gpio & ir->mask_keyup)   ? " up"   : "");
  70
  71         if ((ir->mask_keydown && (gpio & ir->mask_keydown)) ||
  72             (ir->mask_keyup   && !(gpio & ir->mask_keyup))) {
  73                 rc_keydown_notimeout(ir->dev, data, 0);
  74         } else {
  75                 /* HACK: Probably, ir->mask_keydown is missing
  76                    for this board */
  77                 if (btv->c.type == BTTV_BOARD_WINFAST2000)
  78                         rc_keydown_notimeout(ir->dev, data, 0);
  79
  80                 rc_keyup(ir->dev);
  81         }
  82 }
  83
  84 static void ir_enltv_handle_key(struct bttv *btv)
  85 {
  86         struct card_ir *ir = btv->remote;
  87         u32 gpio, data, keyup;
  88
  89         /* read gpio value */
  90         gpio = bttv_gpio_read(&btv->c);
  91
  92         /* extract data */
  93         data = ir_extract_bits(gpio, ir->mask_keycode);
  94
  95         /* Check if it is keyup */
  96         keyup = (gpio & ir->mask_keyup) ? 1 << 31 : 0;
  97
  98         if ((ir->last_gpio & 0x7f) != data) {
  99                 dprintk(KERN_INFO DEVNAME ": gpio=0x%x code=%d | %s\n",
 100                         gpio, data,
 101                         (gpio & ir->mask_keyup) ? " up" : "up/down");
 102
 103                 rc_keydown_notimeout(ir->dev, data, 0);
 104                 if (keyup)
 105                         rc_keyup(ir->dev);
 106         } else {
 107                 if ((ir->last_gpio & 1 << 31) == keyup)
 108                         return;
 109
 110                 dprintk(KERN_INFO DEVNAME ":(cnt) gpio=0x%x code=%d | %s\n",
 111                         gpio, data,
 112                         (gpio & ir->mask_keyup) ? " up" : "down");
 113
 114                 if (keyup)
 115                         rc_keyup(ir->dev);
 116                 else
 117                         rc_keydown_notimeout(ir->dev, data, 0);
 118         }
 119
 120         ir->last_gpio = data | keyup;
 121 }
 122
 123 void bttv_input_irq(struct bttv *btv)
 124 {
 125         struct card_ir *ir = btv->remote;
 126
 127         if (!ir->polling)
 128                 ir_handle_key(btv);
 129 }
 130
 131 static void bttv_input_timer(unsigned long data)
 132 {
 133         struct bttv *btv = (struct bttv*)data;
 134         struct card_ir *ir = btv->remote;
 135
 136         if (btv->c.type == BTTV_BOARD_ENLTV_FM_2)
 137                 ir_enltv_handle_key(btv);
 138         else
 139                 ir_handle_key(btv);
 140         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
 141 }
 142
 143 /*
 144  * FIXME: Nebula digi uses the legacy way to decode RC5, instead of relying
 145  * on the rc-core way. As we need to be sure that both IRQ transitions are
 146  * properly triggered, Better to touch it only with this hardware for
 147  * testing.
 148  */
 149
 150 #define RC5_START(x)    (((x) >> 12) & 3)
 151 #define RC5_TOGGLE(x)   (((x) >> 11) & 1)
 152 #define RC5_ADDR(x)     (((x) >> 6) & 31)
 153 #define RC5_INSTR(x)    ((x) & 63)
 154
 155 /* decode raw bit pattern to RC5 code */
 156 static u32 bttv_rc5_decode(unsigned int code)
 157 {
 158         unsigned int org_code = code;
 159         unsigned int pair;
 160         unsigned int rc5 = 0;
 161         int i;
 162
 163         for (i = 0; i < 14; ++i) {
 164                 pair = code & 0x3;
 165                 code >>= 2;
 166
 167                 rc5 <<= 1;
 168                 switch (pair) {
 169                 case 0:
 170                 case 2:
 171                         break;
 172                 case 1:
 173                         rc5 |= 1;
 174                 break;
 175                 case 3:
 176                         dprintk(KERN_INFO DEVNAME ":rc5_decode(%x) bad code\n",
 177                                 org_code);
 178                         return 0;
 179                 }
 180         }
 181         dprintk(KERN_INFO DEVNAME ":"
 182                 "code=%x, rc5=%x, start=%x, toggle=%x, address=%x, "
 183                 "instr=%x\n", rc5, org_code, RC5_START(rc5),
 184                 RC5_TOGGLE(rc5), RC5_ADDR(rc5), RC5_INSTR(rc5));
 185         return rc5;
 186 }
 187
 188 void bttv_rc5_timer_end(unsigned long data)
 189 {
 190         struct card_ir *ir = (struct card_ir *)data;
 191         struct timeval tv;
 192         unsigned long current_jiffies;
 193         u32 gap;
 194         u32 rc5 = 0;
 195
 196         /* get time */
 197         current_jiffies = jiffies;
 198         do_gettimeofday(&tv);
 199
 200         /* avoid overflow with gap >1s */
 201         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
 202                 gap = 200000;
 203         } else {
 204                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
 205                     tv.tv_usec - ir->base_time.tv_usec;
 206         }
 207
 208         /* signal we're ready to start a new code */
 209         ir->active = 0;
 210
 211         /* Allow some timer jitter (RC5 is ~24ms anyway so this is ok) */
 212         if (gap < 28000) {
 213                 dprintk(KERN_INFO DEVNAME ": spurious timer_end\n");
 214                 return;
 215         }
 216
 217         if (ir->last_bit < 20) {
 218                 /* ignore spurious codes (caused by light/other remotes) */
 219                 dprintk(KERN_INFO DEVNAME ": short code: %x\n", ir->code);
 220         } else {
 221                 ir->code = (ir->code << ir->shift_by) | 1;
 222                 rc5 = bttv_rc5_decode(ir->code);
 223
 224                 /* two start bits? */
 225                 if (RC5_START(rc5) != ir->start) {
 226                         printk(KERN_INFO DEVNAME ":"
 227                                " rc5 start bits invalid: %u\n", RC5_START(rc5));
 228
 229                         /* right address? */
 230                 } else if (RC5_ADDR(rc5) == ir->addr) {
 231                         u32 toggle = RC5_TOGGLE(rc5);
 232                         u32 instr = RC5_INSTR(rc5);
 233
 234                         /* Good code */
 235                         rc_keydown(ir->dev, instr, toggle);
 236                         dprintk(KERN_INFO DEVNAME ":"
 237                                 " instruction %x, toggle %x\n",
 238                                 instr, toggle);
 239                 }
 240         }
 241 }
 242
 243 static int bttv_rc5_irq(struct bttv *btv)
 244 {
 245         struct card_ir *ir = btv->remote;
 246         struct timeval tv;
 247         u32 gpio;
 248         u32 gap;
 249         unsigned long current_jiffies;
 250
 251         /* read gpio port */
 252         gpio = bttv_gpio_read(&btv->c);
 253
 254         /* remote IRQ? */
 255         if (!(gpio & 0x20))
 256                 return 0;
 257
 258         /* get time of bit */
 259         current_jiffies = jiffies;
 260         do_gettimeofday(&tv);
 261
 262         /* avoid overflow with gap >1s */
 263         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
 264                 gap = 200000;
 265         } else {
 266                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
 267                     tv.tv_usec - ir->base_time.tv_usec;
 268         }
 269
 270         /* active code => add bit */
 271         if (ir->active) {
 272                 /* only if in the code (otherwise spurious IRQ or timer
 273                    late) */
 274                 if (ir->last_bit < 28) {
 275                         ir->last_bit = (gap - ir_rc5_remote_gap / 2) /
 276                             ir_rc5_remote_gap;
 277                         ir->code |= 1 << ir->last_bit;
 278                 }
 279                 /* starting new code */
 280         } else {
 281                 ir->active = 1;
 282                 ir->code = 0;
 283                 ir->base_time = tv;
 284                 ir->last_bit = 0;
 285
 286                 mod_timer(&ir->timer_end,
 287                           current_jiffies + msecs_to_jiffies(30));
 288         }
 289
 290         /* toggle GPIO pin 4 to reset the irq */
 291         bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 292         bttv_gpio_write(&btv->c, gpio | (1 << 4));
 293         return 1;
 294 }
 295
 296 /* ---------------------------------------------------------------------- */
 297
 298 static void bttv_ir_start(struct bttv *btv, struct card_ir *ir)
 299 {
 300         if (ir->polling) {
 301                 setup_timer(&ir->timer, bttv_input_timer, (unsigned long)btv);
 302                 ir->timer.expires  = jiffies + msecs_to_jiffies(1000);
 303                 add_timer(&ir->timer);
 304         } else if (ir->rc5_gpio) {
 305                 /* set timer_end for code completion */
 306                 init_timer(&ir->timer_end);
 307                 ir->timer_end.function = bttv_rc5_timer_end;
 308                 ir->timer_end.data = (unsigned long)ir;
 309                 ir->shift_by = 1;
 310                 ir->start = 3;
 311                 ir->addr = 0x0;
 312                 ir->rc5_remote_gap = ir_rc5_remote_gap;
 313         }
 314 }
 315
 316 static void bttv_ir_stop(struct bttv *btv)
 317 {
 318         if (btv->remote->polling) {
 319                 del_timer_sync(&btv->remote->timer);
 320                 flush_scheduled_work();
 321         }
 322
 323         if (btv->remote->rc5_gpio) {
 324                 u32 gpio;
 325
 326                 del_timer_sync(&btv->remote->timer_end);
 327                 flush_scheduled_work();
 328
 329                 gpio = bttv_gpio_read(&btv->c);
 330                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 331         }
 332 }
 333
 334 /*
 335  * Get_key functions used by I2C remotes
 336  */
 337
 338 static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 339 {
 340         unsigned char b;
 341
 342         /* poll IR chip */
 343         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 344                 dprintk(KERN_INFO DEVNAME ": read error\n");
 345                 return -EIO;
 346         }
 347
 348         /* ignore 0xaa */
 349         if (b==0xaa)
 350                 return 0;
 351         dprintk(KERN_INFO DEVNAME ": key %02x\n", b);
 352
 353         *ir_key = b;
 354         *ir_raw = b;
 355         return 1;
 356 }
 357
 358 /* Instantiate the I2C IR receiver device, if present */
 359 void __devinit init_bttv_i2c_ir(struct bttv *btv)
 360 {
 361         const unsigned short addr_list[] = {
 362                 0x1a, 0x18, 0x64, 0x30, 0x71,
 363                 I2C_CLIENT_END
 364         };
 365         struct i2c_board_info info;
 366
 367         if (0 != btv->i2c_rc)
 368                 return;
 369
 370         memset(&info, 0, sizeof(struct i2c_board_info));
 371         memset(&btv->init_data, 0, sizeof(btv->init_data));
 372         strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
 373
 374         switch (btv->c.type) {
 375         case BTTV_BOARD_PV951:
 376                 btv->init_data.name = "PV951";
 377                 btv->init_data.get_key = get_key_pv951;
 378                 btv->init_data.ir_codes = RC_MAP_PV951;
 379                 info.addr = 0x4b;
 380                 break;
 381         default:
 382                 /*
 383                  * The external IR receiver is at i2c address 0x34 (0x35 for
 384                  * reads).  Future Hauppauge cards will have an internal
 385                  * receiver at 0x30 (0x31 for reads).  In theory, both can be
 386                  * fitted, and Hauppauge suggest an external overrides an
 387                  * internal.
 388                  * That's why we probe 0x1a (~0x34) first. CB
 389                  */
 390
 391                 i2c_new_probed_device(&btv->c.i2c_adap, &info, addr_list, NULL);
 392                 return;
 393         }
 394
 395         if (btv->init_data.name)
 396                 info.platform_data = &btv->init_data;
 397         i2c_new_device(&btv->c.i2c_adap, &info);
 398
 399         return;
 400 }
 401
 402 int __devexit fini_bttv_i2c(struct bttv *btv)
 403 {
 404         if (0 != btv->i2c_rc)
 405                 return 0;
 406
 407         return i2c_del_adapter(&btv->c.i2c_adap);
 408 }
 409
 410 int bttv_input_init(struct bttv *btv)
 411 {
 412         struct card_ir *ir;
 413         char *ir_codes = NULL;
 414         struct rc_dev *rc;
 415         int err = -ENOMEM;
 416
 417         if (!btv->has_remote)
 418                 return -ENODEV;
 419
 420         ir = kzalloc(sizeof(*ir),GFP_KERNEL);
 421         rc = rc_allocate_device();
 422         if (!ir || !rc)
 423                 goto err_out_free;
 424
 425         /* detect & configure */
 426         switch (btv->c.type) {
 427         case BTTV_BOARD_AVERMEDIA:
 428         case BTTV_BOARD_AVPHONE98:
 429         case BTTV_BOARD_AVERMEDIA98:
 430                 ir_codes         = RC_MAP_AVERMEDIA;
 431                 ir->mask_keycode = 0xf88000;
 432                 ir->mask_keydown = 0x010000;
 433                 ir->polling      = 50; // ms
 434                 break;
 435
 436         case BTTV_BOARD_AVDVBT_761:
 437         case BTTV_BOARD_AVDVBT_771:
 438                 ir_codes         = RC_MAP_AVERMEDIA_DVBT;
 439                 ir->mask_keycode = 0x0f00c0;
 440                 ir->mask_keydown = 0x000020;
 441                 ir->polling      = 50; // ms
 442                 break;
 443
 444         case BTTV_BOARD_PXELVWPLTVPAK:
 445                 ir_codes         = RC_MAP_PIXELVIEW;
 446                 ir->mask_keycode = 0x003e00;
 447                 ir->mask_keyup   = 0x010000;
 448                 ir->polling      = 50; // ms
 449                 break;
 450         case BTTV_BOARD_PV_M4900:
 451         case BTTV_BOARD_PV_BT878P_9B:
 452         case BTTV_BOARD_PV_BT878P_PLUS:
 453                 ir_codes         = RC_MAP_PIXELVIEW;
 454                 ir->mask_keycode = 0x001f00;
 455                 ir->mask_keyup   = 0x008000;
 456                 ir->polling      = 50; // ms
 457                 break;
 458
 459         case BTTV_BOARD_WINFAST2000:
 460                 ir_codes         = RC_MAP_WINFAST;
 461                 ir->mask_keycode = 0x1f8;
 462                 break;
 463         case BTTV_BOARD_MAGICTVIEW061:
 464         case BTTV_BOARD_MAGICTVIEW063:
 465                 ir_codes         = RC_MAP_WINFAST;
 466                 ir->mask_keycode = 0x0008e000;
 467                 ir->mask_keydown = 0x00200000;
 468                 break;
 469         case BTTV_BOARD_APAC_VIEWCOMP:
 470                 ir_codes         = RC_MAP_APAC_VIEWCOMP;
 471                 ir->mask_keycode = 0x001f00;
 472                 ir->mask_keyup   = 0x008000;
 473                 ir->polling      = 50; // ms
 474                 break;
 475         case BTTV_BOARD_ASKEY_CPH03X:
 476         case BTTV_BOARD_CONCEPTRONIC_CTVFMI2:
 477         case BTTV_BOARD_CONTVFMI:
 478                 ir_codes         = RC_MAP_PIXELVIEW;
 479                 ir->mask_keycode = 0x001F00;
 480                 ir->mask_keyup   = 0x006000;
 481                 ir->polling      = 50; // ms
 482                 break;
 483         case BTTV_BOARD_NEBULA_DIGITV:
 484                 ir_codes = RC_MAP_NEBULA;
 485                 btv->custom_irq = bttv_rc5_irq;
 486                 ir->rc5_gpio = 1;
 487                 break;
 488         case BTTV_BOARD_MACHTV_MAGICTV:
 489                 ir_codes         = RC_MAP_APAC_VIEWCOMP;
 490                 ir->mask_keycode = 0x001F00;
 491                 ir->mask_keyup   = 0x004000;
 492                 ir->polling      = 50; /* ms */
 493                 break;
 494         case BTTV_BOARD_KOZUMI_KTV_01C:
 495                 ir_codes         = RC_MAP_PCTV_SEDNA;
 496                 ir->mask_keycode = 0x001f00;
 497                 ir->mask_keyup   = 0x006000;
 498                 ir->polling      = 50; /* ms */
 499                 break;
 500         case BTTV_BOARD_ENLTV_FM_2:
 501                 ir_codes         = RC_MAP_ENCORE_ENLTV2;
 502                 ir->mask_keycode = 0x00fd00;
 503                 ir->mask_keyup   = 0x000080;
 504                 ir->polling      = 1; /* ms */
 505                 ir->last_gpio    = ir_extract_bits(bttv_gpio_read(&btv->c),
 506                                                    ir->mask_keycode);
 507                 break;
 508         }
 509         if (NULL == ir_codes) {
 510                 dprintk(KERN_INFO "Ooops: IR config error [card=%d]\n", btv->c.type);
 511                 err = -ENODEV;
 512                 goto err_out_free;
 513         }
 514
 515         if (ir->rc5_gpio) {
 516                 u32 gpio;
 517                 /* enable remote irq */
 518                 bttv_gpio_inout(&btv->c, (1 << 4), 1 << 4);
 519                 gpio = bttv_gpio_read(&btv->c);
 520                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 521                 bttv_gpio_write(&btv->c, gpio | (1 << 4));
 522         } else {
 523                 /* init hardware-specific stuff */
 524                 bttv_gpio_inout(&btv->c, ir->mask_keycode | ir->mask_keydown, 0);
 525         }
 526
 527         /* init input device */
 528         ir->dev = rc;
 529
 530         snprintf(ir->name, sizeof(ir->name), "bttv IR (card=%d)",
 531                  btv->c.type);
 532         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0",
 533                  pci_name(btv->c.pci));
 534
 535         rc->input_name = ir->name;
 536         rc->input_phys = ir->phys;
 537         rc->input_id.bustype = BUS_PCI;
 538         rc->input_id.version = 1;
 539         if (btv->c.pci->subsystem_vendor) {
 540                 rc->input_id.vendor  = btv->c.pci->subsystem_vendor;
 541                 rc->input_id.product = btv->c.pci->subsystem_device;
 542         } else {
 543                 rc->input_id.vendor  = btv->c.pci->vendor;
 544                 rc->input_id.product = btv->c.pci->device;
 545         }
 546         rc->dev.parent = &btv->c.pci->dev;
 547         rc->map_name = ir_codes;
 548         rc->driver_name = MODULE_NAME;
 549
 550         btv->remote = ir;
 551         bttv_ir_start(btv, ir);
 552
 553         /* all done */
 554         err = rc_register_device(rc);
 555         if (err)
 556                 goto err_out_stop;
 557
 558         return 0;
 559
 560  err_out_stop:
 561         bttv_ir_stop(btv);
 562         btv->remote = NULL;
 563  err_out_free:
 564         rc_free_device(rc);
 565         kfree(ir);
 566         return err;
 567 }
 568
 569 void bttv_input_fini(struct bttv *btv)
 570 {
 571         if (btv->remote == NULL)
 572                 return;
 573
 574         bttv_ir_stop(btv);
 575         rc_unregister_device(btv->remote->dev);
 576         kfree(btv->remote);
 577         btv->remote = NULL;
 578 }