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/spinlock.h>
  20 #include <linux/kfifo.h>
  21 #include <linux/time.h>
  22 #include <linux/timer.h>
  23 #include <media/rc-map.h>
  24
  25 extern int ir_core_debug;
  26 #define IR_dprintk(level, fmt, arg...)  if (ir_core_debug >= level) \
  27         printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
  28
  29 enum rc_driver_type {
  30         RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
  31         RC_DRIVER_IR_RAW,       /* Needs a Infra-Red pulse/space decoder */
  32 };
  33
  34 enum raw_event_type {
  35         IR_SPACE        = (1 << 0),
  36         IR_PULSE        = (1 << 1),
  37         IR_START_EVENT  = (1 << 2),
  38         IR_STOP_EVENT   = (1 << 3),
  39 };
  40
  41 /**
  42  * struct ir_dev_props - Allow caller drivers to set special properties
  43  * @driver_type: specifies if the driver or hardware have already a decoder,
  44  *      or if it needs to use the IR raw event decoders to produce a scancode
  45  * @allowed_protos: bitmask with the supported IR_TYPE_* protocols
  46  * @scanmask: some hardware decoders are not capable of providing the full
  47  *      scancode to the application. As this is a hardware limit, we can't do
  48  *      anything with it. Yet, as the same keycode table can be used with other
  49  *      devices, a mask is provided to allow its usage. Drivers should generally
  50  *      leave this field in blank
  51  * @priv: driver-specific data, to be used on the callbacks
  52  * @change_protocol: allow changing the protocol used on hardware decoders
  53  * @open: callback to allow drivers to enable polling/irq when IR input device
  54  *      is opened.
  55  * @close: callback to allow drivers to disable polling/irq when IR input device
  56  *      is opened.
  57  */
  58 struct ir_dev_props {
  59         enum rc_driver_type     driver_type;
  60         unsigned long           allowed_protos;
  61         u32                     scanmask;
  62         void                    *priv;
  63         int                     (*change_protocol)(void *priv, u64 ir_type);
  64         int                     (*open)(void *priv);
  65         void                    (*close)(void *priv);
  66 };
  67
  68 struct ir_raw_event {
  69         struct timespec         delta;  /* Time spent before event */
  70         enum raw_event_type     type;   /* event type */
  71 };
  72
  73 struct ir_raw_event_ctrl {
  74         struct kfifo                    kfifo;          /* fifo for the pulse/space events */
  75         struct timespec                 last_event;     /* when last event occurred */
  76 };
  77
  78 struct ir_input_dev {
  79         struct device                   dev;            /* device */
  80         char                            *driver_name;   /* Name of the driver module */
  81         struct ir_scancode_table        rc_tab;         /* scan/key table */
  82         unsigned long                   devno;          /* device number */
  83         const struct ir_dev_props       *props;         /* Device properties */
  84         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  85         struct input_dev                *input_dev;     /* the input device associated with this device */
  86
  87         /* key info - needed by IR keycode handlers */
  88         spinlock_t                      keylock;        /* protects the below members */
  89         bool                            keypressed;     /* current state */
  90         unsigned long                   keyup_jiffies;  /* when should the current keypress be released? */
  91         struct timer_list               timer_keyup;    /* timer for releasing a keypress */
  92         u32                             last_keycode;   /* keycode of last command */
  93         u32                             last_scancode;  /* scancode of last command */
  94         u8                              last_toggle;    /* toggle of last command */
  95 };
  96
  97 struct ir_raw_handler {
  98         struct list_head list;
  99
 100         int (*decode)(struct input_dev *input_dev,
 101                       struct ir_raw_event *ev);
 102         int (*raw_register)(struct input_dev *input_dev);
 103         int (*raw_unregister)(struct input_dev *input_dev);
 104 };
 105
 106 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
 107
 108 /* Routines from ir-keytable.c */
 109
 110 u32 ir_g_keycode_from_table(struct input_dev *input_dev,
 111                             u32 scancode);
 112 void ir_repeat(struct input_dev *dev);
 113 void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
 114 int __ir_input_register(struct input_dev *dev,
 115                       const struct ir_scancode_table *ir_codes,
 116                       const struct ir_dev_props *props,
 117                       const char *driver_name);
 118
 119 static inline int ir_input_register(struct input_dev *dev,
 120                       const char *map_name,
 121                       const struct ir_dev_props *props,
 122                       const char *driver_name) {
 123         struct ir_scancode_table *ir_codes;
 124         struct ir_input_dev *ir_dev;
 125         int rc;
 126
 127         if (!map_name)
 128                 return -EINVAL;
 129
 130         ir_codes = get_rc_map(map_name);
 131         if (!ir_codes)
 132                 return -EINVAL;
 133
 134         rc = __ir_input_register(dev, ir_codes, props, driver_name);
 135         if (rc < 0)
 136                 return -EINVAL;
 137
 138         ir_dev = input_get_drvdata(dev);
 139
 140         if (!rc && ir_dev->props && ir_dev->props->change_protocol)
 141                 rc = ir_dev->props->change_protocol(ir_dev->props->priv,
 142                                                     ir_codes->ir_type);
 143
 144         return rc;
 145 }
 146
 147 void ir_input_unregister(struct input_dev *input_dev);
 148
 149 /* Routines from ir-sysfs.c */
 150
 151 int ir_register_class(struct input_dev *input_dev);
 152 void ir_unregister_class(struct input_dev *input_dev);
 153
 154 /* Routines from ir-raw-event.c */
 155 int ir_raw_event_register(struct input_dev *input_dev);
 156 void ir_raw_event_unregister(struct input_dev *input_dev);
 157 int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
 158 int ir_raw_event_handle(struct input_dev *input_dev);
 159 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
 160 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
 161 void ir_raw_init(void);
 162
 163 /* from ir-nec-decoder.c */
 164 #ifdef CONFIG_IR_NEC_DECODER_MODULE
 165 #define load_nec_decode()       request_module("ir-nec-decoder")
 166 #else
 167 #define load_nec_decode()       0
 168 #endif
 169
 170 /* from ir-rc5-decoder.c */
 171 #ifdef CONFIG_IR_RC5_DECODER_MODULE
 172 #define load_rc5_decode()       request_module("ir-rc5-decoder")
 173 #else
 174 #define load_rc5_decode()       0
 175 #endif
 176
 177 #endif /* _IR_CORE */