1 /* ir-rc5-decoder.c - decoder for RC5(x) and StreamZap protocols
3 * Copyright (C) 2010 by Mauro Carvalho Chehab
4 * Copyright (C) 2010 by Jarod Wilson <jarod@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.
17 * This decoder handles the 14 bit RC5 protocol, 15 bit "StreamZap" protocol
18 * and 20 bit RC5x protocol.
21 #include "rc-core-priv.h"
22 #include <linux/module.h>
25 #define RC5_SZ_NBITS 15
27 #define CHECK_RC5X_NBITS 8
28 #define RC5_UNIT 888888 /* ns */
29 #define RC5_BIT_START (1 * RC5_UNIT)
30 #define RC5_BIT_END (1 * RC5_UNIT)
31 #define RC5X_SPACE (4 * RC5_UNIT)
32 #define RC5_TRAILER (6 * RC5_UNIT) /* In reality, approx 100 */
43 * ir_rc5_decode() - Decode one RC-5 pulse or space
44 * @dev: the struct rc_dev descriptor of the device
45 * @ev: the struct ir_raw_event descriptor of the pulse/space
47 * This function returns -EINVAL if the pulse violates the state machine
49 static int ir_rc5_decode(struct rc_dev
*dev
, struct ir_raw_event ev
)
51 struct rc5_dec
*data
= &dev
->raw
->rc5
;
54 enum rc_type protocol
;
56 if (!is_timing_event(ev
)) {
58 data
->state
= STATE_INACTIVE
;
62 if (!geq_margin(ev
.duration
, RC5_UNIT
, RC5_UNIT
/ 2))
66 IR_dprintk(2, "RC5(x/sz) decode started at state %i (%uus %s)\n",
67 data
->state
, TO_US(ev
.duration
), TO_STR(ev
.pulse
));
69 if (!geq_margin(ev
.duration
, RC5_UNIT
, RC5_UNIT
/ 2))
72 switch (data
->state
) {
78 data
->state
= STATE_BIT_START
;
80 decrease_duration(&ev
, RC5_BIT_START
);
84 if (!ev
.pulse
&& geq_margin(ev
.duration
, RC5_TRAILER
, RC5_UNIT
/ 2)) {
85 data
->state
= STATE_FINISHED
;
89 if (!eq_margin(ev
.duration
, RC5_BIT_START
, RC5_UNIT
/ 2))
96 data
->state
= STATE_BIT_END
;
100 if (!is_transition(&ev
, &dev
->raw
->prev_ev
))
103 if (data
->count
== CHECK_RC5X_NBITS
)
104 data
->state
= STATE_CHECK_RC5X
;
106 data
->state
= STATE_BIT_START
;
108 decrease_duration(&ev
, RC5_BIT_END
);
111 case STATE_CHECK_RC5X
:
112 if (!ev
.pulse
&& geq_margin(ev
.duration
, RC5X_SPACE
, RC5_UNIT
/ 2)) {
113 data
->is_rc5x
= true;
114 decrease_duration(&ev
, RC5X_SPACE
);
116 data
->is_rc5x
= false;
117 data
->state
= STATE_BIT_START
;
124 if (data
->is_rc5x
&& data
->count
== RC5X_NBITS
) {
126 u8 xdata
, command
, system
;
127 if (!(dev
->enabled_protocols
& RC_BIT_RC5X_20
)) {
128 data
->state
= STATE_INACTIVE
;
131 xdata
= (data
->bits
& 0x0003F) >> 0;
132 command
= (data
->bits
& 0x00FC0) >> 6;
133 system
= (data
->bits
& 0x1F000) >> 12;
134 toggle
= (data
->bits
& 0x20000) ? 1 : 0;
135 command
+= (data
->bits
& 0x40000) ? 0 : 0x40;
136 scancode
= system
<< 16 | command
<< 8 | xdata
;
137 protocol
= RC_TYPE_RC5X_20
;
139 } else if (!data
->is_rc5x
&& data
->count
== RC5_NBITS
) {
142 if (!(dev
->enabled_protocols
& RC_BIT_RC5
)) {
143 data
->state
= STATE_INACTIVE
;
146 command
= (data
->bits
& 0x0003F) >> 0;
147 system
= (data
->bits
& 0x007C0) >> 6;
148 toggle
= (data
->bits
& 0x00800) ? 1 : 0;
149 command
+= (data
->bits
& 0x01000) ? 0 : 0x40;
150 scancode
= system
<< 8 | command
;
151 protocol
= RC_TYPE_RC5
;
153 } else if (!data
->is_rc5x
&& data
->count
== RC5_SZ_NBITS
) {
156 if (!(dev
->enabled_protocols
& RC_BIT_RC5_SZ
)) {
157 data
->state
= STATE_INACTIVE
;
160 command
= (data
->bits
& 0x0003F) >> 0;
161 system
= (data
->bits
& 0x02FC0) >> 6;
162 toggle
= (data
->bits
& 0x01000) ? 1 : 0;
163 scancode
= system
<< 6 | command
;
164 protocol
= RC_TYPE_RC5_SZ
;
169 IR_dprintk(1, "RC5(x/sz) scancode 0x%06x (p: %u, t: %u)\n",
170 scancode
, protocol
, toggle
);
172 rc_keydown(dev
, protocol
, scancode
, toggle
);
173 data
->state
= STATE_INACTIVE
;
178 IR_dprintk(1, "RC5(x/sz) decode failed at state %i count %d (%uus %s)\n",
179 data
->state
, data
->count
, TO_US(ev
.duration
), TO_STR(ev
.pulse
));
180 data
->state
= STATE_INACTIVE
;
184 static const struct ir_raw_timings_manchester ir_rc5_timings
= {
186 .pulse_space_start
= 0,
188 .trailer_space
= RC5_UNIT
* 10,
191 static const struct ir_raw_timings_manchester ir_rc5x_timings
[2] = {
194 .pulse_space_start
= 0,
196 .trailer_space
= RC5X_SPACE
,
200 .trailer_space
= RC5_UNIT
* 10,
204 static const struct ir_raw_timings_manchester ir_rc5_sz_timings
= {
206 .pulse_space_start
= 0,
208 .trailer_space
= RC5_UNIT
* 10,
212 * ir_rc5_encode() - Encode a scancode as a stream of raw events
214 * @protocol: protocol variant to encode
215 * @scancode: scancode to encode
216 * @events: array of raw ir events to write into
217 * @max: maximum size of @events
219 * Returns: The number of events written.
220 * -ENOBUFS if there isn't enough space in the array to fit the
221 * encoding. In this case all @max events will have been written.
222 * -EINVAL if the scancode is ambiguous or invalid.
224 static int ir_rc5_encode(enum rc_type protocol
, u32 scancode
,
225 struct ir_raw_event
*events
, unsigned int max
)
228 struct ir_raw_event
*e
= events
;
229 unsigned int data
, xdata
, command
, commandx
, system
, pre_space_data
;
231 /* Detect protocol and convert scancode to raw data */
232 if (protocol
== RC_TYPE_RC5
) {
233 /* decode scancode */
234 command
= (scancode
& 0x003f) >> 0;
235 commandx
= (scancode
& 0x0040) >> 6;
236 system
= (scancode
& 0x1f00) >> 8;
238 data
= !commandx
<< 12 | system
<< 6 | command
;
240 /* Modulate the data */
241 ret
= ir_raw_gen_manchester(&e
, max
, &ir_rc5_timings
,
245 } else if (protocol
== RC_TYPE_RC5X_20
) {
246 /* decode scancode */
247 xdata
= (scancode
& 0x00003f) >> 0;
248 command
= (scancode
& 0x003f00) >> 8;
249 commandx
= !(scancode
& 0x004000);
250 system
= (scancode
& 0x1f0000) >> 16;
253 data
= commandx
<< 18 | system
<< 12 | command
<< 6 | xdata
;
255 /* Modulate the data */
256 pre_space_data
= data
>> (RC5X_NBITS
- CHECK_RC5X_NBITS
);
257 ret
= ir_raw_gen_manchester(&e
, max
, &ir_rc5x_timings
[0],
258 CHECK_RC5X_NBITS
, pre_space_data
);
261 ret
= ir_raw_gen_manchester(&e
, max
- (e
- events
),
263 RC5X_NBITS
- CHECK_RC5X_NBITS
,
267 } else if (protocol
== RC_TYPE_RC5_SZ
) {
268 /* RC5-SZ scancode is raw enough for Manchester as it is */
269 ret
= ir_raw_gen_manchester(&e
, max
, &ir_rc5_sz_timings
,
270 RC5_SZ_NBITS
, scancode
& 0x2fff);
280 static struct ir_raw_handler rc5_handler
= {
281 .protocols
= RC_BIT_RC5
| RC_BIT_RC5X_20
| RC_BIT_RC5_SZ
,
282 .decode
= ir_rc5_decode
,
283 .encode
= ir_rc5_encode
,
286 static int __init
ir_rc5_decode_init(void)
288 ir_raw_handler_register(&rc5_handler
);
290 printk(KERN_INFO
"IR RC5(x/sz) protocol handler initialized\n");
294 static void __exit
ir_rc5_decode_exit(void)
296 ir_raw_handler_unregister(&rc5_handler
);
299 module_init(ir_rc5_decode_init
);
300 module_exit(ir_rc5_decode_exit
);
302 MODULE_LICENSE("GPL");
303 MODULE_AUTHOR("Mauro Carvalho Chehab and Jarod Wilson");
304 MODULE_AUTHOR("Red Hat Inc. (http://www.redhat.com)");
305 MODULE_DESCRIPTION("RC5(x/sz) IR protocol decoder");