blob: 55281b92105a3ebd0d2e899028c3781e298738ea [file] [log] [blame]
Mauro Carvalho Chehab446e4a62009-12-11 08:34:07 -03001/*
2 * Remote Controller core header
3 *
Mauro Carvalho Chehab37e59f82014-02-07 08:03:07 -02004 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
Mauro Carvalho Chehab995187b2010-03-24 20:47:53 -03005 *
Mauro Carvalho Chehab446e4a62009-12-11 08:34:07 -03006 * 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
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -030016#ifndef _RC_CORE
17#define _RC_CORE
Mauro Carvalho Chehab446e4a62009-12-11 08:34:07 -030018
Mauro Carvalho Chehab446e4a62009-12-11 08:34:07 -030019#include <linux/spinlock.h>
Mauro Carvalho Chehaba3572c32010-03-20 20:59:44 -030020#include <linux/kfifo.h>
21#include <linux/time.h>
Mauro Carvalho Chehab9f154782010-03-21 13:00:55 -030022#include <linux/timer.h>
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -030023#include <media/rc-map.h>
Mauro Carvalho Chehab446e4a62009-12-11 08:34:07 -030024
Mauro Carvalho Chehab6bda9642010-11-17 13:28:38 -030025extern int rc_core_debug;
Joe Perches86b0dbe2011-08-21 19:56:45 -030026#define IR_dprintk(level, fmt, ...) \
27do { \
28 if (rc_core_debug >= level) \
Mauro Carvalho Chehab7cec72c2014-07-25 23:25:36 -030029 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
Joe Perches86b0dbe2011-08-21 19:56:45 -030030} while (0)
Mauro Carvalho Chehab446e4a62009-12-11 08:34:07 -030031
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -030032/**
33 * enum rc_driver_type - type of the RC output
34 *
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 */
Mauro Carvalho Chehab626cf692010-04-06 23:21:46 -030039enum rc_driver_type {
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -030040 RC_DRIVER_SCANCODE = 0,
41 RC_DRIVER_IR_RAW,
Mauro Carvalho Chehab626cf692010-04-06 23:21:46 -030042};
43
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -030044/**
James Hogan00942d12014-01-17 10:58:49 -030045 * struct rc_scancode_filter - Filter scan codes.
46 * @data: Scancode data to match.
47 * @mask: Mask of bits of scancode to compare.
48 */
49struct rc_scancode_filter {
50 u32 data;
51 u32 mask;
52};
53
54/**
55 * enum rc_filter_type - Filter type constants.
56 * @RC_FILTER_NORMAL: Filter for normal operation.
57 * @RC_FILTER_WAKEUP: Filter for waking from suspend.
58 * @RC_FILTER_MAX: Number of filter types.
59 */
60enum rc_filter_type {
61 RC_FILTER_NORMAL = 0,
62 RC_FILTER_WAKEUP,
63
64 RC_FILTER_MAX
65};
66
67/**
David Härdemand8b4b582010-10-29 16:08:23 -030068 * struct rc_dev - represents a remote control device
69 * @dev: driver model's view of this device
Mauro Carvalho Chehab078600f2016-03-02 08:00:15 -030070 * @initialized: 1 if the device init has completed, 0 otherwise
Heiner Kallweitddbf7d52016-09-30 17:42:07 -030071 * @managed_alloc: devm_rc_allocate_device was used to create rc_dev
David Härdeman99b0f3c2014-04-04 19:06:06 -030072 * @sysfs_groups: sysfs attribute groups
David Härdemand8b4b582010-10-29 16:08:23 -030073 * @input_name: name of the input child device
74 * @input_phys: physical path to the input child device
75 * @input_id: id of the input child device (struct input_id)
76 * @driver_name: name of the hardware driver which registered this device
77 * @map_name: name of the default keymap
Mauro Carvalho Chehabb088ba62010-11-17 14:28:27 -030078 * @rc_map: current scan/key table
Jarod Wilson08aeb7c2011-05-11 15:14:31 -030079 * @lock: used to ensure we've filled in all protocol details before
80 * anyone can call show_protocols or store_protocols
David Härdemanfcb13092015-05-19 19:03:17 -030081 * @minor: unique minor remote control device number
David Härdemand8b4b582010-10-29 16:08:23 -030082 * @raw: additional data for raw pulse/space devices
83 * @input_dev: the input child device used to communicate events to userspace
Jarod Wilson08aeb7c2011-05-11 15:14:31 -030084 * @driver_type: specifies if protocol decoding is done in hardware or software
David Härdemand8b4b582010-10-29 16:08:23 -030085 * @idle: used to keep track of RX state
David Härdemanc5540fb2014-04-03 20:32:21 -030086 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols
87 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
88 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols
89 * @enabled_wakeup_protocols: bitmask with the enabled RC_BIT_* wakeup protocols
90 * @scancode_filter: scancode filter
91 * @scancode_wakeup_filter: scancode wakeup filters
David Härdeman9d2f1d32014-04-03 20:32:26 -030092 * @scancode_mask: some hardware decoders are not capable of providing the full
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -030093 * scancode to the application. As this is a hardware limit, we can't do
94 * anything with it. Yet, as the same keycode table can be used with other
95 * devices, a mask is provided to allow its usage. Drivers should generally
96 * leave this field in blank
David Härdeman9d2f1d32014-04-03 20:32:26 -030097 * @users: number of current users of the device
David Härdemand8b4b582010-10-29 16:08:23 -030098 * @priv: driver-specific data
99 * @keylock: protects the remaining members of the struct
100 * @keypressed: whether a key is currently pressed
101 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
102 * @timer_keyup: timer for releasing a keypress
103 * @last_keycode: keycode of last keypress
David Härdeman120703f2014-04-03 20:31:30 -0300104 * @last_protocol: protocol of last keypress
David Härdemand8b4b582010-10-29 16:08:23 -0300105 * @last_scancode: scancode of last keypress
106 * @last_toggle: toggle value of last command
Maxim Levitsky4a702eb2010-07-31 11:59:22 -0300107 * @timeout: optional time after which device stops sending data
108 * @min_timeout: minimum timeout supported by device
109 * @max_timeout: maximum timeout supported by device
Maxim Levitskye5893332010-07-31 11:59:23 -0300110 * @rx_resolution : resolution (in ns) of input sampler
111 * @tx_resolution: resolution (in ns) of output sampler
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -0300112 * @change_protocol: allow changing the protocol used on hardware decoders
James Hoganab88c662014-02-28 20:17:05 -0300113 * @change_wakeup_protocol: allow changing the protocol used for wakeup
114 * filtering
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -0300115 * @open: callback to allow drivers to enable polling/irq when IR input device
116 * is opened.
117 * @close: callback to allow drivers to disable polling/irq when IR input device
118 * is opened.
Jarod Wilson9b7c54d2010-06-16 17:55:25 -0300119 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
120 * @s_tx_carrier: set transmit carrier frequency
Maxim Levitskye5893332010-07-31 11:59:23 -0300121 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
Mauro Carvalho Chehabfa810842015-08-22 05:25:45 -0300122 * @s_rx_carrier_range: inform driver about carrier it is expected to handle
Jarod Wilson9b7c54d2010-06-16 17:55:25 -0300123 * @tx_ir: transmit IR
David Härdemand8b4b582010-10-29 16:08:23 -0300124 * @s_idle: enable/disable hardware idle mode, upon which,
125 * device doesn't interrupt host until it sees IR pulses
Maxim Levitskye5893332010-07-31 11:59:23 -0300126 * @s_learning_mode: enable wide band receiver used for learning
Maxim Levitsky46519182010-10-16 19:56:28 -0300127 * @s_carrier_report: enable carrier reports
David Härdeman120703f2014-04-03 20:31:30 -0300128 * @s_filter: set the scancode filter
David Härdeman23c843b2014-04-04 19:06:01 -0300129 * @s_wakeup_filter: set the wakeup scancode filter
Sean Young4f253ce2016-07-10 13:34:38 -0300130 * @s_timeout: set hardware timeout in ns
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -0300131 */
David Härdemand8b4b582010-10-29 16:08:23 -0300132struct rc_dev {
133 struct device dev;
Mauro Carvalho Chehab078600f2016-03-02 08:00:15 -0300134 atomic_t initialized;
Heiner Kallweitddbf7d52016-09-30 17:42:07 -0300135 bool managed_alloc;
David Härdeman99b0f3c2014-04-04 19:06:06 -0300136 const struct attribute_group *sysfs_groups[5];
David Härdemand8b4b582010-10-29 16:08:23 -0300137 const char *input_name;
138 const char *input_phys;
139 struct input_id input_id;
140 char *driver_name;
141 const char *map_name;
Jarod Wilson08aeb7c2011-05-11 15:14:31 -0300142 struct rc_map rc_map;
143 struct mutex lock;
David Härdemanfcb13092015-05-19 19:03:17 -0300144 unsigned int minor;
David Härdemand8b4b582010-10-29 16:08:23 -0300145 struct ir_raw_event_ctrl *raw;
146 struct input_dev *input_dev;
147 enum rc_driver_type driver_type;
Maxim Levitsky4a702eb2010-07-31 11:59:22 -0300148 bool idle;
David Härdemanc5540fb2014-04-03 20:32:21 -0300149 u64 allowed_protocols;
150 u64 enabled_protocols;
151 u64 allowed_wakeup_protocols;
152 u64 enabled_wakeup_protocols;
153 struct rc_scancode_filter scancode_filter;
154 struct rc_scancode_filter scancode_wakeup_filter;
David Härdeman9d2f1d32014-04-03 20:32:26 -0300155 u32 scancode_mask;
Srinivas Kandagatla8b2ff322013-07-22 04:22:57 -0300156 u32 users;
David Härdemand8b4b582010-10-29 16:08:23 -0300157 void *priv;
158 spinlock_t keylock;
159 bool keypressed;
160 unsigned long keyup_jiffies;
161 struct timer_list timer_keyup;
162 u32 last_keycode;
David Härdeman120703f2014-04-03 20:31:30 -0300163 enum rc_type last_protocol;
David Härdemand8b4b582010-10-29 16:08:23 -0300164 u32 last_scancode;
165 u8 last_toggle;
166 u32 timeout;
167 u32 min_timeout;
168 u32 max_timeout;
169 u32 rx_resolution;
170 u32 tx_resolution;
David Härdemanc003ab12012-10-11 19:11:54 -0300171 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
James Hoganab88c662014-02-28 20:17:05 -0300172 int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type);
David Härdemand8b4b582010-10-29 16:08:23 -0300173 int (*open)(struct rc_dev *dev);
174 void (*close)(struct rc_dev *dev);
175 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
176 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
177 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
178 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
David Härdeman5588dc22011-04-28 12:13:58 -0300179 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
David Härdemand8b4b582010-10-29 16:08:23 -0300180 void (*s_idle)(struct rc_dev *dev, bool enable);
181 int (*s_learning_mode)(struct rc_dev *dev, int enable);
182 int (*s_carrier_report) (struct rc_dev *dev, int enable);
James Hogan00942d12014-01-17 10:58:49 -0300183 int (*s_filter)(struct rc_dev *dev,
James Hogan00942d12014-01-17 10:58:49 -0300184 struct rc_scancode_filter *filter);
David Härdeman23c843b2014-04-04 19:06:01 -0300185 int (*s_wakeup_filter)(struct rc_dev *dev,
186 struct rc_scancode_filter *filter);
Sean Young4f253ce2016-07-10 13:34:38 -0300187 int (*s_timeout)(struct rc_dev *dev,
188 unsigned int timeout);
Mauro Carvalho Chehab75543cc2009-12-11 09:44:23 -0300189};
Mauro Carvalho Chehaba3572c32010-03-20 20:59:44 -0300190
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300191#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
192
193/*
194 * From rc-main.c
195 * Those functions can be used on any type of Remote Controller. They
196 * basically creates an input_dev and properly reports the device as a
197 * Remote Controller, at sys/class/rc.
198 */
199
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300200/**
201 * rc_allocate_device - Allocates a RC device
202 *
203 * returns a pointer to struct rc_dev.
204 */
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300205struct rc_dev *rc_allocate_device(void);
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300206
207/**
Heiner Kallweitddbf7d52016-09-30 17:42:07 -0300208 * devm_rc_allocate_device - Managed RC device allocation
209 *
210 * @dev: pointer to struct device
211 * returns a pointer to struct rc_dev.
212 */
213struct rc_dev *devm_rc_allocate_device(struct device *dev);
214
215/**
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300216 * rc_free_device - Frees a RC device
217 *
218 * @dev: pointer to struct rc_dev.
219 */
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300220void rc_free_device(struct rc_dev *dev);
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300221
222/**
223 * rc_register_device - Registers a RC device
224 *
225 * @dev: pointer to struct rc_dev.
226 */
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300227int rc_register_device(struct rc_dev *dev);
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300228
229/**
Heiner Kallweitddbf7d52016-09-30 17:42:07 -0300230 * devm_rc_register_device - Manageded registering of a RC device
231 *
232 * @parent: pointer to struct device.
233 * @dev: pointer to struct rc_dev.
234 */
235int devm_rc_register_device(struct device *parent, struct rc_dev *dev);
236
237/**
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300238 * rc_unregister_device - Unregisters a RC device
239 *
240 * @dev: pointer to struct rc_dev.
241 */
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300242void rc_unregister_device(struct rc_dev *dev);
243
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300244/**
245 * rc_open - Opens a RC device
246 *
247 * @rdev: pointer to struct rc_dev.
248 */
Srinivas Kandagatla8b2ff322013-07-22 04:22:57 -0300249int rc_open(struct rc_dev *rdev);
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300250
251/**
Mauro Carvalho Chehabe383ce02016-09-22 07:59:03 -0300252 * rc_close - Closes a RC device
Mauro Carvalho Chehab5b6137dc2016-07-17 09:16:57 -0300253 *
254 * @rdev: pointer to struct rc_dev.
255 */
Srinivas Kandagatla8b2ff322013-07-22 04:22:57 -0300256void rc_close(struct rc_dev *rdev);
257
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300258void rc_repeat(struct rc_dev *dev);
David Härdeman120703f2014-04-03 20:31:30 -0300259void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
260void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300261void rc_keyup(struct rc_dev *dev);
262u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
263
264/*
265 * From rc-raw.c
266 * The Raw interface is specific to InfraRed. It may be a good idea to
267 * split it later into a separate header.
268 */
269
Mauro Carvalho Chehab3f113e32010-04-08 15:10:27 -0300270enum raw_event_type {
271 IR_SPACE = (1 << 0),
272 IR_PULSE = (1 << 1),
273 IR_START_EVENT = (1 << 2),
274 IR_STOP_EVENT = (1 << 3),
Mauro Carvalho Chehab995187b2010-03-24 20:47:53 -0300275};
276
David Härdemane40b1122010-04-15 18:46:00 -0300277struct ir_raw_event {
Maxim Levitsky46519182010-10-16 19:56:28 -0300278 union {
279 u32 duration;
Heiner Kallweit5f61ff82016-03-17 16:39:13 -0300280 u32 carrier;
Maxim Levitsky46519182010-10-16 19:56:28 -0300281 };
Heiner Kallweit5f61ff82016-03-17 16:39:13 -0300282 u8 duty_cycle;
Maxim Levitsky46519182010-10-16 19:56:28 -0300283
284 unsigned pulse:1;
285 unsigned reset:1;
286 unsigned timeout:1;
287 unsigned carrier_report:1;
David Härdemane40b1122010-04-15 18:46:00 -0300288};
Mauro Carvalho Chehaba3572c32010-03-20 20:59:44 -0300289
Heiner Kallweit5f61ff82016-03-17 16:39:13 -0300290#define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}
Maxim Levitsky46519182010-10-16 19:56:28 -0300291
292static inline void init_ir_raw_event(struct ir_raw_event *ev)
293{
294 memset(ev, 0, sizeof(*ev));
295}
296
Eric Nelsonc8e1bbc2015-10-03 08:18:50 -0700297#define IR_DEFAULT_TIMEOUT MS_TO_NS(125)
Mauro Carvalho Chehab6b20cf32015-06-05 10:30:44 -0300298#define IR_MAX_DURATION 500000000 /* 500 ms */
Jarod Wilson5aad7242011-01-06 16:59:36 -0300299#define US_TO_NS(usec) ((usec) * 1000)
300#define MS_TO_US(msec) ((msec) * 1000)
301#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
David Härdemane40b1122010-04-15 18:46:00 -0300302
David Härdemand8b4b582010-10-29 16:08:23 -0300303void ir_raw_event_handle(struct rc_dev *dev);
304int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
305int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
306int ir_raw_event_store_with_filter(struct rc_dev *dev,
307 struct ir_raw_event *ev);
308void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
309
310static inline void ir_raw_event_reset(struct rc_dev *dev)
David Härdemane40b1122010-04-15 18:46:00 -0300311{
Heiner Kallweit5f61ff82016-03-17 16:39:13 -0300312 struct ir_raw_event ev = { .reset = true };
Maxim Levitsky46519182010-10-16 19:56:28 -0300313
David Härdemand8b4b582010-10-29 16:08:23 -0300314 ir_raw_event_store(dev, &ev);
315 ir_raw_event_handle(dev);
David Härdemane40b1122010-04-15 18:46:00 -0300316}
David Härdeman724e2492010-04-08 13:10:00 -0300317
David Härdeman3ffea492010-10-29 16:08:12 -0300318/* extract mask bits out of data and pack them into the result */
319static inline u32 ir_extract_bits(u32 data, u32 mask)
320{
321 u32 vbit = 1, value = 0;
322
323 do {
David Härdeman829ba9f2010-11-19 20:43:27 -0300324 if (mask & 1) {
325 if (data & 1)
326 value |= vbit;
327 vbit <<= 1;
328 }
329 data >>= 1;
David Härdeman3ffea492010-10-29 16:08:12 -0300330 } while (mask >>= 1);
331
332 return value;
333}
334
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300335#endif /* _RC_CORE */