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 */
27enum 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 */
38struct 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 */
49enum 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 * @rawir: queue for incoming raw IR
61 * @scancodes: queue for incoming decoded scancodes
62 * @wait_poll: poll struct for lirc device
63 * @carrier_low: when setting the carrier range, first the low end must be
64 * set with an ioctl and then the high end with another ioctl
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 */
70struct lirc_fh {
71 struct list_head list;
72 struct rc_dev *rc;
73 DECLARE_KFIFO_PTR(rawir, unsigned int);
74 DECLARE_KFIFO_PTR(scancodes, struct lirc_scancode);
75 wait_queue_head_t wait_poll;
76 u32 carrier_low;
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 * @registered: set to true by rc_register_device(), false by
86 * rc_unregister_device
87 * @idle: used to keep track of RX state
88 * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
89 * wakeup protocols is the set of all raw encoders
90 * @minor: unique minor remote control device number
91 * @sysfs_groups: sysfs attribute groups
92 * @device_name: name of the rc child device
93 * @input_phys: physical path to the input child device
94 * @input_id: id of the input child device (struct input_id)
95 * @driver_name: name of the hardware driver which registered this device
96 * @map_name: name of the default keymap
97 * @rc_map: current scan/key table
98 * @lock: used to ensure we've filled in all protocol details before
99 * anyone can call show_protocols or store_protocols
100 * @raw: additional data for raw pulse/space devices
101 * @input_dev: the input child device used to communicate events to userspace
102 * @driver_type: specifies if protocol decoding is done in hardware or software
103 * @users: number of current users of the device
104 * @allowed_protocols: bitmask with the supported RC_PROTO_BIT_* protocols
105 * @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols
106 * @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup
107 * protocols
108 * @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or
109 * RC_PROTO_UNKNOWN if disabled.
110 * @scancode_filter: scancode filter
111 * @scancode_wakeup_filter: scancode wakeup filters
112 * @scancode_mask: some hardware decoders are not capable of providing the full
113 * scancode to the application. As this is a hardware limit, we can't do
114 * anything with it. Yet, as the same keycode table can be used with other
115 * devices, a mask is provided to allow its usage. Drivers should generally
116 * leave this field in blank
117 * @priv: driver-specific data
118 * @keylock: protects the remaining members of the struct
119 * @keypressed: whether a key is currently pressed
120 * @last_toggle: toggle value of last command
121 * @last_keycode: keycode of last keypress
122 * @last_protocol: protocol of last keypress
123 * @last_scancode: scancode of last keypress
124 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
125 * @timer_keyup: timer for releasing a keypress
126 * @timer_repeat: timer for autorepeat events. This is needed for CEC, which
127 * has non-standard repeats.
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
131 * @rx_resolution : resolution (in us) of input sampler
132 * @lirc_dev: lirc device
133 * @lirc_cdev: lirc char cdev
134 * @gap_start: start time for gap after timeout if non-zero
135 * @lirc_fh_lock: protects lirc_fh list
136 * @lirc_fh: list of open files
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 */
157struct rc_dev {
158 struct device dev;
159 bool managed_alloc;
160 bool registered;
161 bool idle;
162 bool encode_wakeup;
163 unsigned int minor;
164 const struct attribute_group *sysfs_groups[5];
165 const char *device_name;
166 const char *input_phys;
167 struct input_id input_id;
168 const char *driver_name;
169 const char *map_name;
170 struct rc_map rc_map;
171 struct mutex lock;
172 struct ir_raw_event_ctrl *raw;
173 struct input_dev *input_dev;
174 enum rc_driver_type driver_type;
175 u32 users;
176 u64 allowed_protocols;
177 u64 enabled_protocols;
178 u64 allowed_wakeup_protocols;
179 enum rc_proto wakeup_protocol;
180 struct rc_scancode_filter scancode_filter;
181 struct rc_scancode_filter scancode_wakeup_filter;
182 u32 scancode_mask;
183 void *priv;
184 spinlock_t keylock;
185 bool keypressed;
186 u8 last_toggle;
187 u32 last_keycode;
188 enum rc_proto last_protocol;
189 u64 last_scancode;
190 unsigned long keyup_jiffies;
191 struct timer_list timer_keyup;
192 struct timer_list timer_repeat;
193 u32 timeout;
194 u32 min_timeout;
195 u32 max_timeout;
196 u32 rx_resolution;
197#ifdef CONFIG_LIRC
198 struct device lirc_dev;
199 struct cdev lirc_cdev;
200 ktime_t gap_start;
201 spinlock_t lirc_fh_lock;
202 struct list_head lirc_fh;
203#endif
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 */
238struct 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 */
247struct 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 */
254void 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 */
261int 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 */
269int 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 */
276void rc_unregister_device(struct rc_dev *dev);
277
278void rc_repeat(struct rc_dev *dev);
279void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u64 scancode,
280 u8 toggle);
281void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol,
282 u64 scancode, u8 toggle);
283void rc_keyup(struct rc_dev *dev);
284u32 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 */
291struct 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
310void ir_raw_event_handle(struct rc_dev *dev);
311int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
312int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse);
313int ir_raw_event_store_with_filter(struct rc_dev *dev,
314 struct ir_raw_event *ev);
315int ir_raw_event_store_with_timeout(struct rc_dev *dev,
316 struct ir_raw_event *ev);
317void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
318int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode,
319 struct ir_raw_event *events, unsigned int max);
320int ir_raw_encode_carrier(enum rc_proto protocol);
321
322static inline void ir_raw_event_overflow(struct rc_dev *dev)
323{
324 ir_raw_event_store(dev, ev: &((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 */
330static 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 */
347static 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 */
378