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 /**
  35  * struct ir_dev_props - Allow caller drivers to set special properties
  36  * @driver_type: specifies if the driver or hardware have already a decoder,
  37  *      or if it needs to use the IR raw event decoders to produce a scancode
  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  * @timeout: optional time after which device stops sending data
  45  * @min_timeout: minimum timeout supported by device
  46  * @max_timeout: maximum timeout supported by device
  47  * @rx_resolution : resolution (in ns) of input sampler
  48  * @tx_resolution: resolution (in ns) of output sampler
  49  * @priv: driver-specific data, to be used on the callbacks
  50  * @change_protocol: allow changing the protocol used on hardware decoders
  51  * @open: callback to allow drivers to enable polling/irq when IR input device
  52  *      is opened.
  53  * @close: callback to allow drivers to disable polling/irq when IR input device
  54  *      is opened.
  55  * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
  56  * @s_tx_carrier: set transmit carrier frequency
  57  * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
  58  * @s_rx_carrier: inform driver about carrier it is expected to handle
  59  * @tx_ir: transmit IR
  60  * @s_idle: optional: enable/disable hardware idle mode, upon which,
  61         device doesn't interrupt host until it sees IR pulses
  62  * @s_learning_mode: enable wide band receiver used for learning
  63  * @s_carrier_report: enable carrier reports
  64  */
  65 struct ir_dev_props {
  66         enum rc_driver_type     driver_type;
  67         unsigned long           allowed_protos;
  68         u32                     scanmask;
  69
  70         u32                     timeout;
  71         u32                     min_timeout;
  72         u32                     max_timeout;
  73
  74         u32                     rx_resolution;
  75         u32                     tx_resolution;
  76
  77         void                    *priv;
  78         int                     (*change_protocol)(void *priv, u64 ir_type);
  79         int                     (*open)(void *priv);
  80         void                    (*close)(void *priv);
  81         int                     (*s_tx_mask)(void *priv, u32 mask);
  82         int                     (*s_tx_carrier)(void *priv, u32 carrier);
  83         int                     (*s_tx_duty_cycle)(void *priv, u32 duty_cycle);
  84         int                     (*s_rx_carrier_range)(void *priv, u32 min, u32 max);
  85         int                     (*tx_ir)(void *priv, int *txbuf, u32 n);
  86         void                    (*s_idle)(void *priv, bool enable);
  87         int                     (*s_learning_mode)(void *priv, int enable);
  88         int                     (*s_carrier_report) (void *priv, int enable);
  89 };
  90
  91 struct ir_input_dev {
  92         struct device                   dev;            /* device */
  93         char                            *driver_name;   /* Name of the driver module */
  94         struct ir_scancode_table        rc_tab;         /* scan/key table */
  95         unsigned long                   devno;          /* device number */
  96         struct ir_dev_props             *props;         /* Device properties */
  97         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  98         struct input_dev                *input_dev;     /* the input device associated with this device */
  99         bool                            idle;
 100
 101         /* key info - needed by IR keycode handlers */
 102         spinlock_t                      keylock;        /* protects the below members */
 103         bool                            keypressed;     /* current state */
 104         unsigned long                   keyup_jiffies;  /* when should the current keypress be released? */
 105         struct timer_list               timer_keyup;    /* timer for releasing a keypress */
 106         u32                             last_keycode;   /* keycode of last command */
 107         u32                             last_scancode;  /* scancode of last command */
 108         u8                              last_toggle;    /* toggle of last command */
 109 };
 110
 111 enum raw_event_type {
 112         IR_SPACE        = (1 << 0),
 113         IR_PULSE        = (1 << 1),
 114         IR_START_EVENT  = (1 << 2),
 115         IR_STOP_EVENT   = (1 << 3),
 116 };
 117
 118 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
 119
 120 /* From ir-keytable.c */
 121 int __ir_input_register(struct input_dev *dev,
 122                       const struct ir_scancode_table *ir_codes,
 123                       struct ir_dev_props *props,
 124                       const char *driver_name);
 125
 126 static inline int ir_input_register(struct input_dev *dev,
 127                       const char *map_name,
 128                       struct ir_dev_props *props,
 129                       const char *driver_name) {
 130         struct ir_scancode_table *ir_codes;
 131         struct ir_input_dev *ir_dev;
 132         int rc;
 133
 134         if (!map_name)
 135                 return -EINVAL;
 136
 137         ir_codes = get_rc_map(map_name);
 138         if (!ir_codes) {
 139                 ir_codes = get_rc_map(RC_MAP_EMPTY);
 140
 141                 if (!ir_codes)
 142                         return -EINVAL;
 143         }
 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 void ir_repeat(struct input_dev *dev);
 161 void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
 162 void ir_keyup(struct ir_input_dev *ir);
 163 u32 ir_g_keycode_from_table(struct input_dev *input_dev, u32 scancode);
 164
 165 /* From ir-raw-event.c */
 166
 167 struct ir_raw_event {
 168         union {
 169                 u32             duration;
 170
 171                 struct {
 172                         u32     carrier;
 173                         u8      duty_cycle;
 174                 };
 175         };
 176
 177         unsigned                pulse:1;
 178         unsigned                reset:1;
 179         unsigned                timeout:1;
 180         unsigned                carrier_report:1;
 181 };
 182
 183 #define DEFINE_IR_RAW_EVENT(event) \
 184         struct ir_raw_event event = { \
 185                 { .duration = 0 } , \
 186                 .pulse = 0, \
 187                 .reset = 0, \
 188                 .timeout = 0, \
 189                 .carrier_report = 0 }
 190
 191 static inline void init_ir_raw_event(struct ir_raw_event *ev)
 192 {
 193         memset(ev, 0, sizeof(*ev));
 194 }
 195
 196 #define IR_MAX_DURATION         0xFFFFFFFF      /* a bit more than 4 seconds */
 197
 198 void ir_raw_event_handle(struct input_dev *input_dev);
 199 int ir_raw_event_store(struct input_dev *input_dev, struct ir_raw_event *ev);
 200 int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
 201 int ir_raw_event_store_with_filter(struct input_dev *input_dev,
 202                                 struct ir_raw_event *ev);
 203 void ir_raw_event_set_idle(struct input_dev *input_dev, bool idle);
 204
 205 static inline void ir_raw_event_reset(struct input_dev *input_dev)
 206 {
 207         DEFINE_IR_RAW_EVENT(ev);
 208         ev.reset = true;
 209
 210         ir_raw_event_store(input_dev, &ev);
 211         ir_raw_event_handle(input_dev);
 212 }
 213
 214 #endif /* _IR_CORE */