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  * @priv: driver-specific data, to be used on the callbacks
  48  * @change_protocol: allow changing the protocol used on hardware decoders
  49  * @open: callback to allow drivers to enable polling/irq when IR input device
  50  *      is opened.
  51  * @close: callback to allow drivers to disable polling/irq when IR input device
  52  *      is opened.
  53  * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
  54  * @s_tx_carrier: set transmit carrier frequency
  55  * @tx_ir: transmit IR
  56  * @s_idle: optional: enable/disable hardware idle mode, upon which,
  57  *      device doesn't interrupt host untill it sees IR data
  58  */
  59 struct ir_dev_props {
  60         enum rc_driver_type     driver_type;
  61         unsigned long           allowed_protos;
  62         u32                     scanmask;
  63
  64         u32                     timeout;
  65         u32                     min_timeout;
  66         u32                     max_timeout;
  67
  68
  69         void                    *priv;
  70         int                     (*change_protocol)(void *priv, u64 ir_type);
  71         int                     (*open)(void *priv);
  72         void                    (*close)(void *priv);
  73         int                     (*s_tx_mask)(void *priv, u32 mask);
  74         int                     (*s_tx_carrier)(void *priv, u32 carrier);
  75         int                     (*tx_ir)(void *priv, int *txbuf, u32 n);
  76         void                    (*s_idle)(void *priv, int enable);
  77 };
  78
  79 struct ir_input_dev {
  80         struct device                   dev;            /* device */
  81         char                            *driver_name;   /* Name of the driver module */
  82         struct ir_scancode_table        rc_tab;         /* scan/key table */
  83         unsigned long                   devno;          /* device number */
  84         struct ir_dev_props             *props;         /* Device properties */
  85         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  86         struct input_dev                *input_dev;     /* the input device associated with this device */
  87         bool                            idle;
  88
  89         /* key info - needed by IR keycode handlers */
  90         spinlock_t                      keylock;        /* protects the below members */
  91         bool                            keypressed;     /* current state */
  92         unsigned long                   keyup_jiffies;  /* when should the current keypress be released? */
  93         struct timer_list               timer_keyup;    /* timer for releasing a keypress */
  94         u32                             last_keycode;   /* keycode of last command */
  95         u32                             last_scancode;  /* scancode of last command */
  96         u8                              last_toggle;    /* toggle of last command */
  97 };
  98
  99 enum raw_event_type {
 100         IR_SPACE        = (1 << 0),
 101         IR_PULSE        = (1 << 1),
 102         IR_START_EVENT  = (1 << 2),
 103         IR_STOP_EVENT   = (1 << 3),
 104 };
 105
 106 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
 107
 108 /* From ir-keytable.c */
 109 int __ir_input_register(struct input_dev *dev,
 110                       const struct ir_scancode_table *ir_codes,
 111                       struct ir_dev_props *props,
 112                       const char *driver_name);
 113
 114 static inline int ir_input_register(struct input_dev *dev,
 115                       const char *map_name,
 116                       struct ir_dev_props *props,
 117                       const char *driver_name) {
 118         struct ir_scancode_table *ir_codes;
 119         struct ir_input_dev *ir_dev;
 120         int rc;
 121
 122         if (!map_name)
 123                 return -EINVAL;
 124
 125         ir_codes = get_rc_map(map_name);
 126         if (!ir_codes) {
 127                 ir_codes = get_rc_map(RC_MAP_EMPTY);
 128
 129                 if (!ir_codes)
 130                         return -EINVAL;
 131         }
 132
 133         rc = __ir_input_register(dev, ir_codes, props, driver_name);
 134         if (rc < 0)
 135                 return -EINVAL;
 136
 137         ir_dev = input_get_drvdata(dev);
 138
 139         if (!rc && ir_dev->props && ir_dev->props->change_protocol)
 140                 rc = ir_dev->props->change_protocol(ir_dev->props->priv,
 141                                                     ir_codes->ir_type);
 142
 143         return rc;
 144 }
 145
 146 void ir_input_unregister(struct input_dev *input_dev);
 147
 148 void ir_repeat(struct input_dev *dev);
 149 void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
 150 u32 ir_g_keycode_from_table(struct input_dev *input_dev, u32 scancode);
 151
 152 /* From ir-raw-event.c */
 153
 154 struct ir_raw_event {
 155         unsigned                        pulse:1;
 156         unsigned                        duration:31;
 157 };
 158
 159 #define IR_MAX_DURATION                 0x7FFFFFFF      /* a bit more than 2 seconds */
 160
 161 void ir_raw_event_handle(struct input_dev *input_dev);
 162 int ir_raw_event_store(struct input_dev *input_dev, struct ir_raw_event *ev);
 163 int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
 164 int ir_raw_event_store_with_filter(struct input_dev *input_dev,
 165                                 struct ir_raw_event *ev);
 166 void ir_raw_event_set_idle(struct input_dev *input_dev, int idle);
 167
 168 static inline void ir_raw_event_reset(struct input_dev *input_dev)
 169 {
 170         struct ir_raw_event ev = { .pulse = false, .duration = 0 };
 171         ir_raw_event_store(input_dev, &ev);
 172         ir_raw_event_handle(input_dev);
 173 }
 174
 175 #endif /* _IR_CORE */