Commit | Line | Data |
---|---|---|
446e4a64 MCC |
1 | /* |
2 | * Remote Controller core header | |
3 | * | |
995187be MCC |
4 | * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com> |
5 | * | |
446e4a64 MCC |
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 _IR_CORE | |
17 | #define _IR_CORE | |
18 | ||
446e4a64 | 19 | #include <linux/spinlock.h> |
a3572c34 MCC |
20 | #include <linux/kfifo.h> |
21 | #include <linux/time.h> | |
9f154782 | 22 | #include <linux/timer.h> |
02858eed | 23 | #include <media/rc-map.h> |
446e4a64 MCC |
24 | |
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) | |
28 | ||
626cf697 MCC |
29 | enum rc_driver_type { |
30 | RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */ | |
31 | RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */ | |
32 | }; | |
33 | ||
9dfe4e83 MCC |
34 | /** |
35 | * struct ir_dev_props - Allow caller drivers to set special properties | |
626cf697 MCC |
36 | * @driver_type: specifies if the driver or hardware have already a decoder, |
37 | * or if it needs to use the IR raw event decoders to produce a scancode | |
9dfe4e83 MCC |
38 | * @allowed_protos: bitmask with the supported IR_TYPE_* protocols |
39 | * @scanmask: some hardware decoders are not capable of providing the full | |
40 | * scancode to the application. As this is a hardware limit, we can't do | |
41 | * anything with it. Yet, as the same keycode table can be used with other | |
42 | * devices, a mask is provided to allow its usage. Drivers should generally | |
43 | * leave this field in blank | |
44 | * @priv: driver-specific data, to be used on the callbacks | |
45 | * @change_protocol: allow changing the protocol used on hardware decoders | |
46 | * @open: callback to allow drivers to enable polling/irq when IR input device | |
47 | * is opened. | |
48 | * @close: callback to allow drivers to disable polling/irq when IR input device | |
49 | * is opened. | |
9b7c54d9 JW |
50 | * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs) |
51 | * @s_tx_carrier: set transmit carrier frequency | |
52 | * @tx_ir: transmit IR | |
9dfe4e83 | 53 | */ |
e93854da | 54 | struct ir_dev_props { |
626cf697 MCC |
55 | enum rc_driver_type driver_type; |
56 | unsigned long allowed_protos; | |
57 | u32 scanmask; | |
9b7c54d9 | 58 | void *priv; |
626cf697 MCC |
59 | int (*change_protocol)(void *priv, u64 ir_type); |
60 | int (*open)(void *priv); | |
61 | void (*close)(void *priv); | |
9b7c54d9 JW |
62 | int (*s_tx_mask)(void *priv, u32 mask); |
63 | int (*s_tx_carrier)(void *priv, u32 carrier); | |
30eb1be7 | 64 | int (*tx_ir)(void *priv, int *txbuf, u32 n); |
e93854da MCC |
65 | }; |
66 | ||
75543cce | 67 | struct ir_input_dev { |
945cdfa2 | 68 | struct device dev; /* device */ |
727e625c | 69 | char *driver_name; /* Name of the driver module */ |
4714eda8 MCC |
70 | struct ir_scancode_table rc_tab; /* scan/key table */ |
71 | unsigned long devno; /* device number */ | |
e93854da | 72 | const struct ir_dev_props *props; /* Device properties */ |
a3572c34 | 73 | struct ir_raw_event_ctrl *raw; /* for raw pulse/space events */ |
a374fef4 | 74 | struct input_dev *input_dev; /* the input device associated with this device */ |
6660de56 MCC |
75 | |
76 | /* key info - needed by IR keycode handlers */ | |
a374fef4 DH |
77 | spinlock_t keylock; /* protects the below members */ |
78 | bool keypressed; /* current state */ | |
79 | unsigned long keyup_jiffies; /* when should the current keypress be released? */ | |
80 | struct timer_list timer_keyup; /* timer for releasing a keypress */ | |
81 | u32 last_keycode; /* keycode of last command */ | |
82 | u32 last_scancode; /* scancode of last command */ | |
83 | u8 last_toggle; /* toggle of last command */ | |
75543cce | 84 | }; |
a3572c34 | 85 | |
3f113e36 MCC |
86 | enum raw_event_type { |
87 | IR_SPACE = (1 << 0), | |
88 | IR_PULSE = (1 << 1), | |
89 | IR_START_EVENT = (1 << 2), | |
90 | IR_STOP_EVENT = (1 << 3), | |
995187be MCC |
91 | }; |
92 | ||
53f87022 | 93 | #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr) |
75543cce | 94 | |
3f113e36 | 95 | /* From ir-keytable.c */ |
b2245ba1 | 96 | int __ir_input_register(struct input_dev *dev, |
e93854da | 97 | const struct ir_scancode_table *ir_codes, |
727e625c MCC |
98 | const struct ir_dev_props *props, |
99 | const char *driver_name); | |
446e4a64 | 100 | |
b2245ba1 MCC |
101 | static inline int ir_input_register(struct input_dev *dev, |
102 | const char *map_name, | |
103 | const struct ir_dev_props *props, | |
104 | const char *driver_name) { | |
105 | struct ir_scancode_table *ir_codes; | |
02858eed MCC |
106 | struct ir_input_dev *ir_dev; |
107 | int rc; | |
108 | ||
109 | if (!map_name) | |
110 | return -EINVAL; | |
9ce50c1a | 111 | |
b2245ba1 | 112 | ir_codes = get_rc_map(map_name); |
b378f43f ML |
113 | if (!ir_codes) { |
114 | ir_codes = get_rc_map(RC_MAP_EMPTY); | |
115 | ||
116 | if (!ir_codes) | |
117 | return -EINVAL; | |
118 | } | |
b2245ba1 | 119 | |
02858eed MCC |
120 | rc = __ir_input_register(dev, ir_codes, props, driver_name); |
121 | if (rc < 0) | |
122 | return -EINVAL; | |
123 | ||
124 | ir_dev = input_get_drvdata(dev); | |
125 | ||
126 | if (!rc && ir_dev->props && ir_dev->props->change_protocol) | |
127 | rc = ir_dev->props->change_protocol(ir_dev->props->priv, | |
128 | ir_codes->ir_type); | |
129 | ||
130 | return rc; | |
b2245ba1 MCC |
131 | } |
132 | ||
02858eed | 133 | void ir_input_unregister(struct input_dev *input_dev); |
9ce50c1a | 134 | |
3f113e36 MCC |
135 | void ir_repeat(struct input_dev *dev); |
136 | void ir_keydown(struct input_dev *dev, int scancode, u8 toggle); | |
1c0e0ee5 | 137 | u32 ir_g_keycode_from_table(struct input_dev *input_dev, u32 scancode); |
4714eda8 | 138 | |
3f113e36 | 139 | /* From ir-raw-event.c */ |
4714eda8 | 140 | |
e40b1127 DH |
141 | struct ir_raw_event { |
142 | unsigned pulse:1; | |
143 | unsigned duration:31; | |
144 | }; | |
145 | ||
146 | #define IR_MAX_DURATION 0x7FFFFFFF /* a bit more than 2 seconds */ | |
147 | ||
724e2495 | 148 | void ir_raw_event_handle(struct input_dev *input_dev); |
e40b1127 | 149 | int ir_raw_event_store(struct input_dev *input_dev, struct ir_raw_event *ev); |
724e2495 | 150 | int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type); |
e40b1127 DH |
151 | static inline void ir_raw_event_reset(struct input_dev *input_dev) |
152 | { | |
153 | struct ir_raw_event ev = { .pulse = false, .duration = 0 }; | |
154 | ir_raw_event_store(input_dev, &ev); | |
155 | ir_raw_event_handle(input_dev); | |
156 | } | |
724e2495 | 157 | |
995187be | 158 | #endif /* _IR_CORE */ |