blob: 45534da57759a30d4a8c281bda094c8d4921dba3 [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 Chehab626cf692010-04-06 23:21:46 -030032enum 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
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -030037/**
James Hogan00942d12014-01-17 10:58:49 -030038 * 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/**
David Härdemand8b4b582010-10-29 16:08:23 -030061 * struct rc_dev - represents a remote control device
62 * @dev: driver model's view of this device
David Härdeman99b0f3c2014-04-04 19:06:06 -030063 * @sysfs_groups: sysfs attribute groups
David Härdemand8b4b582010-10-29 16:08:23 -030064 * @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
Mauro Carvalho Chehabb088ba62010-11-17 14:28:27 -030069 * @rc_map: current scan/key table
Jarod Wilson08aeb7c2011-05-11 15:14:31 -030070 * @lock: used to ensure we've filled in all protocol details before
71 * anyone can call show_protocols or store_protocols
David Härdemand8b4b582010-10-29 16:08:23 -030072 * @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
Jarod Wilson08aeb7c2011-05-11 15:14:31 -030075 * @driver_type: specifies if protocol decoding is done in hardware or software
David Härdemand8b4b582010-10-29 16:08:23 -030076 * @idle: used to keep track of RX state
James Hogan0d830b22015-03-31 14:48:10 -030077 * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
78 * wakeup protocols is the set of all raw encoders
David Härdemanc5540fb2014-04-03 20:32:21 -030079 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols
80 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
81 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols
82 * @enabled_wakeup_protocols: bitmask with the enabled RC_BIT_* wakeup protocols
83 * @scancode_filter: scancode filter
84 * @scancode_wakeup_filter: scancode wakeup filters
David Härdeman9d2f1d32014-04-03 20:32:26 -030085 * @scancode_mask: some hardware decoders are not capable of providing the full
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -030086 * scancode to the application. As this is a hardware limit, we can't do
87 * anything with it. Yet, as the same keycode table can be used with other
88 * devices, a mask is provided to allow its usage. Drivers should generally
89 * leave this field in blank
David Härdeman9d2f1d32014-04-03 20:32:26 -030090 * @users: number of current users of the device
David Härdemand8b4b582010-10-29 16:08:23 -030091 * @priv: driver-specific data
92 * @keylock: protects the remaining members of the struct
93 * @keypressed: whether a key is currently pressed
94 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
95 * @timer_keyup: timer for releasing a keypress
96 * @last_keycode: keycode of last keypress
David Härdeman120703f2014-04-03 20:31:30 -030097 * @last_protocol: protocol of last keypress
David Härdemand8b4b582010-10-29 16:08:23 -030098 * @last_scancode: scancode of last keypress
99 * @last_toggle: toggle value of last command
Maxim Levitsky4a702eb2010-07-31 11:59:22 -0300100 * @timeout: optional time after which device stops sending data
101 * @min_timeout: minimum timeout supported by device
102 * @max_timeout: maximum timeout supported by device
Maxim Levitskye5893332010-07-31 11:59:23 -0300103 * @rx_resolution : resolution (in ns) of input sampler
104 * @tx_resolution: resolution (in ns) of output sampler
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -0300105 * @change_protocol: allow changing the protocol used on hardware decoders
James Hoganab88c662014-02-28 20:17:05 -0300106 * @change_wakeup_protocol: allow changing the protocol used for wakeup
107 * filtering
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -0300108 * @open: callback to allow drivers to enable polling/irq when IR input device
109 * is opened.
110 * @close: callback to allow drivers to disable polling/irq when IR input device
111 * is opened.
Jarod Wilson9b7c54d2010-06-16 17:55:25 -0300112 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
113 * @s_tx_carrier: set transmit carrier frequency
Maxim Levitskye5893332010-07-31 11:59:23 -0300114 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
115 * @s_rx_carrier: inform driver about carrier it is expected to handle
Jarod Wilson9b7c54d2010-06-16 17:55:25 -0300116 * @tx_ir: transmit IR
David Härdemand8b4b582010-10-29 16:08:23 -0300117 * @s_idle: enable/disable hardware idle mode, upon which,
118 * device doesn't interrupt host until it sees IR pulses
Maxim Levitskye5893332010-07-31 11:59:23 -0300119 * @s_learning_mode: enable wide band receiver used for learning
Maxim Levitsky46519182010-10-16 19:56:28 -0300120 * @s_carrier_report: enable carrier reports
David Härdeman120703f2014-04-03 20:31:30 -0300121 * @s_filter: set the scancode filter
David Härdeman23c843b2014-04-04 19:06:01 -0300122 * @s_wakeup_filter: set the wakeup scancode filter
Mauro Carvalho Chehab9dfe4e82010-04-04 14:06:55 -0300123 */
David Härdemand8b4b582010-10-29 16:08:23 -0300124struct rc_dev {
125 struct device dev;
David Härdeman99b0f3c2014-04-04 19:06:06 -0300126 const struct attribute_group *sysfs_groups[5];
David Härdemand8b4b582010-10-29 16:08:23 -0300127 const char *input_name;
128 const char *input_phys;
129 struct input_id input_id;
130 char *driver_name;
131 const char *map_name;
Jarod Wilson08aeb7c2011-05-11 15:14:31 -0300132 struct rc_map rc_map;
133 struct mutex lock;
David Härdemand8b4b582010-10-29 16:08:23 -0300134 unsigned long devno;
135 struct ir_raw_event_ctrl *raw;
136 struct input_dev *input_dev;
137 enum rc_driver_type driver_type;
Maxim Levitsky4a702eb2010-07-31 11:59:22 -0300138 bool idle;
James Hogan0d830b22015-03-31 14:48:10 -0300139 bool encode_wakeup;
David Härdemanc5540fb2014-04-03 20:32:21 -0300140 u64 allowed_protocols;
141 u64 enabled_protocols;
142 u64 allowed_wakeup_protocols;
143 u64 enabled_wakeup_protocols;
144 struct rc_scancode_filter scancode_filter;
145 struct rc_scancode_filter scancode_wakeup_filter;
David Härdeman9d2f1d32014-04-03 20:32:26 -0300146 u32 scancode_mask;
Srinivas Kandagatla8b2ff322013-07-22 04:22:57 -0300147 u32 users;
David Härdemand8b4b582010-10-29 16:08:23 -0300148 void *priv;
149 spinlock_t keylock;
150 bool keypressed;
151 unsigned long keyup_jiffies;
152 struct timer_list timer_keyup;
153 u32 last_keycode;
David Härdeman120703f2014-04-03 20:31:30 -0300154 enum rc_type last_protocol;
David Härdemand8b4b582010-10-29 16:08:23 -0300155 u32 last_scancode;
156 u8 last_toggle;
157 u32 timeout;
158 u32 min_timeout;
159 u32 max_timeout;
160 u32 rx_resolution;
161 u32 tx_resolution;
David Härdemanc003ab12012-10-11 19:11:54 -0300162 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
James Hoganab88c662014-02-28 20:17:05 -0300163 int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type);
David Härdemand8b4b582010-10-29 16:08:23 -0300164 int (*open)(struct rc_dev *dev);
165 void (*close)(struct rc_dev *dev);
166 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
167 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
168 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
169 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
David Härdeman5588dc22011-04-28 12:13:58 -0300170 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
David Härdemand8b4b582010-10-29 16:08:23 -0300171 void (*s_idle)(struct rc_dev *dev, bool enable);
172 int (*s_learning_mode)(struct rc_dev *dev, int enable);
173 int (*s_carrier_report) (struct rc_dev *dev, int enable);
James Hogan00942d12014-01-17 10:58:49 -0300174 int (*s_filter)(struct rc_dev *dev,
James Hogan00942d12014-01-17 10:58:49 -0300175 struct rc_scancode_filter *filter);
David Härdeman23c843b2014-04-04 19:06:01 -0300176 int (*s_wakeup_filter)(struct rc_dev *dev,
177 struct rc_scancode_filter *filter);
Mauro Carvalho Chehab75543cc2009-12-11 09:44:23 -0300178};
Mauro Carvalho Chehaba3572c32010-03-20 20:59:44 -0300179
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300180#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
181
182/*
183 * From rc-main.c
184 * Those functions can be used on any type of Remote Controller. They
185 * basically creates an input_dev and properly reports the device as a
186 * Remote Controller, at sys/class/rc.
187 */
188
189struct rc_dev *rc_allocate_device(void);
190void rc_free_device(struct rc_dev *dev);
191int rc_register_device(struct rc_dev *dev);
192void rc_unregister_device(struct rc_dev *dev);
193
Srinivas Kandagatla8b2ff322013-07-22 04:22:57 -0300194int rc_open(struct rc_dev *rdev);
195void rc_close(struct rc_dev *rdev);
196
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300197void rc_repeat(struct rc_dev *dev);
David Härdeman120703f2014-04-03 20:31:30 -0300198void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
199void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300200void rc_keyup(struct rc_dev *dev);
201u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
202
203/*
204 * From rc-raw.c
205 * The Raw interface is specific to InfraRed. It may be a good idea to
206 * split it later into a separate header.
207 */
208
Mauro Carvalho Chehab3f113e32010-04-08 15:10:27 -0300209enum raw_event_type {
210 IR_SPACE = (1 << 0),
211 IR_PULSE = (1 << 1),
212 IR_START_EVENT = (1 << 2),
213 IR_STOP_EVENT = (1 << 3),
Mauro Carvalho Chehab995187b2010-03-24 20:47:53 -0300214};
215
David Härdemane40b1122010-04-15 18:46:00 -0300216struct ir_raw_event {
Maxim Levitsky46519182010-10-16 19:56:28 -0300217 union {
218 u32 duration;
219
220 struct {
221 u32 carrier;
222 u8 duty_cycle;
223 };
224 };
225
226 unsigned pulse:1;
227 unsigned reset:1;
228 unsigned timeout:1;
229 unsigned carrier_report:1;
David Härdemane40b1122010-04-15 18:46:00 -0300230};
Mauro Carvalho Chehaba3572c32010-03-20 20:59:44 -0300231
Maxim Levitsky46519182010-10-16 19:56:28 -0300232#define DEFINE_IR_RAW_EVENT(event) \
233 struct ir_raw_event event = { \
234 { .duration = 0 } , \
235 .pulse = 0, \
236 .reset = 0, \
237 .timeout = 0, \
238 .carrier_report = 0 }
239
240static inline void init_ir_raw_event(struct ir_raw_event *ev)
241{
242 memset(ev, 0, sizeof(*ev));
243}
244
Mauro Carvalho Chehab6b20cf32015-06-05 10:30:44 -0300245#define IR_MAX_DURATION 500000000 /* 500 ms */
Jarod Wilson5aad7242011-01-06 16:59:36 -0300246#define US_TO_NS(usec) ((usec) * 1000)
247#define MS_TO_US(msec) ((msec) * 1000)
248#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
Antti Seppäläda7ee602015-03-31 14:48:12 -0300249#define NS_TO_US(nsec) DIV_ROUND_UP(nsec, 1000L)
David Härdemane40b1122010-04-15 18:46:00 -0300250
David Härdemand8b4b582010-10-29 16:08:23 -0300251void ir_raw_event_handle(struct rc_dev *dev);
252int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
253int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
254int ir_raw_event_store_with_filter(struct rc_dev *dev,
255 struct ir_raw_event *ev);
256void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
James Hogan9869da52015-03-31 14:48:06 -0300257int ir_raw_encode_scancode(u64 protocols,
258 const struct rc_scancode_filter *scancode,
259 struct ir_raw_event *events, unsigned int max);
David Härdemand8b4b582010-10-29 16:08:23 -0300260
261static inline void ir_raw_event_reset(struct rc_dev *dev)
David Härdemane40b1122010-04-15 18:46:00 -0300262{
Maxim Levitsky46519182010-10-16 19:56:28 -0300263 DEFINE_IR_RAW_EVENT(ev);
264 ev.reset = true;
265
David Härdemand8b4b582010-10-29 16:08:23 -0300266 ir_raw_event_store(dev, &ev);
267 ir_raw_event_handle(dev);
David Härdemane40b1122010-04-15 18:46:00 -0300268}
David Härdeman724e2492010-04-08 13:10:00 -0300269
David Härdeman3ffea492010-10-29 16:08:12 -0300270/* extract mask bits out of data and pack them into the result */
271static inline u32 ir_extract_bits(u32 data, u32 mask)
272{
273 u32 vbit = 1, value = 0;
274
275 do {
David Härdeman829ba9f2010-11-19 20:43:27 -0300276 if (mask & 1) {
277 if (data & 1)
278 value |= vbit;
279 vbit <<= 1;
280 }
281 data >>= 1;
David Härdeman3ffea492010-10-29 16:08:12 -0300282 } while (mask >>= 1);
283
284 return value;
285}
286
Mauro Carvalho Chehabca866742010-11-17 13:53:11 -0300287#endif /* _RC_CORE */