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