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