Commit | Line | Data |
---|---|---|
829ba9fe | 1 | /* ir-raw.c - handle IR pulse/space events |
a3572c34 MCC |
2 | * |
3 | * Copyright (C) 2010 by Mauro Carvalho Chehab <mchehab@redhat.com> | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation version 2 of the License. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
13 | */ | |
14 | ||
35a24636 | 15 | #include <linux/export.h> |
0d2cb1de | 16 | #include <linux/kthread.h> |
45a568fa | 17 | #include <linux/mutex.h> |
dff65de2 | 18 | #include <linux/kmod.h> |
724e2495 | 19 | #include <linux/sched.h> |
0d2cb1de | 20 | #include <linux/freezer.h> |
f62de675 | 21 | #include "rc-core-priv.h" |
a3572c34 | 22 | |
724e2495 DH |
23 | /* Define the max number of pulse/space transitions to buffer */ |
24 | #define MAX_IR_EVENT_SIZE 512 | |
a3572c34 | 25 | |
c216369e DH |
26 | /* Used to keep track of IR raw clients, protected by ir_raw_handler_lock */ |
27 | static LIST_HEAD(ir_raw_client_list); | |
28 | ||
995187be | 29 | /* Used to handle IR raw handler extensions */ |
45a568fa | 30 | static DEFINE_MUTEX(ir_raw_handler_lock); |
667c9ebe DH |
31 | static LIST_HEAD(ir_raw_handler_list); |
32 | static u64 available_protocols; | |
93c312ff | 33 | |
5fa2989f | 34 | #ifdef MODULE |
995187be MCC |
35 | /* Used to load the decoders */ |
36 | static struct work_struct wq_load; | |
5fa2989f | 37 | #endif |
995187be | 38 | |
0d2cb1de | 39 | static int ir_raw_event_thread(void *data) |
724e2495 | 40 | { |
e40b1127 | 41 | struct ir_raw_event ev; |
c216369e | 42 | struct ir_raw_handler *handler; |
0d2cb1de | 43 | struct ir_raw_event_ctrl *raw = (struct ir_raw_event_ctrl *)data; |
c6ef1e7f | 44 | int retval; |
0d2cb1de ML |
45 | |
46 | while (!kthread_should_stop()) { | |
724e2495 | 47 | |
c6ef1e7f ML |
48 | spin_lock_irq(&raw->lock); |
49 | retval = kfifo_out(&raw->kfifo, &ev, sizeof(ev)); | |
50 | ||
51 | if (!retval) { | |
52 | set_current_state(TASK_INTERRUPTIBLE); | |
0d2cb1de | 53 | |
c6ef1e7f ML |
54 | if (kthread_should_stop()) |
55 | set_current_state(TASK_RUNNING); | |
56 | ||
57 | spin_unlock_irq(&raw->lock); | |
58 | schedule(); | |
59 | continue; | |
0d2cb1de ML |
60 | } |
61 | ||
c6ef1e7f | 62 | spin_unlock_irq(&raw->lock); |
0d2cb1de | 63 | |
c6ef1e7f ML |
64 | |
65 | BUG_ON(retval != sizeof(ev)); | |
66 | ||
67 | mutex_lock(&ir_raw_handler_lock); | |
68 | list_for_each_entry(handler, &ir_raw_handler_list, list) | |
d8b4b582 | 69 | handler->decode(raw->dev, ev); |
c6ef1e7f ML |
70 | raw->prev_ev = ev; |
71 | mutex_unlock(&ir_raw_handler_lock); | |
c216369e | 72 | } |
0d2cb1de ML |
73 | |
74 | return 0; | |
724e2495 DH |
75 | } |
76 | ||
724e2495 DH |
77 | /** |
78 | * ir_raw_event_store() - pass a pulse/space duration to the raw ir decoders | |
d8b4b582 | 79 | * @dev: the struct rc_dev device descriptor |
e40b1127 | 80 | * @ev: the struct ir_raw_event descriptor of the pulse/space |
724e2495 DH |
81 | * |
82 | * This routine (which may be called from an interrupt context) stores a | |
83 | * pulse/space duration for the raw ir decoding state machines. Pulses are | |
84 | * signalled as positive values and spaces as negative values. A zero value | |
85 | * will reset the decoding state machines. | |
86 | */ | |
d8b4b582 | 87 | int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev) |
a3572c34 | 88 | { |
d8b4b582 | 89 | if (!dev->raw) |
a3572c34 MCC |
90 | return -EINVAL; |
91 | ||
74c4792c | 92 | IR_dprintk(2, "sample: (%05dus %s)\n", |
d8b4b582 | 93 | TO_US(ev->duration), TO_STR(ev->pulse)); |
510fcb70 | 94 | |
d8b4b582 | 95 | if (kfifo_in(&dev->raw->kfifo, ev, sizeof(*ev)) != sizeof(*ev)) |
724e2495 | 96 | return -ENOMEM; |
a3572c34 | 97 | |
724e2495 DH |
98 | return 0; |
99 | } | |
100 | EXPORT_SYMBOL_GPL(ir_raw_event_store); | |
a3572c34 | 101 | |
724e2495 DH |
102 | /** |
103 | * ir_raw_event_store_edge() - notify raw ir decoders of the start of a pulse/space | |
d8b4b582 | 104 | * @dev: the struct rc_dev device descriptor |
724e2495 DH |
105 | * @type: the type of the event that has occurred |
106 | * | |
107 | * This routine (which may be called from an interrupt context) is used to | |
108 | * store the beginning of an ir pulse or space (or the start/end of ir | |
109 | * reception) for the raw ir decoding state machines. This is used by | |
110 | * hardware which does not provide durations directly but only interrupts | |
111 | * (or similar events) on state change. | |
112 | */ | |
d8b4b582 | 113 | int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type) |
724e2495 | 114 | { |
724e2495 DH |
115 | ktime_t now; |
116 | s64 delta; /* ns */ | |
83587839 | 117 | DEFINE_IR_RAW_EVENT(ev); |
724e2495 | 118 | int rc = 0; |
3f5c4c73 | 119 | int delay; |
a3572c34 | 120 | |
d8b4b582 | 121 | if (!dev->raw) |
724e2495 | 122 | return -EINVAL; |
a3572c34 | 123 | |
724e2495 | 124 | now = ktime_get(); |
d8b4b582 | 125 | delta = ktime_to_ns(ktime_sub(now, dev->raw->last_event)); |
3f5c4c73 | 126 | delay = MS_TO_NS(dev->input_dev->rep[REP_DELAY]); |
a3572c34 | 127 | |
724e2495 DH |
128 | /* Check for a long duration since last event or if we're |
129 | * being called for the first time, note that delta can't | |
130 | * possibly be negative. | |
131 | */ | |
3f5c4c73 | 132 | if (delta > delay || !dev->raw->last_type) |
724e2495 | 133 | type |= IR_START_EVENT; |
e40b1127 DH |
134 | else |
135 | ev.duration = delta; | |
724e2495 DH |
136 | |
137 | if (type & IR_START_EVENT) | |
d8b4b582 DH |
138 | ir_raw_event_reset(dev); |
139 | else if (dev->raw->last_type & IR_SPACE) { | |
e40b1127 | 140 | ev.pulse = false; |
d8b4b582 DH |
141 | rc = ir_raw_event_store(dev, &ev); |
142 | } else if (dev->raw->last_type & IR_PULSE) { | |
e40b1127 | 143 | ev.pulse = true; |
d8b4b582 | 144 | rc = ir_raw_event_store(dev, &ev); |
e40b1127 | 145 | } else |
724e2495 | 146 | return 0; |
a3572c34 | 147 | |
d8b4b582 DH |
148 | dev->raw->last_event = now; |
149 | dev->raw->last_type = type; | |
a3572c34 MCC |
150 | return rc; |
151 | } | |
724e2495 | 152 | EXPORT_SYMBOL_GPL(ir_raw_event_store_edge); |
a3572c34 | 153 | |
4a702ebf ML |
154 | /** |
155 | * ir_raw_event_store_with_filter() - pass next pulse/space to decoders with some processing | |
d8b4b582 | 156 | * @dev: the struct rc_dev device descriptor |
4a702ebf ML |
157 | * @type: the type of the event that has occurred |
158 | * | |
159 | * This routine (which may be called from an interrupt context) works | |
25985edc | 160 | * in similar manner to ir_raw_event_store_edge. |
4a702ebf ML |
161 | * This routine is intended for devices with limited internal buffer |
162 | * It automerges samples of same type, and handles timeouts | |
163 | */ | |
d8b4b582 | 164 | int ir_raw_event_store_with_filter(struct rc_dev *dev, struct ir_raw_event *ev) |
4a702ebf | 165 | { |
d8b4b582 | 166 | if (!dev->raw) |
4a702ebf ML |
167 | return -EINVAL; |
168 | ||
169 | /* Ignore spaces in idle mode */ | |
d8b4b582 | 170 | if (dev->idle && !ev->pulse) |
4a702ebf | 171 | return 0; |
d8b4b582 DH |
172 | else if (dev->idle) |
173 | ir_raw_event_set_idle(dev, false); | |
174 | ||
175 | if (!dev->raw->this_ev.duration) | |
176 | dev->raw->this_ev = *ev; | |
177 | else if (ev->pulse == dev->raw->this_ev.pulse) | |
178 | dev->raw->this_ev.duration += ev->duration; | |
179 | else { | |
180 | ir_raw_event_store(dev, &dev->raw->this_ev); | |
181 | dev->raw->this_ev = *ev; | |
4a702ebf ML |
182 | } |
183 | ||
184 | /* Enter idle mode if nessesary */ | |
d8b4b582 DH |
185 | if (!ev->pulse && dev->timeout && |
186 | dev->raw->this_ev.duration >= dev->timeout) | |
187 | ir_raw_event_set_idle(dev, true); | |
188 | ||
4a702ebf ML |
189 | return 0; |
190 | } | |
191 | EXPORT_SYMBOL_GPL(ir_raw_event_store_with_filter); | |
192 | ||
4651918a | 193 | /** |
d8b4b582 DH |
194 | * ir_raw_event_set_idle() - provide hint to rc-core when the device is idle or not |
195 | * @dev: the struct rc_dev device descriptor | |
196 | * @idle: whether the device is idle or not | |
4651918a | 197 | */ |
d8b4b582 | 198 | void ir_raw_event_set_idle(struct rc_dev *dev, bool idle) |
4a702ebf | 199 | { |
d8b4b582 | 200 | if (!dev->raw) |
4a702ebf ML |
201 | return; |
202 | ||
4651918a | 203 | IR_dprintk(2, "%s idle mode\n", idle ? "enter" : "leave"); |
4a702ebf ML |
204 | |
205 | if (idle) { | |
d8b4b582 DH |
206 | dev->raw->this_ev.timeout = true; |
207 | ir_raw_event_store(dev, &dev->raw->this_ev); | |
208 | init_ir_raw_event(&dev->raw->this_ev); | |
4a702ebf | 209 | } |
4651918a | 210 | |
d8b4b582 DH |
211 | if (dev->s_idle) |
212 | dev->s_idle(dev, idle); | |
213 | ||
214 | dev->idle = idle; | |
4a702ebf ML |
215 | } |
216 | EXPORT_SYMBOL_GPL(ir_raw_event_set_idle); | |
217 | ||
724e2495 DH |
218 | /** |
219 | * ir_raw_event_handle() - schedules the decoding of stored ir data | |
d8b4b582 | 220 | * @dev: the struct rc_dev device descriptor |
724e2495 | 221 | * |
d8b4b582 | 222 | * This routine will tell rc-core to start decoding stored ir data. |
724e2495 | 223 | */ |
d8b4b582 | 224 | void ir_raw_event_handle(struct rc_dev *dev) |
a3572c34 | 225 | { |
c6ef1e7f | 226 | unsigned long flags; |
a3572c34 | 227 | |
d8b4b582 | 228 | if (!dev->raw) |
724e2495 | 229 | return; |
a3572c34 | 230 | |
d8b4b582 DH |
231 | spin_lock_irqsave(&dev->raw->lock, flags); |
232 | wake_up_process(dev->raw->thread); | |
233 | spin_unlock_irqrestore(&dev->raw->lock, flags); | |
a3572c34 MCC |
234 | } |
235 | EXPORT_SYMBOL_GPL(ir_raw_event_handle); | |
995187be | 236 | |
667c9ebe DH |
237 | /* used internally by the sysfs interface */ |
238 | u64 | |
2dbd61b4 | 239 | ir_raw_get_allowed_protocols(void) |
667c9ebe DH |
240 | { |
241 | u64 protocols; | |
45a568fa | 242 | mutex_lock(&ir_raw_handler_lock); |
667c9ebe | 243 | protocols = available_protocols; |
45a568fa | 244 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe DH |
245 | return protocols; |
246 | } | |
247 | ||
248 | /* | |
249 | * Used to (un)register raw event clients | |
250 | */ | |
d8b4b582 | 251 | int ir_raw_event_register(struct rc_dev *dev) |
667c9ebe | 252 | { |
667c9ebe | 253 | int rc; |
c216369e | 254 | struct ir_raw_handler *handler; |
667c9ebe | 255 | |
d8b4b582 DH |
256 | if (!dev) |
257 | return -EINVAL; | |
667c9ebe | 258 | |
d8b4b582 DH |
259 | dev->raw = kzalloc(sizeof(*dev->raw), GFP_KERNEL); |
260 | if (!dev->raw) | |
261 | return -ENOMEM; | |
0d2cb1de | 262 | |
d8b4b582 DH |
263 | dev->raw->dev = dev; |
264 | dev->raw->enabled_protocols = ~0; | |
265 | rc = kfifo_alloc(&dev->raw->kfifo, | |
266 | sizeof(struct ir_raw_event) * MAX_IR_EVENT_SIZE, | |
667c9ebe | 267 | GFP_KERNEL); |
d8b4b582 DH |
268 | if (rc < 0) |
269 | goto out; | |
667c9ebe | 270 | |
d8b4b582 DH |
271 | spin_lock_init(&dev->raw->lock); |
272 | dev->raw->thread = kthread_run(ir_raw_event_thread, dev->raw, | |
273 | "rc%ld", dev->devno); | |
0d2cb1de | 274 | |
d8b4b582 DH |
275 | if (IS_ERR(dev->raw->thread)) { |
276 | rc = PTR_ERR(dev->raw->thread); | |
277 | goto out; | |
0d2cb1de ML |
278 | } |
279 | ||
45a568fa | 280 | mutex_lock(&ir_raw_handler_lock); |
d8b4b582 | 281 | list_add_tail(&dev->raw->list, &ir_raw_client_list); |
c216369e DH |
282 | list_for_each_entry(handler, &ir_raw_handler_list, list) |
283 | if (handler->raw_register) | |
d8b4b582 | 284 | handler->raw_register(dev); |
45a568fa | 285 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe | 286 | |
c216369e | 287 | return 0; |
d8b4b582 DH |
288 | |
289 | out: | |
290 | kfree(dev->raw); | |
291 | dev->raw = NULL; | |
292 | return rc; | |
667c9ebe DH |
293 | } |
294 | ||
d8b4b582 | 295 | void ir_raw_event_unregister(struct rc_dev *dev) |
667c9ebe | 296 | { |
c216369e | 297 | struct ir_raw_handler *handler; |
667c9ebe | 298 | |
d8b4b582 | 299 | if (!dev || !dev->raw) |
667c9ebe DH |
300 | return; |
301 | ||
d8b4b582 | 302 | kthread_stop(dev->raw->thread); |
c216369e | 303 | |
45a568fa | 304 | mutex_lock(&ir_raw_handler_lock); |
d8b4b582 | 305 | list_del(&dev->raw->list); |
c216369e DH |
306 | list_for_each_entry(handler, &ir_raw_handler_list, list) |
307 | if (handler->raw_unregister) | |
d8b4b582 | 308 | handler->raw_unregister(dev); |
45a568fa | 309 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe | 310 | |
d8b4b582 DH |
311 | kfifo_free(&dev->raw->kfifo); |
312 | kfree(dev->raw); | |
313 | dev->raw = NULL; | |
667c9ebe DH |
314 | } |
315 | ||
995187be MCC |
316 | /* |
317 | * Extension interface - used to register the IR decoders | |
318 | */ | |
319 | ||
320 | int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler) | |
321 | { | |
c216369e DH |
322 | struct ir_raw_event_ctrl *raw; |
323 | ||
45a568fa | 324 | mutex_lock(&ir_raw_handler_lock); |
995187be | 325 | list_add_tail(&ir_raw_handler->list, &ir_raw_handler_list); |
c216369e DH |
326 | if (ir_raw_handler->raw_register) |
327 | list_for_each_entry(raw, &ir_raw_client_list, list) | |
d8b4b582 | 328 | ir_raw_handler->raw_register(raw->dev); |
667c9ebe | 329 | available_protocols |= ir_raw_handler->protocols; |
45a568fa | 330 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe | 331 | |
995187be MCC |
332 | return 0; |
333 | } | |
334 | EXPORT_SYMBOL(ir_raw_handler_register); | |
335 | ||
336 | void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler) | |
337 | { | |
c216369e DH |
338 | struct ir_raw_event_ctrl *raw; |
339 | ||
45a568fa | 340 | mutex_lock(&ir_raw_handler_lock); |
995187be | 341 | list_del(&ir_raw_handler->list); |
c216369e DH |
342 | if (ir_raw_handler->raw_unregister) |
343 | list_for_each_entry(raw, &ir_raw_client_list, list) | |
d8b4b582 | 344 | ir_raw_handler->raw_unregister(raw->dev); |
667c9ebe | 345 | available_protocols &= ~ir_raw_handler->protocols; |
45a568fa | 346 | mutex_unlock(&ir_raw_handler_lock); |
995187be MCC |
347 | } |
348 | EXPORT_SYMBOL(ir_raw_handler_unregister); | |
349 | ||
5fa2989f | 350 | #ifdef MODULE |
995187be MCC |
351 | static void init_decoders(struct work_struct *work) |
352 | { | |
353 | /* Load the decoder modules */ | |
354 | ||
355 | load_nec_decode(); | |
db1423a6 | 356 | load_rc5_decode(); |
784a4931 | 357 | load_rc6_decode(); |
bf670f64 | 358 | load_jvc_decode(); |
3fe29c89 | 359 | load_sony_decode(); |
b32e7243 | 360 | load_sanyo_decode(); |
f5f2cc64 | 361 | load_mce_kbd_decode(); |
ca414698 | 362 | load_lirc_codec(); |
995187be MCC |
363 | |
364 | /* If needed, we may later add some init code. In this case, | |
6bda9644 | 365 | it is needed to change the CONFIG_MODULE test at rc-core.h |
995187be MCC |
366 | */ |
367 | } | |
5fa2989f | 368 | #endif |
995187be MCC |
369 | |
370 | void ir_raw_init(void) | |
371 | { | |
93c312ff | 372 | #ifdef MODULE |
995187be MCC |
373 | INIT_WORK(&wq_load, init_decoders); |
374 | schedule_work(&wq_load); | |
93c312ff MCC |
375 | #endif |
376 | } |