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 pr_debug("%s: " fmt, __func__, ##__VA_ARGS__); \
33 RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
34 RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */
38 * struct rc_scancode_filter - Filter scan codes.
39 * @data: Scancode data to match.
40 * @mask: Mask of bits of scancode to compare.
42 struct rc_scancode_filter {
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.
61 * struct rc_dev - represents a remote control device
62 * @dev: driver model's view of this device
63 * @input_name: name of the input child device
64 * @input_phys: physical path to the input child device
65 * @input_id: id of the input child device (struct input_id)
66 * @driver_name: name of the hardware driver which registered this device
67 * @map_name: name of the default keymap
68 * @rc_map: current scan/key table
69 * @lock: used to ensure we've filled in all protocol details before
70 * anyone can call show_protocols or store_protocols
71 * @devno: unique remote control device number
72 * @raw: additional data for raw pulse/space devices
73 * @input_dev: the input child device used to communicate events to userspace
74 * @driver_type: specifies if protocol decoding is done in hardware or software
75 * @idle: used to keep track of RX state
76 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols for each
78 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols for each
80 * @scanmask: some hardware decoders are not capable of providing the full
81 * scancode to the application. As this is a hardware limit, we can't do
82 * anything with it. Yet, as the same keycode table can be used with other
83 * devices, a mask is provided to allow its usage. Drivers should generally
84 * leave this field in blank
85 * @priv: driver-specific data
86 * @keylock: protects the remaining members of the struct
87 * @keypressed: whether a key is currently pressed
88 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
89 * @timer_keyup: timer for releasing a keypress
90 * @last_keycode: keycode of last keypress
91 * @last_scancode: scancode of last keypress
92 * @last_toggle: toggle value of last command
93 * @timeout: optional time after which device stops sending data
94 * @min_timeout: minimum timeout supported by device
95 * @max_timeout: maximum timeout supported by device
96 * @rx_resolution : resolution (in ns) of input sampler
97 * @tx_resolution: resolution (in ns) of output sampler
98 * @scancode_filters: scancode filters (indexed by enum rc_filter_type)
99 * @change_protocol: allow changing the protocol used on hardware decoders
100 * @open: callback to allow drivers to enable polling/irq when IR input device
102 * @close: callback to allow drivers to disable polling/irq when IR input device
104 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
105 * @s_tx_carrier: set transmit carrier frequency
106 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
107 * @s_rx_carrier: inform driver about carrier it is expected to handle
108 * @tx_ir: transmit IR
109 * @s_idle: enable/disable hardware idle mode, upon which,
110 * device doesn't interrupt host until it sees IR pulses
111 * @s_learning_mode: enable wide band receiver used for learning
112 * @s_carrier_report: enable carrier reports
113 * @s_filter: set the scancode filter of a given type
117 const char *input_name;
118 const char *input_phys;
119 struct input_id input_id;
121 const char *map_name;
122 struct rc_map rc_map;
125 struct ir_raw_event_ctrl *raw;
126 struct input_dev *input_dev;
127 enum rc_driver_type driver_type;
129 u64 allowed_protocols[RC_FILTER_MAX];
130 u64 enabled_protocols[RC_FILTER_MAX];
136 unsigned long keyup_jiffies;
137 struct timer_list timer_keyup;
146 struct rc_scancode_filter scancode_filters[RC_FILTER_MAX];
147 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
148 int (*open)(struct rc_dev *dev);
149 void (*close)(struct rc_dev *dev);
150 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
151 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
152 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
153 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
154 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
155 void (*s_idle)(struct rc_dev *dev, bool enable);
156 int (*s_learning_mode)(struct rc_dev *dev, int enable);
157 int (*s_carrier_report) (struct rc_dev *dev, int enable);
158 int (*s_filter)(struct rc_dev *dev,
159 enum rc_filter_type type,
160 struct rc_scancode_filter *filter);
163 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
165 static inline bool rc_protocols_allowed(struct rc_dev *rdev, u64 protos)
167 return rdev->allowed_protocols[RC_FILTER_NORMAL] & protos;
170 /* should be called prior to registration or with mutex held */
171 static inline void rc_set_allowed_protocols(struct rc_dev *rdev, u64 protos)
173 rdev->allowed_protocols[RC_FILTER_NORMAL] = protos;
176 static inline bool rc_protocols_enabled(struct rc_dev *rdev, u64 protos)
178 return rdev->enabled_protocols[RC_FILTER_NORMAL] & protos;
181 /* should be called prior to registration or with mutex held */
182 static inline void rc_set_enabled_protocols(struct rc_dev *rdev, u64 protos)
184 rdev->enabled_protocols[RC_FILTER_NORMAL] = protos;
187 /* should be called prior to registration or with mutex held */
188 static inline void rc_set_allowed_wakeup_protocols(struct rc_dev *rdev,
191 rdev->allowed_protocols[RC_FILTER_WAKEUP] = protos;
194 /* should be called prior to registration or with mutex held */
195 static inline void rc_set_enabled_wakeup_protocols(struct rc_dev *rdev,
198 rdev->enabled_protocols[RC_FILTER_WAKEUP] = protos;
203 * Those functions can be used on any type of Remote Controller. They
204 * basically creates an input_dev and properly reports the device as a
205 * Remote Controller, at sys/class/rc.
208 struct rc_dev *rc_allocate_device(void);
209 void rc_free_device(struct rc_dev *dev);
210 int rc_register_device(struct rc_dev *dev);
211 void rc_unregister_device(struct rc_dev *dev);
213 int rc_open(struct rc_dev *rdev);
214 void rc_close(struct rc_dev *rdev);
216 void rc_repeat(struct rc_dev *dev);
217 void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
218 void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
219 void rc_keyup(struct rc_dev *dev);
220 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
224 * The Raw interface is specific to InfraRed. It may be a good idea to
225 * split it later into a separate header.
228 enum raw_event_type {
231 IR_START_EVENT = (1 << 2),
232 IR_STOP_EVENT = (1 << 3),
235 struct ir_raw_event {
248 unsigned carrier_report:1;
251 #define DEFINE_IR_RAW_EVENT(event) \
252 struct ir_raw_event event = { \
253 { .duration = 0 } , \
257 .carrier_report = 0 }
259 static inline void init_ir_raw_event(struct ir_raw_event *ev)
261 memset(ev, 0, sizeof(*ev));
264 #define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
265 #define US_TO_NS(usec) ((usec) * 1000)
266 #define MS_TO_US(msec) ((msec) * 1000)
267 #define MS_TO_NS(msec) ((msec) * 1000 * 1000)
269 void ir_raw_event_handle(struct rc_dev *dev);
270 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
271 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
272 int ir_raw_event_store_with_filter(struct rc_dev *dev,
273 struct ir_raw_event *ev);
274 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
276 static inline void ir_raw_event_reset(struct rc_dev *dev)
278 DEFINE_IR_RAW_EVENT(ev);
281 ir_raw_event_store(dev, &ev);
282 ir_raw_event_handle(dev);
285 /* extract mask bits out of data and pack them into the result */
286 static inline u32 ir_extract_bits(u32 data, u32 mask)
288 u32 vbit = 1, value = 0;
297 } while (mask >>= 1);
302 #endif /* _RC_CORE */