include/media/rc-core.h

   1 /*
   2  * Remote Controller core header
   3  *
   4  * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
   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 _RC_CORE
  17 #define _RC_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 rc_core_debug;
  26 #define IR_dprintk(level, fmt, ...)                             \
  27 do {                                                            \
  28         if (rc_core_debug >= level)                             \
  29                 pr_debug("%s: " fmt, __func__, ##__VA_ARGS__);  \
  30 } while (0)
  31
  32 enum rc_driver_type {
  33         RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
  34         RC_DRIVER_IR_RAW,       /* Needs a Infra-Red pulse/space decoder */
  35 };
  36
  37 /**
  38  * struct rc_scancode_filter - Filter scan codes.
  39  * @data:       Scancode data to match.
  40  * @mask:       Mask of bits of scancode to compare.
  41  */
  42 struct rc_scancode_filter {
  43         u32 data;
  44         u32 mask;
  45 };
  46
  47 /**
  48  * enum rc_filter_type - Filter type constants.
  49  * @RC_FILTER_NORMAL:   Filter for normal operation.
  50  * @RC_FILTER_WAKEUP:   Filter for waking from suspend.
  51  * @RC_FILTER_MAX:      Number of filter types.
  52  */
  53 enum rc_filter_type {
  54         RC_FILTER_NORMAL = 0,
  55         RC_FILTER_WAKEUP,
  56
  57         RC_FILTER_MAX
  58 };
  59
  60 /**
  61  * struct rc_dev - represents a remote control device
  62  * @dev: driver model's view of this device
  63  * @sysfs_groups: sysfs attribute groups
  64  * @input_name: name of the input child device
  65  * @input_phys: physical path to the input child device
  66  * @input_id: id of the input child device (struct input_id)
  67  * @driver_name: name of the hardware driver which registered this device
  68  * @map_name: name of the default keymap
  69  * @rc_map: current scan/key table
  70  * @lock: used to ensure we've filled in all protocol details before
  71  *      anyone can call show_protocols or store_protocols
  72  * @devno: unique remote control device number
  73  * @raw: additional data for raw pulse/space devices
  74  * @input_dev: the input child device used to communicate events to userspace
  75  * @driver_type: specifies if protocol decoding is done in hardware or software
  76  * @idle: used to keep track of RX state
  77  * @allowed_protocols: bitmask with the supported RC_BIT_* protocols for each
  78  *      filter type
  79  * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols for each
  80  *      filter type
  81  * @scanmask: some hardware decoders are not capable of providing the full
  82  *      scancode to the application. As this is a hardware limit, we can't do
  83  *      anything with it. Yet, as the same keycode table can be used with other
  84  *      devices, a mask is provided to allow its usage. Drivers should generally
  85  *      leave this field in blank
  86  * @priv: driver-specific data
  87  * @keylock: protects the remaining members of the struct
  88  * @keypressed: whether a key is currently pressed
  89  * @keyup_jiffies: time (in jiffies) when the current keypress should be released
  90  * @timer_keyup: timer for releasing a keypress
  91  * @last_keycode: keycode of last keypress
  92  * @last_scancode: scancode of last keypress
  93  * @last_toggle: toggle value of last command
  94  * @timeout: optional time after which device stops sending data
  95  * @min_timeout: minimum timeout supported by device
  96  * @max_timeout: maximum timeout supported by device
  97  * @rx_resolution : resolution (in ns) of input sampler
  98  * @tx_resolution: resolution (in ns) of output sampler
  99  * @scancode_filters: scancode filters (indexed by enum rc_filter_type)
 100  * @change_protocol: allow changing the protocol used on hardware decoders
 101  * @change_wakeup_protocol: allow changing the protocol used for wakeup
 102  *      filtering
 103  * @open: callback to allow drivers to enable polling/irq when IR input device
 104  *      is opened.
 105  * @close: callback to allow drivers to disable polling/irq when IR input device
 106  *      is opened.
 107  * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
 108  * @s_tx_carrier: set transmit carrier frequency
 109  * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
 110  * @s_rx_carrier: inform driver about carrier it is expected to handle
 111  * @tx_ir: transmit IR
 112  * @s_idle: enable/disable hardware idle mode, upon which,
 113  *      device doesn't interrupt host until it sees IR pulses
 114  * @s_learning_mode: enable wide band receiver used for learning
 115  * @s_carrier_report: enable carrier reports
 116  * @s_filter: set the scancode filter
 117  * @s_wakeup_filter: set the wakeup scancode filter
 118  */
 119 struct rc_dev {
 120         struct device                   dev;
 121         const struct attribute_group    *sysfs_groups[5];
 122         const char                      *input_name;
 123         const char                      *input_phys;
 124         struct input_id                 input_id;
 125         char                            *driver_name;
 126         const char                      *map_name;
 127         struct rc_map                   rc_map;
 128         struct mutex                    lock;
 129         unsigned long                   devno;
 130         struct ir_raw_event_ctrl        *raw;
 131         struct input_dev                *input_dev;
 132         enum rc_driver_type             driver_type;
 133         bool                            idle;
 134         u64                             allowed_protocols[RC_FILTER_MAX];
 135         u64                             enabled_protocols[RC_FILTER_MAX];
 136         u32                             users;
 137         u32                             scanmask;
 138         void                            *priv;
 139         spinlock_t                      keylock;
 140         bool                            keypressed;
 141         unsigned long                   keyup_jiffies;
 142         struct timer_list               timer_keyup;
 143         u32                             last_keycode;
 144         u32                             last_scancode;
 145         u8                              last_toggle;
 146         u32                             timeout;
 147         u32                             min_timeout;
 148         u32                             max_timeout;
 149         u32                             rx_resolution;
 150         u32                             tx_resolution;
 151         struct rc_scancode_filter       scancode_filters[RC_FILTER_MAX];
 152         int                             (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
 153         int                             (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type);
 154         int                             (*open)(struct rc_dev *dev);
 155         void                            (*close)(struct rc_dev *dev);
 156         int                             (*s_tx_mask)(struct rc_dev *dev, u32 mask);
 157         int                             (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
 158         int                             (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
 159         int                             (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
 160         int                             (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
 161         void                            (*s_idle)(struct rc_dev *dev, bool enable);
 162         int                             (*s_learning_mode)(struct rc_dev *dev, int enable);
 163         int                             (*s_carrier_report) (struct rc_dev *dev, int enable);
 164         int                             (*s_filter)(struct rc_dev *dev,
 165                                                     struct rc_scancode_filter *filter);
 166         int                             (*s_wakeup_filter)(struct rc_dev *dev,
 167                                                            struct rc_scancode_filter *filter);
 168 };
 169
 170 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
 171
 172 static inline bool rc_protocols_allowed(struct rc_dev *rdev, u64 protos)
 173 {
 174         return rdev->allowed_protocols[RC_FILTER_NORMAL] & protos;
 175 }
 176
 177 /* should be called prior to registration or with mutex held */
 178 static inline void rc_set_allowed_protocols(struct rc_dev *rdev, u64 protos)
 179 {
 180         rdev->allowed_protocols[RC_FILTER_NORMAL] = protos;
 181 }
 182
 183 static inline bool rc_protocols_enabled(struct rc_dev *rdev, u64 protos)
 184 {
 185         return rdev->enabled_protocols[RC_FILTER_NORMAL] & protos;
 186 }
 187
 188 /* should be called prior to registration or with mutex held */
 189 static inline void rc_set_enabled_protocols(struct rc_dev *rdev, u64 protos)
 190 {
 191         rdev->enabled_protocols[RC_FILTER_NORMAL] = protos;
 192 }
 193
 194 /* should be called prior to registration or with mutex held */
 195 static inline void rc_set_allowed_wakeup_protocols(struct rc_dev *rdev,
 196                                                    u64 protos)
 197 {
 198         rdev->allowed_protocols[RC_FILTER_WAKEUP] = protos;
 199 }
 200
 201 /* should be called prior to registration or with mutex held */
 202 static inline void rc_set_enabled_wakeup_protocols(struct rc_dev *rdev,
 203                                                    u64 protos)
 204 {
 205         rdev->enabled_protocols[RC_FILTER_WAKEUP] = protos;
 206 }
 207
 208 /*
 209  * From rc-main.c
 210  * Those functions can be used on any type of Remote Controller. They
 211  * basically creates an input_dev and properly reports the device as a
 212  * Remote Controller, at sys/class/rc.
 213  */
 214
 215 struct rc_dev *rc_allocate_device(void);
 216 void rc_free_device(struct rc_dev *dev);
 217 int rc_register_device(struct rc_dev *dev);
 218 void rc_unregister_device(struct rc_dev *dev);
 219
 220 int rc_open(struct rc_dev *rdev);
 221 void rc_close(struct rc_dev *rdev);
 222
 223 void rc_repeat(struct rc_dev *dev);
 224 void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
 225 void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
 226 void rc_keyup(struct rc_dev *dev);
 227 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
 228
 229 /*
 230  * From rc-raw.c
 231  * The Raw interface is specific to InfraRed. It may be a good idea to
 232  * split it later into a separate header.
 233  */
 234
 235 enum raw_event_type {
 236         IR_SPACE        = (1 << 0),
 237         IR_PULSE        = (1 << 1),
 238         IR_START_EVENT  = (1 << 2),
 239         IR_STOP_EVENT   = (1 << 3),
 240 };
 241
 242 struct ir_raw_event {
 243         union {
 244                 u32             duration;
 245
 246                 struct {
 247                         u32     carrier;
 248                         u8      duty_cycle;
 249                 };
 250         };
 251
 252         unsigned                pulse:1;
 253         unsigned                reset:1;
 254         unsigned                timeout:1;
 255         unsigned                carrier_report:1;
 256 };
 257
 258 #define DEFINE_IR_RAW_EVENT(event) \
 259         struct ir_raw_event event = { \
 260                 { .duration = 0 } , \
 261                 .pulse = 0, \
 262                 .reset = 0, \
 263                 .timeout = 0, \
 264                 .carrier_report = 0 }
 265
 266 static inline void init_ir_raw_event(struct ir_raw_event *ev)
 267 {
 268         memset(ev, 0, sizeof(*ev));
 269 }
 270
 271 #define IR_MAX_DURATION         0xFFFFFFFF      /* a bit more than 4 seconds */
 272 #define US_TO_NS(usec)          ((usec) * 1000)
 273 #define MS_TO_US(msec)          ((msec) * 1000)
 274 #define MS_TO_NS(msec)          ((msec) * 1000 * 1000)
 275
 276 void ir_raw_event_handle(struct rc_dev *dev);
 277 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
 278 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
 279 int ir_raw_event_store_with_filter(struct rc_dev *dev,
 280                                 struct ir_raw_event *ev);
 281 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
 282
 283 static inline void ir_raw_event_reset(struct rc_dev *dev)
 284 {
 285         DEFINE_IR_RAW_EVENT(ev);
 286         ev.reset = true;
 287
 288         ir_raw_event_store(dev, &ev);
 289         ir_raw_event_handle(dev);
 290 }
 291
 292 /* extract mask bits out of data and pack them into the result */
 293 static inline u32 ir_extract_bits(u32 data, u32 mask)
 294 {
 295         u32 vbit = 1, value = 0;
 296
 297         do {
 298                 if (mask & 1) {
 299                         if (data & 1)
 300                                 value |= vbit;
 301                         vbit <<= 1;
 302                 }
 303                 data >>= 1;
 304         } while (mask >>= 1);
 305
 306         return value;
 307 }
 308
 309 #endif /* _RC_CORE */