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