2 * Remote Controller core header
4 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
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 ir_core_debug
;
26 #define IR_dprintk(level, fmt, arg...) if (ir_core_debug >= level) \
27 printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
30 RC_DRIVER_SCANCODE
= 0, /* Driver or hardware generates a scancode */
31 RC_DRIVER_IR_RAW
, /* Needs a Infra-Red pulse/space decoder */
35 * struct rc_dev - represents a remote control device
36 * @dev: driver model's view of this device
37 * @input_name: name of the input child device
38 * @input_phys: physical path to the input child device
39 * @input_id: id of the input child device (struct input_id)
40 * @driver_name: name of the hardware driver which registered this device
41 * @map_name: name of the default keymap
42 * @rc_tab: current scan/key table
43 * @devno: unique remote control device number
44 * @raw: additional data for raw pulse/space devices
45 * @input_dev: the input child device used to communicate events to userspace
46 * @driver_type: specifies if protocol decoding is done in hardware or software
47 * @idle: used to keep track of RX state
48 * @allowed_protos: bitmask with the supported IR_TYPE_* protocols
49 * @scanmask: some hardware decoders are not capable of providing the full
50 * scancode to the application. As this is a hardware limit, we can't do
51 * anything with it. Yet, as the same keycode table can be used with other
52 * devices, a mask is provided to allow its usage. Drivers should generally
53 * leave this field in blank
54 * @priv: driver-specific data
55 * @keylock: protects the remaining members of the struct
56 * @keypressed: whether a key is currently pressed
57 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
58 * @timer_keyup: timer for releasing a keypress
59 * @last_keycode: keycode of last keypress
60 * @last_scancode: scancode of last keypress
61 * @last_toggle: toggle value of last command
62 * @timeout: optional time after which device stops sending data
63 * @min_timeout: minimum timeout supported by device
64 * @max_timeout: maximum timeout supported by device
65 * @rx_resolution : resolution (in ns) of input sampler
66 * @tx_resolution: resolution (in ns) of output sampler
67 * @change_protocol: allow changing the protocol used on hardware decoders
68 * @open: callback to allow drivers to enable polling/irq when IR input device
70 * @close: callback to allow drivers to disable polling/irq when IR input device
72 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
73 * @s_tx_carrier: set transmit carrier frequency
74 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
75 * @s_rx_carrier: inform driver about carrier it is expected to handle
77 * @s_idle: enable/disable hardware idle mode, upon which,
78 * device doesn't interrupt host until it sees IR pulses
79 * @s_learning_mode: enable wide band receiver used for learning
80 * @s_carrier_report: enable carrier reports
84 const char *input_name
;
85 const char *input_phys
;
86 struct input_id input_id
;
89 struct ir_scancode_table rc_tab
;
91 struct ir_raw_event_ctrl
*raw
;
92 struct input_dev
*input_dev
;
93 enum rc_driver_type driver_type
;
100 unsigned long keyup_jiffies
;
101 struct timer_list timer_keyup
;
110 int (*change_protocol
)(struct rc_dev
*dev
, u64 ir_type
);
111 int (*open
)(struct rc_dev
*dev
);
112 void (*close
)(struct rc_dev
*dev
);
113 int (*s_tx_mask
)(struct rc_dev
*dev
, u32 mask
);
114 int (*s_tx_carrier
)(struct rc_dev
*dev
, u32 carrier
);
115 int (*s_tx_duty_cycle
)(struct rc_dev
*dev
, u32 duty_cycle
);
116 int (*s_rx_carrier_range
)(struct rc_dev
*dev
, u32 min
, u32 max
);
117 int (*tx_ir
)(struct rc_dev
*dev
, int *txbuf
, u32 n
);
118 void (*s_idle
)(struct rc_dev
*dev
, bool enable
);
119 int (*s_learning_mode
)(struct rc_dev
*dev
, int enable
);
120 int (*s_carrier_report
) (struct rc_dev
*dev
, int enable
);
123 enum raw_event_type
{
126 IR_START_EVENT
= (1 << 2),
127 IR_STOP_EVENT
= (1 << 3),
130 #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
133 void ir_repeat(struct rc_dev
*dev
);
134 void ir_keydown(struct rc_dev
*dev
, int scancode
, u8 toggle
);
135 void ir_keydown_notimeout(struct rc_dev
*dev
, int scancode
, u8 toggle
);
136 void ir_keyup(struct rc_dev
*dev
);
137 u32
ir_g_keycode_from_table(struct rc_dev
*dev
, u32 scancode
);
139 /* From ir-raw-event.c */
140 struct ir_raw_event
{
153 unsigned carrier_report
:1;
156 #define DEFINE_IR_RAW_EVENT(event) \
157 struct ir_raw_event event = { \
158 { .duration = 0 } , \
162 .carrier_report = 0 }
164 static inline void init_ir_raw_event(struct ir_raw_event
*ev
)
166 memset(ev
, 0, sizeof(*ev
));
169 #define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
171 struct rc_dev
*rc_allocate_device(void);
172 void rc_free_device(struct rc_dev
*dev
);
173 int rc_register_device(struct rc_dev
*dev
);
174 void rc_unregister_device(struct rc_dev
*dev
);
176 void ir_raw_event_handle(struct rc_dev
*dev
);
177 int ir_raw_event_store(struct rc_dev
*dev
, struct ir_raw_event
*ev
);
178 int ir_raw_event_store_edge(struct rc_dev
*dev
, enum raw_event_type type
);
179 int ir_raw_event_store_with_filter(struct rc_dev
*dev
,
180 struct ir_raw_event
*ev
);
181 void ir_raw_event_set_idle(struct rc_dev
*dev
, bool idle
);
183 static inline void ir_raw_event_reset(struct rc_dev
*dev
)
185 DEFINE_IR_RAW_EVENT(ev
);
188 ir_raw_event_store(dev
, &ev
);
189 ir_raw_event_handle(dev
);
193 /* extract mask bits out of data and pack them into the result */
194 static inline u32
ir_extract_bits(u32 data
, u32 mask
)
196 u32 vbit
= 1, value
= 0;
205 } while (mask
>>= 1);
211 #endif /* _IR_CORE */