drivers/media/video/ir-kbd-i2c.c

   1 /*
   2  *
   3  * keyboard input driver for i2c IR remote controls
   4  *
   5  * Copyright (c) 2000-2003 Gerd Knorr <kraxel@bytesex.org>
   6  * modified for PixelView (BT878P+W/FM) by
   7  *      Michal Kochanowicz <mkochano@pld.org.pl>
   8  *      Christoph Bartelmus <lirc@bartelmus.de>
   9  * modified for KNC ONE TV Station/Anubis Typhoon TView Tuner by
  10  *      Ulrich Mueller <ulrich.mueller42@web.de>
  11  * modified for em2820 based USB TV tuners by
  12  *      Markus Rechberger <mrechberger@gmail.com>
  13  * modified for DViCO Fusion HDTV 5 RT GOLD by
  14  *      Chaogui Zhang <czhang1974@gmail.com>
  15  * modified for MSI TV@nywhere Plus by
  16  *      Henry Wong <henry@stuffedcow.net>
  17  *      Mark Schultz <n9xmj@yahoo.com>
  18  *      Brian Rogers <brian_rogers@comcast.net>
  19  * modified for AVerMedia Cardbus by
  20  *      Oldrich Jedlicka <oldium.pro@seznam.cz>
  21  *
  22  *  This program is free software; you can redistribute it and/or modify
  23  *  it under the terms of the GNU General Public License as published by
  24  *  the Free Software Foundation; either version 2 of the License, or
  25  *  (at your option) any later version.
  26  *
  27  *  This program is distributed in the hope that it will be useful,
  28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  *  GNU General Public License for more details.
  31  *
  32  *  You should have received a copy of the GNU General Public License
  33  *  along with this program; if not, write to the Free Software
  34  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  35  *
  36  */
  37
  38 #include <linux/module.h>
  39 #include <linux/init.h>
  40 #include <linux/kernel.h>
  41 #include <linux/string.h>
  42 #include <linux/timer.h>
  43 #include <linux/delay.h>
  44 #include <linux/errno.h>
  45 #include <linux/slab.h>
  46 #include <linux/i2c.h>
  47 #include <linux/i2c-id.h>
  48 #include <linux/workqueue.h>
  49
  50 #include <media/ir-common.h>
  51 #include <media/ir-kbd-i2c.h>
  52
  53 /* ----------------------------------------------------------------------- */
  54 /* insmod parameters                                                       */
  55
  56 static int debug;
  57 module_param(debug, int, 0644);    /* debug level (0,1,2) */
  58
  59 static int hauppauge;
  60 module_param(hauppauge, int, 0644);    /* Choose Hauppauge remote */
  61 MODULE_PARM_DESC(hauppauge, "Specify Hauppauge remote: 0=black, 1=grey (defaults to 0)");
  62
  63
  64 #define DEVNAME "ir-kbd-i2c"
  65 #define dprintk(level, fmt, arg...)     if (debug >= level) \
  66         printk(KERN_DEBUG DEVNAME ": " fmt , ## arg)
  67
  68 /* ----------------------------------------------------------------------- */
  69
  70 static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
  71                                int size, int offset)
  72 {
  73         unsigned char buf[6];
  74         int start, range, toggle, dev, code, ircode;
  75
  76         /* poll IR chip */
  77         if (size != i2c_master_recv(ir->c, buf, size))
  78                 return -EIO;
  79
  80         /* split rc5 data block ... */
  81         start  = (buf[offset] >> 7) &    1;
  82         range  = (buf[offset] >> 6) &    1;
  83         toggle = (buf[offset] >> 5) &    1;
  84         dev    =  buf[offset]       & 0x1f;
  85         code   = (buf[offset+1] >> 2) & 0x3f;
  86
  87         /* rc5 has two start bits
  88          * the first bit must be one
  89          * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
  90          */
  91         if (!start)
  92                 /* no key pressed */
  93                 return 0;
  94         /*
  95          * Hauppauge remotes (black/silver) always use
  96          * specific device ids. If we do not filter the
  97          * device ids then messages destined for devices
  98          * such as TVs (id=0) will get through causing
  99          * mis-fired events.
 100          *
 101          * We also filter out invalid key presses which
 102          * produce annoying debug log entries.
 103          */
 104         ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
 105         if ((ircode & 0x1fff)==0x1fff)
 106                 /* invalid key press */
 107                 return 0;
 108
 109         if (dev!=0x1e && dev!=0x1f)
 110                 /* not a hauppauge remote */
 111                 return 0;
 112
 113         if (!range)
 114                 code += 64;
 115
 116         dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
 117                 start, range, toggle, dev, code);
 118
 119         /* return key */
 120         *ir_key = code;
 121         *ir_raw = ircode;
 122         return 1;
 123 }
 124
 125 static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 126 {
 127         return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
 128 }
 129
 130 static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 131 {
 132         return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
 133 }
 134
 135 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 136 {
 137         unsigned char b;
 138
 139         /* poll IR chip */
 140         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 141                 dprintk(1,"read error\n");
 142                 return -EIO;
 143         }
 144         *ir_key = b;
 145         *ir_raw = b;
 146         return 1;
 147 }
 148
 149 static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 150 {
 151         unsigned char b;
 152
 153         /* poll IR chip */
 154         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 155                 dprintk(1,"read error\n");
 156                 return -EIO;
 157         }
 158
 159         /* ignore 0xaa */
 160         if (b==0xaa)
 161                 return 0;
 162         dprintk(2,"key %02x\n", b);
 163
 164         *ir_key = b;
 165         *ir_raw = b;
 166         return 1;
 167 }
 168
 169 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 170 {
 171         unsigned char buf[4];
 172
 173         /* poll IR chip */
 174         if (4 != i2c_master_recv(ir->c, buf, 4)) {
 175                 dprintk(1,"read error\n");
 176                 return -EIO;
 177         }
 178
 179         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
 180                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
 181                         buf[0], buf[1], buf[2], buf[3]);
 182
 183         /* no key pressed or signal from other ir remote */
 184         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
 185                 return 0;
 186
 187         *ir_key = buf[2];
 188         *ir_raw = (buf[2] << 8) | buf[3];
 189
 190         return 1;
 191 }
 192
 193 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 194 {
 195         unsigned char b;
 196
 197         /* poll IR chip */
 198         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 199                 dprintk(1,"read error\n");
 200                 return -EIO;
 201         }
 202
 203         /* it seems that 0xFE indicates that a button is still hold
 204            down, while 0xff indicates that no button is hold
 205            down. 0xfe sequences are sometimes interrupted by 0xFF */
 206
 207         dprintk(2,"key %02x\n", b);
 208
 209         if (b == 0xff)
 210                 return 0;
 211
 212         if (b == 0xfe)
 213                 /* keep old data */
 214                 return 1;
 215
 216         *ir_key = b;
 217         *ir_raw = b;
 218         return 1;
 219 }
 220
 221 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
 222                                      u32 *ir_key, u32 *ir_raw)
 223 {
 224         unsigned char subaddr, key, keygroup;
 225         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
 226                                    .buf = &subaddr, .len = 1},
 227                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
 228                                   .buf = &key, .len = 1} };
 229         subaddr = 0x0d;
 230         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 231                 dprintk(1, "read error\n");
 232                 return -EIO;
 233         }
 234
 235         if (key == 0xff)
 236                 return 0;
 237
 238         subaddr = 0x0b;
 239         msg[1].buf = &keygroup;
 240         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 241                 dprintk(1, "read error\n");
 242                 return -EIO;
 243         }
 244
 245         if (keygroup == 0xff)
 246                 return 0;
 247
 248         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
 249         if (keygroup < 2 || keygroup > 3) {
 250                 /* Only a warning */
 251                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
 252                                                                 keygroup, key);
 253         }
 254         key |= (keygroup & 1) << 6;
 255
 256         *ir_key = key;
 257         *ir_raw = key;
 258         return 1;
 259 }
 260
 261 /* ----------------------------------------------------------------------- */
 262
 263 static void ir_key_poll(struct IR_i2c *ir)
 264 {
 265         static u32 ir_key, ir_raw;
 266         int rc;
 267
 268         dprintk(2,"ir_poll_key\n");
 269         rc = ir->get_key(ir, &ir_key, &ir_raw);
 270         if (rc < 0) {
 271                 dprintk(2,"error\n");
 272                 return;
 273         }
 274
 275         if (0 == rc) {
 276                 ir_input_nokey(ir->input, &ir->ir);
 277         } else {
 278                 ir_input_keydown(ir->input, &ir->ir, ir_key);
 279         }
 280 }
 281
 282 static void ir_work(struct work_struct *work)
 283 {
 284         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
 285         int polling_interval = 100;
 286
 287         /* MSI TV@nywhere Plus requires more frequent polling
 288            otherwise it will miss some keypresses */
 289         if (ir->c->adapter->id == I2C_HW_SAA7134 && ir->c->addr == 0x30)
 290                 polling_interval = 50;
 291
 292         ir_key_poll(ir);
 293         schedule_delayed_work(&ir->work, msecs_to_jiffies(polling_interval));
 294 }
 295
 296 /* ----------------------------------------------------------------------- */
 297
 298 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
 299 {
 300         struct ir_scancode_table *ir_codes = NULL;
 301         const char *name = NULL;
 302         u64 ir_type = 0;
 303         struct IR_i2c *ir;
 304         struct input_dev *input_dev;
 305         struct i2c_adapter *adap = client->adapter;
 306         unsigned short addr = client->addr;
 307         int err;
 308
 309         ir = kzalloc(sizeof(struct IR_i2c),GFP_KERNEL);
 310         input_dev = input_allocate_device();
 311         if (!ir || !input_dev) {
 312                 err = -ENOMEM;
 313                 goto err_out_free;
 314         }
 315
 316         ir->c = client;
 317         ir->input = input_dev;
 318         i2c_set_clientdata(client, ir);
 319
 320         switch(addr) {
 321         case 0x64:
 322                 name        = "Pixelview";
 323                 ir->get_key = get_key_pixelview;
 324                 ir_type     = IR_TYPE_OTHER;
 325                 ir_codes    = &ir_codes_empty_table;
 326                 break;
 327         case 0x4b:
 328                 name        = "PV951";
 329                 ir->get_key = get_key_pv951;
 330                 ir_type     = IR_TYPE_OTHER;
 331                 ir_codes    = &ir_codes_pv951_table;
 332                 break;
 333         case 0x18:
 334         case 0x1f:
 335         case 0x1a:
 336                 name        = "Hauppauge";
 337                 ir->get_key = get_key_haup;
 338                 ir_type     = IR_TYPE_RC5;
 339                 if (hauppauge == 1) {
 340                         ir_codes    = &ir_codes_hauppauge_new_table;
 341                 } else {
 342                         ir_codes    = &ir_codes_rc5_tv_table;
 343                 }
 344                 break;
 345         case 0x30:
 346                 name        = "KNC One";
 347                 ir->get_key = get_key_knc1;
 348                 ir_type     = IR_TYPE_OTHER;
 349                 ir_codes    = &ir_codes_empty_table;
 350                 break;
 351         case 0x6b:
 352                 name        = "FusionHDTV";
 353                 ir->get_key = get_key_fusionhdtv;
 354                 ir_type     = IR_TYPE_RC5;
 355                 ir_codes    = &ir_codes_fusionhdtv_mce_table;
 356                 break;
 357         case 0x0b:
 358         case 0x47:
 359         case 0x71:
 360                 if (adap->id == I2C_HW_B_CX2388x ||
 361                     adap->id == I2C_HW_B_CX2341X) {
 362                         /* Handled by cx88-input */
 363                         name = adap->id == I2C_HW_B_CX2341X ? "CX2341x remote"
 364                                                             : "CX2388x remote";
 365                         ir_type     = IR_TYPE_RC5;
 366                         ir->get_key = get_key_haup_xvr;
 367                         if (hauppauge == 1) {
 368                                 ir_codes    = &ir_codes_hauppauge_new_table;
 369                         } else {
 370                                 ir_codes    = &ir_codes_rc5_tv_table;
 371                         }
 372                 } else {
 373                         /* Handled by saa7134-input */
 374                         name        = "SAA713x remote";
 375                         ir_type     = IR_TYPE_OTHER;
 376                 }
 377                 break;
 378         case 0x40:
 379                 name        = "AVerMedia Cardbus remote";
 380                 ir->get_key = get_key_avermedia_cardbus;
 381                 ir_type     = IR_TYPE_OTHER;
 382                 ir_codes    = &ir_codes_avermedia_cardbus_table;
 383                 break;
 384         }
 385
 386         /* Let the caller override settings */
 387         if (client->dev.platform_data) {
 388                 const struct IR_i2c_init_data *init_data =
 389                                                 client->dev.platform_data;
 390
 391                 ir_codes = init_data->ir_codes;
 392                 name = init_data->name;
 393                 if (init_data->type)
 394                         ir_type = init_data->type;
 395
 396                 switch (init_data->internal_get_key_func) {
 397                 case IR_KBD_GET_KEY_CUSTOM:
 398                         /* The bridge driver provided us its own function */
 399                         ir->get_key = init_data->get_key;
 400                         break;
 401                 case IR_KBD_GET_KEY_PIXELVIEW:
 402                         ir->get_key = get_key_pixelview;
 403                         break;
 404                 case IR_KBD_GET_KEY_PV951:
 405                         ir->get_key = get_key_pv951;
 406                         break;
 407                 case IR_KBD_GET_KEY_HAUP:
 408                         ir->get_key = get_key_haup;
 409                         break;
 410                 case IR_KBD_GET_KEY_KNC1:
 411                         ir->get_key = get_key_knc1;
 412                         break;
 413                 case IR_KBD_GET_KEY_FUSIONHDTV:
 414                         ir->get_key = get_key_fusionhdtv;
 415                         break;
 416                 case IR_KBD_GET_KEY_HAUP_XVR:
 417                         ir->get_key = get_key_haup_xvr;
 418                         break;
 419                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
 420                         ir->get_key = get_key_avermedia_cardbus;
 421                         break;
 422                 }
 423         }
 424
 425         /* Make sure we are all setup before going on */
 426         if (!name || !ir->get_key || !ir_type || !ir_codes) {
 427                 dprintk(1, ": Unsupported device at address 0x%02x\n",
 428                         addr);
 429                 err = -ENODEV;
 430                 goto err_out_free;
 431         }
 432
 433         /* Sets name */
 434         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
 435         ir->ir_codes = ir_codes;
 436
 437         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
 438                  dev_name(&adap->dev),
 439                  dev_name(&client->dev));
 440
 441         /* init + register input device */
 442         err = ir_input_init(input_dev, &ir->ir, ir_type);
 443         if (err < 0)
 444                 goto err_out_free;
 445
 446         input_dev->id.bustype = BUS_I2C;
 447         input_dev->name       = ir->name;
 448         input_dev->phys       = ir->phys;
 449
 450         err = ir_input_register(ir->input, ir->ir_codes, NULL);
 451         if (err)
 452                 goto err_out_free;
 453
 454         printk(DEVNAME ": %s detected at %s [%s]\n",
 455                ir->input->name, ir->input->phys, adap->name);
 456
 457         /* start polling via eventd */
 458         INIT_DELAYED_WORK(&ir->work, ir_work);
 459         schedule_delayed_work(&ir->work, 0);
 460
 461         return 0;
 462
 463  err_out_free:
 464         kfree(ir);
 465         return err;
 466 }
 467
 468 static int ir_remove(struct i2c_client *client)
 469 {
 470         struct IR_i2c *ir = i2c_get_clientdata(client);
 471
 472         /* kill outstanding polls */
 473         cancel_delayed_work_sync(&ir->work);
 474
 475         /* unregister device */
 476         ir_input_unregister(ir->input);
 477
 478         /* free memory */
 479         kfree(ir);
 480         return 0;
 481 }
 482
 483 static const struct i2c_device_id ir_kbd_id[] = {
 484         /* Generic entry for any IR receiver */
 485         { "ir_video", 0 },
 486         /* IR device specific entries should be added here */
 487         { "ir_rx_z8f0811_haup", 0 },
 488         { }
 489 };
 490
 491 static struct i2c_driver driver = {
 492         .driver = {
 493                 .name   = "ir-kbd-i2c",
 494         },
 495         .probe          = ir_probe,
 496         .remove         = ir_remove,
 497         .id_table       = ir_kbd_id,
 498 };
 499
 500 /* ----------------------------------------------------------------------- */
 501
 502 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
 503 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
 504 MODULE_LICENSE("GPL");
 505
 506 static int __init ir_init(void)
 507 {
 508         return i2c_add_driver(&driver);
 509 }
 510
 511 static void __exit ir_fini(void)
 512 {
 513         i2c_del_driver(&driver);
 514 }
 515
 516 module_init(ir_init);
 517 module_exit(ir_fini);
 518
 519 /*
 520  * Overrides for Emacs so that we follow Linus's tabbing style.
 521  * ---------------------------------------------------------------------------
 522  * Local variables:
 523  * c-basic-offset: 8
 524  * End:
 525  */