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 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 u64 enabled_protocols; /* enabled raw protocol decoders */
43
44 /* raw decoder state follows */
45 struct ir_raw_event prev_ev;
46 struct ir_raw_event this_ev;
47 struct nec_dec {
48 int state;
49 unsigned count;
50 u32 bits;
51 bool is_nec_x;
52 bool necx_repeat;
53 } nec;
54 struct rc5_dec {
55 int state;
56 u32 bits;
57 unsigned count;
58 unsigned wanted_bits;
59 } rc5;
60 struct rc6_dec {
61 int state;
62 u8 header;
63 u32 body;
64 bool toggle;
65 unsigned count;
66 unsigned wanted_bits;
67 } rc6;
68 struct sony_dec {
69 int state;
70 u32 bits;
71 unsigned count;
72 } sony;
73 struct jvc_dec {
74 int state;
75 u16 bits;
76 u16 old_bits;
77 unsigned count;
78 bool first;
79 bool toggle;
80 } jvc;
81 struct rc5_sz_dec {
82 int state;
83 u32 bits;
84 unsigned count;
85 unsigned wanted_bits;
86 } rc5_sz;
87 struct lirc_codec {
88 struct rc_dev *dev;
89 struct lirc_driver *drv;
90 int carrier_low;
91
92 ktime_t gap_start;
93 u64 gap_duration;
94 bool gap;
95 bool send_timeout_reports;
96
97 } lirc;
98 };
99
100 /* macros for IR decoders */
geq_margin(unsigned d1,unsigned d2,unsigned margin)101 static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
102 {
103 return d1 > (d2 - margin);
104 }
105
eq_margin(unsigned d1,unsigned d2,unsigned margin)106 static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
107 {
108 return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
109 }
110
is_transition(struct ir_raw_event * x,struct ir_raw_event * y)111 static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
112 {
113 return x->pulse != y->pulse;
114 }
115
decrease_duration(struct ir_raw_event * ev,unsigned duration)116 static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
117 {
118 if (duration > ev->duration)
119 ev->duration = 0;
120 else
121 ev->duration -= duration;
122 }
123
124 /* Returns true if event is normal pulse/space event */
is_timing_event(struct ir_raw_event ev)125 static inline bool is_timing_event(struct ir_raw_event ev)
126 {
127 return !ev.carrier_report && !ev.reset;
128 }
129
130 #define TO_US(duration) DIV_ROUND_CLOSEST((duration), 1000)
131 #define TO_STR(is_pulse) ((is_pulse) ? "pulse" : "space")
132
133 /*
134 * Routines from rc-raw.c to be used internally and by decoders
135 */
136 u64 ir_raw_get_allowed_protocols(void);
137 int ir_raw_event_register(struct rc_dev *dev);
138 void ir_raw_event_unregister(struct rc_dev *dev);
139 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
140 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
141 void ir_raw_init(void);
142
143 /*
144 * Decoder initialization code
145 *
146 * Those load logic are called during ir-core init, and automatically
147 * loads the compiled decoders for their usage with IR raw events
148 */
149
150 /* from ir-nec-decoder.c */
151 #ifdef CONFIG_IR_NEC_DECODER_MODULE
152 #define load_nec_decode() request_module("ir-nec-decoder")
153 #else
154 #define load_nec_decode() 0
155 #endif
156
157 /* from ir-rc5-decoder.c */
158 #ifdef CONFIG_IR_RC5_DECODER_MODULE
159 #define load_rc5_decode() request_module("ir-rc5-decoder")
160 #else
161 #define load_rc5_decode() 0
162 #endif
163
164 /* from ir-rc6-decoder.c */
165 #ifdef CONFIG_IR_RC6_DECODER_MODULE
166 #define load_rc6_decode() request_module("ir-rc6-decoder")
167 #else
168 #define load_rc6_decode() 0
169 #endif
170
171 /* from ir-jvc-decoder.c */
172 #ifdef CONFIG_IR_JVC_DECODER_MODULE
173 #define load_jvc_decode() request_module("ir-jvc-decoder")
174 #else
175 #define load_jvc_decode() 0
176 #endif
177
178 /* from ir-sony-decoder.c */
179 #ifdef CONFIG_IR_SONY_DECODER_MODULE
180 #define load_sony_decode() request_module("ir-sony-decoder")
181 #else
182 #define load_sony_decode() 0
183 #endif
184
185 /* from ir-lirc-codec.c */
186 #ifdef CONFIG_IR_LIRC_CODEC_MODULE
187 #define load_lirc_codec() request_module("ir-lirc-codec")
188 #else
189 #define load_lirc_codec() 0
190 #endif
191
192
193 #endif /* _RC_CORE_PRIV */
194