xref: /linux/drivers/media/rc/rc-core-priv.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
1 /*
2  * Remote Controller core raw events header
3  *
4  * Copyright (C) 2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
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 mce_kbd_dec {
92 		struct input_dev *idev;
93 		struct timer_list rx_timeout;
94 		char name[64];
95 		char phys[64];
96 		int state;
97 		u8 header;
98 		u32 body;
99 		unsigned count;
100 		unsigned wanted_bits;
101 	} mce_kbd;
102 	struct lirc_codec {
103 		struct rc_dev *dev;
104 		struct lirc_driver *drv;
105 		int carrier_low;
106 
107 		ktime_t gap_start;
108 		u64 gap_duration;
109 		bool gap;
110 		bool send_timeout_reports;
111 
112 	} lirc;
113 };
114 
115 /* macros for IR decoders */
116 static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
117 {
118 	return d1 > (d2 - margin);
119 }
120 
121 static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
122 {
123 	return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
124 }
125 
126 static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
127 {
128 	return x->pulse != y->pulse;
129 }
130 
131 static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
132 {
133 	if (duration > ev->duration)
134 		ev->duration = 0;
135 	else
136 		ev->duration -= duration;
137 }
138 
139 /* Returns true if event is normal pulse/space event */
140 static inline bool is_timing_event(struct ir_raw_event ev)
141 {
142 	return !ev.carrier_report && !ev.reset;
143 }
144 
145 #define TO_US(duration)			DIV_ROUND_CLOSEST((duration), 1000)
146 #define TO_STR(is_pulse)		((is_pulse) ? "pulse" : "space")
147 
148 /*
149  * Routines from rc-raw.c to be used internally and by decoders
150  */
151 u64 ir_raw_get_allowed_protocols(void);
152 int ir_raw_event_register(struct rc_dev *dev);
153 void ir_raw_event_unregister(struct rc_dev *dev);
154 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
155 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
156 void ir_raw_init(void);
157 
158 /*
159  * Decoder initialization code
160  *
161  * Those load logic are called during ir-core init, and automatically
162  * loads the compiled decoders for their usage with IR raw events
163  */
164 
165 /* from ir-nec-decoder.c */
166 #ifdef CONFIG_IR_NEC_DECODER_MODULE
167 #define load_nec_decode()	request_module_nowait("ir-nec-decoder")
168 #else
169 static inline void load_nec_decode(void) { }
170 #endif
171 
172 /* from ir-rc5-decoder.c */
173 #ifdef CONFIG_IR_RC5_DECODER_MODULE
174 #define load_rc5_decode()	request_module_nowait("ir-rc5-decoder")
175 #else
176 static inline void load_rc5_decode(void) { }
177 #endif
178 
179 /* from ir-rc6-decoder.c */
180 #ifdef CONFIG_IR_RC6_DECODER_MODULE
181 #define load_rc6_decode()	request_module_nowait("ir-rc6-decoder")
182 #else
183 static inline void load_rc6_decode(void) { }
184 #endif
185 
186 /* from ir-jvc-decoder.c */
187 #ifdef CONFIG_IR_JVC_DECODER_MODULE
188 #define load_jvc_decode()	request_module_nowait("ir-jvc-decoder")
189 #else
190 static inline void load_jvc_decode(void) { }
191 #endif
192 
193 /* from ir-sony-decoder.c */
194 #ifdef CONFIG_IR_SONY_DECODER_MODULE
195 #define load_sony_decode()	request_module_nowait("ir-sony-decoder")
196 #else
197 static inline void load_sony_decode(void) { }
198 #endif
199 
200 /* from ir-sanyo-decoder.c */
201 #ifdef CONFIG_IR_SANYO_DECODER_MODULE
202 #define load_sanyo_decode()	request_module_nowait("ir-sanyo-decoder")
203 #else
204 static inline void load_sanyo_decode(void) { }
205 #endif
206 
207 /* from ir-mce_kbd-decoder.c */
208 #ifdef CONFIG_IR_MCE_KBD_DECODER_MODULE
209 #define load_mce_kbd_decode()	request_module_nowait("ir-mce_kbd-decoder")
210 #else
211 static inline void load_mce_kbd_decode(void) { }
212 #endif
213 
214 /* from ir-lirc-codec.c */
215 #ifdef CONFIG_IR_LIRC_CODEC_MODULE
216 #define load_lirc_codec()	request_module_nowait("ir-lirc-codec")
217 #else
218 static inline void load_lirc_codec(void) { }
219 #endif
220 
221 
222 #endif /* _RC_CORE_PRIV */
223