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/cdev.h>
  21 #include <linux/kfifo.h>
  22 #include <linux/time.h>
  23 #include <linux/timer.h>
  24 #include <media/rc-map.h>
  25
  26 /**
  27  * enum rc_driver_type - type of the RC driver.
  28  *
  29  * @RC_DRIVER_SCANCODE:  Driver or hardware generates a scancode.
  30  * @RC_DRIVER_IR_RAW:    Driver or hardware generates pulse/space sequences.
  31  *                       It needs a Infra-Red pulse/space decoder
  32  * @RC_DRIVER_IR_RAW_TX: Device transmitter only,
  33  *                       driver requires pulse/space data sequence.
  34  */
  35 enum rc_driver_type {
  36         RC_DRIVER_SCANCODE = 0,
  37         RC_DRIVER_IR_RAW,
  38         RC_DRIVER_IR_RAW_TX,
  39 };
  40
  41 /**
  42  * struct rc_scancode_filter - Filter scan codes.
  43  * @data:       Scancode data to match.
  44  * @mask:       Mask of bits of scancode to compare.
  45  */
  46 struct rc_scancode_filter {
  47         u32 data;
  48         u32 mask;
  49 };
  50
  51 /**
  52  * enum rc_filter_type - Filter type constants.
  53  * @RC_FILTER_NORMAL:   Filter for normal operation.
  54  * @RC_FILTER_WAKEUP:   Filter for waking from suspend.
  55  * @RC_FILTER_MAX:      Number of filter types.
  56  */
  57 enum rc_filter_type {
  58         RC_FILTER_NORMAL = 0,
  59         RC_FILTER_WAKEUP,
  60
  61         RC_FILTER_MAX
  62 };
  63
  64 /**
  65  * struct lirc_fh - represents an open lirc file
  66  * @list: list of open file handles
  67  * @rc: rcdev for this lirc chardev
  68  * @carrier_low: when setting the carrier range, first the low end must be
  69  *      set with an ioctl and then the high end with another ioctl
  70  * @send_timeout_reports: report timeouts in lirc raw IR.
  71  * @rawir: queue for incoming raw IR
  72  * @scancodes: queue for incoming decoded scancodes
  73  * @wait_poll: poll struct for lirc device
  74  * @send_mode: lirc mode for sending, either LIRC_MODE_SCANCODE or
  75  *      LIRC_MODE_PULSE
  76  * @rec_mode: lirc mode for receiving, either LIRC_MODE_SCANCODE or
  77  *      LIRC_MODE_MODE2
  78  */
  79 struct lirc_fh {
  80         struct list_head list;
  81         struct rc_dev *rc;
  82         int                             carrier_low;
  83         bool                            send_timeout_reports;
  84         DECLARE_KFIFO_PTR(rawir, unsigned int);
  85         DECLARE_KFIFO_PTR(scancodes, struct lirc_scancode);
  86         wait_queue_head_t               wait_poll;
  87         u8                              send_mode;
  88         u8                              rec_mode;
  89 };
  90
  91 /**
  92  * struct rc_dev - represents a remote control device
  93  * @dev: driver model's view of this device
  94  * @managed_alloc: devm_rc_allocate_device was used to create rc_dev
  95  * @sysfs_groups: sysfs attribute groups
  96  * @device_name: name of the rc child device
  97  * @input_phys: physical path to the input child device
  98  * @input_id: id of the input child device (struct input_id)
  99  * @driver_name: name of the hardware driver which registered this device
 100  * @map_name: name of the default keymap
 101  * @rc_map: current scan/key table
 102  * @lock: used to ensure we've filled in all protocol details before
 103  *      anyone can call show_protocols or store_protocols
 104  * @minor: unique minor remote control device number
 105  * @raw: additional data for raw pulse/space devices
 106  * @input_dev: the input child device used to communicate events to userspace
 107  * @driver_type: specifies if protocol decoding is done in hardware or software
 108  * @idle: used to keep track of RX state
 109  * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
 110  *      wakeup protocols is the set of all raw encoders
 111  * @allowed_protocols: bitmask with the supported RC_PROTO_BIT_* protocols
 112  * @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols
 113  * @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup
 114  *      protocols
 115  * @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or
 116  *      RC_PROTO_UNKNOWN if disabled.
 117  * @scancode_filter: scancode filter
 118  * @scancode_wakeup_filter: scancode wakeup filters
 119  * @scancode_mask: some hardware decoders are not capable of providing the full
 120  *      scancode to the application. As this is a hardware limit, we can't do
 121  *      anything with it. Yet, as the same keycode table can be used with other
 122  *      devices, a mask is provided to allow its usage. Drivers should generally
 123  *      leave this field in blank
 124  * @users: number of current users of the device
 125  * @priv: driver-specific data
 126  * @keylock: protects the remaining members of the struct
 127  * @keypressed: whether a key is currently pressed
 128  * @keyup_jiffies: time (in jiffies) when the current keypress should be released
 129  * @timer_keyup: timer for releasing a keypress
 130  * @timer_repeat: timer for autorepeat events. This is needed for CEC, which
 131  *      has non-standard repeats.
 132  * @last_keycode: keycode of last keypress
 133  * @last_protocol: protocol of last keypress
 134  * @last_scancode: scancode of last keypress
 135  * @last_toggle: toggle value of last command
 136  * @timeout: optional time after which device stops sending data
 137  * @min_timeout: minimum timeout supported by device
 138  * @max_timeout: maximum timeout supported by device
 139  * @rx_resolution : resolution (in ns) of input sampler
 140  * @tx_resolution: resolution (in ns) of output sampler
 141  * @lirc_dev: lirc device
 142  * @lirc_cdev: lirc char cdev
 143  * @gap_start: time when gap starts
 144  * @gap_duration: duration of initial gap
 145  * @gap: true if we're in a gap
 146  * @lirc_fh_lock: protects lirc_fh list
 147  * @lirc_fh: list of open files
 148  * @registered: set to true by rc_register_device(), false by
 149  *      rc_unregister_device
 150  * @change_protocol: allow changing the protocol used on hardware decoders
 151  * @open: callback to allow drivers to enable polling/irq when IR input device
 152  *      is opened.
 153  * @close: callback to allow drivers to disable polling/irq when IR input device
 154  *      is opened.
 155  * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
 156  * @s_tx_carrier: set transmit carrier frequency
 157  * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
 158  * @s_rx_carrier_range: inform driver about carrier it is expected to handle
 159  * @tx_ir: transmit IR
 160  * @s_idle: enable/disable hardware idle mode, upon which,
 161  *      device doesn't interrupt host until it sees IR pulses
 162  * @s_learning_mode: enable wide band receiver used for learning
 163  * @s_carrier_report: enable carrier reports
 164  * @s_filter: set the scancode filter
 165  * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
 166  *      then wakeup should be disabled. wakeup_protocol will be set to
 167  *      a valid protocol if mask is nonzero.
 168  * @s_timeout: set hardware timeout in ns
 169  */
 170 struct rc_dev {
 171         struct device                   dev;
 172         bool                            managed_alloc;
 173         const struct attribute_group    *sysfs_groups[5];
 174         const char                      *device_name;
 175         const char                      *input_phys;
 176         struct input_id                 input_id;
 177         const char                      *driver_name;
 178         const char                      *map_name;
 179         struct rc_map                   rc_map;
 180         struct mutex                    lock;
 181         unsigned int                    minor;
 182         struct ir_raw_event_ctrl        *raw;
 183         struct input_dev                *input_dev;
 184         enum rc_driver_type             driver_type;
 185         bool                            idle;
 186         bool                            encode_wakeup;
 187         u64                             allowed_protocols;
 188         u64                             enabled_protocols;
 189         u64                             allowed_wakeup_protocols;
 190         enum rc_proto                   wakeup_protocol;
 191         struct rc_scancode_filter       scancode_filter;
 192         struct rc_scancode_filter       scancode_wakeup_filter;
 193         u32                             scancode_mask;
 194         u32                             users;
 195         void                            *priv;
 196         spinlock_t                      keylock;
 197         bool                            keypressed;
 198         unsigned long                   keyup_jiffies;
 199         struct timer_list               timer_keyup;
 200         struct timer_list               timer_repeat;
 201         u32                             last_keycode;
 202         enum rc_proto                   last_protocol;
 203         u32                             last_scancode;
 204         u8                              last_toggle;
 205         u32                             timeout;
 206         u32                             min_timeout;
 207         u32                             max_timeout;
 208         u32                             rx_resolution;
 209         u32                             tx_resolution;
 210 #ifdef CONFIG_LIRC
 211         struct device                   lirc_dev;
 212         struct cdev                     lirc_cdev;
 213         ktime_t                         gap_start;
 214         u64                             gap_duration;
 215         bool                            gap;
 216         spinlock_t                      lirc_fh_lock;
 217         struct list_head                lirc_fh;
 218 #endif
 219         bool                            registered;
 220         int                             (*change_protocol)(struct rc_dev *dev, u64 *rc_proto);
 221         int                             (*open)(struct rc_dev *dev);
 222         void                            (*close)(struct rc_dev *dev);
 223         int                             (*s_tx_mask)(struct rc_dev *dev, u32 mask);
 224         int                             (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
 225         int                             (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
 226         int                             (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
 227         int                             (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
 228         void                            (*s_idle)(struct rc_dev *dev, bool enable);
 229         int                             (*s_learning_mode)(struct rc_dev *dev, int enable);
 230         int                             (*s_carrier_report) (struct rc_dev *dev, int enable);
 231         int                             (*s_filter)(struct rc_dev *dev,
 232                                                     struct rc_scancode_filter *filter);
 233         int                             (*s_wakeup_filter)(struct rc_dev *dev,
 234                                                            struct rc_scancode_filter *filter);
 235         int                             (*s_timeout)(struct rc_dev *dev,
 236                                                      unsigned int timeout);
 237 };
 238
 239 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
 240
 241 /*
 242  * From rc-main.c
 243  * Those functions can be used on any type of Remote Controller. They
 244  * basically creates an input_dev and properly reports the device as a
 245  * Remote Controller, at sys/class/rc.
 246  */
 247
 248 /**
 249  * rc_allocate_device - Allocates a RC device
 250  *
 251  * @rc_driver_type: specifies the type of the RC output to be allocated
 252  * returns a pointer to struct rc_dev.
 253  */
 254 struct rc_dev *rc_allocate_device(enum rc_driver_type);
 255
 256 /**
 257  * devm_rc_allocate_device - Managed RC device allocation
 258  *
 259  * @dev: pointer to struct device
 260  * @rc_driver_type: specifies the type of the RC output to be allocated
 261  * returns a pointer to struct rc_dev.
 262  */
 263 struct rc_dev *devm_rc_allocate_device(struct device *dev, enum rc_driver_type);
 264
 265 /**
 266  * rc_free_device - Frees a RC device
 267  *
 268  * @dev: pointer to struct rc_dev.
 269  */
 270 void rc_free_device(struct rc_dev *dev);
 271
 272 /**
 273  * rc_register_device - Registers a RC device
 274  *
 275  * @dev: pointer to struct rc_dev.
 276  */
 277 int rc_register_device(struct rc_dev *dev);
 278
 279 /**
 280  * devm_rc_register_device - Manageded registering of a RC device
 281  *
 282  * @parent: pointer to struct device.
 283  * @dev: pointer to struct rc_dev.
 284  */
 285 int devm_rc_register_device(struct device *parent, struct rc_dev *dev);
 286
 287 /**
 288  * rc_unregister_device - Unregisters a RC device
 289  *
 290  * @dev: pointer to struct rc_dev.
 291  */
 292 void rc_unregister_device(struct rc_dev *dev);
 293
 294 void rc_repeat(struct rc_dev *dev);
 295 void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u32 scancode,
 296                 u8 toggle);
 297 void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol,
 298                           u32 scancode, u8 toggle);
 299 void rc_keyup(struct rc_dev *dev);
 300 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
 301
 302 /*
 303  * From rc-raw.c
 304  * The Raw interface is specific to InfraRed. It may be a good idea to
 305  * split it later into a separate header.
 306  */
 307 struct ir_raw_event {
 308         union {
 309                 u32             duration;
 310                 u32             carrier;
 311         };
 312         u8                      duty_cycle;
 313
 314         unsigned                pulse:1;
 315         unsigned                reset:1;
 316         unsigned                timeout:1;
 317         unsigned                carrier_report:1;
 318 };
 319
 320 #define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}
 321
 322 static inline void init_ir_raw_event(struct ir_raw_event *ev)
 323 {
 324         memset(ev, 0, sizeof(*ev));
 325 }
 326
 327 #define IR_DEFAULT_TIMEOUT      MS_TO_NS(125)
 328 #define IR_MAX_DURATION         500000000       /* 500 ms */
 329 #define US_TO_NS(usec)          ((usec) * 1000)
 330 #define MS_TO_US(msec)          ((msec) * 1000)
 331 #define MS_TO_NS(msec)          ((msec) * 1000 * 1000)
 332
 333 void ir_raw_event_handle(struct rc_dev *dev);
 334 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
 335 int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse);
 336 int ir_raw_event_store_with_filter(struct rc_dev *dev,
 337                                    struct ir_raw_event *ev);
 338 int ir_raw_event_store_with_timeout(struct rc_dev *dev,
 339                                     struct ir_raw_event *ev);
 340 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
 341 int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode,
 342                            struct ir_raw_event *events, unsigned int max);
 343 int ir_raw_encode_carrier(enum rc_proto protocol);
 344
 345 static inline void ir_raw_event_reset(struct rc_dev *dev)
 346 {
 347         struct ir_raw_event ev = { .reset = true };
 348
 349         ir_raw_event_store(dev, &ev);
 350         ir_raw_event_handle(dev);
 351 }
 352
 353 /* extract mask bits out of data and pack them into the result */
 354 static inline u32 ir_extract_bits(u32 data, u32 mask)
 355 {
 356         u32 vbit = 1, value = 0;
 357
 358         do {
 359                 if (mask & 1) {
 360                         if (data & 1)
 361                                 value |= vbit;
 362                         vbit <<= 1;
 363                 }
 364                 data >>= 1;
 365         } while (mask >>= 1);
 366
 367         return value;
 368 }
 369
 370 /* Get NEC scancode and protocol type from address and command bytes */
 371 static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address,
 372                                            u8 command, u8 not_command,
 373                                            enum rc_proto *protocol)
 374 {
 375         u32 scancode;
 376
 377         if ((command ^ not_command) != 0xff) {
 378                 /* NEC transport, but modified protocol, used by at
 379                  * least Apple and TiVo remotes
 380                  */
 381                 scancode = not_address << 24 |
 382                         address     << 16 |
 383                         not_command <<  8 |
 384                         command;
 385                 *protocol = RC_PROTO_NEC32;
 386         } else if ((address ^ not_address) != 0xff) {
 387                 /* Extended NEC */
 388                 scancode = address     << 16 |
 389                            not_address <<  8 |
 390                            command;
 391                 *protocol = RC_PROTO_NECX;
 392         } else {
 393                 /* Normal NEC */
 394                 scancode = address << 8 | command;
 395                 *protocol = RC_PROTO_NEC;
 396         }
 397
 398         return scancode;
 399 }
 400
 401 #endif /* _RC_CORE */