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