Commit | Line | Data |
---|---|---|
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 | 25 | extern int rc_core_debug; |
86b0dbef JP |
26 | #define IR_dprintk(level, fmt, ...) \ |
27 | do { \ | |
28 | if (rc_core_debug >= level) \ | |
7cec72ce | 29 | printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \ |
86b0dbef | 30 | } while (0) |
446e4a64 | 31 | |
626cf697 MCC |
32 | enum 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 | */ | |
42 | struct 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 | */ | |
53 | enum 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 |
0d830b2d JH |
77 | * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed |
78 | * wakeup protocols is the set of all raw encoders | |
c5540fbb DH |
79 | * @allowed_protocols: bitmask with the supported RC_BIT_* protocols |
80 | * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols | |
81 | * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols | |
82 | * @enabled_wakeup_protocols: bitmask with the enabled RC_BIT_* wakeup protocols | |
83 | * @scancode_filter: scancode filter | |
84 | * @scancode_wakeup_filter: scancode wakeup filters | |
9d2f1d3c | 85 | * @scancode_mask: some hardware decoders are not capable of providing the full |
9dfe4e83 MCC |
86 | * scancode to the application. As this is a hardware limit, we can't do |
87 | * anything with it. Yet, as the same keycode table can be used with other | |
88 | * devices, a mask is provided to allow its usage. Drivers should generally | |
89 | * leave this field in blank | |
9d2f1d3c | 90 | * @users: number of current users of the device |
d8b4b582 DH |
91 | * @priv: driver-specific data |
92 | * @keylock: protects the remaining members of the struct | |
93 | * @keypressed: whether a key is currently pressed | |
94 | * @keyup_jiffies: time (in jiffies) when the current keypress should be released | |
95 | * @timer_keyup: timer for releasing a keypress | |
96 | * @last_keycode: keycode of last keypress | |
120703f9 | 97 | * @last_protocol: protocol of last keypress |
d8b4b582 DH |
98 | * @last_scancode: scancode of last keypress |
99 | * @last_toggle: toggle value of last command | |
4a702ebf ML |
100 | * @timeout: optional time after which device stops sending data |
101 | * @min_timeout: minimum timeout supported by device | |
102 | * @max_timeout: maximum timeout supported by device | |
e589333f ML |
103 | * @rx_resolution : resolution (in ns) of input sampler |
104 | * @tx_resolution: resolution (in ns) of output sampler | |
9dfe4e83 | 105 | * @change_protocol: allow changing the protocol used on hardware decoders |
ab88c66d JH |
106 | * @change_wakeup_protocol: allow changing the protocol used for wakeup |
107 | * filtering | |
9dfe4e83 MCC |
108 | * @open: callback to allow drivers to enable polling/irq when IR input device |
109 | * is opened. | |
110 | * @close: callback to allow drivers to disable polling/irq when IR input device | |
111 | * is opened. | |
9b7c54d9 JW |
112 | * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs) |
113 | * @s_tx_carrier: set transmit carrier frequency | |
e589333f ML |
114 | * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%) |
115 | * @s_rx_carrier: inform driver about carrier it is expected to handle | |
9b7c54d9 | 116 | * @tx_ir: transmit IR |
d8b4b582 DH |
117 | * @s_idle: enable/disable hardware idle mode, upon which, |
118 | * device doesn't interrupt host until it sees IR pulses | |
e589333f | 119 | * @s_learning_mode: enable wide band receiver used for learning |
4651918a | 120 | * @s_carrier_report: enable carrier reports |
120703f9 | 121 | * @s_filter: set the scancode filter |
23c843b5 | 122 | * @s_wakeup_filter: set the wakeup scancode filter |
9dfe4e83 | 123 | */ |
d8b4b582 DH |
124 | struct rc_dev { |
125 | struct device dev; | |
99b0f3c9 | 126 | const struct attribute_group *sysfs_groups[5]; |
d8b4b582 DH |
127 | const char *input_name; |
128 | const char *input_phys; | |
129 | struct input_id input_id; | |
130 | char *driver_name; | |
131 | const char *map_name; | |
08aeb7c9 JW |
132 | struct rc_map rc_map; |
133 | struct mutex lock; | |
d8b4b582 DH |
134 | unsigned long devno; |
135 | struct ir_raw_event_ctrl *raw; | |
136 | struct input_dev *input_dev; | |
137 | enum rc_driver_type driver_type; | |
4a702ebf | 138 | bool idle; |
0d830b2d | 139 | bool encode_wakeup; |
c5540fbb DH |
140 | u64 allowed_protocols; |
141 | u64 enabled_protocols; | |
142 | u64 allowed_wakeup_protocols; | |
143 | u64 enabled_wakeup_protocols; | |
144 | struct rc_scancode_filter scancode_filter; | |
145 | struct rc_scancode_filter scancode_wakeup_filter; | |
9d2f1d3c | 146 | u32 scancode_mask; |
8b2ff320 | 147 | u32 users; |
d8b4b582 DH |
148 | void *priv; |
149 | spinlock_t keylock; | |
150 | bool keypressed; | |
151 | unsigned long keyup_jiffies; | |
152 | struct timer_list timer_keyup; | |
153 | u32 last_keycode; | |
120703f9 | 154 | enum rc_type last_protocol; |
d8b4b582 DH |
155 | u32 last_scancode; |
156 | u8 last_toggle; | |
157 | u32 timeout; | |
158 | u32 min_timeout; | |
159 | u32 max_timeout; | |
160 | u32 rx_resolution; | |
161 | u32 tx_resolution; | |
c003ab1b | 162 | int (*change_protocol)(struct rc_dev *dev, u64 *rc_type); |
ab88c66d | 163 | int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type); |
d8b4b582 DH |
164 | int (*open)(struct rc_dev *dev); |
165 | void (*close)(struct rc_dev *dev); | |
166 | int (*s_tx_mask)(struct rc_dev *dev, u32 mask); | |
167 | int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier); | |
168 | int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle); | |
169 | int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max); | |
5588dc2b | 170 | int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n); |
d8b4b582 DH |
171 | void (*s_idle)(struct rc_dev *dev, bool enable); |
172 | int (*s_learning_mode)(struct rc_dev *dev, int enable); | |
173 | int (*s_carrier_report) (struct rc_dev *dev, int enable); | |
00942d1a | 174 | int (*s_filter)(struct rc_dev *dev, |
00942d1a | 175 | struct rc_scancode_filter *filter); |
23c843b5 DH |
176 | int (*s_wakeup_filter)(struct rc_dev *dev, |
177 | struct rc_scancode_filter *filter); | |
75543cce | 178 | }; |
a3572c34 | 179 | |
ca86674b MCC |
180 | #define to_rc_dev(d) container_of(d, struct rc_dev, dev) |
181 | ||
182 | /* | |
183 | * From rc-main.c | |
184 | * Those functions can be used on any type of Remote Controller. They | |
185 | * basically creates an input_dev and properly reports the device as a | |
186 | * Remote Controller, at sys/class/rc. | |
187 | */ | |
188 | ||
189 | struct rc_dev *rc_allocate_device(void); | |
190 | void rc_free_device(struct rc_dev *dev); | |
191 | int rc_register_device(struct rc_dev *dev); | |
192 | void rc_unregister_device(struct rc_dev *dev); | |
193 | ||
8b2ff320 SK |
194 | int rc_open(struct rc_dev *rdev); |
195 | void rc_close(struct rc_dev *rdev); | |
196 | ||
ca86674b | 197 | void rc_repeat(struct rc_dev *dev); |
120703f9 DH |
198 | void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle); |
199 | void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle); | |
ca86674b MCC |
200 | void rc_keyup(struct rc_dev *dev); |
201 | u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode); | |
202 | ||
203 | /* | |
204 | * From rc-raw.c | |
205 | * The Raw interface is specific to InfraRed. It may be a good idea to | |
206 | * split it later into a separate header. | |
207 | */ | |
208 | ||
3f113e36 MCC |
209 | enum raw_event_type { |
210 | IR_SPACE = (1 << 0), | |
211 | IR_PULSE = (1 << 1), | |
212 | IR_START_EVENT = (1 << 2), | |
213 | IR_STOP_EVENT = (1 << 3), | |
995187be MCC |
214 | }; |
215 | ||
e40b1127 | 216 | struct ir_raw_event { |
4651918a ML |
217 | union { |
218 | u32 duration; | |
219 | ||
220 | struct { | |
221 | u32 carrier; | |
222 | u8 duty_cycle; | |
223 | }; | |
224 | }; | |
225 | ||
226 | unsigned pulse:1; | |
227 | unsigned reset:1; | |
228 | unsigned timeout:1; | |
229 | unsigned carrier_report:1; | |
e40b1127 DH |
230 | }; |
231 | ||
4651918a ML |
232 | #define DEFINE_IR_RAW_EVENT(event) \ |
233 | struct ir_raw_event event = { \ | |
234 | { .duration = 0 } , \ | |
235 | .pulse = 0, \ | |
236 | .reset = 0, \ | |
237 | .timeout = 0, \ | |
238 | .carrier_report = 0 } | |
239 | ||
240 | static inline void init_ir_raw_event(struct ir_raw_event *ev) | |
241 | { | |
242 | memset(ev, 0, sizeof(*ev)); | |
243 | } | |
244 | ||
6b20cf3c | 245 | #define IR_MAX_DURATION 500000000 /* 500 ms */ |
5aad7242 JW |
246 | #define US_TO_NS(usec) ((usec) * 1000) |
247 | #define MS_TO_US(msec) ((msec) * 1000) | |
248 | #define MS_TO_NS(msec) ((msec) * 1000 * 1000) | |
da7ee60b | 249 | #define NS_TO_US(nsec) DIV_ROUND_UP(nsec, 1000L) |
e40b1127 | 250 | |
d8b4b582 DH |
251 | void ir_raw_event_handle(struct rc_dev *dev); |
252 | int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev); | |
253 | int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type); | |
254 | int ir_raw_event_store_with_filter(struct rc_dev *dev, | |
4a702ebf | 255 | struct ir_raw_event *ev); |
d8b4b582 | 256 | void ir_raw_event_set_idle(struct rc_dev *dev, bool idle); |
9869da5b JH |
257 | int ir_raw_encode_scancode(u64 protocols, |
258 | const struct rc_scancode_filter *scancode, | |
259 | struct ir_raw_event *events, unsigned int max); | |
4a702ebf | 260 | |
d8b4b582 | 261 | static inline void ir_raw_event_reset(struct rc_dev *dev) |
e40b1127 | 262 | { |
4651918a ML |
263 | DEFINE_IR_RAW_EVENT(ev); |
264 | ev.reset = true; | |
265 | ||
d8b4b582 DH |
266 | ir_raw_event_store(dev, &ev); |
267 | ir_raw_event_handle(dev); | |
e40b1127 | 268 | } |
724e2495 | 269 | |
3ffea498 DH |
270 | /* extract mask bits out of data and pack them into the result */ |
271 | static inline u32 ir_extract_bits(u32 data, u32 mask) | |
272 | { | |
273 | u32 vbit = 1, value = 0; | |
274 | ||
275 | do { | |
829ba9fe DH |
276 | if (mask & 1) { |
277 | if (data & 1) | |
278 | value |= vbit; | |
279 | vbit <<= 1; | |
280 | } | |
281 | data >>= 1; | |
3ffea498 DH |
282 | } while (mask >>= 1); |
283 | ||
284 | return value; | |
285 | } | |
286 | ||
ca86674b | 287 | #endif /* _RC_CORE */ |