[media] rc: add allowed/enabled wakeup protocol masks
[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
MCC
99 * @change_protocol: allow changing the protocol used on hardware decoders
100 * @open: callback to allow drivers to enable polling/irq when IR input device
101 * is opened.
102 * @close: callback to allow drivers to disable polling/irq when IR input device
103 * is opened.
9b7c54d9
JW
104 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
105 * @s_tx_carrier: set transmit carrier frequency
e589333f
ML
106 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
107 * @s_rx_carrier: inform driver about carrier it is expected to handle
9b7c54d9 108 * @tx_ir: transmit IR
d8b4b582
DH
109 * @s_idle: enable/disable hardware idle mode, upon which,
110 * device doesn't interrupt host until it sees IR pulses
e589333f 111 * @s_learning_mode: enable wide band receiver used for learning
4651918a 112 * @s_carrier_report: enable carrier reports
00942d1a 113 * @s_filter: set the scancode filter of a given type
9dfe4e83 114 */
d8b4b582
DH
115struct rc_dev {
116 struct device dev;
117 const char *input_name;
118 const char *input_phys;
119 struct input_id input_id;
120 char *driver_name;
121 const char *map_name;
08aeb7c9
JW
122 struct rc_map rc_map;
123 struct mutex lock;
d8b4b582
DH
124 unsigned long devno;
125 struct ir_raw_event_ctrl *raw;
126 struct input_dev *input_dev;
127 enum rc_driver_type driver_type;
4a702ebf 128 bool idle;
acff5f24
JH
129 u64 allowed_protocols[RC_FILTER_MAX];
130 u64 enabled_protocols[RC_FILTER_MAX];
8b2ff320 131 u32 users;
d8b4b582
DH
132 u32 scanmask;
133 void *priv;
134 spinlock_t keylock;
135 bool keypressed;
136 unsigned long keyup_jiffies;
137 struct timer_list timer_keyup;
138 u32 last_keycode;
139 u32 last_scancode;
140 u8 last_toggle;
141 u32 timeout;
142 u32 min_timeout;
143 u32 max_timeout;
144 u32 rx_resolution;
145 u32 tx_resolution;
00942d1a 146 struct rc_scancode_filter scancode_filters[RC_FILTER_MAX];
c003ab1b 147 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
d8b4b582
DH
148 int (*open)(struct rc_dev *dev);
149 void (*close)(struct rc_dev *dev);
150 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
151 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
152 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
153 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
5588dc2b 154 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
d8b4b582
DH
155 void (*s_idle)(struct rc_dev *dev, bool enable);
156 int (*s_learning_mode)(struct rc_dev *dev, int enable);
157 int (*s_carrier_report) (struct rc_dev *dev, int enable);
00942d1a
JH
158 int (*s_filter)(struct rc_dev *dev,
159 enum rc_filter_type type,
160 struct rc_scancode_filter *filter);
75543cce 161};
a3572c34 162
ca86674b
MCC
163#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
164
1a1934fa
JH
165static inline bool rc_protocols_allowed(struct rc_dev *rdev, u64 protos)
166{
acff5f24 167 return rdev->allowed_protocols[RC_FILTER_NORMAL] & protos;
1a1934fa
JH
168}
169
170/* should be called prior to registration or with mutex held */
171static inline void rc_set_allowed_protocols(struct rc_dev *rdev, u64 protos)
172{
acff5f24 173 rdev->allowed_protocols[RC_FILTER_NORMAL] = protos;
1a1934fa
JH
174}
175
176static inline bool rc_protocols_enabled(struct rc_dev *rdev, u64 protos)
177{
acff5f24 178 return rdev->enabled_protocols[RC_FILTER_NORMAL] & protos;
1a1934fa
JH
179}
180
181/* should be called prior to registration or with mutex held */
182static inline void rc_set_enabled_protocols(struct rc_dev *rdev, u64 protos)
183{
acff5f24
JH
184 rdev->enabled_protocols[RC_FILTER_NORMAL] = protos;
185}
186
187/* should be called prior to registration or with mutex held */
188static inline void rc_set_allowed_wakeup_protocols(struct rc_dev *rdev,
189 u64 protos)
190{
191 rdev->allowed_protocols[RC_FILTER_WAKEUP] = protos;
192}
193
194/* should be called prior to registration or with mutex held */
195static inline void rc_set_enabled_wakeup_protocols(struct rc_dev *rdev,
196 u64 protos)
197{
198 rdev->enabled_protocols[RC_FILTER_WAKEUP] = protos;
1a1934fa
JH
199}
200
ca86674b
MCC
201/*
202 * From rc-main.c
203 * Those functions can be used on any type of Remote Controller. They
204 * basically creates an input_dev and properly reports the device as a
205 * Remote Controller, at sys/class/rc.
206 */
207
208struct rc_dev *rc_allocate_device(void);
209void rc_free_device(struct rc_dev *dev);
210int rc_register_device(struct rc_dev *dev);
211void rc_unregister_device(struct rc_dev *dev);
212
8b2ff320
SK
213int rc_open(struct rc_dev *rdev);
214void rc_close(struct rc_dev *rdev);
215
ca86674b
MCC
216void rc_repeat(struct rc_dev *dev);
217void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
218void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
219void rc_keyup(struct rc_dev *dev);
220u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
221
222/*
223 * From rc-raw.c
224 * The Raw interface is specific to InfraRed. It may be a good idea to
225 * split it later into a separate header.
226 */
227
3f113e36
MCC
228enum raw_event_type {
229 IR_SPACE = (1 << 0),
230 IR_PULSE = (1 << 1),
231 IR_START_EVENT = (1 << 2),
232 IR_STOP_EVENT = (1 << 3),
995187be
MCC
233};
234
e40b1127 235struct ir_raw_event {
4651918a
ML
236 union {
237 u32 duration;
238
239 struct {
240 u32 carrier;
241 u8 duty_cycle;
242 };
243 };
244
245 unsigned pulse:1;
246 unsigned reset:1;
247 unsigned timeout:1;
248 unsigned carrier_report:1;
e40b1127
DH
249};
250
4651918a
ML
251#define DEFINE_IR_RAW_EVENT(event) \
252 struct ir_raw_event event = { \
253 { .duration = 0 } , \
254 .pulse = 0, \
255 .reset = 0, \
256 .timeout = 0, \
257 .carrier_report = 0 }
258
259static inline void init_ir_raw_event(struct ir_raw_event *ev)
260{
261 memset(ev, 0, sizeof(*ev));
262}
263
264#define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
5aad7242
JW
265#define US_TO_NS(usec) ((usec) * 1000)
266#define MS_TO_US(msec) ((msec) * 1000)
267#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
e40b1127 268
d8b4b582
DH
269void ir_raw_event_handle(struct rc_dev *dev);
270int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
271int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
272int ir_raw_event_store_with_filter(struct rc_dev *dev,
4a702ebf 273 struct ir_raw_event *ev);
d8b4b582 274void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
4a702ebf 275
d8b4b582 276static inline void ir_raw_event_reset(struct rc_dev *dev)
e40b1127 277{
4651918a
ML
278 DEFINE_IR_RAW_EVENT(ev);
279 ev.reset = true;
280
d8b4b582
DH
281 ir_raw_event_store(dev, &ev);
282 ir_raw_event_handle(dev);
e40b1127 283}
724e2495 284
3ffea498
DH
285/* extract mask bits out of data and pack them into the result */
286static inline u32 ir_extract_bits(u32 data, u32 mask)
287{
288 u32 vbit = 1, value = 0;
289
290 do {
829ba9fe
DH
291 if (mask & 1) {
292 if (data & 1)
293 value |= vbit;
294 vbit <<= 1;
295 }
296 data >>= 1;
3ffea498
DH
297 } while (mask >>= 1);
298
299 return value;
300}
301
ca86674b 302#endif /* _RC_CORE */
This page took 0.291948 seconds and 5 git commands to generate.