V4L/DVB: ir-core/saa7134: Move ir keyup/keydown code to the ir-core
[safe/jmp/linux-2.6] / 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
22 extern int ir_core_debug;
23 #define IR_dprintk(level, fmt, arg...)  if (ir_core_debug >= level) \
24         printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
25
26 #define IR_TYPE_UNKNOWN 0
27 #define IR_TYPE_RC5     (1  << 0)       /* Philips RC5 protocol */
28 #define IR_TYPE_PD      (1  << 1)       /* Pulse distance encoded IR */
29 #define IR_TYPE_NEC     (1  << 2)
30 #define IR_TYPE_OTHER   (((u64)1) << 63l)
31
32 enum raw_event_type {
33         IR_SPACE        = (1 << 0),
34         IR_PULSE        = (1 << 1),
35         IR_START_EVENT  = (1 << 2),
36         IR_STOP_EVENT   = (1 << 3),
37 };
38
39 struct ir_scancode {
40         u16     scancode;
41         u32     keycode;
42 };
43
44 struct ir_scancode_table {
45         struct ir_scancode      *scan;
46         int                     size;
47         u64                     ir_type;
48         char                    *name;
49         spinlock_t              lock;
50 };
51
52 struct ir_dev_props {
53         unsigned long allowed_protos;
54         void            *priv;
55         int (*change_protocol)(void *priv, u64 ir_type);
56 };
57
58 struct ir_raw_event {
59         struct timespec         delta;  /* Time spent before event */
60         enum raw_event_type     type;   /* event type */
61 };
62
63 struct ir_raw_event_ctrl {
64         struct kfifo                    kfifo;          /* fifo for the pulse/space events */
65         struct timespec                 last_event;     /* when last event occurred */
66 };
67
68 struct ir_input_dev {
69         struct device                   dev;            /* device */
70         char                            *driver_name;   /* Name of the driver module */
71         struct ir_scancode_table        rc_tab;         /* scan/key table */
72         unsigned long                   devno;          /* device number */
73         const struct ir_dev_props       *props;         /* Device properties */
74         struct ir_raw_event_ctrl        *raw;           /* for raw pulse/space events */
75
76         /* key info - needed by IR keycode handlers */
77         u32                             keycode;        /* linux key code */
78         int                             keypressed;     /* current state */
79 };
80
81 #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
82
83 /* Routines from ir-keytable.c */
84
85 u32 ir_g_keycode_from_table(struct input_dev *input_dev,
86                             u32 scancode);
87 void ir_keyup(struct input_dev *dev);
88 void ir_keydown(struct input_dev *dev, int scancode);
89 int ir_input_register(struct input_dev *dev,
90                       const struct ir_scancode_table *ir_codes,
91                       const struct ir_dev_props *props,
92                       const char *driver_name);
93 void ir_input_unregister(struct input_dev *input_dev);
94
95 /* Routines from ir-sysfs.c */
96
97 int ir_register_class(struct input_dev *input_dev);
98 void ir_unregister_class(struct input_dev *input_dev);
99
100 /* Routines from ir-raw-event.c */
101 int ir_raw_event_register(struct input_dev *input_dev);
102 void ir_raw_event_unregister(struct input_dev *input_dev);
103 int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type);
104 int ir_raw_event_handle(struct input_dev *input_dev);
105
106 /* from ir-nec-decoder.c */
107 int ir_nec_decode(struct input_dev *input_dev,
108                   struct ir_raw_event *evs,
109                   int len);
110
111
112 #endif