drivers/media/i2c/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/workqueue.h>
  48
  49 #include <media/rc-core.h>
  50 #include <media/ir-kbd-i2c.h>
  51
  52 /* ----------------------------------------------------------------------- */
  53 /* insmod parameters                                                       */
  54
  55 static int debug;
  56 module_param(debug, int, 0644);    /* debug level (0,1,2) */
  57
  58
  59 #define MODULE_NAME "ir-kbd-i2c"
  60 #define dprintk(level, fmt, arg...)     if (debug >= level) \
  61         printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg)
  62
  63 /* ----------------------------------------------------------------------- */
  64
  65 static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
  66                                int size, int offset)
  67 {
  68         unsigned char buf[6];
  69         int start, range, toggle, dev, code, ircode;
  70
  71         /* poll IR chip */
  72         if (size != i2c_master_recv(ir->c, buf, size))
  73                 return -EIO;
  74
  75         /* split rc5 data block ... */
  76         start  = (buf[offset] >> 7) &    1;
  77         range  = (buf[offset] >> 6) &    1;
  78         toggle = (buf[offset] >> 5) &    1;
  79         dev    =  buf[offset]       & 0x1f;
  80         code   = (buf[offset+1] >> 2) & 0x3f;
  81
  82         /* rc5 has two start bits
  83          * the first bit must be one
  84          * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
  85          */
  86         if (!start)
  87                 /* no key pressed */
  88                 return 0;
  89         /*
  90          * Hauppauge remotes (black/silver) always use
  91          * specific device ids. If we do not filter the
  92          * device ids then messages destined for devices
  93          * such as TVs (id=0) will get through causing
  94          * mis-fired events.
  95          *
  96          * We also filter out invalid key presses which
  97          * produce annoying debug log entries.
  98          */
  99         ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
 100         if ((ircode & 0x1fff)==0x1fff)
 101                 /* invalid key press */
 102                 return 0;
 103
 104         if (!range)
 105                 code += 64;
 106
 107         dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
 108                 start, range, toggle, dev, code);
 109
 110         /* return key */
 111         *ir_key = (dev << 8) | code;
 112         *ir_raw = ircode;
 113         return 1;
 114 }
 115
 116 static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 117 {
 118         return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
 119 }
 120
 121 static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 122 {
 123         int ret;
 124         unsigned char buf[1] = { 0 };
 125
 126         /*
 127          * This is the same apparent "are you ready?" poll command observed
 128          * watching Windows driver traffic and implemented in lirc_zilog. With
 129          * this added, we get far saner remote behavior with z8 chips on usb
 130          * connected devices, even with the default polling interval of 100ms.
 131          */
 132         ret = i2c_master_send(ir->c, buf, 1);
 133         if (ret != 1)
 134                 return (ret < 0) ? ret : -EINVAL;
 135
 136         return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
 137 }
 138
 139 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 140 {
 141         unsigned char b;
 142
 143         /* poll IR chip */
 144         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 145                 dprintk(1,"read error\n");
 146                 return -EIO;
 147         }
 148         *ir_key = b;
 149         *ir_raw = b;
 150         return 1;
 151 }
 152
 153 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 154 {
 155         unsigned char buf[4];
 156
 157         /* poll IR chip */
 158         if (4 != i2c_master_recv(ir->c, buf, 4)) {
 159                 dprintk(1,"read error\n");
 160                 return -EIO;
 161         }
 162
 163         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
 164                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
 165                         buf[0], buf[1], buf[2], buf[3]);
 166
 167         /* no key pressed or signal from other ir remote */
 168         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
 169                 return 0;
 170
 171         *ir_key = buf[2];
 172         *ir_raw = (buf[2] << 8) | buf[3];
 173
 174         return 1;
 175 }
 176
 177 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 178 {
 179         unsigned char b;
 180
 181         /* poll IR chip */
 182         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 183                 dprintk(1,"read error\n");
 184                 return -EIO;
 185         }
 186
 187         /* it seems that 0xFE indicates that a button is still hold
 188            down, while 0xff indicates that no button is hold
 189            down. 0xfe sequences are sometimes interrupted by 0xFF */
 190
 191         dprintk(2,"key %02x\n", b);
 192
 193         if (b == 0xff)
 194                 return 0;
 195
 196         if (b == 0xfe)
 197                 /* keep old data */
 198                 return 1;
 199
 200         *ir_key = b;
 201         *ir_raw = b;
 202         return 1;
 203 }
 204
 205 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
 206                                      u32 *ir_key, u32 *ir_raw)
 207 {
 208         unsigned char subaddr, key, keygroup;
 209         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
 210                                    .buf = &subaddr, .len = 1},
 211                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
 212                                   .buf = &key, .len = 1} };
 213         subaddr = 0x0d;
 214         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 215                 dprintk(1, "read error\n");
 216                 return -EIO;
 217         }
 218
 219         if (key == 0xff)
 220                 return 0;
 221
 222         subaddr = 0x0b;
 223         msg[1].buf = &keygroup;
 224         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 225                 dprintk(1, "read error\n");
 226                 return -EIO;
 227         }
 228
 229         if (keygroup == 0xff)
 230                 return 0;
 231
 232         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
 233         if (keygroup < 2 || keygroup > 4) {
 234                 /* Only a warning */
 235                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
 236                                                                 keygroup, key);
 237         }
 238         key |= (keygroup & 1) << 6;
 239
 240         *ir_key = key;
 241         *ir_raw = key;
 242         if (!strcmp(ir->ir_codes, RC_MAP_AVERMEDIA_M733A_RM_K6)) {
 243                 *ir_key |= keygroup << 8;
 244                 *ir_raw |= keygroup << 8;
 245         }
 246         return 1;
 247 }
 248
 249 /* ----------------------------------------------------------------------- */
 250
 251 static int ir_key_poll(struct IR_i2c *ir)
 252 {
 253         static u32 ir_key, ir_raw;
 254         int rc;
 255
 256         dprintk(3, "%s\n", __func__);
 257         rc = ir->get_key(ir, &ir_key, &ir_raw);
 258         if (rc < 0) {
 259                 dprintk(2,"error\n");
 260                 return rc;
 261         }
 262
 263         if (rc) {
 264                 dprintk(1, "%s: keycode = 0x%04x\n", __func__, ir_key);
 265                 rc_keydown(ir->rc, ir_key, 0);
 266         }
 267         return 0;
 268 }
 269
 270 static void ir_work(struct work_struct *work)
 271 {
 272         int rc;
 273         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
 274
 275         rc = ir_key_poll(ir);
 276         if (rc == -ENODEV) {
 277                 rc_unregister_device(ir->rc);
 278                 ir->rc = NULL;
 279                 return;
 280         }
 281
 282         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
 283 }
 284
 285 /* ----------------------------------------------------------------------- */
 286
 287 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
 288 {
 289         char *ir_codes = NULL;
 290         const char *name = NULL;
 291         u64 rc_type = RC_BIT_UNKNOWN;
 292         struct IR_i2c *ir;
 293         struct rc_dev *rc = NULL;
 294         struct i2c_adapter *adap = client->adapter;
 295         unsigned short addr = client->addr;
 296         int err;
 297
 298         ir = devm_kzalloc(&client->dev, sizeof(*ir), GFP_KERNEL);
 299         if (!ir)
 300                 return -ENOMEM;
 301
 302         ir->c = client;
 303         ir->polling_interval = DEFAULT_POLLING_INTERVAL;
 304         i2c_set_clientdata(client, ir);
 305
 306         switch(addr) {
 307         case 0x64:
 308                 name        = "Pixelview";
 309                 ir->get_key = get_key_pixelview;
 310                 rc_type     = RC_BIT_OTHER;
 311                 ir_codes    = RC_MAP_EMPTY;
 312                 break;
 313         case 0x18:
 314         case 0x1f:
 315         case 0x1a:
 316                 name        = "Hauppauge";
 317                 ir->get_key = get_key_haup;
 318                 rc_type     = RC_BIT_RC5;
 319                 ir_codes    = RC_MAP_HAUPPAUGE;
 320                 break;
 321         case 0x30:
 322                 name        = "KNC One";
 323                 ir->get_key = get_key_knc1;
 324                 rc_type     = RC_BIT_OTHER;
 325                 ir_codes    = RC_MAP_EMPTY;
 326                 break;
 327         case 0x6b:
 328                 name        = "FusionHDTV";
 329                 ir->get_key = get_key_fusionhdtv;
 330                 rc_type     = RC_BIT_RC5;
 331                 ir_codes    = RC_MAP_FUSIONHDTV_MCE;
 332                 break;
 333         case 0x40:
 334                 name        = "AVerMedia Cardbus remote";
 335                 ir->get_key = get_key_avermedia_cardbus;
 336                 rc_type     = RC_BIT_OTHER;
 337                 ir_codes    = RC_MAP_AVERMEDIA_CARDBUS;
 338                 break;
 339         case 0x41:
 340                 name        = "AVerMedia EM78P153";
 341                 ir->get_key = get_key_avermedia_cardbus;
 342                 rc_type     = RC_BIT_OTHER;
 343                 /* RM-KV remote, seems to be same as RM-K6 */
 344                 ir_codes    = RC_MAP_AVERMEDIA_M733A_RM_K6;
 345                 break;
 346         case 0x71:
 347                 name        = "Hauppauge/Zilog Z8";
 348                 ir->get_key = get_key_haup_xvr;
 349                 rc_type     = RC_BIT_RC5;
 350                 ir_codes    = RC_MAP_HAUPPAUGE;
 351                 break;
 352         }
 353
 354         /* Let the caller override settings */
 355         if (client->dev.platform_data) {
 356                 const struct IR_i2c_init_data *init_data =
 357                                                 client->dev.platform_data;
 358
 359                 ir_codes = init_data->ir_codes;
 360                 rc = init_data->rc_dev;
 361
 362                 name = init_data->name;
 363                 if (init_data->type)
 364                         rc_type = init_data->type;
 365
 366                 if (init_data->polling_interval)
 367                         ir->polling_interval = init_data->polling_interval;
 368
 369                 switch (init_data->internal_get_key_func) {
 370                 case IR_KBD_GET_KEY_CUSTOM:
 371                         /* The bridge driver provided us its own function */
 372                         ir->get_key = init_data->get_key;
 373                         break;
 374                 case IR_KBD_GET_KEY_PIXELVIEW:
 375                         ir->get_key = get_key_pixelview;
 376                         break;
 377                 case IR_KBD_GET_KEY_HAUP:
 378                         ir->get_key = get_key_haup;
 379                         break;
 380                 case IR_KBD_GET_KEY_KNC1:
 381                         ir->get_key = get_key_knc1;
 382                         break;
 383                 case IR_KBD_GET_KEY_FUSIONHDTV:
 384                         ir->get_key = get_key_fusionhdtv;
 385                         break;
 386                 case IR_KBD_GET_KEY_HAUP_XVR:
 387                         ir->get_key = get_key_haup_xvr;
 388                         break;
 389                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
 390                         ir->get_key = get_key_avermedia_cardbus;
 391                         break;
 392                 }
 393         }
 394
 395         if (!rc) {
 396                 /*
 397                  * If platform_data doesn't specify rc_dev, initilize it
 398                  * internally
 399                  */
 400                 rc = rc_allocate_device();
 401                 if (!rc)
 402                         return -ENOMEM;
 403         }
 404         ir->rc = rc;
 405
 406         /* Make sure we are all setup before going on */
 407         if (!name || !ir->get_key || !rc_type || !ir_codes) {
 408                 dprintk(1, ": Unsupported device at address 0x%02x\n",
 409                         addr);
 410                 err = -ENODEV;
 411                 goto err_out_free;
 412         }
 413
 414         /* Sets name */
 415         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
 416         ir->ir_codes = ir_codes;
 417
 418         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
 419                  dev_name(&adap->dev),
 420                  dev_name(&client->dev));
 421
 422         /*
 423          * Initialize input_dev fields
 424          * It doesn't make sense to allow overriding them via platform_data
 425          */
 426         rc->input_id.bustype = BUS_I2C;
 427         rc->input_phys       = ir->phys;
 428         rc->input_name       = ir->name;
 429
 430         /*
 431          * Initialize the other fields of rc_dev
 432          */
 433         rc->map_name       = ir->ir_codes;
 434         rc->allowed_protos = rc_type;
 435         rc->enabled_protocols = rc_type;
 436         if (!rc->driver_name)
 437                 rc->driver_name = MODULE_NAME;
 438
 439         err = rc_register_device(rc);
 440         if (err)
 441                 goto err_out_free;
 442
 443         printk(MODULE_NAME ": %s detected at %s [%s]\n",
 444                ir->name, ir->phys, adap->name);
 445
 446         /* start polling via eventd */
 447         INIT_DELAYED_WORK(&ir->work, ir_work);
 448         schedule_delayed_work(&ir->work, 0);
 449
 450         return 0;
 451
 452  err_out_free:
 453         /* Only frees rc if it were allocated internally */
 454         rc_free_device(rc);
 455         return err;
 456 }
 457
 458 static int ir_remove(struct i2c_client *client)
 459 {
 460         struct IR_i2c *ir = i2c_get_clientdata(client);
 461
 462         /* kill outstanding polls */
 463         cancel_delayed_work_sync(&ir->work);
 464
 465         /* unregister device */
 466         if (ir->rc)
 467                 rc_unregister_device(ir->rc);
 468
 469         /* free memory */
 470         return 0;
 471 }
 472
 473 static const struct i2c_device_id ir_kbd_id[] = {
 474         /* Generic entry for any IR receiver */
 475         { "ir_video", 0 },
 476         /* IR device specific entries should be added here */
 477         { "ir_rx_z8f0811_haup", 0 },
 478         { "ir_rx_z8f0811_hdpvr", 0 },
 479         { }
 480 };
 481
 482 static struct i2c_driver ir_kbd_driver = {
 483         .driver = {
 484                 .name   = "ir-kbd-i2c",
 485         },
 486         .probe          = ir_probe,
 487         .remove         = ir_remove,
 488         .id_table       = ir_kbd_id,
 489 };
 490
 491 module_i2c_driver(ir_kbd_driver);
 492
 493 /* ----------------------------------------------------------------------- */
 494
 495 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
 496 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
 497 MODULE_LICENSE("GPL");