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