tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * Remote Controller core header
3 *
4 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
5 *
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
16#ifndef _RC_CORE
17#define _RC_CORE
18
19#include <linux/spinlock.h>
20#include <linux/kfifo.h>
21#include <linux/time.h>
22#include <linux/timer.h>
23#include <media/rc-map.h>
24
25extern int rc_core_debug;
26#define IR_dprintk(level, fmt, ...) \
27do { \
28 if (rc_core_debug >= level) \
29 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
30} while (0)
31
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
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
60/**
61 * struct rc_dev - represents a remote control device
62 * @dev: driver model's view of this device
63 * @sysfs_groups: sysfs attribute groups
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
69 * @rc_map: current scan/key table
70 * @lock: used to ensure we've filled in all protocol details before
71 * anyone can call show_protocols or store_protocols
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
75 * @driver_type: specifies if protocol decoding is done in hardware or software
76 * @idle: used to keep track of RX state
77 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols
78 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
79 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols
80 * @enabled_wakeup_protocols: bitmask with the enabled RC_BIT_* wakeup protocols
81 * @scancode_filter: scancode filter
82 * @scancode_wakeup_filter: scancode wakeup filters
83 * @scancode_mask: some hardware decoders are not capable of providing the full
84 * scancode to the application. As this is a hardware limit, we can't do
85 * anything with it. Yet, as the same keycode table can be used with other
86 * devices, a mask is provided to allow its usage. Drivers should generally
87 * leave this field in blank
88 * @users: number of current users of the device
89 * @priv: driver-specific data
90 * @keylock: protects the remaining members of the struct
91 * @keypressed: whether a key is currently pressed
92 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
93 * @timer_keyup: timer for releasing a keypress
94 * @last_keycode: keycode of last keypress
95 * @last_protocol: protocol of last keypress
96 * @last_scancode: scancode of last keypress
97 * @last_toggle: toggle value of last command
98 * @timeout: optional time after which device stops sending data
99 * @min_timeout: minimum timeout supported by device
100 * @max_timeout: maximum timeout supported by device
101 * @rx_resolution : resolution (in ns) of input sampler
102 * @tx_resolution: resolution (in ns) of output sampler
103 * @change_protocol: allow changing the protocol used on hardware decoders
104 * @change_wakeup_protocol: allow changing the protocol used for wakeup
105 * filtering
106 * @open: callback to allow drivers to enable polling/irq when IR input device
107 * is opened.
108 * @close: callback to allow drivers to disable polling/irq when IR input device
109 * is opened.
110 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
111 * @s_tx_carrier: set transmit carrier frequency
112 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
113 * @s_rx_carrier: inform driver about carrier it is expected to handle
114 * @tx_ir: transmit IR
115 * @s_idle: enable/disable hardware idle mode, upon which,
116 * device doesn't interrupt host until it sees IR pulses
117 * @s_learning_mode: enable wide band receiver used for learning
118 * @s_carrier_report: enable carrier reports
119 * @s_filter: set the scancode filter
120 * @s_wakeup_filter: set the wakeup scancode filter
121 */
122struct rc_dev {
123 struct device dev;
124 const struct attribute_group *sysfs_groups[5];
125 const char *input_name;
126 const char *input_phys;
127 struct input_id input_id;
128 char *driver_name;
129 const char *map_name;
130 struct rc_map rc_map;
131 struct mutex lock;
132 unsigned long devno;
133 struct ir_raw_event_ctrl *raw;
134 struct input_dev *input_dev;
135 enum rc_driver_type driver_type;
136 bool idle;
137 u64 allowed_protocols;
138 u64 enabled_protocols;
139 u64 allowed_wakeup_protocols;
140 u64 enabled_wakeup_protocols;
141 struct rc_scancode_filter scancode_filter;
142 struct rc_scancode_filter scancode_wakeup_filter;
143 u32 scancode_mask;
144 u32 users;
145 void *priv;
146 spinlock_t keylock;
147 bool keypressed;
148 unsigned long keyup_jiffies;
149 struct timer_list timer_keyup;
150 u32 last_keycode;
151 enum rc_type last_protocol;
152 u32 last_scancode;
153 u8 last_toggle;
154 u32 timeout;
155 u32 min_timeout;
156 u32 max_timeout;
157 u32 rx_resolution;
158 u32 tx_resolution;
159 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
160 int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type);
161 int (*open)(struct rc_dev *dev);
162 void (*close)(struct rc_dev *dev);
163 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
164 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
165 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
166 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
167 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
168 void (*s_idle)(struct rc_dev *dev, bool enable);
169 int (*s_learning_mode)(struct rc_dev *dev, int enable);
170 int (*s_carrier_report) (struct rc_dev *dev, int enable);
171 int (*s_filter)(struct rc_dev *dev,
172 struct rc_scancode_filter *filter);
173 int (*s_wakeup_filter)(struct rc_dev *dev,
174 struct rc_scancode_filter *filter);
175};
176
177#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
178
179/*
180 * From rc-main.c
181 * Those functions can be used on any type of Remote Controller. They
182 * basically creates an input_dev and properly reports the device as a
183 * Remote Controller, at sys/class/rc.
184 */
185
186struct rc_dev *rc_allocate_device(void);
187void rc_free_device(struct rc_dev *dev);
188int rc_register_device(struct rc_dev *dev);
189void rc_unregister_device(struct rc_dev *dev);
190
191int rc_open(struct rc_dev *rdev);
192void rc_close(struct rc_dev *rdev);
193
194void rc_repeat(struct rc_dev *dev);
195void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
196void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
197void rc_keyup(struct rc_dev *dev);
198u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
199
200/*
201 * From rc-raw.c
202 * The Raw interface is specific to InfraRed. It may be a good idea to
203 * split it later into a separate header.
204 */
205
206enum raw_event_type {
207 IR_SPACE = (1 << 0),
208 IR_PULSE = (1 << 1),
209 IR_START_EVENT = (1 << 2),
210 IR_STOP_EVENT = (1 << 3),
211};
212
213struct ir_raw_event {
214 union {
215 u32 duration;
216
217 struct {
218 u32 carrier;
219 u8 duty_cycle;
220 };
221 };
222
223 unsigned pulse:1;
224 unsigned reset:1;
225 unsigned timeout:1;
226 unsigned carrier_report:1;
227};
228
229#define DEFINE_IR_RAW_EVENT(event) \
230 struct ir_raw_event event = { \
231 { .duration = 0 } , \
232 .pulse = 0, \
233 .reset = 0, \
234 .timeout = 0, \
235 .carrier_report = 0 }
236
237static inline void init_ir_raw_event(struct ir_raw_event *ev)
238{
239 memset(ev, 0, sizeof(*ev));
240}
241
242#define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
243#define US_TO_NS(usec) ((usec) * 1000)
244#define MS_TO_US(msec) ((msec) * 1000)
245#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
246
247void ir_raw_event_handle(struct rc_dev *dev);
248int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
249int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
250int ir_raw_event_store_with_filter(struct rc_dev *dev,
251 struct ir_raw_event *ev);
252void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
253
254static inline void ir_raw_event_reset(struct rc_dev *dev)
255{
256 DEFINE_IR_RAW_EVENT(ev);
257 ev.reset = true;
258
259 ir_raw_event_store(dev, &ev);
260 ir_raw_event_handle(dev);
261}
262
263/* extract mask bits out of data and pack them into the result */
264static inline u32 ir_extract_bits(u32 data, u32 mask)
265{
266 u32 vbit = 1, value = 0;
267
268 do {
269 if (mask & 1) {
270 if (data & 1)
271 value |= vbit;
272 vbit <<= 1;
273 }
274 data >>= 1;
275 } while (mask >>= 1);
276
277 return value;
278}
279
280#endif /* _RC_CORE */