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/cdev.h>
21 #include <linux/kfifo.h>
22 #include <linux/time.h>
23 #include <linux/timer.h>
24 #include <media/rc-map.h>
26 extern int rc_core_debug
;
27 #define IR_dprintk(level, fmt, ...) \
29 if (rc_core_debug >= level) \
30 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
34 * enum rc_driver_type - type of the RC driver.
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.
43 RC_DRIVER_SCANCODE
= 0,
49 * struct rc_scancode_filter - Filter scan codes.
50 * @data: Scancode data to match.
51 * @mask: Mask of bits of scancode to compare.
53 struct rc_scancode_filter
{
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.
72 * struct lirc_fh - represents an open lirc file
73 * @list: list of open file handles
74 * @rc: rcdev for this lirc chardev
75 * @carrier_low: when setting the carrier range, first the low end must be
76 * set with an ioctl and then the high end with another ioctl
77 * @send_timeout_reports: report timeouts in lirc raw IR.
78 * @rawir: queue for incoming raw IR
79 * @scancodes: queue for incoming decoded scancodes
80 * @wait_poll: poll struct for lirc device
81 * @send_mode: lirc mode for sending, either LIRC_MODE_SCANCODE or
83 * @rec_mode: lirc mode for receiving, either LIRC_MODE_SCANCODE or
87 struct list_head list
;
90 bool send_timeout_reports
;
91 DECLARE_KFIFO_PTR(rawir
, unsigned int);
92 DECLARE_KFIFO_PTR(scancodes
, struct lirc_scancode
);
93 wait_queue_head_t wait_poll
;
99 * struct rc_dev - represents a remote control device
100 * @dev: driver model's view of this device
101 * @managed_alloc: devm_rc_allocate_device was used to create rc_dev
102 * @sysfs_groups: sysfs attribute groups
103 * @device_name: name of the rc child device
104 * @input_phys: physical path to the input child device
105 * @input_id: id of the input child device (struct input_id)
106 * @driver_name: name of the hardware driver which registered this device
107 * @map_name: name of the default keymap
108 * @rc_map: current scan/key table
109 * @lock: used to ensure we've filled in all protocol details before
110 * anyone can call show_protocols or store_protocols
111 * @minor: unique minor remote control device number
112 * @raw: additional data for raw pulse/space devices
113 * @input_dev: the input child device used to communicate events to userspace
114 * @driver_type: specifies if protocol decoding is done in hardware or software
115 * @idle: used to keep track of RX state
116 * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
117 * wakeup protocols is the set of all raw encoders
118 * @allowed_protocols: bitmask with the supported RC_PROTO_BIT_* protocols
119 * @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols
120 * @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup
122 * @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or
123 * RC_PROTO_UNKNOWN if disabled.
124 * @scancode_filter: scancode filter
125 * @scancode_wakeup_filter: scancode wakeup filters
126 * @scancode_mask: some hardware decoders are not capable of providing the full
127 * scancode to the application. As this is a hardware limit, we can't do
128 * anything with it. Yet, as the same keycode table can be used with other
129 * devices, a mask is provided to allow its usage. Drivers should generally
130 * leave this field in blank
131 * @users: number of current users of the device
132 * @priv: driver-specific data
133 * @keylock: protects the remaining members of the struct
134 * @keypressed: whether a key is currently pressed
135 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
136 * @timer_keyup: timer for releasing a keypress
137 * @timer_repeat: timer for autorepeat events. This is needed for CEC, which
138 * has non-standard repeats.
139 * @last_keycode: keycode of last keypress
140 * @last_protocol: protocol of last keypress
141 * @last_scancode: scancode of last keypress
142 * @last_toggle: toggle value of last command
143 * @timeout: optional time after which device stops sending data
144 * @min_timeout: minimum timeout supported by device
145 * @max_timeout: maximum timeout supported by device
146 * @rx_resolution : resolution (in ns) of input sampler
147 * @tx_resolution: resolution (in ns) of output sampler
148 * @lirc_dev: lirc device
149 * @lirc_cdev: lirc char cdev
150 * @gap_start: time when gap starts
151 * @gap_duration: duration of initial gap
152 * @gap: true if we're in a gap
153 * @lirc_fh_lock: protects lirc_fh list
154 * @lirc_fh: list of open files
155 * @registered: set to true by rc_register_device(), false by
156 * rc_unregister_device
157 * @change_protocol: allow changing the protocol used on hardware decoders
158 * @open: callback to allow drivers to enable polling/irq when IR input device
160 * @close: callback to allow drivers to disable polling/irq when IR input device
162 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
163 * @s_tx_carrier: set transmit carrier frequency
164 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
165 * @s_rx_carrier_range: inform driver about carrier it is expected to handle
166 * @tx_ir: transmit IR
167 * @s_idle: enable/disable hardware idle mode, upon which,
168 * device doesn't interrupt host until it sees IR pulses
169 * @s_learning_mode: enable wide band receiver used for learning
170 * @s_carrier_report: enable carrier reports
171 * @s_filter: set the scancode filter
172 * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
173 * then wakeup should be disabled. wakeup_protocol will be set to
174 * a valid protocol if mask is nonzero.
175 * @s_timeout: set hardware timeout in ns
180 const struct attribute_group
*sysfs_groups
[5];
181 const char *device_name
;
182 const char *input_phys
;
183 struct input_id input_id
;
184 const char *driver_name
;
185 const char *map_name
;
186 struct rc_map rc_map
;
189 struct ir_raw_event_ctrl
*raw
;
190 struct input_dev
*input_dev
;
191 enum rc_driver_type driver_type
;
194 u64 allowed_protocols
;
195 u64 enabled_protocols
;
196 u64 allowed_wakeup_protocols
;
197 enum rc_proto wakeup_protocol
;
198 struct rc_scancode_filter scancode_filter
;
199 struct rc_scancode_filter scancode_wakeup_filter
;
205 unsigned long keyup_jiffies
;
206 struct timer_list timer_keyup
;
207 struct timer_list timer_repeat
;
209 enum rc_proto last_protocol
;
218 struct device lirc_dev
;
219 struct cdev lirc_cdev
;
223 spinlock_t lirc_fh_lock
;
224 struct list_head lirc_fh
;
227 int (*change_protocol
)(struct rc_dev
*dev
, u64
*rc_proto
);
228 int (*open
)(struct rc_dev
*dev
);
229 void (*close
)(struct rc_dev
*dev
);
230 int (*s_tx_mask
)(struct rc_dev
*dev
, u32 mask
);
231 int (*s_tx_carrier
)(struct rc_dev
*dev
, u32 carrier
);
232 int (*s_tx_duty_cycle
)(struct rc_dev
*dev
, u32 duty_cycle
);
233 int (*s_rx_carrier_range
)(struct rc_dev
*dev
, u32 min
, u32 max
);
234 int (*tx_ir
)(struct rc_dev
*dev
, unsigned *txbuf
, unsigned n
);
235 void (*s_idle
)(struct rc_dev
*dev
, bool enable
);
236 int (*s_learning_mode
)(struct rc_dev
*dev
, int enable
);
237 int (*s_carrier_report
) (struct rc_dev
*dev
, int enable
);
238 int (*s_filter
)(struct rc_dev
*dev
,
239 struct rc_scancode_filter
*filter
);
240 int (*s_wakeup_filter
)(struct rc_dev
*dev
,
241 struct rc_scancode_filter
*filter
);
242 int (*s_timeout
)(struct rc_dev
*dev
,
243 unsigned int timeout
);
246 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
250 * Those functions can be used on any type of Remote Controller. They
251 * basically creates an input_dev and properly reports the device as a
252 * Remote Controller, at sys/class/rc.
256 * rc_allocate_device - Allocates a RC device
258 * @rc_driver_type: specifies the type of the RC output to be allocated
259 * returns a pointer to struct rc_dev.
261 struct rc_dev
*rc_allocate_device(enum rc_driver_type
);
264 * devm_rc_allocate_device - Managed RC device allocation
266 * @dev: pointer to struct device
267 * @rc_driver_type: specifies the type of the RC output to be allocated
268 * returns a pointer to struct rc_dev.
270 struct rc_dev
*devm_rc_allocate_device(struct device
*dev
, enum rc_driver_type
);
273 * rc_free_device - Frees a RC device
275 * @dev: pointer to struct rc_dev.
277 void rc_free_device(struct rc_dev
*dev
);
280 * rc_register_device - Registers a RC device
282 * @dev: pointer to struct rc_dev.
284 int rc_register_device(struct rc_dev
*dev
);
287 * devm_rc_register_device - Manageded registering of a RC device
289 * @parent: pointer to struct device.
290 * @dev: pointer to struct rc_dev.
292 int devm_rc_register_device(struct device
*parent
, struct rc_dev
*dev
);
295 * rc_unregister_device - Unregisters a RC device
297 * @dev: pointer to struct rc_dev.
299 void rc_unregister_device(struct rc_dev
*dev
);
301 void rc_repeat(struct rc_dev
*dev
);
302 void rc_keydown(struct rc_dev
*dev
, enum rc_proto protocol
, u32 scancode
,
304 void rc_keydown_notimeout(struct rc_dev
*dev
, enum rc_proto protocol
,
305 u32 scancode
, u8 toggle
);
306 void rc_keyup(struct rc_dev
*dev
);
307 u32
rc_g_keycode_from_table(struct rc_dev
*dev
, u32 scancode
);
311 * The Raw interface is specific to InfraRed. It may be a good idea to
312 * split it later into a separate header.
314 struct ir_raw_event
{
324 unsigned carrier_report
:1;
327 #define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}
329 static inline void init_ir_raw_event(struct ir_raw_event
*ev
)
331 memset(ev
, 0, sizeof(*ev
));
334 #define IR_DEFAULT_TIMEOUT MS_TO_NS(125)
335 #define IR_MAX_DURATION 500000000 /* 500 ms */
336 #define US_TO_NS(usec) ((usec) * 1000)
337 #define MS_TO_US(msec) ((msec) * 1000)
338 #define MS_TO_NS(msec) ((msec) * 1000 * 1000)
340 void ir_raw_event_handle(struct rc_dev
*dev
);
341 int ir_raw_event_store(struct rc_dev
*dev
, struct ir_raw_event
*ev
);
342 int ir_raw_event_store_edge(struct rc_dev
*dev
, bool pulse
);
343 int ir_raw_event_store_with_filter(struct rc_dev
*dev
,
344 struct ir_raw_event
*ev
);
345 void ir_raw_event_set_idle(struct rc_dev
*dev
, bool idle
);
346 int ir_raw_encode_scancode(enum rc_proto protocol
, u32 scancode
,
347 struct ir_raw_event
*events
, unsigned int max
);
348 int ir_raw_encode_carrier(enum rc_proto protocol
);
350 static inline void ir_raw_event_reset(struct rc_dev
*dev
)
352 struct ir_raw_event ev
= { .reset
= true };
354 ir_raw_event_store(dev
, &ev
);
355 ir_raw_event_handle(dev
);
358 /* extract mask bits out of data and pack them into the result */
359 static inline u32
ir_extract_bits(u32 data
, u32 mask
)
361 u32 vbit
= 1, value
= 0;
370 } while (mask
>>= 1);
375 /* Get NEC scancode and protocol type from address and command bytes */
376 static inline u32
ir_nec_bytes_to_scancode(u8 address
, u8 not_address
,
377 u8 command
, u8 not_command
,
378 enum rc_proto
*protocol
)
382 if ((command
^ not_command
) != 0xff) {
383 /* NEC transport, but modified protocol, used by at
384 * least Apple and TiVo remotes
386 scancode
= not_address
<< 24 |
390 *protocol
= RC_PROTO_NEC32
;
391 } else if ((address
^ not_address
) != 0xff) {
393 scancode
= address
<< 16 |
396 *protocol
= RC_PROTO_NECX
;
399 scancode
= address
<< 8 | command
;
400 *protocol
= RC_PROTO_NEC
;
406 #endif /* _RC_CORE */