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 | |
c216369e DH |
23 | /* Used to keep track of IR raw clients, protected by ir_raw_handler_lock */ |
24 | static LIST_HEAD(ir_raw_client_list); | |
25 | ||
995187be | 26 | /* Used to handle IR raw handler extensions */ |
45a568fa | 27 | static DEFINE_MUTEX(ir_raw_handler_lock); |
667c9ebe DH |
28 | static LIST_HEAD(ir_raw_handler_list); |
29 | static u64 available_protocols; | |
93c312ff | 30 | |
0d2cb1de | 31 | static int ir_raw_event_thread(void *data) |
724e2495 | 32 | { |
e40b1127 | 33 | struct ir_raw_event ev; |
c216369e | 34 | struct ir_raw_handler *handler; |
0d2cb1de ML |
35 | struct ir_raw_event_ctrl *raw = (struct ir_raw_event_ctrl *)data; |
36 | ||
37 | while (!kthread_should_stop()) { | |
724e2495 | 38 | |
c6ef1e7f | 39 | spin_lock_irq(&raw->lock); |
c6ef1e7f | 40 | |
464254e5 | 41 | if (!kfifo_len(&raw->kfifo)) { |
c6ef1e7f | 42 | set_current_state(TASK_INTERRUPTIBLE); |
0d2cb1de | 43 | |
c6ef1e7f ML |
44 | if (kthread_should_stop()) |
45 | set_current_state(TASK_RUNNING); | |
46 | ||
47 | spin_unlock_irq(&raw->lock); | |
48 | schedule(); | |
49 | continue; | |
0d2cb1de ML |
50 | } |
51 | ||
464254e5 HK |
52 | if(!kfifo_out(&raw->kfifo, &ev, 1)) |
53 | dev_err(&raw->dev->dev, "IR event FIFO is empty!\n"); | |
c6ef1e7f | 54 | spin_unlock_irq(&raw->lock); |
0d2cb1de | 55 | |
c6ef1e7f ML |
56 | mutex_lock(&ir_raw_handler_lock); |
57 | list_for_each_entry(handler, &ir_raw_handler_list, list) | |
d80ca8bd HK |
58 | if (raw->dev->enabled_protocols & handler->protocols || |
59 | !handler->protocols) | |
60 | handler->decode(raw->dev, ev); | |
c6ef1e7f ML |
61 | raw->prev_ev = ev; |
62 | mutex_unlock(&ir_raw_handler_lock); | |
c216369e | 63 | } |
0d2cb1de ML |
64 | |
65 | return 0; | |
724e2495 DH |
66 | } |
67 | ||
724e2495 DH |
68 | /** |
69 | * ir_raw_event_store() - pass a pulse/space duration to the raw ir decoders | |
d8b4b582 | 70 | * @dev: the struct rc_dev device descriptor |
e40b1127 | 71 | * @ev: the struct ir_raw_event descriptor of the pulse/space |
724e2495 DH |
72 | * |
73 | * This routine (which may be called from an interrupt context) stores a | |
74 | * pulse/space duration for the raw ir decoding state machines. Pulses are | |
75 | * signalled as positive values and spaces as negative values. A zero value | |
76 | * will reset the decoding state machines. | |
77 | */ | |
d8b4b582 | 78 | int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev) |
a3572c34 | 79 | { |
d8b4b582 | 80 | if (!dev->raw) |
a3572c34 MCC |
81 | return -EINVAL; |
82 | ||
74c4792c | 83 | IR_dprintk(2, "sample: (%05dus %s)\n", |
d8b4b582 | 84 | TO_US(ev->duration), TO_STR(ev->pulse)); |
510fcb70 | 85 | |
464254e5 HK |
86 | if (!kfifo_put(&dev->raw->kfifo, *ev)) { |
87 | dev_err(&dev->dev, "IR event FIFO is full!\n"); | |
88 | return -ENOSPC; | |
89 | } | |
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 | ||
93cffffc HK |
249 | static void ir_raw_disable_protocols(struct rc_dev *dev, u64 protocols) |
250 | { | |
251 | mutex_lock(&dev->lock); | |
252 | dev->enabled_protocols &= ~protocols; | |
253 | dev->enabled_wakeup_protocols &= ~protocols; | |
254 | mutex_unlock(&dev->lock); | |
255 | } | |
256 | ||
667c9ebe DH |
257 | /* |
258 | * Used to (un)register raw event clients | |
259 | */ | |
d8b4b582 | 260 | int ir_raw_event_register(struct rc_dev *dev) |
667c9ebe | 261 | { |
667c9ebe | 262 | int rc; |
c216369e | 263 | struct ir_raw_handler *handler; |
667c9ebe | 264 | |
d8b4b582 DH |
265 | if (!dev) |
266 | return -EINVAL; | |
667c9ebe | 267 | |
d8b4b582 DH |
268 | dev->raw = kzalloc(sizeof(*dev->raw), GFP_KERNEL); |
269 | if (!dev->raw) | |
270 | return -ENOMEM; | |
0d2cb1de | 271 | |
d8b4b582 | 272 | dev->raw->dev = dev; |
da6e162d | 273 | dev->change_protocol = change_protocol; |
464254e5 | 274 | INIT_KFIFO(dev->raw->kfifo); |
667c9ebe | 275 | |
d8b4b582 DH |
276 | spin_lock_init(&dev->raw->lock); |
277 | dev->raw->thread = kthread_run(ir_raw_event_thread, dev->raw, | |
fcb13097 | 278 | "rc%u", dev->minor); |
0d2cb1de | 279 | |
d8b4b582 DH |
280 | if (IS_ERR(dev->raw->thread)) { |
281 | rc = PTR_ERR(dev->raw->thread); | |
282 | goto out; | |
0d2cb1de ML |
283 | } |
284 | ||
45a568fa | 285 | mutex_lock(&ir_raw_handler_lock); |
d8b4b582 | 286 | list_add_tail(&dev->raw->list, &ir_raw_client_list); |
c216369e DH |
287 | list_for_each_entry(handler, &ir_raw_handler_list, list) |
288 | if (handler->raw_register) | |
d8b4b582 | 289 | handler->raw_register(dev); |
45a568fa | 290 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe | 291 | |
c216369e | 292 | return 0; |
d8b4b582 DH |
293 | |
294 | out: | |
295 | kfree(dev->raw); | |
296 | dev->raw = NULL; | |
297 | return rc; | |
667c9ebe DH |
298 | } |
299 | ||
d8b4b582 | 300 | void ir_raw_event_unregister(struct rc_dev *dev) |
667c9ebe | 301 | { |
c216369e | 302 | struct ir_raw_handler *handler; |
667c9ebe | 303 | |
d8b4b582 | 304 | if (!dev || !dev->raw) |
667c9ebe DH |
305 | return; |
306 | ||
d8b4b582 | 307 | kthread_stop(dev->raw->thread); |
c216369e | 308 | |
45a568fa | 309 | mutex_lock(&ir_raw_handler_lock); |
d8b4b582 | 310 | list_del(&dev->raw->list); |
c216369e DH |
311 | list_for_each_entry(handler, &ir_raw_handler_list, list) |
312 | if (handler->raw_unregister) | |
d8b4b582 | 313 | handler->raw_unregister(dev); |
45a568fa | 314 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe | 315 | |
d8b4b582 DH |
316 | kfree(dev->raw); |
317 | dev->raw = NULL; | |
667c9ebe DH |
318 | } |
319 | ||
995187be MCC |
320 | /* |
321 | * Extension interface - used to register the IR decoders | |
322 | */ | |
323 | ||
324 | int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler) | |
325 | { | |
c216369e DH |
326 | struct ir_raw_event_ctrl *raw; |
327 | ||
45a568fa | 328 | mutex_lock(&ir_raw_handler_lock); |
995187be | 329 | list_add_tail(&ir_raw_handler->list, &ir_raw_handler_list); |
c216369e DH |
330 | if (ir_raw_handler->raw_register) |
331 | list_for_each_entry(raw, &ir_raw_client_list, list) | |
d8b4b582 | 332 | ir_raw_handler->raw_register(raw->dev); |
667c9ebe | 333 | available_protocols |= ir_raw_handler->protocols; |
45a568fa | 334 | mutex_unlock(&ir_raw_handler_lock); |
667c9ebe | 335 | |
995187be MCC |
336 | return 0; |
337 | } | |
338 | EXPORT_SYMBOL(ir_raw_handler_register); | |
339 | ||
340 | void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler) | |
341 | { | |
c216369e | 342 | struct ir_raw_event_ctrl *raw; |
93cffffc | 343 | u64 protocols = ir_raw_handler->protocols; |
c216369e | 344 | |
45a568fa | 345 | mutex_lock(&ir_raw_handler_lock); |
995187be | 346 | list_del(&ir_raw_handler->list); |
93cffffc HK |
347 | list_for_each_entry(raw, &ir_raw_client_list, list) { |
348 | ir_raw_disable_protocols(raw->dev, protocols); | |
349 | if (ir_raw_handler->raw_unregister) | |
d8b4b582 | 350 | ir_raw_handler->raw_unregister(raw->dev); |
93cffffc HK |
351 | } |
352 | available_protocols &= ~protocols; | |
45a568fa | 353 | mutex_unlock(&ir_raw_handler_lock); |
995187be MCC |
354 | } |
355 | EXPORT_SYMBOL(ir_raw_handler_unregister); |