drivers/media/rc/ir-raw.c

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