include/media/ir-core.h

   1 /*
   2  * Remote Controller core header
   3  *
   4  * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation version 2 of the License.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  */
  15
  16 #ifndef _IR_CORE
  17 #define _IR_CORE
  18
  19 #include <linux/input.h>
  20 #include <linux/spinlock.h>
  21 #include <linux/kfifo.h>
  22 #include <linux/time.h>
  23 #include <linux/timer.h>
  24
  25 extern int ir_core_debug;
  26 #define IR_dprintk(level, fmt, arg...)  if (ir_core_debug >= level) \
  27         printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
  28
  29 #define IR_TYPE_UNKNOWN 0
  30 #define IR_TYPE_RC5     (1  << 0)       /* Philips RC5 protocol */
  31 #define IR_TYPE_PD      (1  << 1)       /* Pulse distance encoded IR */
  32 #define IR_TYPE_NEC     (1  << 2)
  33 #define IR_TYPE_OTHER   (((u64)1) << 63l)
  34
  35 enum raw_event_type {
  36         IR_SPACE        = (1 << 0),
  37         IR_PULSE        = (1 << 1),
  38         IR_START_EVENT  = (1 << 2),
  39         IR_STOP_EVENT   = (1 << 3),
  40 };
  41
  42 struct ir_scancode {
  43         u16     scancode;
  44         u32     keycode;
  45 };
  46
  47 struct ir_scancode_table {
  48         struct ir_scancode      *scan;
  49         int                     size;
  50         u64                     ir_type;
  51         char                    *name;
  52         spinlock_t              lock;
  53 };
  54
  55 struct ir_dev_props {
  56         unsigned long allowed_protos;
  57         void            *priv;
  58         int (*change_protocol)(void *priv, u64 ir_type);
  59 };
  60
  61 struct ir_raw_event {
  62         struct timespec         delta;  /* Time spent before event */
  63         enum raw_event_type     type;   /* event type */
  64 };
  65
  66 struct ir_raw_event_ctrl {
  67         struct kfifo                    kfifo;          /* fifo for the pulse/space events */
  68         struct timespec                 last_event;     /* when last event occurred */
  69         struct timer_list               timer_keyup;    /* timer for key release */
  70 };
  71
  72 struct ir_input_dev {
  73         struct device                   dev;            /* device */
  74         char                            *driver_name;   /* Name of the driver module */
  75         struct ir_scancode_table        rc_tab;         /* scan/key table */
  76         unsigned long                   devno;          /* device number */
  77         const struct ir_dev_props       *props;         /* Device properties */
  78         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  79
  80         /* key info - needed by IR keycode handlers */
  81         u32                             keycode;        /* linux key code */
  82         int                             keypressed;     /* current state */
  83 };
  84
  85 struct ir_raw_handler {
  86         struct list_head list;
  87
  88         int (*decode)(struct input_dev *input_dev,
  89                       struct ir_raw_event *evs,
  90                       int len);
  91 };
  92
  93 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
  94
  95 /* Routines from ir-keytable.c */
  96
  97 u32 ir_g_keycode_from_table(struct input_dev *input_dev,
  98                             u32 scancode);
  99 void ir_keyup(struct input_dev *dev);
 100 void ir_keydown(struct input_dev *dev, int scancode);
 101 int ir_input_register(struct input_dev *dev,
 102                       const struct ir_scancode_table *ir_codes,
 103                       const struct ir_dev_props *props,
 104                       const char *driver_name);
 105 void ir_input_unregister(struct input_dev *input_dev);
 106
 107 /* Routines from ir-sysfs.c */
 108
 109 int ir_register_class(struct input_dev *input_dev);
 110 void ir_unregister_class(struct input_dev *input_dev);
 111
 112 /* Routines from ir-raw-event.c */
 113 int ir_raw_event_register(struct input_dev *input_dev);
 114 void ir_raw_event_unregister(struct input_dev *input_dev);
 115 int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
 116 int ir_raw_event_handle(struct input_dev *input_dev);
 117 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
 118 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
 119
 120 #ifdef MODULE
 121 void ir_raw_init(void);
 122 #else
 123 #define ir_raw_init() 0
 124 #endif
 125
 126 /* from ir-nec-decoder.c */
 127 #ifdef CONFIG_IR_NEC_DECODER_MODULE
 128 #define load_nec_decode()       request_module("ir-nec-decoder")
 129 #else
 130 #define load_nec_decode()       0
 131 #endif
 132
 133 #endif /* _IR_CORE */