1 /*
2 * Remote Controller core header
3 *
4 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
5 *
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.
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
16 #ifndef _RC_CORE
17 #define _RC_CORE
18
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>
24
25 extern int rc_core_debug;
26 #define IR_dprintk(level, fmt, ...) \
27 do { \
28 if (rc_core_debug >= level) \
29 pr_debug("%s: " fmt, __func__, ##__VA_ARGS__); \
30 } while (0)
31
32 enum 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
37 /**
38 * struct rc_dev - represents a remote control device
39 * @dev: driver model's view of this device
40 * @input_name: name of the input child device
41 * @input_phys: physical path to the input child device
42 * @input_id: id of the input child device (struct input_id)
43 * @driver_name: name of the hardware driver which registered this device
44 * @map_name: name of the default keymap
45 * @rc_map: current scan/key table
46 * @lock: used to ensure we've filled in all protocol details before
47 * anyone can call show_protocols or store_protocols
48 * @devno: unique remote control device number
49 * @raw: additional data for raw pulse/space devices
50 * @input_dev: the input child device used to communicate events to userspace
51 * @driver_type: specifies if protocol decoding is done in hardware or software
52 * @idle: used to keep track of RX state
53 * @allowed_protos: bitmask with the supported RC_TYPE_* protocols
54 * @scanmask: some hardware decoders are not capable of providing the full
55 * scancode to the application. As this is a hardware limit, we can't do
56 * anything with it. Yet, as the same keycode table can be used with other
57 * devices, a mask is provided to allow its usage. Drivers should generally
58 * leave this field in blank
59 * @priv: driver-specific data
60 * @keylock: protects the remaining members of the struct
61 * @keypressed: whether a key is currently pressed
62 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
63 * @timer_keyup: timer for releasing a keypress
64 * @last_keycode: keycode of last keypress
65 * @last_scancode: scancode of last keypress
66 * @last_toggle: toggle value of last command
67 * @timeout: optional time after which device stops sending data
68 * @min_timeout: minimum timeout supported by device
69 * @max_timeout: maximum timeout supported by device
70 * @rx_resolution : resolution (in ns) of input sampler
71 * @tx_resolution: resolution (in ns) of output sampler
72 * @change_protocol: allow changing the protocol used on hardware decoders
73 * @open: callback to allow drivers to enable polling/irq when IR input device
74 * is opened.
75 * @close: callback to allow drivers to disable polling/irq when IR input device
76 * is opened.
77 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
78 * @s_tx_carrier: set transmit carrier frequency
79 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
80 * @s_rx_carrier: inform driver about carrier it is expected to handle
81 * @tx_ir: transmit IR
82 * @s_idle: enable/disable hardware idle mode, upon which,
83 * device doesn't interrupt host until it sees IR pulses
84 * @s_learning_mode: enable wide band receiver used for learning
85 * @s_carrier_report: enable carrier reports
86 */
87 struct rc_dev {
88 struct device dev;
89 const char *input_name;
90 const char *input_phys;
91 struct input_id input_id;
92 char *driver_name;
93 const char *map_name;
94 struct rc_map rc_map;
95 struct mutex lock;
96 unsigned long devno;
97 struct ir_raw_event_ctrl *raw;
98 struct input_dev *input_dev;
99 enum rc_driver_type driver_type;
100 bool idle;
101 u64 allowed_protos;
102 u32 scanmask;
103 void *priv;
104 spinlock_t keylock;
105 bool keypressed;
106 unsigned long keyup_jiffies;
107 struct timer_list timer_keyup;
108 u32 last_keycode;
109 u32 last_scancode;
110 u8 last_toggle;
111 u32 timeout;
112 u32 min_timeout;
113 u32 max_timeout;
114 u32 rx_resolution;
115 u32 tx_resolution;
116 int (*change_protocol)(struct rc_dev *dev, u64 rc_type);
117 int (*open)(struct rc_dev *dev);
118 void (*close)(struct rc_dev *dev);
119 int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
120 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
121 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
122 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
123 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
124 void (*s_idle)(struct rc_dev *dev, bool enable);
125 int (*s_learning_mode)(struct rc_dev *dev, int enable);
126 int (*s_carrier_report) (struct rc_dev *dev, int enable);
127 };
128
129 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
130
131 /*
132 * From rc-main.c
133 * Those functions can be used on any type of Remote Controller. They
134 * basically creates an input_dev and properly reports the device as a
135 * Remote Controller, at sys/class/rc.
136 */
137
138 struct rc_dev *rc_allocate_device(void);
139 void rc_free_device(struct rc_dev *dev);
140 int rc_register_device(struct rc_dev *dev);
141 void rc_unregister_device(struct rc_dev *dev);
142
143 void rc_repeat(struct rc_dev *dev);
144 void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
145 void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
146 void rc_keyup(struct rc_dev *dev);
147 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
148
149 /*
150 * From rc-raw.c
151 * The Raw interface is specific to InfraRed. It may be a good idea to
152 * split it later into a separate header.
153 */
154
155 enum raw_event_type {
156 IR_SPACE = (1 << 0),
157 IR_PULSE = (1 << 1),
158 IR_START_EVENT = (1 << 2),
159 IR_STOP_EVENT = (1 << 3),
160 };
161
162 struct ir_raw_event {
163 union {
164 u32 duration;
165
166 struct {
167 u32 carrier;
168 u8 duty_cycle;
169 };
170 };
171
172 unsigned pulse:1;
173 unsigned reset:1;
174 unsigned timeout:1;
175 unsigned carrier_report:1;
176 };
177
178 #define DEFINE_IR_RAW_EVENT(event) \
179 struct ir_raw_event event = { \
180 { .duration = 0 } , \
181 .pulse = 0, \
182 .reset = 0, \
183 .timeout = 0, \
184 .carrier_report = 0 }
185
init_ir_raw_event(struct ir_raw_event * ev)186 static inline void init_ir_raw_event(struct ir_raw_event *ev)
187 {
188 memset(ev, 0, sizeof(*ev));
189 }
190
191 #define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
192 #define US_TO_NS(usec) ((usec) * 1000)
193 #define MS_TO_US(msec) ((msec) * 1000)
194 #define MS_TO_NS(msec) ((msec) * 1000 * 1000)
195
196 void ir_raw_event_handle(struct rc_dev *dev);
197 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
198 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
199 int ir_raw_event_store_with_filter(struct rc_dev *dev,
200 struct ir_raw_event *ev);
201 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
202
ir_raw_event_reset(struct rc_dev * dev)203 static inline void ir_raw_event_reset(struct rc_dev *dev)
204 {
205 DEFINE_IR_RAW_EVENT(ev);
206 ev.reset = true;
207
208 ir_raw_event_store(dev, &ev);
209 ir_raw_event_handle(dev);
210 }
211
212 /* extract mask bits out of data and pack them into the result */
ir_extract_bits(u32 data,u32 mask)213 static inline u32 ir_extract_bits(u32 data, u32 mask)
214 {
215 u32 vbit = 1, value = 0;
216
217 do {
218 if (mask & 1) {
219 if (data & 1)
220 value |= vbit;
221 vbit <<= 1;
222 }
223 data >>= 1;
224 } while (mask >>= 1);
225
226 return value;
227 }
228
229 #endif /* _RC_CORE */
230