include/media/ir-core.h

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