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