xref: /openbmc/linux/drivers/media/rc/rc-core-priv.h (revision afb46f79)
1 /*
2  * Remote Controller core raw events header
3  *
4  * Copyright (C) 2010 by Mauro Carvalho Chehab
5  *
6  * This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation version 2 of the License.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  */
15 
16 #ifndef _RC_CORE_PRIV
17 #define _RC_CORE_PRIV
18 
19 #include <linux/slab.h>
20 #include <linux/spinlock.h>
21 #include <media/rc-core.h>
22 
23 struct ir_raw_handler {
24 	struct list_head list;
25 
26 	u64 protocols; /* which are handled by this handler */
27 	int (*decode)(struct rc_dev *dev, struct ir_raw_event event);
28 
29 	/* These two should only be used by the lirc decoder */
30 	int (*raw_register)(struct rc_dev *dev);
31 	int (*raw_unregister)(struct rc_dev *dev);
32 };
33 
34 struct ir_raw_event_ctrl {
35 	struct list_head		list;		/* to keep track of raw clients */
36 	struct task_struct		*thread;
37 	spinlock_t			lock;
38 	struct kfifo_rec_ptr_1		kfifo;		/* fifo for the pulse/space durations */
39 	ktime_t				last_event;	/* when last event occurred */
40 	enum raw_event_type		last_type;	/* last event type */
41 	struct rc_dev			*dev;		/* pointer to the parent rc_dev */
42 
43 	/* raw decoder state follows */
44 	struct ir_raw_event prev_ev;
45 	struct ir_raw_event this_ev;
46 	struct nec_dec {
47 		int state;
48 		unsigned count;
49 		u32 bits;
50 		bool is_nec_x;
51 		bool necx_repeat;
52 	} nec;
53 	struct rc5_dec {
54 		int state;
55 		u32 bits;
56 		unsigned count;
57 		unsigned wanted_bits;
58 	} rc5;
59 	struct rc6_dec {
60 		int state;
61 		u8 header;
62 		u32 body;
63 		bool toggle;
64 		unsigned count;
65 		unsigned wanted_bits;
66 	} rc6;
67 	struct sony_dec {
68 		int state;
69 		u32 bits;
70 		unsigned count;
71 	} sony;
72 	struct jvc_dec {
73 		int state;
74 		u16 bits;
75 		u16 old_bits;
76 		unsigned count;
77 		bool first;
78 		bool toggle;
79 	} jvc;
80 	struct rc5_sz_dec {
81 		int state;
82 		u32 bits;
83 		unsigned count;
84 		unsigned wanted_bits;
85 	} rc5_sz;
86 	struct sanyo_dec {
87 		int state;
88 		unsigned count;
89 		u64 bits;
90 	} sanyo;
91 	struct sharp_dec {
92 		int state;
93 		unsigned count;
94 		u32 bits;
95 		unsigned int pulse_len;
96 	} sharp;
97 	struct mce_kbd_dec {
98 		struct input_dev *idev;
99 		struct timer_list rx_timeout;
100 		char name[64];
101 		char phys[64];
102 		int state;
103 		u8 header;
104 		u32 body;
105 		unsigned count;
106 		unsigned wanted_bits;
107 	} mce_kbd;
108 	struct lirc_codec {
109 		struct rc_dev *dev;
110 		struct lirc_driver *drv;
111 		int carrier_low;
112 
113 		ktime_t gap_start;
114 		u64 gap_duration;
115 		bool gap;
116 		bool send_timeout_reports;
117 
118 	} lirc;
119 };
120 
121 /* macros for IR decoders */
122 static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
123 {
124 	return d1 > (d2 - margin);
125 }
126 
127 static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
128 {
129 	return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
130 }
131 
132 static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
133 {
134 	return x->pulse != y->pulse;
135 }
136 
137 static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
138 {
139 	if (duration > ev->duration)
140 		ev->duration = 0;
141 	else
142 		ev->duration -= duration;
143 }
144 
145 /* Returns true if event is normal pulse/space event */
146 static inline bool is_timing_event(struct ir_raw_event ev)
147 {
148 	return !ev.carrier_report && !ev.reset;
149 }
150 
151 #define TO_US(duration)			DIV_ROUND_CLOSEST((duration), 1000)
152 #define TO_STR(is_pulse)		((is_pulse) ? "pulse" : "space")
153 
154 /*
155  * Routines from rc-raw.c to be used internally and by decoders
156  */
157 u64 ir_raw_get_allowed_protocols(void);
158 int ir_raw_event_register(struct rc_dev *dev);
159 void ir_raw_event_unregister(struct rc_dev *dev);
160 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
161 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
162 void ir_raw_init(void);
163 
164 /*
165  * Decoder initialization code
166  *
167  * Those load logic are called during ir-core init, and automatically
168  * loads the compiled decoders for their usage with IR raw events
169  */
170 
171 /* from ir-nec-decoder.c */
172 #ifdef CONFIG_IR_NEC_DECODER_MODULE
173 #define load_nec_decode()	request_module_nowait("ir-nec-decoder")
174 #else
175 static inline void load_nec_decode(void) { }
176 #endif
177 
178 /* from ir-rc5-decoder.c */
179 #ifdef CONFIG_IR_RC5_DECODER_MODULE
180 #define load_rc5_decode()	request_module_nowait("ir-rc5-decoder")
181 #else
182 static inline void load_rc5_decode(void) { }
183 #endif
184 
185 /* from ir-rc6-decoder.c */
186 #ifdef CONFIG_IR_RC6_DECODER_MODULE
187 #define load_rc6_decode()	request_module_nowait("ir-rc6-decoder")
188 #else
189 static inline void load_rc6_decode(void) { }
190 #endif
191 
192 /* from ir-jvc-decoder.c */
193 #ifdef CONFIG_IR_JVC_DECODER_MODULE
194 #define load_jvc_decode()	request_module_nowait("ir-jvc-decoder")
195 #else
196 static inline void load_jvc_decode(void) { }
197 #endif
198 
199 /* from ir-sony-decoder.c */
200 #ifdef CONFIG_IR_SONY_DECODER_MODULE
201 #define load_sony_decode()	request_module_nowait("ir-sony-decoder")
202 #else
203 static inline void load_sony_decode(void) { }
204 #endif
205 
206 /* from ir-sanyo-decoder.c */
207 #ifdef CONFIG_IR_SANYO_DECODER_MODULE
208 #define load_sanyo_decode()	request_module_nowait("ir-sanyo-decoder")
209 #else
210 static inline void load_sanyo_decode(void) { }
211 #endif
212 
213 /* from ir-sharp-decoder.c */
214 #ifdef CONFIG_IR_SHARP_DECODER_MODULE
215 #define load_sharp_decode()	request_module_nowait("ir-sharp-decoder")
216 #else
217 static inline void load_sharp_decode(void) { }
218 #endif
219 
220 /* from ir-mce_kbd-decoder.c */
221 #ifdef CONFIG_IR_MCE_KBD_DECODER_MODULE
222 #define load_mce_kbd_decode()	request_module_nowait("ir-mce_kbd-decoder")
223 #else
224 static inline void load_mce_kbd_decode(void) { }
225 #endif
226 
227 /* from ir-lirc-codec.c */
228 #ifdef CONFIG_IR_LIRC_CODEC_MODULE
229 #define load_lirc_codec()	request_module_nowait("ir-lirc-codec")
230 #else
231 static inline void load_lirc_codec(void) { }
232 #endif
233 
234 
235 #endif /* _RC_CORE_PRIV */
236