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