SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/media/ir-core.h

   1 /*
   2  * Remote Controller core header
   3  *
   4  * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
   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 version 2 of the License.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  */
  15
  16 #ifndef _IR_CORE
  17 #define _IR_CORE
  18
  19 #include <linux/input.h>
  20 #include <linux/spinlock.h>
  21 #include <linux/kfifo.h>
  22 #include <linux/time.h>
  23 #include <linux/timer.h>
  24 #include <media/rc-map.h>
  25
  26 extern int ir_core_debug;
  27 #define IR_dprintk(level, fmt, arg...)  if (ir_core_debug >= level) \
  28         printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
  29
  30 #define IR_TYPE_UNKNOWN 0
  31 #define IR_TYPE_RC5     (1  << 0)       /* Philips RC5 protocol */
  32 #define IR_TYPE_PD      (1  << 1)       /* Pulse distance encoded IR */
  33 #define IR_TYPE_NEC     (1  << 2)
  34 #define IR_TYPE_OTHER   (((u64)1) << 63l)
  35
  36 enum raw_event_type {
  37         IR_SPACE        = (1 << 0),
  38         IR_PULSE        = (1 << 1),
  39         IR_START_EVENT  = (1 << 2),
  40         IR_STOP_EVENT   = (1 << 3),
  41 };
  42
  43 struct ir_scancode {
  44         u16     scancode;
  45         u32     keycode;
  46 };
  47
  48 struct ir_scancode_table {
  49         struct ir_scancode      *scan;
  50         unsigned int            size;   /* Max number of entries */
  51         unsigned int            len;    /* Used number of entries */
  52         unsigned int            alloc;  /* Size of *scan in bytes */
  53         u64                     ir_type;
  54         char                    *name;
  55         spinlock_t              lock;
  56 };
  57
  58 struct rc_keymap {
  59         struct list_head         list;
  60         struct ir_scancode_table map;
  61 };
  62
  63 struct ir_dev_props {
  64         unsigned long allowed_protos;
  65         void            *priv;
  66         int (*change_protocol)(void *priv, u64 ir_type);
  67         int (*open)(void *priv);
  68         void (*close)(void *priv);
  69 };
  70
  71 struct ir_raw_event {
  72         struct timespec         delta;  /* Time spent before event */
  73         enum raw_event_type     type;   /* event type */
  74 };
  75
  76 struct ir_raw_event_ctrl {
  77         struct kfifo                    kfifo;          /* fifo for the pulse/space events */
  78         struct timespec                 last_event;     /* when last event occurred */
  79 };
  80
  81 struct ir_input_dev {
  82         struct device                   dev;            /* device */
  83         char                            *driver_name;   /* Name of the driver module */
  84         struct ir_scancode_table        rc_tab;         /* scan/key table */
  85         unsigned long                   devno;          /* device number */
  86         const struct ir_dev_props       *props;         /* Device properties */
  87         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  88         struct input_dev                *input_dev;     /* the input device associated with this device */
  89
  90         /* key info - needed by IR keycode handlers */
  91         spinlock_t                      keylock;        /* protects the below members */
  92         bool                            keypressed;     /* current state */
  93         unsigned long                   keyup_jiffies;  /* when should the current keypress be released? */
  94         struct timer_list               timer_keyup;    /* timer for releasing a keypress */
  95         u32                             last_keycode;   /* keycode of last command */
  96         u32                             last_scancode;  /* scancode of last command */
  97         u8                              last_toggle;    /* toggle of last command */
  98 };
  99
 100 struct ir_raw_handler {
 101         struct list_head list;
 102
 103         int (*decode)(struct input_dev *input_dev,
 104                       struct ir_raw_event *evs,
 105                       int len);
 106         int (*raw_register)(struct input_dev *input_dev);
 107         int (*raw_unregister)(struct input_dev *input_dev);
 108 };
 109
 110 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
 111
 112 /* Routines from rc-map.c */
 113
 114 int ir_register_map(struct rc_keymap *map);
 115 void ir_unregister_map(struct rc_keymap *map);
 116 struct ir_scancode_table *get_rc_map(const char *name);
 117 void rc_map_init(void);
 118
 119 /* Routines from ir-keytable.c */
 120
 121 u32 ir_g_keycode_from_table(struct input_dev *input_dev,
 122                             u32 scancode);
 123 void ir_repeat(struct input_dev *dev);
 124 void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
 125 int __ir_input_register(struct input_dev *dev,
 126                       const struct ir_scancode_table *ir_codes,
 127                       const struct ir_dev_props *props,
 128                       const char *driver_name);
 129
 130 static inline int ir_input_register(struct input_dev *dev,
 131                       const char *map_name,
 132                       const struct ir_dev_props *props,
 133                       const char *driver_name) {
 134         struct ir_scancode_table *ir_codes;
 135         struct ir_input_dev *ir_dev;
 136         int rc;
 137
 138         if (!map_name)
 139                 return -EINVAL;
 140
 141         ir_codes = get_rc_map(map_name);
 142         if (!ir_codes)
 143                 return -EINVAL;
 144
 145         rc = __ir_input_register(dev, ir_codes, props, driver_name);
 146         if (rc < 0)
 147                 return -EINVAL;
 148
 149         ir_dev = input_get_drvdata(dev);
 150
 151         if (!rc && ir_dev->props && ir_dev->props->change_protocol)
 152                 rc = ir_dev->props->change_protocol(ir_dev->props->priv,
 153                                                     ir_codes->ir_type);
 154
 155         return rc;
 156 }
 157
 158 void ir_input_unregister(struct input_dev *input_dev);
 159
 160 /* Routines from ir-sysfs.c */
 161
 162 int ir_register_class(struct input_dev *input_dev);
 163 void ir_unregister_class(struct input_dev *input_dev);
 164
 165 /* Routines from ir-raw-event.c */
 166 int ir_raw_event_register(struct input_dev *input_dev);
 167 void ir_raw_event_unregister(struct input_dev *input_dev);
 168 int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
 169 int ir_raw_event_handle(struct input_dev *input_dev);
 170 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
 171 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
 172 void ir_raw_init(void);
 173
 174 /* from ir-nec-decoder.c */
 175 #ifdef CONFIG_IR_NEC_DECODER_MODULE
 176 #define load_nec_decode()       request_module("ir-nec-decoder")
 177 #else
 178 #define load_nec_decode()       0
 179 #endif
 180
 181 /* from ir-rc5-decoder.c */
 182 #ifdef CONFIG_IR_RC5_DECODER_MODULE
 183 #define load_rc5_decode()       request_module("ir-rc5-decoder")
 184 #else
 185 #define load_rc5_decode()       0
 186 #endif
 187
 188 #endif /* _IR_CORE */