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-core.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 MODULE_NAME "ir-kbd-i2c"
  65 #define dprintk(level, fmt, arg...)     if (debug >= level) \
  66         printk(KERN_DEBUG MODULE_NAME ": " 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_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 150 {
 151         unsigned char buf[4];
 152
 153         /* poll IR chip */
 154         if (4 != i2c_master_recv(ir->c, buf, 4)) {
 155                 dprintk(1,"read error\n");
 156                 return -EIO;
 157         }
 158
 159         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
 160                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
 161                         buf[0], buf[1], buf[2], buf[3]);
 162
 163         /* no key pressed or signal from other ir remote */
 164         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
 165                 return 0;
 166
 167         *ir_key = buf[2];
 168         *ir_raw = (buf[2] << 8) | buf[3];
 169
 170         return 1;
 171 }
 172
 173 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 174 {
 175         unsigned char b;
 176
 177         /* poll IR chip */
 178         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 179                 dprintk(1,"read error\n");
 180                 return -EIO;
 181         }
 182
 183         /* it seems that 0xFE indicates that a button is still hold
 184            down, while 0xff indicates that no button is hold
 185            down. 0xfe sequences are sometimes interrupted by 0xFF */
 186
 187         dprintk(2,"key %02x\n", b);
 188
 189         if (b == 0xff)
 190                 return 0;
 191
 192         if (b == 0xfe)
 193                 /* keep old data */
 194                 return 1;
 195
 196         *ir_key = b;
 197         *ir_raw = b;
 198         return 1;
 199 }
 200
 201 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
 202                                      u32 *ir_key, u32 *ir_raw)
 203 {
 204         unsigned char subaddr, key, keygroup;
 205         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
 206                                    .buf = &subaddr, .len = 1},
 207                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
 208                                   .buf = &key, .len = 1} };
 209         subaddr = 0x0d;
 210         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 211                 dprintk(1, "read error\n");
 212                 return -EIO;
 213         }
 214
 215         if (key == 0xff)
 216                 return 0;
 217
 218         subaddr = 0x0b;
 219         msg[1].buf = &keygroup;
 220         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 221                 dprintk(1, "read error\n");
 222                 return -EIO;
 223         }
 224
 225         if (keygroup == 0xff)
 226                 return 0;
 227
 228         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
 229         if (keygroup < 2 || keygroup > 3) {
 230                 /* Only a warning */
 231                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
 232                                                                 keygroup, key);
 233         }
 234         key |= (keygroup & 1) << 6;
 235
 236         *ir_key = key;
 237         *ir_raw = key;
 238         return 1;
 239 }
 240
 241 /* ----------------------------------------------------------------------- */
 242
 243 static void ir_key_poll(struct IR_i2c *ir)
 244 {
 245         static u32 ir_key, ir_raw;
 246         int rc;
 247
 248         dprintk(2,"ir_poll_key\n");
 249         rc = ir->get_key(ir, &ir_key, &ir_raw);
 250         if (rc < 0) {
 251                 dprintk(2,"error\n");
 252                 return;
 253         }
 254
 255         if (rc)
 256                 ir_keydown(ir->input, ir_key, 0);
 257 }
 258
 259 static void ir_work(struct work_struct *work)
 260 {
 261         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
 262
 263         ir_key_poll(ir);
 264         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
 265 }
 266
 267 /* ----------------------------------------------------------------------- */
 268
 269 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
 270 {
 271         char *ir_codes = NULL;
 272         const char *name = NULL;
 273         u64 ir_type = 0;
 274         struct IR_i2c *ir;
 275         struct input_dev *input_dev;
 276         struct i2c_adapter *adap = client->adapter;
 277         unsigned short addr = client->addr;
 278         int err;
 279
 280         ir = kzalloc(sizeof(struct IR_i2c),GFP_KERNEL);
 281         input_dev = input_allocate_device();
 282         if (!ir || !input_dev) {
 283                 err = -ENOMEM;
 284                 goto err_out_free;
 285         }
 286
 287         ir->c = client;
 288         ir->input = input_dev;
 289         ir->polling_interval = DEFAULT_POLLING_INTERVAL;
 290         i2c_set_clientdata(client, ir);
 291
 292         switch(addr) {
 293         case 0x64:
 294                 name        = "Pixelview";
 295                 ir->get_key = get_key_pixelview;
 296                 ir_type     = IR_TYPE_OTHER;
 297                 ir_codes    = RC_MAP_EMPTY;
 298                 break;
 299         case 0x18:
 300         case 0x1f:
 301         case 0x1a:
 302                 name        = "Hauppauge";
 303                 ir->get_key = get_key_haup;
 304                 ir_type     = IR_TYPE_RC5;
 305                 if (hauppauge == 1) {
 306                         ir_codes    = RC_MAP_HAUPPAUGE_NEW;
 307                 } else {
 308                         ir_codes    = RC_MAP_RC5_TV;
 309                 }
 310                 break;
 311         case 0x30:
 312                 name        = "KNC One";
 313                 ir->get_key = get_key_knc1;
 314                 ir_type     = IR_TYPE_OTHER;
 315                 ir_codes    = RC_MAP_EMPTY;
 316                 break;
 317         case 0x6b:
 318                 name        = "FusionHDTV";
 319                 ir->get_key = get_key_fusionhdtv;
 320                 ir_type     = IR_TYPE_RC5;
 321                 ir_codes    = RC_MAP_FUSIONHDTV_MCE;
 322                 break;
 323         case 0x40:
 324                 name        = "AVerMedia Cardbus remote";
 325                 ir->get_key = get_key_avermedia_cardbus;
 326                 ir_type     = IR_TYPE_OTHER;
 327                 ir_codes    = RC_MAP_AVERMEDIA_CARDBUS;
 328                 break;
 329         }
 330
 331         /* Let the caller override settings */
 332         if (client->dev.platform_data) {
 333                 const struct IR_i2c_init_data *init_data =
 334                                                 client->dev.platform_data;
 335
 336                 ir_codes = init_data->ir_codes;
 337                 name = init_data->name;
 338                 if (init_data->type)
 339                         ir_type = init_data->type;
 340
 341                 if (init_data->polling_interval)
 342                         ir->polling_interval = init_data->polling_interval;
 343
 344                 switch (init_data->internal_get_key_func) {
 345                 case IR_KBD_GET_KEY_CUSTOM:
 346                         /* The bridge driver provided us its own function */
 347                         ir->get_key = init_data->get_key;
 348                         break;
 349                 case IR_KBD_GET_KEY_PIXELVIEW:
 350                         ir->get_key = get_key_pixelview;
 351                         break;
 352                 case IR_KBD_GET_KEY_HAUP:
 353                         ir->get_key = get_key_haup;
 354                         break;
 355                 case IR_KBD_GET_KEY_KNC1:
 356                         ir->get_key = get_key_knc1;
 357                         break;
 358                 case IR_KBD_GET_KEY_FUSIONHDTV:
 359                         ir->get_key = get_key_fusionhdtv;
 360                         break;
 361                 case IR_KBD_GET_KEY_HAUP_XVR:
 362                         ir->get_key = get_key_haup_xvr;
 363                         break;
 364                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
 365                         ir->get_key = get_key_avermedia_cardbus;
 366                         break;
 367                 }
 368         }
 369
 370         /* Make sure we are all setup before going on */
 371         if (!name || !ir->get_key || !ir_type || !ir_codes) {
 372                 dprintk(1, ": Unsupported device at address 0x%02x\n",
 373                         addr);
 374                 err = -ENODEV;
 375                 goto err_out_free;
 376         }
 377
 378         /* Sets name */
 379         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
 380         ir->ir_codes = ir_codes;
 381
 382         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
 383                  dev_name(&adap->dev),
 384                  dev_name(&client->dev));
 385
 386         /* init + register input device */
 387         ir->ir_type = ir_type;
 388         input_dev->id.bustype = BUS_I2C;
 389         input_dev->name       = ir->name;
 390         input_dev->phys       = ir->phys;
 391
 392         err = ir_input_register(ir->input, ir->ir_codes, NULL, MODULE_NAME);
 393         if (err)
 394                 goto err_out_free;
 395
 396         printk(MODULE_NAME ": %s detected at %s [%s]\n",
 397                ir->input->name, ir->input->phys, adap->name);
 398
 399         /* start polling via eventd */
 400         INIT_DELAYED_WORK(&ir->work, ir_work);
 401         schedule_delayed_work(&ir->work, 0);
 402
 403         return 0;
 404
 405  err_out_free:
 406         kfree(ir);
 407         return err;
 408 }
 409
 410 static int ir_remove(struct i2c_client *client)
 411 {
 412         struct IR_i2c *ir = i2c_get_clientdata(client);
 413
 414         /* kill outstanding polls */
 415         cancel_delayed_work_sync(&ir->work);
 416
 417         /* unregister device */
 418         ir_input_unregister(ir->input);
 419
 420         /* free memory */
 421         kfree(ir);
 422         return 0;
 423 }
 424
 425 static const struct i2c_device_id ir_kbd_id[] = {
 426         /* Generic entry for any IR receiver */
 427         { "ir_video", 0 },
 428         /* IR device specific entries should be added here */
 429         { "ir_rx_z8f0811_haup", 0 },
 430         { }
 431 };
 432
 433 static struct i2c_driver driver = {
 434         .driver = {
 435                 .name   = "ir-kbd-i2c",
 436         },
 437         .probe          = ir_probe,
 438         .remove         = ir_remove,
 439         .id_table       = ir_kbd_id,
 440 };
 441
 442 /* ----------------------------------------------------------------------- */
 443
 444 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
 445 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
 446 MODULE_LICENSE("GPL");
 447
 448 static int __init ir_init(void)
 449 {
 450         return i2c_add_driver(&driver);
 451 }
 452
 453 static void __exit ir_fini(void)
 454 {
 455         i2c_del_driver(&driver);
 456 }
 457
 458 module_init(ir_init);
 459 module_exit(ir_fini);
 460
 461 /*
 462  * Overrides for Emacs so that we follow Linus's tabbing style.
 463  * ---------------------------------------------------------------------------
 464  * Local variables:
 465  * c-basic-offset: 8
 466  * End:
 467  */