1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * IgorPlug-USB IR Receiver
4 *
5 * Copyright (C) 2014 Sean Young <sean@mess.org>
6 *
7 * Supports the standard homebrew IgorPlugUSB receiver with Igor's firmware.
8 * See http://www.cesko.host.sk/IgorPlugUSB/IgorPlug-USB%20(AVR)_eng.htm
9 *
10 * Based on the lirc_igorplugusb.c driver:
11 * Copyright (C) 2004 Jan M. Hochstein
12 * <hochstein@algo.informatik.tu-darmstadt.de>
13 */
14 #include <linux/device.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/usb.h>
18 #include <linux/usb/input.h>
19 #include <media/rc-core.h>
20
21 #define DRIVER_DESC "IgorPlug-USB IR Receiver"
22 #define DRIVER_NAME "igorplugusb"
23
24 #define HEADERLEN 3
25 #define BUFLEN 36
26 #define MAX_PACKET (HEADERLEN + BUFLEN)
27
28 #define SET_INFRABUFFER_EMPTY 1
29 #define GET_INFRACODE 2
30
31
32 struct igorplugusb {
33 struct rc_dev *rc;
34 struct device *dev;
35
36 struct urb *urb;
37 struct usb_ctrlrequest request;
38
39 struct timer_list timer;
40
41 uint8_t buf_in[MAX_PACKET];
42
43 char phys[64];
44 };
45
46 static void igorplugusb_cmd(struct igorplugusb *ir, int cmd);
47
igorplugusb_irdata(struct igorplugusb * ir,unsigned len)48 static void igorplugusb_irdata(struct igorplugusb *ir, unsigned len)
49 {
50 struct ir_raw_event rawir = {};
51 unsigned i, start, overflow;
52
53 dev_dbg(ir->dev, "irdata: %*ph (len=%u)", len, ir->buf_in, len);
54
55 /*
56 * If more than 36 pulses and spaces follow each other, the igorplugusb
57 * overwrites its buffer from the beginning. The overflow value is the
58 * last offset which was not overwritten. Everything from this offset
59 * onwards occurred before everything until this offset.
60 */
61 overflow = ir->buf_in[2];
62 i = start = overflow + HEADERLEN;
63
64 if (start >= len) {
65 dev_err(ir->dev, "receive overflow invalid: %u", overflow);
66 } else {
67 if (overflow > 0) {
68 dev_warn(ir->dev, "receive overflow, at least %u lost",
69 overflow);
70 ir_raw_event_overflow(ir->rc);
71 }
72
73 do {
74 rawir.duration = ir->buf_in[i] * 85;
75 rawir.pulse = i & 1;
76
77 ir_raw_event_store_with_filter(ir->rc, &rawir);
78
79 if (++i == len)
80 i = HEADERLEN;
81 } while (i != start);
82
83 /* add a trailing space */
84 rawir.duration = ir->rc->timeout;
85 rawir.pulse = false;
86 ir_raw_event_store_with_filter(ir->rc, &rawir);
87
88 ir_raw_event_handle(ir->rc);
89 }
90
91 igorplugusb_cmd(ir, SET_INFRABUFFER_EMPTY);
92 }
93
igorplugusb_callback(struct urb * urb)94 static void igorplugusb_callback(struct urb *urb)
95 {
96 struct usb_ctrlrequest *req;
97 struct igorplugusb *ir = urb->context;
98
99 req = (struct usb_ctrlrequest *)urb->setup_packet;
100
101 switch (urb->status) {
102 case 0:
103 if (req->bRequest == GET_INFRACODE &&
104 urb->actual_length > HEADERLEN)
105 igorplugusb_irdata(ir, urb->actual_length);
106 else /* request IR */
107 mod_timer(&ir->timer, jiffies + msecs_to_jiffies(50));
108 break;
109 case -EPROTO:
110 case -ECONNRESET:
111 case -ENOENT:
112 case -ESHUTDOWN:
113 usb_unlink_urb(urb);
114 return;
115 default:
116 dev_warn(ir->dev, "Error: urb status = %d\n", urb->status);
117 igorplugusb_cmd(ir, SET_INFRABUFFER_EMPTY);
118 break;
119 }
120 }
121
igorplugusb_cmd(struct igorplugusb * ir,int cmd)122 static void igorplugusb_cmd(struct igorplugusb *ir, int cmd)
123 {
124 int ret;
125
126 ir->request.bRequest = cmd;
127 ir->urb->transfer_flags = 0;
128 ret = usb_submit_urb(ir->urb, GFP_ATOMIC);
129 if (ret)
130 dev_err(ir->dev, "submit urb failed: %d", ret);
131 }
132
igorplugusb_timer(struct timer_list * t)133 static void igorplugusb_timer(struct timer_list *t)
134 {
135 struct igorplugusb *ir = from_timer(ir, t, timer);
136
137 igorplugusb_cmd(ir, GET_INFRACODE);
138 }
139
igorplugusb_probe(struct usb_interface * intf,const struct usb_device_id * id)140 static int igorplugusb_probe(struct usb_interface *intf,
141 const struct usb_device_id *id)
142 {
143 struct usb_device *udev;
144 struct usb_host_interface *idesc;
145 struct usb_endpoint_descriptor *ep;
146 struct igorplugusb *ir;
147 struct rc_dev *rc;
148 int ret = -ENOMEM;
149
150 udev = interface_to_usbdev(intf);
151 idesc = intf->cur_altsetting;
152
153 if (idesc->desc.bNumEndpoints != 1) {
154 dev_err(&intf->dev, "incorrect number of endpoints");
155 return -ENODEV;
156 }
157
158 ep = &idesc->endpoint[0].desc;
159 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_control(ep)) {
160 dev_err(&intf->dev, "endpoint incorrect");
161 return -ENODEV;
162 }
163
164 ir = devm_kzalloc(&intf->dev, sizeof(*ir), GFP_KERNEL);
165 if (!ir)
166 return -ENOMEM;
167
168 ir->dev = &intf->dev;
169
170 timer_setup(&ir->timer, igorplugusb_timer, 0);
171
172 ir->request.bRequest = GET_INFRACODE;
173 ir->request.bRequestType = USB_TYPE_VENDOR | USB_DIR_IN;
174 ir->request.wLength = cpu_to_le16(sizeof(ir->buf_in));
175
176 ir->urb = usb_alloc_urb(0, GFP_KERNEL);
177 if (!ir->urb)
178 goto fail;
179
180 usb_fill_control_urb(ir->urb, udev,
181 usb_rcvctrlpipe(udev, 0), (uint8_t *)&ir->request,
182 ir->buf_in, sizeof(ir->buf_in), igorplugusb_callback, ir);
183
184 usb_make_path(udev, ir->phys, sizeof(ir->phys));
185
186 rc = rc_allocate_device(RC_DRIVER_IR_RAW);
187 if (!rc)
188 goto fail;
189
190 rc->device_name = DRIVER_DESC;
191 rc->input_phys = ir->phys;
192 usb_to_input_id(udev, &rc->input_id);
193 rc->dev.parent = &intf->dev;
194 /*
195 * This device can only store 36 pulses + spaces, which is not enough
196 * for the NEC protocol and many others.
197 */
198 rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER &
199 ~(RC_PROTO_BIT_NEC | RC_PROTO_BIT_NECX | RC_PROTO_BIT_NEC32 |
200 RC_PROTO_BIT_RC6_6A_20 | RC_PROTO_BIT_RC6_6A_24 |
201 RC_PROTO_BIT_RC6_6A_32 | RC_PROTO_BIT_RC6_MCE |
202 RC_PROTO_BIT_SONY20 | RC_PROTO_BIT_SANYO);
203
204 rc->priv = ir;
205 rc->driver_name = DRIVER_NAME;
206 rc->map_name = RC_MAP_HAUPPAUGE;
207 rc->timeout = MS_TO_US(100);
208 rc->rx_resolution = 85;
209
210 ir->rc = rc;
211 ret = rc_register_device(rc);
212 if (ret) {
213 dev_err(&intf->dev, "failed to register rc device: %d", ret);
214 goto fail;
215 }
216
217 usb_set_intfdata(intf, ir);
218
219 igorplugusb_cmd(ir, SET_INFRABUFFER_EMPTY);
220
221 return 0;
222 fail:
223 rc_free_device(ir->rc);
224 usb_free_urb(ir->urb);
225 del_timer(&ir->timer);
226
227 return ret;
228 }
229
igorplugusb_disconnect(struct usb_interface * intf)230 static void igorplugusb_disconnect(struct usb_interface *intf)
231 {
232 struct igorplugusb *ir = usb_get_intfdata(intf);
233
234 rc_unregister_device(ir->rc);
235 del_timer_sync(&ir->timer);
236 usb_set_intfdata(intf, NULL);
237 usb_kill_urb(ir->urb);
238 usb_free_urb(ir->urb);
239 }
240
241 static const struct usb_device_id igorplugusb_table[] = {
242 /* Igor Plug USB (Atmel's Manufact. ID) */
243 { USB_DEVICE(0x03eb, 0x0002) },
244 /* Fit PC2 Infrared Adapter */
245 { USB_DEVICE(0x03eb, 0x21fe) },
246 /* Terminating entry */
247 { }
248 };
249
250 static struct usb_driver igorplugusb_driver = {
251 .name = DRIVER_NAME,
252 .probe = igorplugusb_probe,
253 .disconnect = igorplugusb_disconnect,
254 .id_table = igorplugusb_table
255 };
256
257 module_usb_driver(igorplugusb_driver);
258
259 MODULE_DESCRIPTION(DRIVER_DESC);
260 MODULE_AUTHOR("Sean Young <sean@mess.org>");
261 MODULE_LICENSE("GPL");
262 MODULE_DEVICE_TABLE(usb, igorplugusb_table);
263