2 * Remote Controller core header
4 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
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.
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.
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>
25 extern int rc_core_debug
;
26 #define IR_dprintk(level, fmt, ...) \
28 if (rc_core_debug >= level) \
29 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
33 * enum rc_driver_type - type of the RC output
35 * @RC_DRIVER_SCANCODE: Driver or hardware generates a scancode
36 * @RC_DRIVER_IR_RAW: Driver or hardware generates pulse/space sequences.
37 * It needs a Infra-Red pulse/space decoder
38 * @RC_DRIVER_IR_RAW_TX: Device transmitter only,
39 * driver requires pulse/space data sequence.
42 RC_DRIVER_SCANCODE
= 0,
48 * struct rc_scancode_filter - Filter scan codes.
49 * @data: Scancode data to match.
50 * @mask: Mask of bits of scancode to compare.
52 struct rc_scancode_filter
{
58 * enum rc_filter_type - Filter type constants.
59 * @RC_FILTER_NORMAL: Filter for normal operation.
60 * @RC_FILTER_WAKEUP: Filter for waking from suspend.
61 * @RC_FILTER_MAX: Number of filter types.
71 * struct rc_dev - represents a remote control device
72 * @dev: driver model's view of this device
73 * @initialized: 1 if the device init has completed, 0 otherwise
74 * @managed_alloc: devm_rc_allocate_device was used to create rc_dev
75 * @sysfs_groups: sysfs attribute groups
76 * @input_name: name of the input child device
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
81 * @rc_map: current scan/key table
82 * @lock: used to ensure we've filled in all protocol details before
83 * anyone can call show_protocols or store_protocols
84 * @minor: unique minor remote control device number
85 * @raw: additional data for raw pulse/space devices
86 * @input_dev: the input child device used to communicate events to userspace
87 * @driver_type: specifies if protocol decoding is done in hardware or software
88 * @idle: used to keep track of RX state
89 * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
90 * wakeup protocols is the set of all raw encoders
91 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols
92 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
93 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols
94 * @wakeup_protocol: the enabled RC_TYPE_* wakeup protocol or
95 * RC_TYPE_UNKNOWN if disabled.
96 * @scancode_filter: scancode filter
97 * @scancode_wakeup_filter: scancode wakeup filters
98 * @scancode_mask: some hardware decoders are not capable of providing the full
99 * scancode to the application. As this is a hardware limit, we can't do
100 * anything with it. Yet, as the same keycode table can be used with other
101 * devices, a mask is provided to allow its usage. Drivers should generally
102 * leave this field in blank
103 * @users: number of current users of the device
104 * @priv: driver-specific data
105 * @keylock: protects the remaining members of the struct
106 * @keypressed: whether a key is currently pressed
107 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
108 * @timer_keyup: timer for releasing a keypress
109 * @last_keycode: keycode of last keypress
110 * @last_protocol: protocol of last keypress
111 * @last_scancode: scancode of last keypress
112 * @last_toggle: toggle value of last command
113 * @timeout: optional time after which device stops sending data
114 * @min_timeout: minimum timeout supported by device
115 * @max_timeout: maximum timeout supported by device
116 * @rx_resolution : resolution (in ns) of input sampler
117 * @tx_resolution: resolution (in ns) of output sampler
118 * @change_protocol: allow changing the protocol used on hardware decoders
119 * @open: callback to allow drivers to enable polling/irq when IR input device
121 * @close: callback to allow drivers to disable polling/irq when IR input device
123 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
124 * @s_tx_carrier: set transmit carrier frequency
125 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
126 * @s_rx_carrier_range: inform driver about carrier it is expected to handle
127 * @tx_ir: transmit IR
128 * @s_idle: enable/disable hardware idle mode, upon which,
129 * device doesn't interrupt host until it sees IR pulses
130 * @s_learning_mode: enable wide band receiver used for learning
131 * @s_carrier_report: enable carrier reports
132 * @s_filter: set the scancode filter
133 * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
134 * then wakeup should be disabled. wakeup_protocol will be set to
135 * a valid protocol if mask is nonzero.
136 * @s_timeout: set hardware timeout in ns
140 atomic_t initialized
;
142 const struct attribute_group
*sysfs_groups
[5];
143 const char *input_name
;
144 const char *input_phys
;
145 struct input_id input_id
;
147 const char *map_name
;
148 struct rc_map rc_map
;
151 struct ir_raw_event_ctrl
*raw
;
152 struct input_dev
*input_dev
;
153 enum rc_driver_type driver_type
;
156 u64 allowed_protocols
;
157 u64 enabled_protocols
;
158 u64 allowed_wakeup_protocols
;
159 enum rc_type wakeup_protocol
;
160 struct rc_scancode_filter scancode_filter
;
161 struct rc_scancode_filter scancode_wakeup_filter
;
167 unsigned long keyup_jiffies
;
168 struct timer_list timer_keyup
;
170 enum rc_type last_protocol
;
178 int (*change_protocol
)(struct rc_dev
*dev
, u64
*rc_type
);
179 int (*open
)(struct rc_dev
*dev
);
180 void (*close
)(struct rc_dev
*dev
);
181 int (*s_tx_mask
)(struct rc_dev
*dev
, u32 mask
);
182 int (*s_tx_carrier
)(struct rc_dev
*dev
, u32 carrier
);
183 int (*s_tx_duty_cycle
)(struct rc_dev
*dev
, u32 duty_cycle
);
184 int (*s_rx_carrier_range
)(struct rc_dev
*dev
, u32 min
, u32 max
);
185 int (*tx_ir
)(struct rc_dev
*dev
, unsigned *txbuf
, unsigned n
);
186 void (*s_idle
)(struct rc_dev
*dev
, bool enable
);
187 int (*s_learning_mode
)(struct rc_dev
*dev
, int enable
);
188 int (*s_carrier_report
) (struct rc_dev
*dev
, int enable
);
189 int (*s_filter
)(struct rc_dev
*dev
,
190 struct rc_scancode_filter
*filter
);
191 int (*s_wakeup_filter
)(struct rc_dev
*dev
,
192 struct rc_scancode_filter
*filter
);
193 int (*s_timeout
)(struct rc_dev
*dev
,
194 unsigned int timeout
);
197 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
201 * Those functions can be used on any type of Remote Controller. They
202 * basically creates an input_dev and properly reports the device as a
203 * Remote Controller, at sys/class/rc.
207 * rc_allocate_device - Allocates a RC device
209 * @rc_driver_type: specifies the type of the RC output to be allocated
210 * returns a pointer to struct rc_dev.
212 struct rc_dev
*rc_allocate_device(enum rc_driver_type
);
215 * devm_rc_allocate_device - Managed RC device allocation
217 * @dev: pointer to struct device
218 * @rc_driver_type: specifies the type of the RC output to be allocated
219 * returns a pointer to struct rc_dev.
221 struct rc_dev
*devm_rc_allocate_device(struct device
*dev
, enum rc_driver_type
);
224 * rc_free_device - Frees a RC device
226 * @dev: pointer to struct rc_dev.
228 void rc_free_device(struct rc_dev
*dev
);
231 * rc_register_device - Registers a RC device
233 * @dev: pointer to struct rc_dev.
235 int rc_register_device(struct rc_dev
*dev
);
238 * devm_rc_register_device - Manageded registering of a RC device
240 * @parent: pointer to struct device.
241 * @dev: pointer to struct rc_dev.
243 int devm_rc_register_device(struct device
*parent
, struct rc_dev
*dev
);
246 * rc_unregister_device - Unregisters a RC device
248 * @dev: pointer to struct rc_dev.
250 void rc_unregister_device(struct rc_dev
*dev
);
253 * rc_open - Opens a RC device
255 * @rdev: pointer to struct rc_dev.
257 int rc_open(struct rc_dev
*rdev
);
260 * rc_close - Closes a RC device
262 * @rdev: pointer to struct rc_dev.
264 void rc_close(struct rc_dev
*rdev
);
266 void rc_repeat(struct rc_dev
*dev
);
267 void rc_keydown(struct rc_dev
*dev
, enum rc_type protocol
, u32 scancode
, u8 toggle
);
268 void rc_keydown_notimeout(struct rc_dev
*dev
, enum rc_type protocol
, u32 scancode
, u8 toggle
);
269 void rc_keyup(struct rc_dev
*dev
);
270 u32
rc_g_keycode_from_table(struct rc_dev
*dev
, u32 scancode
);
274 * The Raw interface is specific to InfraRed. It may be a good idea to
275 * split it later into a separate header.
278 enum raw_event_type
{
281 IR_START_EVENT
= (1 << 2),
282 IR_STOP_EVENT
= (1 << 3),
285 struct ir_raw_event
{
295 unsigned carrier_report
:1;
298 #define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}
300 static inline void init_ir_raw_event(struct ir_raw_event
*ev
)
302 memset(ev
, 0, sizeof(*ev
));
305 #define IR_DEFAULT_TIMEOUT MS_TO_NS(125)
306 #define IR_MAX_DURATION 500000000 /* 500 ms */
307 #define US_TO_NS(usec) ((usec) * 1000)
308 #define MS_TO_US(msec) ((msec) * 1000)
309 #define MS_TO_NS(msec) ((msec) * 1000 * 1000)
311 void ir_raw_event_handle(struct rc_dev
*dev
);
312 int ir_raw_event_store(struct rc_dev
*dev
, struct ir_raw_event
*ev
);
313 int ir_raw_event_store_edge(struct rc_dev
*dev
, enum raw_event_type type
);
314 int ir_raw_event_store_with_filter(struct rc_dev
*dev
,
315 struct ir_raw_event
*ev
);
316 void ir_raw_event_set_idle(struct rc_dev
*dev
, bool idle
);
317 int ir_raw_encode_scancode(enum rc_type protocol
, u32 scancode
,
318 struct ir_raw_event
*events
, unsigned int max
);
320 static inline void ir_raw_event_reset(struct rc_dev
*dev
)
322 struct ir_raw_event ev
= { .reset
= true };
324 ir_raw_event_store(dev
, &ev
);
325 ir_raw_event_handle(dev
);
328 /* extract mask bits out of data and pack them into the result */
329 static inline u32
ir_extract_bits(u32 data
, u32 mask
)
331 u32 vbit
= 1, value
= 0;
340 } while (mask
>>= 1);
345 #endif /* _RC_CORE */