projects/linux·blob master · refs

375 lines · 12.0 KiB

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 * @registered: set to true by rc_register_device(), false by
85 * rc_unregister_device
86 * @idle: used to keep track of RX state
87 * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
88 * wakeup protocols is the set of all raw encoders
89 * @minor: unique minor remote control device number
90 * @sysfs_groups: sysfs attribute groups
91 * @device_name: name of the rc child device
92 * @input_phys: physical path to the input child device
93 * @input_id: id of the input child device (struct input_id)
94 * @driver_name: name of the hardware driver which registered this device
95 * @map_name: name of the default keymap
96 * @rc_map: current scan/key table
97 * @lock: used to ensure we've filled in all protocol details before
98 * anyone can call show_protocols or store_protocols
99 * @raw: additional data for raw pulse/space devices
100 * @input_dev: the input child device used to communicate events to userspace
101 * @driver_type: specifies if protocol decoding is done in hardware or software
102 * @users: number of current users of the device
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.
109 * @scancode_filter: scancode filter
110 * @scancode_wakeup_filter: scancode wakeup filters
111 * @scancode_mask: some hardware decoders are not capable of providing the full
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
116 * @priv: driver-specific data
117 * @keylock: protects the remaining members of the struct
118 * @keypressed: whether a key is currently pressed
119 * @last_toggle: toggle value of last command
120 * @last_keycode: keycode of last keypress
121 * @last_protocol: protocol of last keypress
122 * @last_scancode: scancode of last keypress
123 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
124 * @timer_keyup: timer for releasing a keypress
125 * @timer_repeat: timer for autorepeat events. This is needed for CEC, which
126 * has non-standard repeats.
127 * @timeout: optional time after which device stops sending data
128 * @min_timeout: minimum timeout supported by device
129 * @max_timeout: maximum timeout supported by device
130 * @rx_resolution : resolution (in us) of input sampler
131 * @lirc_dev: lirc device
132 * @lirc_cdev: lirc char cdev
133 * @gap_start: start time for gap after timeout if non-zero
134 * @lirc_fh_lock: protects lirc_fh list
135 * @lirc_fh: list of open files
136 * @change_protocol: allow changing the protocol used on hardware decoders
137 * @open: callback to allow drivers to enable polling/irq when IR input device
138 * is opened.
139 * @close: callback to allow drivers to disable polling/irq when IR input device
140 * is opened.
141 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
142 * @s_tx_carrier: set transmit carrier frequency
143 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
144 * @s_rx_carrier_range: inform driver about carrier it is expected to handle
145 * @tx_ir: transmit IR
146 * @s_idle: enable/disable hardware idle mode, upon which,
147 * device doesn't interrupt host until it sees IR pulses
148 * @s_wideband_receiver: enable wide band receiver used for learning
149 * @s_carrier_report: enable carrier reports
150 * @s_filter: set the scancode filter
151 * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
152 * then wakeup should be disabled. wakeup_protocol will be set to
153 * a valid protocol if mask is nonzero.
154 * @s_timeout: set hardware timeout in us
155 */
156struct rc_dev {
157 struct device dev;
158 bool registered;
159 bool idle;
160 bool encode_wakeup;
161 unsigned int minor;
162 const struct attribute_group *sysfs_groups[5];
163 const char *device_name;
164 const char *input_phys;
165 struct input_id input_id;
166 const char *driver_name;
167 const char *map_name;
168 struct rc_map rc_map;
169 struct mutex lock;
170 struct ir_raw_event_ctrl *raw;
171 struct input_dev *input_dev;
172 enum rc_driver_type driver_type;
173 u32 users;
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 void *priv;
182 spinlock_t keylock;
183 bool keypressed;
184 u8 last_toggle;
185 u32 last_keycode;
186 enum rc_proto last_protocol;
187 u64 last_scancode;
188 unsigned long keyup_jiffies;
189 struct timer_list timer_keyup;
190 struct timer_list timer_repeat;
191 u32 timeout;
192 u32 min_timeout;
193 u32 max_timeout;
194 u32 rx_resolution;
195#ifdef CONFIG_LIRC
196 struct device lirc_dev;
197 struct cdev lirc_cdev;
198 ktime_t gap_start;
199 spinlock_t lirc_fh_lock;
200 struct list_head lirc_fh;
201#endif
202 int (*change_protocol)(struct rc_dev *dev, u64 *rc_proto);
203 int (*open)(struct rc_dev *dev);
204 void (*close)(struct rc_dev *dev);
205 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
206 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
207 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
208 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
209 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
210 void (*s_idle)(struct rc_dev *dev, bool enable);
211 int (*s_wideband_receiver)(struct rc_dev *dev, int enable);
212 int (*s_carrier_report) (struct rc_dev *dev, int enable);
213 int (*s_filter)(struct rc_dev *dev,
214 struct rc_scancode_filter *filter);
215 int (*s_wakeup_filter)(struct rc_dev *dev,
216 struct rc_scancode_filter *filter);
217 int (*s_timeout)(struct rc_dev *dev,
218 unsigned int timeout);
219};
220
221#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
222
223/*
224 * From rc-main.c
225 * Those functions can be used on any type of Remote Controller. They
226 * basically creates an input_dev and properly reports the device as a
227 * Remote Controller, at sys/class/rc.
228 */
229
230/**
231 * rc_allocate_device - Allocates a RC device
232 *
233 * @rc_driver_type: specifies the type of the RC output to be allocated
234 * returns a pointer to struct rc_dev.
235 */
236struct rc_dev *rc_allocate_device(enum rc_driver_type);
237
238/**
239 * devm_rc_allocate_device - Managed RC device allocation
240 *
241 * @dev: pointer to struct device
242 * @rc_driver_type: specifies the type of the RC output to be allocated
243 * returns a pointer to struct rc_dev.
244 */
245struct rc_dev *devm_rc_allocate_device(struct device *dev, enum rc_driver_type);
246
247/**
248 * rc_free_device - Frees a RC device
249 *
250 * @dev: pointer to struct rc_dev.
251 */
252void rc_free_device(struct rc_dev *dev);
253
254/**
255 * rc_register_device - Registers a RC device
256 *
257 * @dev: pointer to struct rc_dev.
258 */
259int rc_register_device(struct rc_dev *dev);
260
261/**
262 * devm_rc_register_device - Manageded registering of a RC device
263 *
264 * @parent: pointer to struct device.
265 * @dev: pointer to struct rc_dev.
266 */
267int devm_rc_register_device(struct device *parent, struct rc_dev *dev);
268
269/**
270 * rc_unregister_device - Unregisters a RC device
271 *
272 * @dev: pointer to struct rc_dev.
273 */
274void rc_unregister_device(struct rc_dev *dev);
275
276void rc_repeat(struct rc_dev *dev);
277void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u64 scancode,
278 u8 toggle);
279void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol,
280 u64 scancode, u8 toggle);
281void rc_keyup(struct rc_dev *dev);
282u32 rc_g_keycode_from_table(struct rc_dev *dev, u64 scancode);
283
284/*
285 * From rc-raw.c
286 * The Raw interface is specific to InfraRed. It may be a good idea to
287 * split it later into a separate header.
288 */
289struct ir_raw_event {
290 union {
291 u32 duration;
292 u32 carrier;
293 };
294 u8 duty_cycle;
295
296 unsigned pulse:1;
297 unsigned overflow:1;
298 unsigned timeout:1;
299 unsigned carrier_report:1;
300};
301
302#define US_TO_NS(usec) ((usec) * 1000)
303#define MS_TO_US(msec) ((msec) * 1000)
304#define IR_MAX_DURATION MS_TO_US(1000)
305#define IR_DEFAULT_TIMEOUT MS_TO_US(125)
306#define IR_MAX_TIMEOUT LIRC_VALUE_MASK
307
308void ir_raw_event_handle(struct rc_dev *dev);
309int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
310int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse);
311int ir_raw_event_store_with_filter(struct rc_dev *dev,
312 struct ir_raw_event *ev);
313int ir_raw_event_store_with_timeout(struct rc_dev *dev,
314 struct ir_raw_event *ev);
315void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
316int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode,
317 struct ir_raw_event *events, unsigned int max);
318int ir_raw_encode_carrier(enum rc_proto protocol);
319
320static inline void ir_raw_event_overflow(struct rc_dev *dev)
321{
322 ir_raw_event_store(dev, &((struct ir_raw_event) { .overflow = true }));
323 dev->idle = true;
324 ir_raw_event_handle(dev);
325}
326
327/* extract mask bits out of data and pack them into the result */
328static inline u32 ir_extract_bits(u32 data, u32 mask)
329{
330 u32 vbit = 1, value = 0;
331
332 do {
333 if (mask & 1) {
334 if (data & 1)
335 value |= vbit;
336 vbit <<= 1;
337 }
338 data >>= 1;
339 } while (mask >>= 1);
340
341 return value;
342}
343
344/* Get NEC scancode and protocol type from address and command bytes */
345static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address,
346 u8 command, u8 not_command,
347 enum rc_proto *protocol)
348{
349 u32 scancode;
350
351 if ((command ^ not_command) != 0xff) {
352 /* NEC transport, but modified protocol, used by at
353 * least Apple and TiVo remotes
354 */
355 scancode = not_address << 24 |
356 address << 16 |
357 not_command << 8 |
358 command;
359 *protocol = RC_PROTO_NEC32;
360 } else if ((address ^ not_address) != 0xff) {
361 /* Extended NEC */
362 scancode = address << 16 |
363 not_address << 8 |
364 command;
365 *protocol = RC_PROTO_NECX;
366 } else {
367 /* Normal NEC */
368 scancode = address << 8 | command;
369 *protocol = RC_PROTO_NEC;
370 }
371
372 return scancode;
373}
374
375#endif /* _RC_CORE */