drivers/media/rc/rc-ir-raw.c

   1 /* rc-ir-raw.c - handle IR pulse/space events
   2  *
   3  * Copyright (C) 2010 by Mauro Carvalho Chehab
   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/export.h>
  16 #include <linux/kthread.h>
  17 #include <linux/mutex.h>
  18 #include <linux/kmod.h>
  19 #include <linux/sched.h>
  20 #include <linux/freezer.h>
  21 #include "rc-core-priv.h"
  22
  23 /* Define the max number of pulse/space transitions to buffer */
  24 #define MAX_IR_EVENT_SIZE      512
  25
  26 /* Used to keep track of IR raw clients, protected by ir_raw_handler_lock */
  27 static LIST_HEAD(ir_raw_client_list);
  28
  29 /* Used to handle IR raw handler extensions */
  30 static DEFINE_MUTEX(ir_raw_handler_lock);
  31 static LIST_HEAD(ir_raw_handler_list);
  32 static u64 available_protocols;
  33
  34 static int ir_raw_event_thread(void *data)
  35 {
  36         struct ir_raw_event ev;
  37         struct ir_raw_handler *handler;
  38         struct ir_raw_event_ctrl *raw = (struct ir_raw_event_ctrl *)data;
  39         int retval;
  40
  41         while (!kthread_should_stop()) {
  42
  43                 spin_lock_irq(&raw->lock);
  44                 retval = kfifo_len(&raw->kfifo);
  45
  46                 if (retval < sizeof(ev)) {
  47                         set_current_state(TASK_INTERRUPTIBLE);
  48
  49                         if (kthread_should_stop())
  50                                 set_current_state(TASK_RUNNING);
  51
  52                         spin_unlock_irq(&raw->lock);
  53                         schedule();
  54                         continue;
  55                 }
  56
  57                 retval = kfifo_out(&raw->kfifo, &ev, sizeof(ev));
  58                 spin_unlock_irq(&raw->lock);
  59
  60                 mutex_lock(&ir_raw_handler_lock);
  61                 list_for_each_entry(handler, &ir_raw_handler_list, list)
  62                         handler->decode(raw->dev, ev);
  63                 raw->prev_ev = ev;
  64                 mutex_unlock(&ir_raw_handler_lock);
  65         }
  66
  67         return 0;
  68 }
  69
  70 /**
  71  * ir_raw_event_store() - pass a pulse/space duration to the raw ir decoders
  72  * @dev:        the struct rc_dev device descriptor
  73  * @ev:         the struct ir_raw_event descriptor of the pulse/space
  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  */
  80 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev)
  81 {
  82         if (!dev->raw)
  83                 return -EINVAL;
  84
  85         IR_dprintk(2, "sample: (%05dus %s)\n",
  86                    TO_US(ev->duration), TO_STR(ev->pulse));
  87
  88         if (kfifo_in(&dev->raw->kfifo, ev, sizeof(*ev)) != sizeof(*ev))
  89                 return -ENOMEM;
  90
  91         return 0;
  92 }
  93 EXPORT_SYMBOL_GPL(ir_raw_event_store);
  94
  95 /**
  96  * ir_raw_event_store_edge() - notify raw ir decoders of the start of a pulse/space
  97  * @dev:        the struct rc_dev device descriptor
  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  */
 106 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type)
 107 {
 108         ktime_t                 now;
 109         s64                     delta; /* ns */
 110         DEFINE_IR_RAW_EVENT(ev);
 111         int                     rc = 0;
 112         int                     delay;
 113
 114         if (!dev->raw)
 115                 return -EINVAL;
 116
 117         now = ktime_get();
 118         delta = ktime_to_ns(ktime_sub(now, dev->raw->last_event));
 119         delay = MS_TO_NS(dev->input_dev->rep[REP_DELAY]);
 120
 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          */
 125         if (delta > delay || !dev->raw->last_type)
 126                 type |= IR_START_EVENT;
 127         else
 128                 ev.duration = delta;
 129
 130         if (type & IR_START_EVENT)
 131                 ir_raw_event_reset(dev);
 132         else if (dev->raw->last_type & IR_SPACE) {
 133                 ev.pulse = false;
 134                 rc = ir_raw_event_store(dev, &ev);
 135         } else if (dev->raw->last_type & IR_PULSE) {
 136                 ev.pulse = true;
 137                 rc = ir_raw_event_store(dev, &ev);
 138         } else
 139                 return 0;
 140
 141         dev->raw->last_event = now;
 142         dev->raw->last_type = type;
 143         return rc;
 144 }
 145 EXPORT_SYMBOL_GPL(ir_raw_event_store_edge);
 146
 147 /**
 148  * ir_raw_event_store_with_filter() - pass next pulse/space to decoders with some processing
 149  * @dev:        the struct rc_dev device descriptor
 150  * @type:       the type of the event that has occurred
 151  *
 152  * This routine (which may be called from an interrupt context) works
 153  * in similar manner to ir_raw_event_store_edge.
 154  * This routine is intended for devices with limited internal buffer
 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.
 158  */
 159 int ir_raw_event_store_with_filter(struct rc_dev *dev, struct ir_raw_event *ev)
 160 {
 161         if (!dev->raw)
 162                 return -EINVAL;
 163
 164         /* Ignore spaces in idle mode */
 165         if (dev->idle && !ev->pulse)
 166                 return 0;
 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;
 177         }
 178
 179         /* Enter idle mode if nessesary */
 180         if (!ev->pulse && dev->timeout &&
 181             dev->raw->this_ev.duration >= dev->timeout)
 182                 ir_raw_event_set_idle(dev, true);
 183
 184         return 1;
 185 }
 186 EXPORT_SYMBOL_GPL(ir_raw_event_store_with_filter);
 187
 188 /**
 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
 192  */
 193 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle)
 194 {
 195         if (!dev->raw)
 196                 return;
 197
 198         IR_dprintk(2, "%s idle mode\n", idle ? "enter" : "leave");
 199
 200         if (idle) {
 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);
 204         }
 205
 206         if (dev->s_idle)
 207                 dev->s_idle(dev, idle);
 208
 209         dev->idle = idle;
 210 }
 211 EXPORT_SYMBOL_GPL(ir_raw_event_set_idle);
 212
 213 /**
 214  * ir_raw_event_handle() - schedules the decoding of stored ir data
 215  * @dev:        the struct rc_dev device descriptor
 216  *
 217  * This routine will tell rc-core to start decoding stored ir data.
 218  */
 219 void ir_raw_event_handle(struct rc_dev *dev)
 220 {
 221         unsigned long flags;
 222
 223         if (!dev->raw)
 224                 return;
 225
 226         spin_lock_irqsave(&dev->raw->lock, flags);
 227         wake_up_process(dev->raw->thread);
 228         spin_unlock_irqrestore(&dev->raw->lock, flags);
 229 }
 230 EXPORT_SYMBOL_GPL(ir_raw_event_handle);
 231
 232 /* used internally by the sysfs interface */
 233 u64
 234 ir_raw_get_allowed_protocols(void)
 235 {
 236         u64 protocols;
 237         mutex_lock(&ir_raw_handler_lock);
 238         protocols = available_protocols;
 239         mutex_unlock(&ir_raw_handler_lock);
 240         return protocols;
 241 }
 242
 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
 249 /**
 250  * ir_raw_gen_manchester() - Encode data with Manchester (bi-phase) modulation.
 251  * @ev:         Pointer to pointer to next free event. *@ev is incremented for
 252  *              each raw event filled.
 253  * @max:        Maximum number of raw events to fill.
 254  * @timings:    Manchester modulation timings.
 255  * @n:          Number of bits of data.
 256  * @data:       Data bits to encode.
 257  *
 258  * Encodes the @n least significant bits of @data using Manchester (bi-phase)
 259  * modulation with the timing characteristics described by @timings, writing up
 260  * to @max raw IR events using the *@ev pointer.
 261  *
 262  * Returns:     0 on success.
 263  *              -ENOBUFS if there isn't enough space in the array to fit the
 264  *              full encoded data. In this case all @max events will have been
 265  *              written.
 266  */
 267 int ir_raw_gen_manchester(struct ir_raw_event **ev, unsigned int max,
 268                           const struct ir_raw_timings_manchester *timings,
 269                           unsigned int n, unsigned int data)
 270 {
 271         bool need_pulse;
 272         unsigned int i;
 273         int ret = -ENOBUFS;
 274
 275         i = 1 << (n - 1);
 276
 277         if (timings->leader) {
 278                 if (!max--)
 279                         return ret;
 280                 if (timings->pulse_space_start) {
 281                         init_ir_raw_event_duration((*ev)++, 1, timings->leader);
 282
 283                         if (!max--)
 284                                 return ret;
 285                         init_ir_raw_event_duration((*ev), 0, timings->leader);
 286                 } else {
 287                         init_ir_raw_event_duration((*ev), 1, timings->leader);
 288                 }
 289                 i >>= 1;
 290         } else {
 291                 /* continue existing signal */
 292                 --(*ev);
 293         }
 294         /* from here on *ev will point to the last event rather than the next */
 295
 296         while (n && i > 0) {
 297                 need_pulse = !(data & i);
 298                 if (timings->invert)
 299                         need_pulse = !need_pulse;
 300                 if (need_pulse == !!(*ev)->pulse) {
 301                         (*ev)->duration += timings->clock;
 302                 } else {
 303                         if (!max--)
 304                                 goto nobufs;
 305                         init_ir_raw_event_duration(++(*ev), need_pulse,
 306                                                    timings->clock);
 307                 }
 308
 309                 if (!max--)
 310                         goto nobufs;
 311                 init_ir_raw_event_duration(++(*ev), !need_pulse,
 312                                            timings->clock);
 313                 i >>= 1;
 314         }
 315
 316         if (timings->trailer_space) {
 317                 if (!(*ev)->pulse)
 318                         (*ev)->duration += timings->trailer_space;
 319                 else if (!max--)
 320                         goto nobufs;
 321                 else
 322                         init_ir_raw_event_duration(++(*ev), 0,
 323                                                    timings->trailer_space);
 324         }
 325
 326         ret = 0;
 327 nobufs:
 328         /* point to the next event rather than last event before returning */
 329         ++(*ev);
 330         return ret;
 331 }
 332 EXPORT_SYMBOL(ir_raw_gen_manchester);
 333
 334 /**
 335  * ir_raw_encode_scancode() - Encode a scancode as raw events
 336  *
 337  * @protocols:          permitted protocols
 338  * @scancode:           scancode filter describing a single scancode
 339  * @events:             array of raw events to write into
 340  * @max:                max number of raw events
 341  *
 342  * Attempts to encode the scancode as raw events.
 343  *
 344  * Returns:     The number of events written.
 345  *              -ENOBUFS if there isn't enough space in the array to fit the
 346  *              encoding. In this case all @max events will have been written.
 347  *              -EINVAL if the scancode is ambiguous or invalid, or if no
 348  *              compatible encoder was found.
 349  */
 350 int ir_raw_encode_scancode(u64 protocols,
 351                            const struct rc_scancode_filter *scancode,
 352                            struct ir_raw_event *events, unsigned int max)
 353 {
 354         struct ir_raw_handler *handler;
 355         int ret = -EINVAL;
 356
 357         mutex_lock(&ir_raw_handler_lock);
 358         list_for_each_entry(handler, &ir_raw_handler_list, list) {
 359                 if (handler->protocols & protocols && handler->encode) {
 360                         ret = handler->encode(protocols, scancode, events, max);
 361                         if (ret >= 0 || ret == -ENOBUFS)
 362                                 break;
 363                 }
 364         }
 365         mutex_unlock(&ir_raw_handler_lock);
 366
 367         return ret;
 368 }
 369 EXPORT_SYMBOL(ir_raw_encode_scancode);
 370
 371 /*
 372  * Used to (un)register raw event clients
 373  */
 374 int ir_raw_event_register(struct rc_dev *dev)
 375 {
 376         int rc;
 377         struct ir_raw_handler *handler;
 378
 379         if (!dev)
 380                 return -EINVAL;
 381
 382         dev->raw = kzalloc(sizeof(*dev->raw), GFP_KERNEL);
 383         if (!dev->raw)
 384                 return -ENOMEM;
 385
 386         dev->raw->dev = dev;
 387         dev->change_protocol = change_protocol;
 388         rc = kfifo_alloc(&dev->raw->kfifo,
 389                          sizeof(struct ir_raw_event) * MAX_IR_EVENT_SIZE,
 390                          GFP_KERNEL);
 391         if (rc < 0)
 392                 goto out;
 393
 394         spin_lock_init(&dev->raw->lock);
 395         dev->raw->thread = kthread_run(ir_raw_event_thread, dev->raw,
 396                                        "rc%ld", dev->devno);
 397
 398         if (IS_ERR(dev->raw->thread)) {
 399                 rc = PTR_ERR(dev->raw->thread);
 400                 goto out;
 401         }
 402
 403         mutex_lock(&ir_raw_handler_lock);
 404         list_add_tail(&dev->raw->list, &ir_raw_client_list);
 405         list_for_each_entry(handler, &ir_raw_handler_list, list)
 406                 if (handler->raw_register)
 407                         handler->raw_register(dev);
 408         mutex_unlock(&ir_raw_handler_lock);
 409
 410         return 0;
 411
 412 out:
 413         kfree(dev->raw);
 414         dev->raw = NULL;
 415         return rc;
 416 }
 417
 418 void ir_raw_event_unregister(struct rc_dev *dev)
 419 {
 420         struct ir_raw_handler *handler;
 421
 422         if (!dev || !dev->raw)
 423                 return;
 424
 425         kthread_stop(dev->raw->thread);
 426
 427         mutex_lock(&ir_raw_handler_lock);
 428         list_del(&dev->raw->list);
 429         list_for_each_entry(handler, &ir_raw_handler_list, list)
 430                 if (handler->raw_unregister)
 431                         handler->raw_unregister(dev);
 432         mutex_unlock(&ir_raw_handler_lock);
 433
 434         kfifo_free(&dev->raw->kfifo);
 435         kfree(dev->raw);
 436         dev->raw = NULL;
 437 }
 438
 439 /*
 440  * Extension interface - used to register the IR decoders
 441  */
 442
 443 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler)
 444 {
 445         struct ir_raw_event_ctrl *raw;
 446
 447         mutex_lock(&ir_raw_handler_lock);
 448         list_add_tail(&ir_raw_handler->list, &ir_raw_handler_list);
 449         if (ir_raw_handler->raw_register)
 450                 list_for_each_entry(raw, &ir_raw_client_list, list)
 451                         ir_raw_handler->raw_register(raw->dev);
 452         available_protocols |= ir_raw_handler->protocols;
 453         mutex_unlock(&ir_raw_handler_lock);
 454
 455         return 0;
 456 }
 457 EXPORT_SYMBOL(ir_raw_handler_register);
 458
 459 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler)
 460 {
 461         struct ir_raw_event_ctrl *raw;
 462
 463         mutex_lock(&ir_raw_handler_lock);
 464         list_del(&ir_raw_handler->list);
 465         if (ir_raw_handler->raw_unregister)
 466                 list_for_each_entry(raw, &ir_raw_client_list, list)
 467                         ir_raw_handler->raw_unregister(raw->dev);
 468         available_protocols &= ~ir_raw_handler->protocols;
 469         mutex_unlock(&ir_raw_handler_lock);
 470 }
 471 EXPORT_SYMBOL(ir_raw_handler_unregister);
 472
 473 void ir_raw_init(void)
 474 {
 475         /* Load the decoder modules */
 476
 477         load_nec_decode();
 478         load_rc5_decode();
 479         load_rc6_decode();
 480         load_jvc_decode();
 481         load_sony_decode();
 482         load_sanyo_decode();
 483         load_sharp_decode();
 484         load_mce_kbd_decode();
 485         load_lirc_codec();
 486         load_xmp_decode();
 487
 488         /* If needed, we may later add some init code. In this case,
 489            it is needed to change the CONFIG_MODULE test at rc-core.h
 490          */
 491 }