[media] rc-core: split dev->s_filter
[deliverable/linux.git] / include / media / rc-core.h
CommitLineData
446e4a64
MCC
1/*
2 * Remote Controller core header
3 *
37e59f87 4 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
995187be 5 *
446e4a64
MCC
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
ca86674b
MCC
16#ifndef _RC_CORE
17#define _RC_CORE
446e4a64 18
446e4a64 19#include <linux/spinlock.h>
a3572c34
MCC
20#include <linux/kfifo.h>
21#include <linux/time.h>
9f154782 22#include <linux/timer.h>
02858eed 23#include <media/rc-map.h>
446e4a64 24
6bda9644 25extern int rc_core_debug;
86b0dbef
JP
26#define IR_dprintk(level, fmt, ...) \
27do { \
28 if (rc_core_debug >= level) \
29 pr_debug("%s: " fmt, __func__, ##__VA_ARGS__); \
30} while (0)
446e4a64 31
626cf697
MCC
32enum rc_driver_type {
33 RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
34 RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */
35};
36
00942d1a
JH
37/**
38 * struct rc_scancode_filter - Filter scan codes.
39 * @data: Scancode data to match.
40 * @mask: Mask of bits of scancode to compare.
41 */
42struct rc_scancode_filter {
43 u32 data;
44 u32 mask;
45};
46
47/**
48 * enum rc_filter_type - Filter type constants.
49 * @RC_FILTER_NORMAL: Filter for normal operation.
50 * @RC_FILTER_WAKEUP: Filter for waking from suspend.
51 * @RC_FILTER_MAX: Number of filter types.
52 */
53enum rc_filter_type {
54 RC_FILTER_NORMAL = 0,
55 RC_FILTER_WAKEUP,
56
57 RC_FILTER_MAX
58};
59
9dfe4e83 60/**
d8b4b582
DH
61 * struct rc_dev - represents a remote control device
62 * @dev: driver model's view of this device
63 * @input_name: name of the input child device
64 * @input_phys: physical path to the input child device
65 * @input_id: id of the input child device (struct input_id)
66 * @driver_name: name of the hardware driver which registered this device
67 * @map_name: name of the default keymap
b088ba65 68 * @rc_map: current scan/key table
08aeb7c9
JW
69 * @lock: used to ensure we've filled in all protocol details before
70 * anyone can call show_protocols or store_protocols
d8b4b582
DH
71 * @devno: unique remote control device number
72 * @raw: additional data for raw pulse/space devices
73 * @input_dev: the input child device used to communicate events to userspace
08aeb7c9 74 * @driver_type: specifies if protocol decoding is done in hardware or software
d8b4b582 75 * @idle: used to keep track of RX state
acff5f24
JH
76 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols for each
77 * filter type
78 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols for each
79 * filter type
9dfe4e83
MCC
80 * @scanmask: some hardware decoders are not capable of providing the full
81 * scancode to the application. As this is a hardware limit, we can't do
82 * anything with it. Yet, as the same keycode table can be used with other
83 * devices, a mask is provided to allow its usage. Drivers should generally
84 * leave this field in blank
d8b4b582
DH
85 * @priv: driver-specific data
86 * @keylock: protects the remaining members of the struct
87 * @keypressed: whether a key is currently pressed
88 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
89 * @timer_keyup: timer for releasing a keypress
90 * @last_keycode: keycode of last keypress
91 * @last_scancode: scancode of last keypress
92 * @last_toggle: toggle value of last command
4a702ebf
ML
93 * @timeout: optional time after which device stops sending data
94 * @min_timeout: minimum timeout supported by device
95 * @max_timeout: maximum timeout supported by device
e589333f
ML
96 * @rx_resolution : resolution (in ns) of input sampler
97 * @tx_resolution: resolution (in ns) of output sampler
00942d1a 98 * @scancode_filters: scancode filters (indexed by enum rc_filter_type)
9dfe4e83 99 * @change_protocol: allow changing the protocol used on hardware decoders
ab88c66d
JH
100 * @change_wakeup_protocol: allow changing the protocol used for wakeup
101 * filtering
9dfe4e83
MCC
102 * @open: callback to allow drivers to enable polling/irq when IR input device
103 * is opened.
104 * @close: callback to allow drivers to disable polling/irq when IR input device
105 * is opened.
9b7c54d9
JW
106 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
107 * @s_tx_carrier: set transmit carrier frequency
e589333f
ML
108 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
109 * @s_rx_carrier: inform driver about carrier it is expected to handle
9b7c54d9 110 * @tx_ir: transmit IR
d8b4b582
DH
111 * @s_idle: enable/disable hardware idle mode, upon which,
112 * device doesn't interrupt host until it sees IR pulses
e589333f 113 * @s_learning_mode: enable wide band receiver used for learning
4651918a 114 * @s_carrier_report: enable carrier reports
23c843b5
DH
115 * @s_filter: set the scancode filter
116 * @s_wakeup_filter: set the wakeup scancode filter
9dfe4e83 117 */
d8b4b582
DH
118struct rc_dev {
119 struct device dev;
120 const char *input_name;
121 const char *input_phys;
122 struct input_id input_id;
123 char *driver_name;
124 const char *map_name;
08aeb7c9
JW
125 struct rc_map rc_map;
126 struct mutex lock;
d8b4b582
DH
127 unsigned long devno;
128 struct ir_raw_event_ctrl *raw;
129 struct input_dev *input_dev;
130 enum rc_driver_type driver_type;
4a702ebf 131 bool idle;
acff5f24
JH
132 u64 allowed_protocols[RC_FILTER_MAX];
133 u64 enabled_protocols[RC_FILTER_MAX];
8b2ff320 134 u32 users;
d8b4b582
DH
135 u32 scanmask;
136 void *priv;
137 spinlock_t keylock;
138 bool keypressed;
139 unsigned long keyup_jiffies;
140 struct timer_list timer_keyup;
141 u32 last_keycode;
142 u32 last_scancode;
143 u8 last_toggle;
144 u32 timeout;
145 u32 min_timeout;
146 u32 max_timeout;
147 u32 rx_resolution;
148 u32 tx_resolution;
00942d1a 149 struct rc_scancode_filter scancode_filters[RC_FILTER_MAX];
c003ab1b 150 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
ab88c66d 151 int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type);
d8b4b582
DH
152 int (*open)(struct rc_dev *dev);
153 void (*close)(struct rc_dev *dev);
154 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
155 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
156 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
157 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
5588dc2b 158 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
d8b4b582
DH
159 void (*s_idle)(struct rc_dev *dev, bool enable);
160 int (*s_learning_mode)(struct rc_dev *dev, int enable);
161 int (*s_carrier_report) (struct rc_dev *dev, int enable);
00942d1a 162 int (*s_filter)(struct rc_dev *dev,
00942d1a 163 struct rc_scancode_filter *filter);
23c843b5
DH
164 int (*s_wakeup_filter)(struct rc_dev *dev,
165 struct rc_scancode_filter *filter);
75543cce 166};
a3572c34 167
ca86674b
MCC
168#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
169
1a1934fa
JH
170static inline bool rc_protocols_allowed(struct rc_dev *rdev, u64 protos)
171{
acff5f24 172 return rdev->allowed_protocols[RC_FILTER_NORMAL] & protos;
1a1934fa
JH
173}
174
175/* should be called prior to registration or with mutex held */
176static inline void rc_set_allowed_protocols(struct rc_dev *rdev, u64 protos)
177{
acff5f24 178 rdev->allowed_protocols[RC_FILTER_NORMAL] = protos;
1a1934fa
JH
179}
180
181static inline bool rc_protocols_enabled(struct rc_dev *rdev, u64 protos)
182{
acff5f24 183 return rdev->enabled_protocols[RC_FILTER_NORMAL] & protos;
1a1934fa
JH
184}
185
186/* should be called prior to registration or with mutex held */
187static inline void rc_set_enabled_protocols(struct rc_dev *rdev, u64 protos)
188{
acff5f24
JH
189 rdev->enabled_protocols[RC_FILTER_NORMAL] = protos;
190}
191
192/* should be called prior to registration or with mutex held */
193static inline void rc_set_allowed_wakeup_protocols(struct rc_dev *rdev,
194 u64 protos)
195{
196 rdev->allowed_protocols[RC_FILTER_WAKEUP] = protos;
197}
198
199/* should be called prior to registration or with mutex held */
200static inline void rc_set_enabled_wakeup_protocols(struct rc_dev *rdev,
201 u64 protos)
202{
203 rdev->enabled_protocols[RC_FILTER_WAKEUP] = protos;
1a1934fa
JH
204}
205
ca86674b
MCC
206/*
207 * From rc-main.c
208 * Those functions can be used on any type of Remote Controller. They
209 * basically creates an input_dev and properly reports the device as a
210 * Remote Controller, at sys/class/rc.
211 */
212
213struct rc_dev *rc_allocate_device(void);
214void rc_free_device(struct rc_dev *dev);
215int rc_register_device(struct rc_dev *dev);
216void rc_unregister_device(struct rc_dev *dev);
217
8b2ff320
SK
218int rc_open(struct rc_dev *rdev);
219void rc_close(struct rc_dev *rdev);
220
ca86674b
MCC
221void rc_repeat(struct rc_dev *dev);
222void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
223void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
224void rc_keyup(struct rc_dev *dev);
225u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
226
227/*
228 * From rc-raw.c
229 * The Raw interface is specific to InfraRed. It may be a good idea to
230 * split it later into a separate header.
231 */
232
3f113e36
MCC
233enum raw_event_type {
234 IR_SPACE = (1 << 0),
235 IR_PULSE = (1 << 1),
236 IR_START_EVENT = (1 << 2),
237 IR_STOP_EVENT = (1 << 3),
995187be
MCC
238};
239
e40b1127 240struct ir_raw_event {
4651918a
ML
241 union {
242 u32 duration;
243
244 struct {
245 u32 carrier;
246 u8 duty_cycle;
247 };
248 };
249
250 unsigned pulse:1;
251 unsigned reset:1;
252 unsigned timeout:1;
253 unsigned carrier_report:1;
e40b1127
DH
254};
255
4651918a
ML
256#define DEFINE_IR_RAW_EVENT(event) \
257 struct ir_raw_event event = { \
258 { .duration = 0 } , \
259 .pulse = 0, \
260 .reset = 0, \
261 .timeout = 0, \
262 .carrier_report = 0 }
263
264static inline void init_ir_raw_event(struct ir_raw_event *ev)
265{
266 memset(ev, 0, sizeof(*ev));
267}
268
269#define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
5aad7242
JW
270#define US_TO_NS(usec) ((usec) * 1000)
271#define MS_TO_US(msec) ((msec) * 1000)
272#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
e40b1127 273
d8b4b582
DH
274void ir_raw_event_handle(struct rc_dev *dev);
275int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
276int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
277int ir_raw_event_store_with_filter(struct rc_dev *dev,
4a702ebf 278 struct ir_raw_event *ev);
d8b4b582 279void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
4a702ebf 280
d8b4b582 281static inline void ir_raw_event_reset(struct rc_dev *dev)
e40b1127 282{
4651918a
ML
283 DEFINE_IR_RAW_EVENT(ev);
284 ev.reset = true;
285
d8b4b582
DH
286 ir_raw_event_store(dev, &ev);
287 ir_raw_event_handle(dev);
e40b1127 288}
724e2495 289
3ffea498
DH
290/* extract mask bits out of data and pack them into the result */
291static inline u32 ir_extract_bits(u32 data, u32 mask)
292{
293 u32 vbit = 1, value = 0;
294
295 do {
829ba9fe
DH
296 if (mask & 1) {
297 if (data & 1)
298 value |= vbit;
299 vbit <<= 1;
300 }
301 data >>= 1;
3ffea498
DH
302 } while (mask >>= 1);
303
304 return value;
305}
306
ca86674b 307#endif /* _RC_CORE */
This page took 0.222138 seconds and 5 git commands to generate.