2 * SPDX-License-Identifier: GPL-2.0
3 * Remote Controller core raw events header
5 * Copyright (C) 2010 by Mauro Carvalho Chehab
11 #define RC_DEV_MAX 256
12 /* Define the max number of pulse/space transitions to buffer */
13 #define MAX_IR_EVENT_SIZE 512
15 #include <linux/slab.h>
16 #include <uapi/linux/bpf.h>
17 #include <media/rc-core.h>
20 * rc_open - Opens a RC device
22 * @rdev: pointer to struct rc_dev.
24 int rc_open(struct rc_dev *rdev);
27 * rc_close - Closes a RC device
29 * @rdev: pointer to struct rc_dev.
31 void rc_close(struct rc_dev *rdev);
33 struct ir_raw_handler {
34 struct list_head list;
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);
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);
48 struct 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;
59 /* raw decoder state follows */
60 struct ir_raw_event prev_ev;
61 struct ir_raw_event this_ev;
63 #ifdef CONFIG_BPF_LIRC_MODE2
65 struct bpf_prog_array __rcu *progs;
110 unsigned int pulse_len;
113 /* locks key up timer */
115 struct timer_list rx_timeout;
120 unsigned wanted_bits;
136 /* Mutex for locking raw IR processing and handler change */
137 extern struct mutex ir_raw_handler_lock;
139 /* macros for IR decoders */
140 static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
142 return d1 > (d2 - margin);
145 static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
147 return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
150 static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
152 return x->pulse != y->pulse;
155 static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
157 if (duration > ev->duration)
160 ev->duration -= duration;
163 /* Returns true if event is normal pulse/space event */
164 static inline bool is_timing_event(struct ir_raw_event ev)
166 return !ev.carrier_report && !ev.reset;
169 #define TO_US(duration) DIV_ROUND_CLOSEST((duration), 1000)
170 #define TO_STR(is_pulse) ((is_pulse) ? "pulse" : "space")
172 /* functions for IR encoders */
173 bool rc_validate_scancode(enum rc_proto proto, u32 scancode);
175 static inline void init_ir_raw_event_duration(struct ir_raw_event *ev,
179 *ev = (struct ir_raw_event) {
180 .duration = duration,
186 * struct ir_raw_timings_manchester - Manchester coding timings
187 * @leader_pulse: duration of leader pulse (if any) 0 if continuing
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
195 struct ir_raw_timings_manchester {
196 unsigned int leader_pulse;
197 unsigned int leader_space;
199 unsigned int invert:1;
200 unsigned int trailer_space;
203 int 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);
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.
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.
220 static inline int ir_raw_gen_pulse_space(struct ir_raw_event **ev,
222 unsigned int pulse_width,
223 unsigned int space_width)
227 init_ir_raw_event_duration((*ev)++, 1, pulse_width);
230 init_ir_raw_event_duration((*ev)++, 0, space_width);
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
245 struct 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;
255 int 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);
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
267 struct 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;
275 int 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);
280 * Routines from rc-raw.c to be used internally and by decoders
282 u64 ir_raw_get_allowed_protocols(void);
283 int ir_raw_event_prepare(struct rc_dev *dev);
284 int ir_raw_event_register(struct rc_dev *dev);
285 void ir_raw_event_free(struct rc_dev *dev);
286 void ir_raw_event_unregister(struct rc_dev *dev);
287 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
288 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
289 void ir_raw_load_modules(u64 *protocols);
290 void ir_raw_init(void);
296 int lirc_dev_init(void);
297 void lirc_dev_exit(void);
298 void ir_lirc_raw_event(struct rc_dev *dev, struct ir_raw_event ev);
299 void ir_lirc_scancode_event(struct rc_dev *dev, struct lirc_scancode *lsc);
300 int ir_lirc_register(struct rc_dev *dev);
301 void ir_lirc_unregister(struct rc_dev *dev);
302 struct rc_dev *rc_dev_get_from_fd(int fd);
304 static inline int lirc_dev_init(void) { return 0; }
305 static inline void lirc_dev_exit(void) {}
306 static inline void ir_lirc_raw_event(struct rc_dev *dev,
307 struct ir_raw_event ev) { }
308 static inline void ir_lirc_scancode_event(struct rc_dev *dev,
309 struct lirc_scancode *lsc) { }
310 static inline int ir_lirc_register(struct rc_dev *dev) { return 0; }
311 static inline void ir_lirc_unregister(struct rc_dev *dev) { }
317 #ifdef CONFIG_BPF_LIRC_MODE2
318 void lirc_bpf_free(struct rc_dev *dev);
319 void lirc_bpf_run(struct rc_dev *dev, u32 sample);
321 static inline void lirc_bpf_free(struct rc_dev *dev) { }
322 static inline void lirc_bpf_run(struct rc_dev *dev, u32 sample) { }
325 #endif /* _RC_CORE_PRIV */