2963263f31e213d785d6e17cee3c0863c1e9a201
[linux-2.6.git] / include / media / rc-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 _RC_CORE
17 #define _RC_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 rc_core_debug;
26 #define IR_dprintk(level, fmt, arg...)  if (rc_core_debug >= level) \
27         printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
28
29 enum rc_driver_type {
30         RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
31         RC_DRIVER_IR_RAW,       /* Needs a Infra-Red pulse/space decoder */
32 };
33
34 /**
35  * struct rc_dev - represents a remote control device
36  * @dev: driver model's view of this device
37  * @input_name: name of the input child device
38  * @input_phys: physical path to the input child device
39  * @input_id: id of the input child device (struct input_id)
40  * @driver_name: name of the hardware driver which registered this device
41  * @map_name: name of the default keymap
42  * @rc_map: current scan/key table
43  * @devno: unique remote control device number
44  * @raw: additional data for raw pulse/space devices
45  * @input_dev: the input child device used to communicate events to userspace
46  * @driver_type: specifies if protocol decoding is done in hardware or software 
47  * @idle: used to keep track of RX state
48  * @allowed_protos: bitmask with the supported RC_TYPE_* protocols
49  * @scanmask: some hardware decoders are not capable of providing the full
50  *      scancode to the application. As this is a hardware limit, we can't do
51  *      anything with it. Yet, as the same keycode table can be used with other
52  *      devices, a mask is provided to allow its usage. Drivers should generally
53  *      leave this field in blank
54  * @priv: driver-specific data
55  * @keylock: protects the remaining members of the struct
56  * @keypressed: whether a key is currently pressed
57  * @keyup_jiffies: time (in jiffies) when the current keypress should be released
58  * @timer_keyup: timer for releasing a keypress
59  * @last_keycode: keycode of last keypress
60  * @last_scancode: scancode of last keypress
61  * @last_toggle: toggle value of last command
62  * @timeout: optional time after which device stops sending data
63  * @min_timeout: minimum timeout supported by device
64  * @max_timeout: maximum timeout supported by device
65  * @rx_resolution : resolution (in ns) of input sampler
66  * @tx_resolution: resolution (in ns) of output sampler
67  * @change_protocol: allow changing the protocol used on hardware decoders
68  * @open: callback to allow drivers to enable polling/irq when IR input device
69  *      is opened.
70  * @close: callback to allow drivers to disable polling/irq when IR input device
71  *      is opened.
72  * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
73  * @s_tx_carrier: set transmit carrier frequency
74  * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
75  * @s_rx_carrier: inform driver about carrier it is expected to handle
76  * @tx_ir: transmit IR
77  * @s_idle: enable/disable hardware idle mode, upon which,
78  *      device doesn't interrupt host until it sees IR pulses
79  * @s_learning_mode: enable wide band receiver used for learning
80  * @s_carrier_report: enable carrier reports
81  */
82 struct rc_dev {
83         struct device                   dev;
84         const char                      *input_name;
85         const char                      *input_phys;
86         struct input_id                 input_id;
87         char                            *driver_name;
88         const char                      *map_name;
89         struct rc_map   rc_map;
90         unsigned long                   devno;
91         struct ir_raw_event_ctrl        *raw;
92         struct input_dev                *input_dev;
93         enum rc_driver_type             driver_type;
94         bool                            idle;
95         u64                             allowed_protos;
96         u32                             scanmask;
97         void                            *priv;
98         spinlock_t                      keylock;
99         bool                            keypressed;
100         unsigned long                   keyup_jiffies;
101         struct timer_list               timer_keyup;
102         u32                             last_keycode;
103         u32                             last_scancode;
104         u8                              last_toggle;
105         u32                             timeout;
106         u32                             min_timeout;
107         u32                             max_timeout;
108         u32                             rx_resolution;
109         u32                             tx_resolution;
110         int                             (*change_protocol)(struct rc_dev *dev, u64 rc_type);
111         int                             (*open)(struct rc_dev *dev);
112         void                            (*close)(struct rc_dev *dev);
113         int                             (*s_tx_mask)(struct rc_dev *dev, u32 mask);
114         int                             (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
115         int                             (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
116         int                             (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
117         int                             (*tx_ir)(struct rc_dev *dev, int *txbuf, u32 n);
118         void                            (*s_idle)(struct rc_dev *dev, bool enable);
119         int                             (*s_learning_mode)(struct rc_dev *dev, int enable);
120         int                             (*s_carrier_report) (struct rc_dev *dev, int enable);
121 };
122
123 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
124
125 /*
126  * From rc-main.c
127  * Those functions can be used on any type of Remote Controller. They
128  * basically creates an input_dev and properly reports the device as a
129  * Remote Controller, at sys/class/rc.
130  */
131
132 struct rc_dev *rc_allocate_device(void);
133 void rc_free_device(struct rc_dev *dev);
134 int rc_register_device(struct rc_dev *dev);
135 void rc_unregister_device(struct rc_dev *dev);
136
137 void rc_repeat(struct rc_dev *dev);
138 void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
139 void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
140 void rc_keyup(struct rc_dev *dev);
141 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
142
143 /*
144  * From rc-raw.c
145  * The Raw interface is specific to InfraRed. It may be a good idea to
146  * split it later into a separate header.
147  */
148
149 enum raw_event_type {
150         IR_SPACE        = (1 << 0),
151         IR_PULSE        = (1 << 1),
152         IR_START_EVENT  = (1 << 2),
153         IR_STOP_EVENT   = (1 << 3),
154 };
155
156 struct ir_raw_event {
157         union {
158                 u32             duration;
159
160                 struct {
161                         u32     carrier;
162                         u8      duty_cycle;
163                 };
164         };
165
166         unsigned                pulse:1;
167         unsigned                reset:1;
168         unsigned                timeout:1;
169         unsigned                carrier_report:1;
170 };
171
172 #define DEFINE_IR_RAW_EVENT(event) \
173         struct ir_raw_event event = { \
174                 { .duration = 0 } , \
175                 .pulse = 0, \
176                 .reset = 0, \
177                 .timeout = 0, \
178                 .carrier_report = 0 }
179
180 static inline void init_ir_raw_event(struct ir_raw_event *ev)
181 {
182         memset(ev, 0, sizeof(*ev));
183 }
184
185 #define IR_MAX_DURATION         0xFFFFFFFF      /* a bit more than 4 seconds */
186 #define US_TO_NS(usec)          ((usec) * 1000)
187 #define MS_TO_US(msec)          ((msec) * 1000)
188 #define MS_TO_NS(msec)          ((msec) * 1000 * 1000)
189
190 void ir_raw_event_handle(struct rc_dev *dev);
191 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
192 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
193 int ir_raw_event_store_with_filter(struct rc_dev *dev,
194                                 struct ir_raw_event *ev);
195 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
196
197 static inline void ir_raw_event_reset(struct rc_dev *dev)
198 {
199         DEFINE_IR_RAW_EVENT(ev);
200         ev.reset = true;
201
202         ir_raw_event_store(dev, &ev);
203         ir_raw_event_handle(dev);
204 }
205
206 /* extract mask bits out of data and pack them into the result */
207 static inline u32 ir_extract_bits(u32 data, u32 mask)
208 {
209         u32 vbit = 1, value = 0;
210
211         do {
212                 if (mask & 1) {
213                         if (data & 1)
214                                 value |= vbit;
215                         vbit <<= 1;
216                 }
217                 data >>= 1;
218         } while (mask >>= 1);
219
220         return value;
221 }
222
223 #endif /* _RC_CORE */