18e8e69d6SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
232cf86f6SMauro Carvalho Chehab /* ir-sony-decoder.c - handle Sony IR Pulse/Space protocol
332cf86f6SMauro Carvalho Chehab *
432cf86f6SMauro Carvalho Chehab * Copyright (C) 2010 by David Härdeman <david@hardeman.nu>
532cf86f6SMauro Carvalho Chehab */
632cf86f6SMauro Carvalho Chehab
732cf86f6SMauro Carvalho Chehab #include <linux/bitrev.h>
87a707b89SPaul Gortmaker #include <linux/module.h>
9f62de675SMauro Carvalho Chehab #include "rc-core-priv.h"
1032cf86f6SMauro Carvalho Chehab
11528222d8SSean Young #define SONY_UNIT 600 /* us */
1232cf86f6SMauro Carvalho Chehab #define SONY_HEADER_PULSE (4 * SONY_UNIT)
1332cf86f6SMauro Carvalho Chehab #define SONY_HEADER_SPACE (1 * SONY_UNIT)
1432cf86f6SMauro Carvalho Chehab #define SONY_BIT_0_PULSE (1 * SONY_UNIT)
1532cf86f6SMauro Carvalho Chehab #define SONY_BIT_1_PULSE (2 * SONY_UNIT)
1632cf86f6SMauro Carvalho Chehab #define SONY_BIT_SPACE (1 * SONY_UNIT)
1732cf86f6SMauro Carvalho Chehab #define SONY_TRAILER_SPACE (10 * SONY_UNIT) /* minimum */
1832cf86f6SMauro Carvalho Chehab
1932cf86f6SMauro Carvalho Chehab enum sony_state {
2032cf86f6SMauro Carvalho Chehab STATE_INACTIVE,
2132cf86f6SMauro Carvalho Chehab STATE_HEADER_SPACE,
2232cf86f6SMauro Carvalho Chehab STATE_BIT_PULSE,
2332cf86f6SMauro Carvalho Chehab STATE_BIT_SPACE,
2432cf86f6SMauro Carvalho Chehab STATE_FINISHED,
2532cf86f6SMauro Carvalho Chehab };
2632cf86f6SMauro Carvalho Chehab
2732cf86f6SMauro Carvalho Chehab /**
2832cf86f6SMauro Carvalho Chehab * ir_sony_decode() - Decode one Sony pulse or space
29d8b4b582SDavid Härdeman * @dev: the struct rc_dev descriptor of the device
3032cf86f6SMauro Carvalho Chehab * @ev: the struct ir_raw_event descriptor of the pulse/space
3132cf86f6SMauro Carvalho Chehab *
3232cf86f6SMauro Carvalho Chehab * This function returns -EINVAL if the pulse violates the state machine
3332cf86f6SMauro Carvalho Chehab */
ir_sony_decode(struct rc_dev * dev,struct ir_raw_event ev)34d8b4b582SDavid Härdeman static int ir_sony_decode(struct rc_dev *dev, struct ir_raw_event ev)
3532cf86f6SMauro Carvalho Chehab {
36d8b4b582SDavid Härdeman struct sony_dec *data = &dev->raw->sony;
376d741bfeSSean Young enum rc_proto protocol;
3832cf86f6SMauro Carvalho Chehab u32 scancode;
3932cf86f6SMauro Carvalho Chehab u8 device, subdevice, function;
4032cf86f6SMauro Carvalho Chehab
4132cf86f6SMauro Carvalho Chehab if (!is_timing_event(ev)) {
42*950170d6SSean Young if (ev.overflow)
4332cf86f6SMauro Carvalho Chehab data->state = STATE_INACTIVE;
4432cf86f6SMauro Carvalho Chehab return 0;
4532cf86f6SMauro Carvalho Chehab }
4632cf86f6SMauro Carvalho Chehab
4732cf86f6SMauro Carvalho Chehab if (!geq_margin(ev.duration, SONY_UNIT, SONY_UNIT / 2))
4832cf86f6SMauro Carvalho Chehab goto out;
4932cf86f6SMauro Carvalho Chehab
5050078a90SSean Young dev_dbg(&dev->dev, "Sony decode started at state %d (%uus %s)\n",
51528222d8SSean Young data->state, ev.duration, TO_STR(ev.pulse));
5232cf86f6SMauro Carvalho Chehab
5332cf86f6SMauro Carvalho Chehab switch (data->state) {
5432cf86f6SMauro Carvalho Chehab
5532cf86f6SMauro Carvalho Chehab case STATE_INACTIVE:
5632cf86f6SMauro Carvalho Chehab if (!ev.pulse)
5732cf86f6SMauro Carvalho Chehab break;
5832cf86f6SMauro Carvalho Chehab
5932cf86f6SMauro Carvalho Chehab if (!eq_margin(ev.duration, SONY_HEADER_PULSE, SONY_UNIT / 2))
6032cf86f6SMauro Carvalho Chehab break;
6132cf86f6SMauro Carvalho Chehab
6232cf86f6SMauro Carvalho Chehab data->count = 0;
6332cf86f6SMauro Carvalho Chehab data->state = STATE_HEADER_SPACE;
6432cf86f6SMauro Carvalho Chehab return 0;
6532cf86f6SMauro Carvalho Chehab
6632cf86f6SMauro Carvalho Chehab case STATE_HEADER_SPACE:
6732cf86f6SMauro Carvalho Chehab if (ev.pulse)
6832cf86f6SMauro Carvalho Chehab break;
6932cf86f6SMauro Carvalho Chehab
7032cf86f6SMauro Carvalho Chehab if (!eq_margin(ev.duration, SONY_HEADER_SPACE, SONY_UNIT / 2))
7132cf86f6SMauro Carvalho Chehab break;
7232cf86f6SMauro Carvalho Chehab
7332cf86f6SMauro Carvalho Chehab data->state = STATE_BIT_PULSE;
7432cf86f6SMauro Carvalho Chehab return 0;
7532cf86f6SMauro Carvalho Chehab
7632cf86f6SMauro Carvalho Chehab case STATE_BIT_PULSE:
7732cf86f6SMauro Carvalho Chehab if (!ev.pulse)
7832cf86f6SMauro Carvalho Chehab break;
7932cf86f6SMauro Carvalho Chehab
8032cf86f6SMauro Carvalho Chehab data->bits <<= 1;
8132cf86f6SMauro Carvalho Chehab if (eq_margin(ev.duration, SONY_BIT_1_PULSE, SONY_UNIT / 2))
8232cf86f6SMauro Carvalho Chehab data->bits |= 1;
8332cf86f6SMauro Carvalho Chehab else if (!eq_margin(ev.duration, SONY_BIT_0_PULSE, SONY_UNIT / 2))
8432cf86f6SMauro Carvalho Chehab break;
8532cf86f6SMauro Carvalho Chehab
8632cf86f6SMauro Carvalho Chehab data->count++;
8732cf86f6SMauro Carvalho Chehab data->state = STATE_BIT_SPACE;
8832cf86f6SMauro Carvalho Chehab return 0;
8932cf86f6SMauro Carvalho Chehab
9032cf86f6SMauro Carvalho Chehab case STATE_BIT_SPACE:
9132cf86f6SMauro Carvalho Chehab if (ev.pulse)
9232cf86f6SMauro Carvalho Chehab break;
9332cf86f6SMauro Carvalho Chehab
9432cf86f6SMauro Carvalho Chehab if (!geq_margin(ev.duration, SONY_BIT_SPACE, SONY_UNIT / 2))
9532cf86f6SMauro Carvalho Chehab break;
9632cf86f6SMauro Carvalho Chehab
9732cf86f6SMauro Carvalho Chehab decrease_duration(&ev, SONY_BIT_SPACE);
9832cf86f6SMauro Carvalho Chehab
9932cf86f6SMauro Carvalho Chehab if (!geq_margin(ev.duration, SONY_UNIT, SONY_UNIT / 2)) {
10032cf86f6SMauro Carvalho Chehab data->state = STATE_BIT_PULSE;
10132cf86f6SMauro Carvalho Chehab return 0;
10232cf86f6SMauro Carvalho Chehab }
10332cf86f6SMauro Carvalho Chehab
10432cf86f6SMauro Carvalho Chehab data->state = STATE_FINISHED;
105df561f66SGustavo A. R. Silva fallthrough;
10632cf86f6SMauro Carvalho Chehab
10732cf86f6SMauro Carvalho Chehab case STATE_FINISHED:
10832cf86f6SMauro Carvalho Chehab if (ev.pulse)
10932cf86f6SMauro Carvalho Chehab break;
11032cf86f6SMauro Carvalho Chehab
11132cf86f6SMauro Carvalho Chehab if (!geq_margin(ev.duration, SONY_TRAILER_SPACE, SONY_UNIT / 2))
11232cf86f6SMauro Carvalho Chehab break;
11332cf86f6SMauro Carvalho Chehab
11432cf86f6SMauro Carvalho Chehab switch (data->count) {
11532cf86f6SMauro Carvalho Chehab case 12:
1166d741bfeSSean Young if (!(dev->enabled_protocols & RC_PROTO_BIT_SONY12))
117abefe12aSMauro Carvalho Chehab goto finish_state_machine;
118abefe12aSMauro Carvalho Chehab
11932cf86f6SMauro Carvalho Chehab device = bitrev8((data->bits << 3) & 0xF8);
12032cf86f6SMauro Carvalho Chehab subdevice = 0;
12132cf86f6SMauro Carvalho Chehab function = bitrev8((data->bits >> 4) & 0xFE);
1226d741bfeSSean Young protocol = RC_PROTO_SONY12;
12332cf86f6SMauro Carvalho Chehab break;
12432cf86f6SMauro Carvalho Chehab case 15:
1256d741bfeSSean Young if (!(dev->enabled_protocols & RC_PROTO_BIT_SONY15))
126abefe12aSMauro Carvalho Chehab goto finish_state_machine;
127abefe12aSMauro Carvalho Chehab
12832cf86f6SMauro Carvalho Chehab device = bitrev8((data->bits >> 0) & 0xFF);
12932cf86f6SMauro Carvalho Chehab subdevice = 0;
130ec9ee8e2SJames Hogan function = bitrev8((data->bits >> 7) & 0xFE);
1316d741bfeSSean Young protocol = RC_PROTO_SONY15;
13232cf86f6SMauro Carvalho Chehab break;
13332cf86f6SMauro Carvalho Chehab case 20:
1346d741bfeSSean Young if (!(dev->enabled_protocols & RC_PROTO_BIT_SONY20))
135abefe12aSMauro Carvalho Chehab goto finish_state_machine;
136abefe12aSMauro Carvalho Chehab
13732cf86f6SMauro Carvalho Chehab device = bitrev8((data->bits >> 5) & 0xF8);
13832cf86f6SMauro Carvalho Chehab subdevice = bitrev8((data->bits >> 0) & 0xFF);
13932cf86f6SMauro Carvalho Chehab function = bitrev8((data->bits >> 12) & 0xFE);
1406d741bfeSSean Young protocol = RC_PROTO_SONY20;
14132cf86f6SMauro Carvalho Chehab break;
14232cf86f6SMauro Carvalho Chehab default:
14350078a90SSean Young dev_dbg(&dev->dev, "Sony invalid bitcount %u\n",
14450078a90SSean Young data->count);
14532cf86f6SMauro Carvalho Chehab goto out;
14632cf86f6SMauro Carvalho Chehab }
14732cf86f6SMauro Carvalho Chehab
14832cf86f6SMauro Carvalho Chehab scancode = device << 16 | subdevice << 8 | function;
14950078a90SSean Young dev_dbg(&dev->dev, "Sony(%u) scancode 0x%05x\n", data->count,
15050078a90SSean Young scancode);
151120703f9SDavid Härdeman rc_keydown(dev, protocol, scancode, 0);
152abefe12aSMauro Carvalho Chehab goto finish_state_machine;
15332cf86f6SMauro Carvalho Chehab }
15432cf86f6SMauro Carvalho Chehab
15532cf86f6SMauro Carvalho Chehab out:
15650078a90SSean Young dev_dbg(&dev->dev, "Sony decode failed at state %d (%uus %s)\n",
157528222d8SSean Young data->state, ev.duration, TO_STR(ev.pulse));
15832cf86f6SMauro Carvalho Chehab data->state = STATE_INACTIVE;
15932cf86f6SMauro Carvalho Chehab return -EINVAL;
160abefe12aSMauro Carvalho Chehab
161abefe12aSMauro Carvalho Chehab finish_state_machine:
162abefe12aSMauro Carvalho Chehab data->state = STATE_INACTIVE;
163abefe12aSMauro Carvalho Chehab return 0;
16432cf86f6SMauro Carvalho Chehab }
16532cf86f6SMauro Carvalho Chehab
166103293beSSean Young static const struct ir_raw_timings_pl ir_sony_timings = {
167103293beSSean Young .header_pulse = SONY_HEADER_PULSE,
168103293beSSean Young .bit_space = SONY_BIT_SPACE,
169103293beSSean Young .bit_pulse[0] = SONY_BIT_0_PULSE,
170103293beSSean Young .bit_pulse[1] = SONY_BIT_1_PULSE,
171103293beSSean Young .trailer_space = SONY_TRAILER_SPACE + SONY_BIT_SPACE,
172103293beSSean Young .msb_first = 0,
173103293beSSean Young };
174103293beSSean Young
175103293beSSean Young /**
176103293beSSean Young * ir_sony_encode() - Encode a scancode as a stream of raw events
177103293beSSean Young *
178103293beSSean Young * @protocol: protocol to encode
179103293beSSean Young * @scancode: scancode to encode
180103293beSSean Young * @events: array of raw ir events to write into
181103293beSSean Young * @max: maximum size of @events
182103293beSSean Young *
183103293beSSean Young * Returns: The number of events written.
184103293beSSean Young * -ENOBUFS if there isn't enough space in the array to fit the
185103293beSSean Young * encoding. In this case all @max events will have been written.
186103293beSSean Young */
ir_sony_encode(enum rc_proto protocol,u32 scancode,struct ir_raw_event * events,unsigned int max)1876d741bfeSSean Young static int ir_sony_encode(enum rc_proto protocol, u32 scancode,
188103293beSSean Young struct ir_raw_event *events, unsigned int max)
189103293beSSean Young {
190103293beSSean Young struct ir_raw_event *e = events;
191103293beSSean Young u32 raw, len;
192103293beSSean Young int ret;
193103293beSSean Young
1946d741bfeSSean Young if (protocol == RC_PROTO_SONY12) {
195103293beSSean Young raw = (scancode & 0x7f) | ((scancode & 0x1f0000) >> 9);
196103293beSSean Young len = 12;
1976d741bfeSSean Young } else if (protocol == RC_PROTO_SONY15) {
198103293beSSean Young raw = (scancode & 0x7f) | ((scancode & 0xff0000) >> 9);
199103293beSSean Young len = 15;
200103293beSSean Young } else {
201103293beSSean Young raw = (scancode & 0x7f) | ((scancode & 0x1f0000) >> 9) |
202103293beSSean Young ((scancode & 0xff00) << 4);
203103293beSSean Young len = 20;
204103293beSSean Young }
205103293beSSean Young
206103293beSSean Young ret = ir_raw_gen_pl(&e, max, &ir_sony_timings, len, raw);
207103293beSSean Young if (ret < 0)
208103293beSSean Young return ret;
209103293beSSean Young
210103293beSSean Young return e - events;
211103293beSSean Young }
212103293beSSean Young
21332cf86f6SMauro Carvalho Chehab static struct ir_raw_handler sony_handler = {
2146d741bfeSSean Young .protocols = RC_PROTO_BIT_SONY12 | RC_PROTO_BIT_SONY15 |
2156d741bfeSSean Young RC_PROTO_BIT_SONY20,
21632cf86f6SMauro Carvalho Chehab .decode = ir_sony_decode,
217103293beSSean Young .encode = ir_sony_encode,
218cdfaa01cSSean Young .carrier = 40000,
219a86d6df8SSean Young .min_timeout = SONY_TRAILER_SPACE,
22032cf86f6SMauro Carvalho Chehab };
22132cf86f6SMauro Carvalho Chehab
ir_sony_decode_init(void)22232cf86f6SMauro Carvalho Chehab static int __init ir_sony_decode_init(void)
22332cf86f6SMauro Carvalho Chehab {
22432cf86f6SMauro Carvalho Chehab ir_raw_handler_register(&sony_handler);
22532cf86f6SMauro Carvalho Chehab
22632cf86f6SMauro Carvalho Chehab printk(KERN_INFO "IR Sony protocol handler initialized\n");
22732cf86f6SMauro Carvalho Chehab return 0;
22832cf86f6SMauro Carvalho Chehab }
22932cf86f6SMauro Carvalho Chehab
ir_sony_decode_exit(void)23032cf86f6SMauro Carvalho Chehab static void __exit ir_sony_decode_exit(void)
23132cf86f6SMauro Carvalho Chehab {
23232cf86f6SMauro Carvalho Chehab ir_raw_handler_unregister(&sony_handler);
23332cf86f6SMauro Carvalho Chehab }
23432cf86f6SMauro Carvalho Chehab
23532cf86f6SMauro Carvalho Chehab module_init(ir_sony_decode_init);
23632cf86f6SMauro Carvalho Chehab module_exit(ir_sony_decode_exit);
23732cf86f6SMauro Carvalho Chehab
23832cf86f6SMauro Carvalho Chehab MODULE_LICENSE("GPL");
23932cf86f6SMauro Carvalho Chehab MODULE_AUTHOR("David Härdeman <david@hardeman.nu>");
24032cf86f6SMauro Carvalho Chehab MODULE_DESCRIPTION("Sony IR protocol decoder");
241