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/spinlock.h>
  20 #include <linux/kfifo.h>
  21 #include <linux/time.h>
  22 #include <linux/timer.h>
  23 #include <media/rc-map.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 enum raw_event_type {
  30         IR_SPACE        = (1 << 0),
  31         IR_PULSE        = (1 << 1),
  32         IR_START_EVENT  = (1 << 2),
  33         IR_STOP_EVENT   = (1 << 3),
  34 };
  35
  36 struct ir_dev_props {
  37         unsigned long allowed_protos;
  38         void            *priv;
  39         int (*change_protocol)(void *priv, u64 ir_type);
  40         int (*open)(void *priv);
  41         void (*close)(void *priv);
  42 };
  43
  44 struct ir_raw_event {
  45         struct timespec         delta;  /* Time spent before event */
  46         enum raw_event_type     type;   /* event type */
  47 };
  48
  49 struct ir_raw_event_ctrl {
  50         struct kfifo                    kfifo;          /* fifo for the pulse/space events */
  51         struct timespec                 last_event;     /* when last event occurred */
  52 };
  53
  54 struct ir_input_dev {
  55         struct device                   dev;            /* device */
  56         char                            *driver_name;   /* Name of the driver module */
  57         struct ir_scancode_table        rc_tab;         /* scan/key table */
  58         unsigned long                   devno;          /* device number */
  59         const struct ir_dev_props       *props;         /* Device properties */
  60         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
  61         struct input_dev                *input_dev;     /* the input device associated with this device */
  62
  63         /* key info - needed by IR keycode handlers */
  64         spinlock_t                      keylock;        /* protects the below members */
  65         bool                            keypressed;     /* current state */
  66         unsigned long                   keyup_jiffies;  /* when should the current keypress be released? */
  67         struct timer_list               timer_keyup;    /* timer for releasing a keypress */
  68         u32                             last_keycode;   /* keycode of last command */
  69         u32                             last_scancode;  /* scancode of last command */
  70         u8                              last_toggle;    /* toggle of last command */
  71 };
  72
  73 struct ir_raw_handler {
  74         struct list_head list;
  75
  76         int (*decode)(struct input_dev *input_dev,
  77                       struct ir_raw_event *ev);
  78         int (*raw_register)(struct input_dev *input_dev);
  79         int (*raw_unregister)(struct input_dev *input_dev);
  80 };
  81
  82 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
  83
  84 /* Routines from ir-keytable.c */
  85
  86 u32 ir_g_keycode_from_table(struct input_dev *input_dev,
  87                             u32 scancode);
  88 void ir_repeat(struct input_dev *dev);
  89 void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
  90 int __ir_input_register(struct input_dev *dev,
  91                       const struct ir_scancode_table *ir_codes,
  92                       const struct ir_dev_props *props,
  93                       const char *driver_name);
  94
  95 static inline int ir_input_register(struct input_dev *dev,
  96                       const char *map_name,
  97                       const struct ir_dev_props *props,
  98                       const char *driver_name) {
  99         struct ir_scancode_table *ir_codes;
 100         struct ir_input_dev *ir_dev;
 101         int rc;
 102
 103         if (!map_name)
 104                 return -EINVAL;
 105
 106         ir_codes = get_rc_map(map_name);
 107         if (!ir_codes)
 108                 return -EINVAL;
 109
 110         rc = __ir_input_register(dev, ir_codes, props, driver_name);
 111         if (rc < 0)
 112                 return -EINVAL;
 113
 114         ir_dev = input_get_drvdata(dev);
 115
 116         if (!rc && ir_dev->props && ir_dev->props->change_protocol)
 117                 rc = ir_dev->props->change_protocol(ir_dev->props->priv,
 118                                                     ir_codes->ir_type);
 119
 120         return rc;
 121 }
 122
 123 void ir_input_unregister(struct input_dev *input_dev);
 124
 125 /* Routines from ir-sysfs.c */
 126
 127 int ir_register_class(struct input_dev *input_dev);
 128 void ir_unregister_class(struct input_dev *input_dev);
 129
 130 /* Routines from ir-raw-event.c */
 131 int ir_raw_event_register(struct input_dev *input_dev);
 132 void ir_raw_event_unregister(struct input_dev *input_dev);
 133 int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
 134 int ir_raw_event_handle(struct input_dev *input_dev);
 135 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
 136 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
 137 void ir_raw_init(void);
 138
 139 /* from ir-nec-decoder.c */
 140 #ifdef CONFIG_IR_NEC_DECODER_MODULE
 141 #define load_nec_decode()       request_module("ir-nec-decoder")
 142 #else
 143 #define load_nec_decode()       0
 144 #endif
 145
 146 /* from ir-rc5-decoder.c */
 147 #ifdef CONFIG_IR_RC5_DECODER_MODULE
 148 #define load_rc5_decode()       request_module("ir-rc5-decoder")
 149 #else
 150 #define load_rc5_decode()       0
 151 #endif
 152
 153 #endif /* _IR_CORE */