drivers/media/common/ir-common.c

   1 /*
   2  * some common structs and functions to handle infrared remotes via
   3  * input layer ...
   4  *
   5  * (c) 2003 Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include <linux/module.h>
  23
  24 #include <media/ir-common.h>
  25
  26 /* -------------------------------------------------------------------------- */
  27
  28 MODULE_AUTHOR("Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]");
  29 MODULE_LICENSE("GPL");
  30
  31 static int repeat = 1;
  32 MODULE_PARM(repeat,"i");
  33 MODULE_PARM_DESC(repeat,"auto-repeat for IR keys (default: on)");
  34
  35 static int debug = 0;    /* debug level (0,1,2) */
  36 MODULE_PARM(debug,"i");
  37
  38 #define dprintk(level, fmt, arg...)     if (debug >= level) \
  39         printk(KERN_DEBUG fmt , ## arg)
  40
  41 /* -------------------------------------------------------------------------- */
  42
  43 /* generic RC5 keytable                                          */
  44 /* see http://users.pandora.be/nenya/electronics/rc5/codes00.htm */
  45 IR_KEYTAB_TYPE ir_codes_rc5_tv[IR_KEYTAB_SIZE] = {
  46         [ 0x00 ] = KEY_KP0,             // 0
  47         [ 0x01 ] = KEY_KP1,             // 1
  48         [ 0x02 ] = KEY_KP2,             // 2
  49         [ 0x03 ] = KEY_KP3,             // 3
  50         [ 0x04 ] = KEY_KP4,             // 4
  51         [ 0x05 ] = KEY_KP5,             // 5
  52         [ 0x06 ] = KEY_KP6,             // 6
  53         [ 0x07 ] = KEY_KP7,             // 7
  54         [ 0x08 ] = KEY_KP8,             // 8
  55         [ 0x09 ] = KEY_KP9,             // 9
  56
  57         [ 0x0b ] = KEY_CHANNEL,         // channel / program (japan: 11)
  58         [ 0x0c ] = KEY_POWER,           // standby
  59         [ 0x0d ] = KEY_MUTE,            // mute / demute
  60         [ 0x0f ] = KEY_TV,              // display
  61         [ 0x10 ] = KEY_VOLUMEUP,        // volume +
  62         [ 0x11 ] = KEY_VOLUMEDOWN,      // volume -
  63         [ 0x12 ] = KEY_BRIGHTNESSUP,    // brightness +
  64         [ 0x13 ] = KEY_BRIGHTNESSDOWN,  // brightness -
  65         [ 0x1e ] = KEY_SEARCH,          // search +
  66         [ 0x20 ] = KEY_CHANNELUP,       // channel / program +
  67         [ 0x21 ] = KEY_CHANNELDOWN,     // channel / program -
  68         [ 0x22 ] = KEY_CHANNEL,         // alt / channel
  69         [ 0x23 ] = KEY_LANGUAGE,        // 1st / 2nd language
  70         [ 0x26 ] = KEY_SLEEP,           // sleeptimer
  71         [ 0x2e ] = KEY_MENU,            // 2nd controls (USA: menu)
  72         [ 0x30 ] = KEY_PAUSE,           // pause
  73         [ 0x32 ] = KEY_REWIND,          // rewind
  74         [ 0x33 ] = KEY_GOTO,            // go to
  75         [ 0x35 ] = KEY_PLAY,            // play
  76         [ 0x36 ] = KEY_STOP,            // stop
  77         [ 0x37 ] = KEY_RECORD,          // recording
  78
  79 #if 0 /* FIXME */
  80         [ 0x0a ] = KEY_RESERVED,        // 1/2/3 digits (japan: 10)
  81         [ 0x0e ] = KEY_RESERVED,        // P.P. (personal preference)
  82         [ 0x14 ] = KEY_RESERVED,        // colour saturation +
  83         [ 0x15 ] = KEY_RESERVED,        // colour saturation -
  84         [ 0x16 ] = KEY_RESERVED,        // bass +
  85         [ 0x17 ] = KEY_RESERVED,        // bass -
  86         [ 0x18 ] = KEY_RESERVED,        // treble +
  87         [ 0x19 ] = KEY_RESERVED,        // treble -
  88         [ 0x1a ] = KEY_RESERVED,        // balance right
  89         [ 0x1b ] = KEY_RESERVED,        // balance left
  90         [ 0x1c ] = KEY_RESERVED,        // contrast +
  91         [ 0x1d ] = KEY_RESERVED,        // contrast -
  92         [ 0x1f ] = KEY_RESERVED,        // tint/hue +
  93         [ 0x24 ] = KEY_RESERVED,        // spacial stereo on/off
  94         [ 0x25 ] = KEY_RESERVED,        // mono / stereo (USA)
  95         [ 0x27 ] = KEY_RESERVED,        // tint / hue -
  96         [ 0x28 ] = KEY_RESERVED,        // RF switch/PIP select
  97         [ 0x29 ] = KEY_RESERVED,        // vote
  98         [ 0x2a ] = KEY_RESERVED,        // timed page/channel clck
  99         [ 0x2b ] = KEY_RESERVED,        // increment (USA)
 100         [ 0x2c ] = KEY_RESERVED,        // decrement (USA)
 101         [ 0x2d ] = KEY_RESERVED,        //
 102         [ 0x2f ] = KEY_RESERVED,        // PIP shift
 103         [ 0x31 ] = KEY_RESERVED,        // erase
 104         [ 0x34 ] = KEY_RESERVED,        // wind
 105         [ 0x38 ] = KEY_RESERVED,        // external 1
 106         [ 0x39 ] = KEY_RESERVED,        // external 2
 107         [ 0x3a ] = KEY_RESERVED,        // PIP display mode
 108         [ 0x3b ] = KEY_RESERVED,        // view data mode / advance
 109         [ 0x3c ] = KEY_RESERVED,        // teletext submode (Japan: 12)
 110         [ 0x3d ] = KEY_RESERVED,        // system standby
 111         [ 0x3e ] = KEY_RESERVED,        // crispener on/off
 112         [ 0x3f ] = KEY_RESERVED,        // system select
 113 #endif
 114 };
 115 EXPORT_SYMBOL_GPL(ir_codes_rc5_tv);
 116
 117 /* empty keytable, can be used as placeholder for not-yet created keytables */
 118 IR_KEYTAB_TYPE ir_codes_empty[IR_KEYTAB_SIZE] = {
 119         [ 42 ] = KEY_COFFEE,
 120 };
 121 EXPORT_SYMBOL_GPL(ir_codes_empty);
 122
 123 /* -------------------------------------------------------------------------- */
 124
 125 static void ir_input_key_event(struct input_dev *dev, struct ir_input_state *ir)
 126 {
 127         if (KEY_RESERVED == ir->keycode) {
 128                 printk(KERN_INFO "%s: unknown key: key=0x%02x raw=0x%02x down=%d\n",
 129                        dev->name,ir->ir_key,ir->ir_raw,ir->keypressed);
 130                 return;
 131         }
 132         dprintk(1,"%s: key event code=%d down=%d\n",
 133                 dev->name,ir->keycode,ir->keypressed);
 134         input_report_key(dev,ir->keycode,ir->keypressed);
 135         input_sync(dev);
 136 }
 137
 138 /* -------------------------------------------------------------------------- */
 139
 140 void ir_input_init(struct input_dev *dev, struct ir_input_state *ir,
 141                    int ir_type, IR_KEYTAB_TYPE *ir_codes)
 142 {
 143         int i;
 144
 145         ir->ir_type = ir_type;
 146         if (ir_codes)
 147                 memcpy(ir->ir_codes, ir_codes, sizeof(ir->ir_codes));
 148
 149         init_input_dev(dev);
 150         dev->keycode     = ir->ir_codes;
 151         dev->keycodesize = sizeof(IR_KEYTAB_TYPE);
 152         dev->keycodemax  = IR_KEYTAB_SIZE;
 153         for (i = 0; i < IR_KEYTAB_SIZE; i++)
 154                 set_bit(ir->ir_codes[i], dev->keybit);
 155         clear_bit(0, dev->keybit);
 156
 157         set_bit(EV_KEY, dev->evbit);
 158         if (repeat)
 159                 set_bit(EV_REP, dev->evbit);
 160 }
 161
 162 void ir_input_nokey(struct input_dev *dev, struct ir_input_state *ir)
 163 {
 164         if (ir->keypressed) {
 165                 ir->keypressed = 0;
 166                 ir_input_key_event(dev,ir);
 167         }
 168 }
 169
 170 void ir_input_keydown(struct input_dev *dev, struct ir_input_state *ir,
 171                       u32 ir_key, u32 ir_raw)
 172 {
 173         u32 keycode = IR_KEYCODE(ir->ir_codes, ir_key);
 174
 175         if (ir->keypressed && ir->keycode != keycode) {
 176                 ir->keypressed = 0;
 177                 ir_input_key_event(dev,ir);
 178         }
 179         if (!ir->keypressed) {
 180                 ir->ir_key  = ir_key;
 181                 ir->ir_raw  = ir_raw;
 182                 ir->keycode = keycode;
 183                 ir->keypressed = 1;
 184                 ir_input_key_event(dev,ir);
 185         }
 186 #if 0
 187         /* maybe do something like this ??? */
 188         input_event(a, EV_IR, ir->ir_type, ir->ir_raw);
 189 #endif
 190 }
 191
 192 u32 ir_extract_bits(u32 data, u32 mask)
 193 {
 194         int mbit, vbit;
 195         u32 value;
 196
 197         value = 0;
 198         vbit  = 0;
 199         for (mbit = 0; mbit < 32; mbit++) {
 200                 if (!(mask & ((u32)1 << mbit)))
 201                         continue;
 202                 if (data & ((u32)1 << mbit))
 203                         value |= (1 << vbit);
 204                 vbit++;
 205         }
 206         return value;
 207 }
 208
 209 EXPORT_SYMBOL_GPL(ir_input_init);
 210 EXPORT_SYMBOL_GPL(ir_input_nokey);
 211 EXPORT_SYMBOL_GPL(ir_input_keydown);
 212 EXPORT_SYMBOL_GPL(ir_extract_bits);
 213
 214 /*
 215  * Local variables:
 216  * c-basic-offset: 8
 217  * End:
 218  */