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