tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * SPDX-License-Identifier: GPL-2.0
3 * Remote Controller core raw events header
4 *
5 * Copyright (C) 2010 by Mauro Carvalho Chehab
6 */
7
8#ifndef _RC_CORE_PRIV
9#define _RC_CORE_PRIV
10
11#define RC_DEV_MAX 256
12/* Define the max number of pulse/space transitions to buffer */
13#define MAX_IR_EVENT_SIZE 512
14
15#include <linux/slab.h>
16#include <uapi/linux/bpf.h>
17#include <media/rc-core.h>
18
19/**
20 * rc_open - Opens a RC device
21 *
22 * @rdev: pointer to struct rc_dev.
23 */
24int rc_open(struct rc_dev *rdev);
25
26/**
27 * rc_close - Closes a RC device
28 *
29 * @rdev: pointer to struct rc_dev.
30 */
31void rc_close(struct rc_dev *rdev);
32
33struct ir_raw_handler {
34 struct list_head list;
35
36 u64 protocols; /* which are handled by this handler */
37 int (*decode)(struct rc_dev *dev, struct ir_raw_event event);
38 int (*encode)(enum rc_proto protocol, u32 scancode,
39 struct ir_raw_event *events, unsigned int max);
40 u32 carrier;
41 u32 min_timeout;
42
43 /* These two should only be used by the mce kbd decoder */
44 int (*raw_register)(struct rc_dev *dev);
45 int (*raw_unregister)(struct rc_dev *dev);
46};
47
48struct ir_raw_event_ctrl {
49 struct list_head list; /* to keep track of raw clients */
50 struct task_struct *thread;
51 /* fifo for the pulse/space durations */
52 DECLARE_KFIFO(kfifo, struct ir_raw_event, MAX_IR_EVENT_SIZE);
53 ktime_t last_event; /* when last event occurred */
54 struct rc_dev *dev; /* pointer to the parent rc_dev */
55 /* handle delayed ir_raw_event_store_edge processing */
56 spinlock_t edge_spinlock;
57 struct timer_list edge_handle;
58
59 /* raw decoder state follows */
60 struct ir_raw_event prev_ev;
61 struct ir_raw_event this_ev;
62
63#ifdef CONFIG_BPF_LIRC_MODE2
64 u32 bpf_sample;
65 struct bpf_prog_array __rcu *progs;
66#endif
67 struct nec_dec {
68 int state;
69 unsigned count;
70 u32 bits;
71 bool is_nec_x;
72 bool necx_repeat;
73 } nec;
74 struct rc5_dec {
75 int state;
76 u32 bits;
77 unsigned count;
78 bool is_rc5x;
79 } rc5;
80 struct rc6_dec {
81 int state;
82 u8 header;
83 u32 body;
84 bool toggle;
85 unsigned count;
86 unsigned wanted_bits;
87 } rc6;
88 struct sony_dec {
89 int state;
90 u32 bits;
91 unsigned count;
92 } sony;
93 struct jvc_dec {
94 int state;
95 u16 bits;
96 u16 old_bits;
97 unsigned count;
98 bool first;
99 bool toggle;
100 } jvc;
101 struct sanyo_dec {
102 int state;
103 unsigned count;
104 u64 bits;
105 } sanyo;
106 struct sharp_dec {
107 int state;
108 unsigned count;
109 u32 bits;
110 unsigned int pulse_len;
111 } sharp;
112 struct mce_kbd_dec {
113 /* locks key up timer */
114 spinlock_t keylock;
115 struct timer_list rx_timeout;
116 int state;
117 u8 header;
118 u32 body;
119 unsigned count;
120 unsigned wanted_bits;
121 } mce_kbd;
122 struct xmp_dec {
123 int state;
124 unsigned count;
125 u32 durations[16];
126 } xmp;
127 struct imon_dec {
128 int state;
129 int count;
130 int last_chk;
131 unsigned int bits;
132 bool stick_keyboard;
133 } imon;
134};
135
136/* Mutex for locking raw IR processing and handler change */
137extern struct mutex ir_raw_handler_lock;
138
139/* macros for IR decoders */
140static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
141{
142 return d1 > (d2 - margin);
143}
144
145static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
146{
147 return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
148}
149
150static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
151{
152 return x->pulse != y->pulse;
153}
154
155static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
156{
157 if (duration > ev->duration)
158 ev->duration = 0;
159 else
160 ev->duration -= duration;
161}
162
163/* Returns true if event is normal pulse/space event */
164static inline bool is_timing_event(struct ir_raw_event ev)
165{
166 return !ev.carrier_report && !ev.reset;
167}
168
169#define TO_US(duration) DIV_ROUND_CLOSEST((duration), 1000)
170#define TO_STR(is_pulse) ((is_pulse) ? "pulse" : "space")
171
172/* functions for IR encoders */
173bool rc_validate_scancode(enum rc_proto proto, u32 scancode);
174
175static inline void init_ir_raw_event_duration(struct ir_raw_event *ev,
176 unsigned int pulse,
177 u32 duration)
178{
179 *ev = (struct ir_raw_event) {
180 .duration = duration,
181 .pulse = pulse
182 };
183}
184
185/**
186 * struct ir_raw_timings_manchester - Manchester coding timings
187 * @leader_pulse: duration of leader pulse (if any) 0 if continuing
188 * existing signal
189 * @leader_space: duration of leader space (if any)
190 * @clock: duration of each pulse/space in ns
191 * @invert: if set clock logic is inverted
192 * (0 = space + pulse, 1 = pulse + space)
193 * @trailer_space: duration of trailer space in ns
194 */
195struct ir_raw_timings_manchester {
196 unsigned int leader_pulse;
197 unsigned int leader_space;
198 unsigned int clock;
199 unsigned int invert:1;
200 unsigned int trailer_space;
201};
202
203int ir_raw_gen_manchester(struct ir_raw_event **ev, unsigned int max,
204 const struct ir_raw_timings_manchester *timings,
205 unsigned int n, u64 data);
206
207/**
208 * ir_raw_gen_pulse_space() - generate pulse and space raw events.
209 * @ev: Pointer to pointer to next free raw event.
210 * Will be incremented for each raw event written.
211 * @max: Pointer to number of raw events available in buffer.
212 * Will be decremented for each raw event written.
213 * @pulse_width: Width of pulse in ns.
214 * @space_width: Width of space in ns.
215 *
216 * Returns: 0 on success.
217 * -ENOBUFS if there isn't enough buffer space to write both raw
218 * events. In this case @max events will have been written.
219 */
220static inline int ir_raw_gen_pulse_space(struct ir_raw_event **ev,
221 unsigned int *max,
222 unsigned int pulse_width,
223 unsigned int space_width)
224{
225 if (!*max)
226 return -ENOBUFS;
227 init_ir_raw_event_duration((*ev)++, 1, pulse_width);
228 if (!--*max)
229 return -ENOBUFS;
230 init_ir_raw_event_duration((*ev)++, 0, space_width);
231 --*max;
232 return 0;
233}
234
235/**
236 * struct ir_raw_timings_pd - pulse-distance modulation timings
237 * @header_pulse: duration of header pulse in ns (0 for none)
238 * @header_space: duration of header space in ns
239 * @bit_pulse: duration of bit pulse in ns
240 * @bit_space: duration of bit space (for logic 0 and 1) in ns
241 * @trailer_pulse: duration of trailer pulse in ns
242 * @trailer_space: duration of trailer space in ns
243 * @msb_first: 1 if most significant bit is sent first
244 */
245struct ir_raw_timings_pd {
246 unsigned int header_pulse;
247 unsigned int header_space;
248 unsigned int bit_pulse;
249 unsigned int bit_space[2];
250 unsigned int trailer_pulse;
251 unsigned int trailer_space;
252 unsigned int msb_first:1;
253};
254
255int ir_raw_gen_pd(struct ir_raw_event **ev, unsigned int max,
256 const struct ir_raw_timings_pd *timings,
257 unsigned int n, u64 data);
258
259/**
260 * struct ir_raw_timings_pl - pulse-length modulation timings
261 * @header_pulse: duration of header pulse in ns (0 for none)
262 * @bit_space: duration of bit space in ns
263 * @bit_pulse: duration of bit pulse (for logic 0 and 1) in ns
264 * @trailer_space: duration of trailer space in ns
265 * @msb_first: 1 if most significant bit is sent first
266 */
267struct ir_raw_timings_pl {
268 unsigned int header_pulse;
269 unsigned int bit_space;
270 unsigned int bit_pulse[2];
271 unsigned int trailer_space;
272 unsigned int msb_first:1;
273};
274
275int ir_raw_gen_pl(struct ir_raw_event **ev, unsigned int max,
276 const struct ir_raw_timings_pl *timings,
277 unsigned int n, u64 data);
278
279/*
280 * Routines from rc-raw.c to be used internally and by decoders
281 */
282u64 ir_raw_get_allowed_protocols(void);
283int ir_raw_event_prepare(struct rc_dev *dev);
284int ir_raw_event_register(struct rc_dev *dev);
285void ir_raw_event_free(struct rc_dev *dev);
286void ir_raw_event_unregister(struct rc_dev *dev);
287int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
288void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
289void ir_raw_load_modules(u64 *protocols);
290void ir_raw_init(void);
291
292/*
293 * lirc interface
294 */
295#ifdef CONFIG_LIRC
296int lirc_dev_init(void);
297void lirc_dev_exit(void);
298void ir_lirc_raw_event(struct rc_dev *dev, struct ir_raw_event ev);
299void ir_lirc_scancode_event(struct rc_dev *dev, struct lirc_scancode *lsc);
300int ir_lirc_register(struct rc_dev *dev);
301void ir_lirc_unregister(struct rc_dev *dev);
302struct rc_dev *rc_dev_get_from_fd(int fd);
303#else
304static inline int lirc_dev_init(void) { return 0; }
305static inline void lirc_dev_exit(void) {}
306static inline void ir_lirc_raw_event(struct rc_dev *dev,
307 struct ir_raw_event ev) { }
308static inline void ir_lirc_scancode_event(struct rc_dev *dev,
309 struct lirc_scancode *lsc) { }
310static inline int ir_lirc_register(struct rc_dev *dev) { return 0; }
311static inline void ir_lirc_unregister(struct rc_dev *dev) { }
312#endif
313
314/*
315 * bpf interface
316 */
317#ifdef CONFIG_BPF_LIRC_MODE2
318void lirc_bpf_free(struct rc_dev *dev);
319void lirc_bpf_run(struct rc_dev *dev, u32 sample);
320#else
321static inline void lirc_bpf_free(struct rc_dev *dev) { }
322static inline void lirc_bpf_run(struct rc_dev *dev, u32 sample) { }
323#endif
324
325#endif /* _RC_CORE_PRIV */