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> |
a6ddd4fe | 20 | #include <linux/cdev.h> |
a3572c34 MCC |
21 | #include <linux/kfifo.h> |
22 | #include <linux/time.h> | |
9f154782 | 23 | #include <linux/timer.h> |
02858eed | 24 | #include <media/rc-map.h> |
446e4a64 | 25 | |
6bda9644 | 26 | extern int rc_core_debug; |
86b0dbef JP |
27 | #define IR_dprintk(level, fmt, ...) \ |
28 | do { \ | |
29 | if (rc_core_debug >= level) \ | |
7cec72ce | 30 | printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \ |
86b0dbef | 31 | } while (0) |
446e4a64 | 32 | |
5b6137dc MCC |
33 | /** |
34 | * enum rc_driver_type - type of the RC output | |
35 | * | |
d34aee10 AS |
36 | * @RC_DRIVER_SCANCODE: Driver or hardware generates a scancode |
37 | * @RC_DRIVER_IR_RAW: Driver or hardware generates pulse/space sequences. | |
38 | * It needs a Infra-Red pulse/space decoder | |
39 | * @RC_DRIVER_IR_RAW_TX: Device transmitter only, | |
40 | * driver requires pulse/space data sequence. | |
5b6137dc | 41 | */ |
626cf697 | 42 | enum rc_driver_type { |
5b6137dc MCC |
43 | RC_DRIVER_SCANCODE = 0, |
44 | RC_DRIVER_IR_RAW, | |
d34aee10 | 45 | RC_DRIVER_IR_RAW_TX, |
626cf697 MCC |
46 | }; |
47 | ||
00942d1a JH |
48 | /** |
49 | * struct rc_scancode_filter - Filter scan codes. | |
50 | * @data: Scancode data to match. | |
51 | * @mask: Mask of bits of scancode to compare. | |
52 | */ | |
53 | struct rc_scancode_filter { | |
54 | u32 data; | |
55 | u32 mask; | |
56 | }; | |
57 | ||
58 | /** | |
59 | * enum rc_filter_type - Filter type constants. | |
60 | * @RC_FILTER_NORMAL: Filter for normal operation. | |
61 | * @RC_FILTER_WAKEUP: Filter for waking from suspend. | |
62 | * @RC_FILTER_MAX: Number of filter types. | |
63 | */ | |
64 | enum rc_filter_type { | |
65 | RC_FILTER_NORMAL = 0, | |
66 | RC_FILTER_WAKEUP, | |
67 | ||
68 | RC_FILTER_MAX | |
69 | }; | |
70 | ||
9dfe4e83 | 71 | /** |
d8b4b582 DH |
72 | * struct rc_dev - represents a remote control device |
73 | * @dev: driver model's view of this device | |
ddbf7d5a | 74 | * @managed_alloc: devm_rc_allocate_device was used to create rc_dev |
99b0f3c9 | 75 | * @sysfs_groups: sysfs attribute groups |
518f4b26 | 76 | * @device_name: name of the rc child device |
d8b4b582 DH |
77 | * @input_phys: physical path to the input child device |
78 | * @input_id: id of the input child device (struct input_id) | |
79 | * @driver_name: name of the hardware driver which registered this device | |
80 | * @map_name: name of the default keymap | |
b088ba65 | 81 | * @rc_map: current scan/key table |
08aeb7c9 JW |
82 | * @lock: used to ensure we've filled in all protocol details before |
83 | * anyone can call show_protocols or store_protocols | |
fcb13097 | 84 | * @minor: unique minor remote control device number |
d8b4b582 DH |
85 | * @raw: additional data for raw pulse/space devices |
86 | * @input_dev: the input child device used to communicate events to userspace | |
08aeb7c9 | 87 | * @driver_type: specifies if protocol decoding is done in hardware or software |
d8b4b582 | 88 | * @idle: used to keep track of RX state |
f423ccc1 JH |
89 | * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed |
90 | * wakeup protocols is the set of all raw encoders | |
6d741bfe SY |
91 | * @allowed_protocols: bitmask with the supported RC_PROTO_BIT_* protocols |
92 | * @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols | |
93 | * @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup | |
94 | * protocols | |
95 | * @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or | |
96 | * RC_PROTO_UNKNOWN if disabled. | |
c5540fbb DH |
97 | * @scancode_filter: scancode filter |
98 | * @scancode_wakeup_filter: scancode wakeup filters | |
9d2f1d3c | 99 | * @scancode_mask: some hardware decoders are not capable of providing the full |
9dfe4e83 MCC |
100 | * scancode to the application. As this is a hardware limit, we can't do |
101 | * anything with it. Yet, as the same keycode table can be used with other | |
102 | * devices, a mask is provided to allow its usage. Drivers should generally | |
103 | * leave this field in blank | |
9d2f1d3c | 104 | * @users: number of current users of the device |
d8b4b582 DH |
105 | * @priv: driver-specific data |
106 | * @keylock: protects the remaining members of the struct | |
107 | * @keypressed: whether a key is currently pressed | |
108 | * @keyup_jiffies: time (in jiffies) when the current keypress should be released | |
109 | * @timer_keyup: timer for releasing a keypress | |
110 | * @last_keycode: keycode of last keypress | |
120703f9 | 111 | * @last_protocol: protocol of last keypress |
d8b4b582 DH |
112 | * @last_scancode: scancode of last keypress |
113 | * @last_toggle: toggle value of last command | |
4a702ebf ML |
114 | * @timeout: optional time after which device stops sending data |
115 | * @min_timeout: minimum timeout supported by device | |
116 | * @max_timeout: maximum timeout supported by device | |
e589333f ML |
117 | * @rx_resolution : resolution (in ns) of input sampler |
118 | * @tx_resolution: resolution (in ns) of output sampler | |
a6ddd4fe SY |
119 | * @lirc_dev: lirc device |
120 | * @lirc_cdev: lirc char cdev | |
111429fb | 121 | * @lirc_open: count of the number of times the device has been opened |
a60d64b1 SY |
122 | * @carrier_low: when setting the carrier range, first the low end must be |
123 | * set with an ioctl and then the high end with another ioctl | |
124 | * @gap_start: time when gap starts | |
125 | * @gap_duration: duration of initial gap | |
126 | * @gap: true if we're in a gap | |
127 | * @send_timeout_reports: report timeouts in lirc raw IR. | |
71695aff SY |
128 | * @rawir: queue for incoming raw IR |
129 | * @wait_poll: poll struct for lirc device | |
a60d64b1 SY |
130 | * @send_mode: lirc mode for sending, either LIRC_MODE_SCANCODE or |
131 | * LIRC_MODE_PULSE | |
7790e81f SY |
132 | * @registered: set to true by rc_register_device(), false by |
133 | * rc_unregister_device | |
9dfe4e83 MCC |
134 | * @change_protocol: allow changing the protocol used on hardware decoders |
135 | * @open: callback to allow drivers to enable polling/irq when IR input device | |
136 | * is opened. | |
137 | * @close: callback to allow drivers to disable polling/irq when IR input device | |
138 | * is opened. | |
9b7c54d9 JW |
139 | * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs) |
140 | * @s_tx_carrier: set transmit carrier frequency | |
e589333f | 141 | * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%) |
fa810845 | 142 | * @s_rx_carrier_range: inform driver about carrier it is expected to handle |
9b7c54d9 | 143 | * @tx_ir: transmit IR |
d8b4b582 DH |
144 | * @s_idle: enable/disable hardware idle mode, upon which, |
145 | * device doesn't interrupt host until it sees IR pulses | |
e589333f | 146 | * @s_learning_mode: enable wide band receiver used for learning |
4651918a | 147 | * @s_carrier_report: enable carrier reports |
120703f9 | 148 | * @s_filter: set the scancode filter |
0751d33c SY |
149 | * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero |
150 | * then wakeup should be disabled. wakeup_protocol will be set to | |
151 | * a valid protocol if mask is nonzero. | |
4f253cec | 152 | * @s_timeout: set hardware timeout in ns |
9dfe4e83 | 153 | */ |
d8b4b582 DH |
154 | struct rc_dev { |
155 | struct device dev; | |
ddbf7d5a | 156 | bool managed_alloc; |
99b0f3c9 | 157 | const struct attribute_group *sysfs_groups[5]; |
518f4b26 | 158 | const char *device_name; |
d8b4b582 DH |
159 | const char *input_phys; |
160 | struct input_id input_id; | |
518f4b26 | 161 | const char *driver_name; |
d8b4b582 | 162 | const char *map_name; |
08aeb7c9 JW |
163 | struct rc_map rc_map; |
164 | struct mutex lock; | |
fcb13097 | 165 | unsigned int minor; |
d8b4b582 DH |
166 | struct ir_raw_event_ctrl *raw; |
167 | struct input_dev *input_dev; | |
168 | enum rc_driver_type driver_type; | |
4a702ebf | 169 | bool idle; |
f423ccc1 | 170 | bool encode_wakeup; |
c5540fbb DH |
171 | u64 allowed_protocols; |
172 | u64 enabled_protocols; | |
173 | u64 allowed_wakeup_protocols; | |
6d741bfe | 174 | enum rc_proto wakeup_protocol; |
c5540fbb DH |
175 | struct rc_scancode_filter scancode_filter; |
176 | struct rc_scancode_filter scancode_wakeup_filter; | |
9d2f1d3c | 177 | u32 scancode_mask; |
8b2ff320 | 178 | u32 users; |
d8b4b582 DH |
179 | void *priv; |
180 | spinlock_t keylock; | |
181 | bool keypressed; | |
182 | unsigned long keyup_jiffies; | |
183 | struct timer_list timer_keyup; | |
184 | u32 last_keycode; | |
6d741bfe | 185 | enum rc_proto last_protocol; |
d8b4b582 DH |
186 | u32 last_scancode; |
187 | u8 last_toggle; | |
188 | u32 timeout; | |
189 | u32 min_timeout; | |
190 | u32 max_timeout; | |
191 | u32 rx_resolution; | |
192 | u32 tx_resolution; | |
a60d64b1 | 193 | #ifdef CONFIG_LIRC |
a6ddd4fe SY |
194 | struct device lirc_dev; |
195 | struct cdev lirc_cdev; | |
111429fb | 196 | int lirc_open; |
a60d64b1 SY |
197 | int carrier_low; |
198 | ktime_t gap_start; | |
199 | u64 gap_duration; | |
200 | bool gap; | |
201 | bool send_timeout_reports; | |
71695aff SY |
202 | DECLARE_KFIFO_PTR(rawir, unsigned int); |
203 | wait_queue_head_t wait_poll; | |
a60d64b1 SY |
204 | u8 send_mode; |
205 | #endif | |
7790e81f | 206 | bool registered; |
6d741bfe | 207 | int (*change_protocol)(struct rc_dev *dev, u64 *rc_proto); |
d8b4b582 DH |
208 | int (*open)(struct rc_dev *dev); |
209 | void (*close)(struct rc_dev *dev); | |
210 | int (*s_tx_mask)(struct rc_dev *dev, u32 mask); | |
211 | int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier); | |
212 | int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle); | |
213 | int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max); | |
5588dc2b | 214 | int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n); |
d8b4b582 DH |
215 | void (*s_idle)(struct rc_dev *dev, bool enable); |
216 | int (*s_learning_mode)(struct rc_dev *dev, int enable); | |
217 | int (*s_carrier_report) (struct rc_dev *dev, int enable); | |
00942d1a | 218 | int (*s_filter)(struct rc_dev *dev, |
00942d1a | 219 | struct rc_scancode_filter *filter); |
23c843b5 DH |
220 | int (*s_wakeup_filter)(struct rc_dev *dev, |
221 | struct rc_scancode_filter *filter); | |
4f253cec SY |
222 | int (*s_timeout)(struct rc_dev *dev, |
223 | unsigned int timeout); | |
75543cce | 224 | }; |
a3572c34 | 225 | |
ca86674b MCC |
226 | #define to_rc_dev(d) container_of(d, struct rc_dev, dev) |
227 | ||
228 | /* | |
229 | * From rc-main.c | |
230 | * Those functions can be used on any type of Remote Controller. They | |
231 | * basically creates an input_dev and properly reports the device as a | |
232 | * Remote Controller, at sys/class/rc. | |
233 | */ | |
234 | ||
5b6137dc MCC |
235 | /** |
236 | * rc_allocate_device - Allocates a RC device | |
237 | * | |
0f7499fd | 238 | * @rc_driver_type: specifies the type of the RC output to be allocated |
5b6137dc MCC |
239 | * returns a pointer to struct rc_dev. |
240 | */ | |
0f7499fd | 241 | struct rc_dev *rc_allocate_device(enum rc_driver_type); |
5b6137dc | 242 | |
ddbf7d5a HK |
243 | /** |
244 | * devm_rc_allocate_device - Managed RC device allocation | |
245 | * | |
246 | * @dev: pointer to struct device | |
0f7499fd | 247 | * @rc_driver_type: specifies the type of the RC output to be allocated |
ddbf7d5a HK |
248 | * returns a pointer to struct rc_dev. |
249 | */ | |
0f7499fd | 250 | struct rc_dev *devm_rc_allocate_device(struct device *dev, enum rc_driver_type); |
ddbf7d5a | 251 | |
5b6137dc MCC |
252 | /** |
253 | * rc_free_device - Frees a RC device | |
254 | * | |
255 | * @dev: pointer to struct rc_dev. | |
256 | */ | |
ca86674b | 257 | void rc_free_device(struct rc_dev *dev); |
5b6137dc MCC |
258 | |
259 | /** | |
260 | * rc_register_device - Registers a RC device | |
261 | * | |
262 | * @dev: pointer to struct rc_dev. | |
263 | */ | |
ca86674b | 264 | int rc_register_device(struct rc_dev *dev); |
5b6137dc | 265 | |
ddbf7d5a HK |
266 | /** |
267 | * devm_rc_register_device - Manageded registering of a RC device | |
268 | * | |
269 | * @parent: pointer to struct device. | |
270 | * @dev: pointer to struct rc_dev. | |
271 | */ | |
272 | int devm_rc_register_device(struct device *parent, struct rc_dev *dev); | |
273 | ||
5b6137dc MCC |
274 | /** |
275 | * rc_unregister_device - Unregisters a RC device | |
276 | * | |
277 | * @dev: pointer to struct rc_dev. | |
278 | */ | |
ca86674b MCC |
279 | void rc_unregister_device(struct rc_dev *dev); |
280 | ||
281 | void rc_repeat(struct rc_dev *dev); | |
6d741bfe SY |
282 | void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u32 scancode, |
283 | u8 toggle); | |
284 | void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol, | |
285 | u32 scancode, u8 toggle); | |
ca86674b MCC |
286 | void rc_keyup(struct rc_dev *dev); |
287 | u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode); | |
288 | ||
289 | /* | |
290 | * From rc-raw.c | |
291 | * The Raw interface is specific to InfraRed. It may be a good idea to | |
292 | * split it later into a separate header. | |
293 | */ | |
e40b1127 | 294 | struct ir_raw_event { |
4651918a ML |
295 | union { |
296 | u32 duration; | |
5f61ff86 | 297 | u32 carrier; |
4651918a | 298 | }; |
5f61ff86 | 299 | u8 duty_cycle; |
4651918a ML |
300 | |
301 | unsigned pulse:1; | |
302 | unsigned reset:1; | |
303 | unsigned timeout:1; | |
304 | unsigned carrier_report:1; | |
e40b1127 DH |
305 | }; |
306 | ||
5f61ff86 | 307 | #define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {} |
4651918a ML |
308 | |
309 | static inline void init_ir_raw_event(struct ir_raw_event *ev) | |
310 | { | |
311 | memset(ev, 0, sizeof(*ev)); | |
312 | } | |
313 | ||
c8e1bbc5 | 314 | #define IR_DEFAULT_TIMEOUT MS_TO_NS(125) |
6b20cf3c | 315 | #define IR_MAX_DURATION 500000000 /* 500 ms */ |
5aad7242 JW |
316 | #define US_TO_NS(usec) ((usec) * 1000) |
317 | #define MS_TO_US(msec) ((msec) * 1000) | |
318 | #define MS_TO_NS(msec) ((msec) * 1000 * 1000) | |
e40b1127 | 319 | |
d8b4b582 DH |
320 | void ir_raw_event_handle(struct rc_dev *dev); |
321 | int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev); | |
86fe1ac0 | 322 | int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse); |
d8b4b582 | 323 | int ir_raw_event_store_with_filter(struct rc_dev *dev, |
4a702ebf | 324 | struct ir_raw_event *ev); |
d8b4b582 | 325 | void ir_raw_event_set_idle(struct rc_dev *dev, bool idle); |
6d741bfe | 326 | int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode, |
3875233d | 327 | struct ir_raw_event *events, unsigned int max); |
cdfaa01c | 328 | int ir_raw_encode_carrier(enum rc_proto protocol); |
4a702ebf | 329 | |
d8b4b582 | 330 | static inline void ir_raw_event_reset(struct rc_dev *dev) |
e40b1127 | 331 | { |
5f61ff86 | 332 | struct ir_raw_event ev = { .reset = true }; |
4651918a | 333 | |
d8b4b582 DH |
334 | ir_raw_event_store(dev, &ev); |
335 | ir_raw_event_handle(dev); | |
e40b1127 | 336 | } |
724e2495 | 337 | |
3ffea498 DH |
338 | /* extract mask bits out of data and pack them into the result */ |
339 | static inline u32 ir_extract_bits(u32 data, u32 mask) | |
340 | { | |
341 | u32 vbit = 1, value = 0; | |
342 | ||
343 | do { | |
829ba9fe DH |
344 | if (mask & 1) { |
345 | if (data & 1) | |
346 | value |= vbit; | |
347 | vbit <<= 1; | |
348 | } | |
349 | data >>= 1; | |
3ffea498 DH |
350 | } while (mask >>= 1); |
351 | ||
352 | return value; | |
353 | } | |
354 | ||
e8ffda78 SG |
355 | /* Get NEC scancode and protocol type from address and command bytes */ |
356 | static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address, | |
357 | u8 command, u8 not_command, | |
6d741bfe | 358 | enum rc_proto *protocol) |
e8ffda78 SG |
359 | { |
360 | u32 scancode; | |
361 | ||
362 | if ((command ^ not_command) != 0xff) { | |
363 | /* NEC transport, but modified protocol, used by at | |
364 | * least Apple and TiVo remotes | |
365 | */ | |
366 | scancode = not_address << 24 | | |
367 | address << 16 | | |
368 | not_command << 8 | | |
369 | command; | |
6d741bfe | 370 | *protocol = RC_PROTO_NEC32; |
e8ffda78 SG |
371 | } else if ((address ^ not_address) != 0xff) { |
372 | /* Extended NEC */ | |
373 | scancode = address << 16 | | |
374 | not_address << 8 | | |
375 | command; | |
6d741bfe | 376 | *protocol = RC_PROTO_NECX; |
e8ffda78 SG |
377 | } else { |
378 | /* Normal NEC */ | |
379 | scancode = address << 8 | command; | |
6d741bfe | 380 | *protocol = RC_PROTO_NEC; |
e8ffda78 SG |
381 | } |
382 | ||
383 | return scancode; | |
384 | } | |
385 | ||
ca86674b | 386 | #endif /* _RC_CORE */ |