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