include/media/rc-core.h

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