SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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         int (*open)(void *priv);
  60         void (*close)(void *priv);
  61 };
  62
  63 struct ir_raw_event {
  64         struct timespec         delta;  /* Time spent before event */
  65         enum raw_event_type     type;   /* event type */
  66 };
  67
  68 struct ir_raw_event_ctrl {
  69         struct kfifo                    kfifo;          /* fifo for the pulse/space events */
  70         struct timespec                 last_event;     /* when last event occurred */
  71         struct timer_list               timer_keyup;    /* timer for key release */
  72 };
  73
  74 struct ir_input_dev {
  75         struct device                   dev;            /* device */
  76         char                            *driver_name;   /* Name of the driver module */
  77         struct ir_scancode_table        rc_tab;         /* scan/key table */
  78         unsigned long                   devno;          /* device number */
  79         const struct ir_dev_props       *props;         /* Device properties */
  80         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  81
  82         /* key info - needed by IR keycode handlers */
  83         u32                             keycode;        /* linux key code */
  84         int                             keypressed;     /* current state */
  85 };
  86
  87 struct ir_raw_handler {
  88         struct list_head list;
  89
  90         int (*decode)(struct input_dev *input_dev,
  91                       struct ir_raw_event *evs,
  92                       int len);
  93         int (*raw_register)(struct input_dev *input_dev);
  94         int (*raw_unregister)(struct input_dev *input_dev);
  95 };
  96
  97 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
  98
  99 #define IR_KEYTABLE(a)                                  \
 100 ir_codes_ ## a ## _table
 101
 102 #define DECLARE_IR_KEYTABLE(a)                                  \
 103 extern struct ir_scancode_table IR_KEYTABLE(a)
 104
 105 #define DEFINE_IR_KEYTABLE(tabname, type)                       \
 106 struct ir_scancode_table IR_KEYTABLE(tabname) = {               \
 107         .scan = tabname,                                        \
 108         .size = ARRAY_SIZE(tabname),                            \
 109         .ir_type = type,                                        \
 110         .name = #tabname,                                       \
 111 };                                                              \
 112 EXPORT_SYMBOL_GPL(IR_KEYTABLE(tabname))
 113
 114 #define DEFINE_LEGACY_IR_KEYTABLE(tabname)                      \
 115         DEFINE_IR_KEYTABLE(tabname, IR_TYPE_UNKNOWN)
 116
 117 /* Routines from ir-keytable.c */
 118
 119 u32 ir_g_keycode_from_table(struct input_dev *input_dev,
 120                             u32 scancode);
 121 void ir_keyup(struct input_dev *dev);
 122 void ir_keydown(struct input_dev *dev, int scancode);
 123 int ir_input_register(struct input_dev *dev,
 124                       const struct ir_scancode_table *ir_codes,
 125                       const struct ir_dev_props *props,
 126                       const char *driver_name);
 127 void ir_input_unregister(struct input_dev *input_dev);
 128
 129 /* Routines from ir-sysfs.c */
 130
 131 int ir_register_class(struct input_dev *input_dev);
 132 void ir_unregister_class(struct input_dev *input_dev);
 133
 134 /* Routines from ir-raw-event.c */
 135 int ir_raw_event_register(struct input_dev *input_dev);
 136 void ir_raw_event_unregister(struct input_dev *input_dev);
 137 int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
 138 int ir_raw_event_handle(struct input_dev *input_dev);
 139 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
 140 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
 141 void ir_raw_init(void);
 142
 143 /* from ir-nec-decoder.c */
 144 #ifdef CONFIG_IR_NEC_DECODER_MODULE
 145 #define load_nec_decode()       request_module("ir-nec-decoder")
 146 #else
 147 #define load_nec_decode()       0
 148 #endif
 149
 150 #endif /* _IR_CORE */