[media] rc-core: simplify sysfs code
[deliverable/linux.git] / drivers / media / rc / redrat3.c
CommitLineData
2154be65
JW
1/*
2 * USB RedRat3 IR Transceiver rc-core driver
3 *
4 * Copyright (c) 2011 by Jarod Wilson <jarod@redhat.com>
5 * based heavily on the work of Stephen Cox, with additional
6 * help from RedRat Ltd.
7 *
8 * This driver began life based an an old version of the first-generation
9 * lirc_mceusb driver from the lirc 0.7.2 distribution. It was then
10 * significantly rewritten by Stephen Cox with the aid of RedRat Ltd's
11 * Chris Dodge.
12 *
13 * The driver was then ported to rc-core and significantly rewritten again,
14 * by Jarod, using the in-kernel mceusb driver as a guide, after an initial
15 * port effort was started by Stephen.
16 *
17 * TODO LIST:
18 * - fix lirc not showing repeats properly
19 * --
20 *
21 * The RedRat3 is a USB transceiver with both send & receive,
22 * with 2 separate sensors available for receive to enable
23 * both good long range reception for general use, and good
24 * short range reception when required for learning a signal.
25 *
26 * http://www.redrat.co.uk/
27 *
28 * It uses its own little protocol to communicate, the required
29 * parts of which are embedded within this driver.
30 * --
31 *
32 * This program is free software; you can redistribute it and/or modify
33 * it under the terms of the GNU General Public License as published by
34 * the Free Software Foundation; either version 2 of the License, or
35 * (at your option) any later version.
36 *
37 * This program is distributed in the hope that it will be useful,
38 * but WITHOUT ANY WARRANTY; without even the implied warranty of
39 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40 * GNU General Public License for more details.
41 *
42 * You should have received a copy of the GNU General Public License
43 * along with this program; if not, write to the Free Software
44 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
45 *
46 */
47
4c055a5a 48#include <asm/unaligned.h>
2154be65 49#include <linux/device.h>
bf139726 50#include <linux/leds.h>
2154be65
JW
51#include <linux/module.h>
52#include <linux/slab.h>
53#include <linux/usb.h>
54#include <linux/usb/input.h>
55#include <media/rc-core.h>
56
57/* Driver Information */
2154be65
JW
58#define DRIVER_AUTHOR "Jarod Wilson <jarod@redhat.com>"
59#define DRIVER_AUTHOR2 "The Dweller, Stephen Cox"
60#define DRIVER_DESC "RedRat3 USB IR Transceiver Driver"
61#define DRIVER_NAME "redrat3"
62
2154be65
JW
63/* bulk data transfer types */
64#define RR3_ERROR 0x01
65#define RR3_MOD_SIGNAL_IN 0x20
66#define RR3_MOD_SIGNAL_OUT 0x21
67
68/* Get the RR firmware version */
69#define RR3_FW_VERSION 0xb1
70#define RR3_FW_VERSION_LEN 64
71/* Send encoded signal bulk-sent earlier*/
72#define RR3_TX_SEND_SIGNAL 0xb3
73#define RR3_SET_IR_PARAM 0xb7
74#define RR3_GET_IR_PARAM 0xb8
75/* Blink the red LED on the device */
76#define RR3_BLINK_LED 0xb9
77/* Read serial number of device */
78#define RR3_READ_SER_NO 0xba
79#define RR3_SER_NO_LEN 4
80/* Start capture with the RC receiver */
81#define RR3_RC_DET_ENABLE 0xbb
82/* Stop capture with the RC receiver */
83#define RR3_RC_DET_DISABLE 0xbc
84/* Return the status of RC detector capture */
85#define RR3_RC_DET_STATUS 0xbd
86/* Reset redrat */
87#define RR3_RESET 0xa0
88
89/* Max number of lengths in the signal. */
90#define RR3_IR_IO_MAX_LENGTHS 0x01
91/* Periods to measure mod. freq. */
92#define RR3_IR_IO_PERIODS_MF 0x02
93/* Size of memory for main signal data */
94#define RR3_IR_IO_SIG_MEM_SIZE 0x03
95/* Delta value when measuring lengths */
96#define RR3_IR_IO_LENGTH_FUZZ 0x04
97/* Timeout for end of signal detection */
98#define RR3_IR_IO_SIG_TIMEOUT 0x05
39c1cb2b 99/* Minimum value for pause recognition. */
2154be65
JW
100#define RR3_IR_IO_MIN_PAUSE 0x06
101
102/* Clock freq. of EZ-USB chip */
103#define RR3_CLK 24000000
104/* Clock periods per timer count */
105#define RR3_CLK_PER_COUNT 12
106/* (RR3_CLK / RR3_CLK_PER_COUNT) */
107#define RR3_CLK_CONV_FACTOR 2000000
108/* USB bulk-in IR data endpoint address */
109#define RR3_BULK_IN_EP_ADDR 0x82
110
2154be65 111/* Size of the fixed-length portion of the signal */
2154be65
JW
112#define RR3_DRIVER_MAXLENS 128
113#define RR3_MAX_SIG_SIZE 512
2154be65
JW
114#define RR3_TIME_UNIT 50
115#define RR3_END_OF_SIGNAL 0x7f
2154be65
JW
116#define RR3_TX_TRAILER_LEN 2
117#define RR3_RX_MIN_TIMEOUT 5
118#define RR3_RX_MAX_TIMEOUT 2000
119
120/* The 8051's CPUCS Register address */
121#define RR3_CPUCS_REG_ADDR 0x7f92
122
123#define USB_RR3USB_VENDOR_ID 0x112a
124#define USB_RR3USB_PRODUCT_ID 0x0001
125#define USB_RR3IIUSB_PRODUCT_ID 0x0005
126
4c055a5a
SY
127struct redrat3_header {
128 __be16 length;
129 __be16 transfer_type;
130} __packed;
131
132/* sending and receiving irdata */
133struct redrat3_irdata {
134 struct redrat3_header header;
135 __be32 pause;
136 __be16 mod_freq_count;
137 __be16 num_periods;
138 __u8 max_lengths;
139 __u8 no_lengths;
140 __be16 max_sig_size;
141 __be16 sig_size;
142 __u8 no_repeats;
143 __be16 lens[RR3_DRIVER_MAXLENS]; /* not aligned */
144 __u8 sigdata[RR3_MAX_SIG_SIZE];
145} __packed;
146
147/* firmware errors */
148struct redrat3_error {
149 struct redrat3_header header;
150 __be16 fw_error;
151} __packed;
152
2154be65
JW
153/* table of devices that work with this driver */
154static struct usb_device_id redrat3_dev_table[] = {
155 /* Original version of the RedRat3 */
156 {USB_DEVICE(USB_RR3USB_VENDOR_ID, USB_RR3USB_PRODUCT_ID)},
157 /* Second Version/release of the RedRat3 - RetRat3-II */
158 {USB_DEVICE(USB_RR3USB_VENDOR_ID, USB_RR3IIUSB_PRODUCT_ID)},
159 {} /* Terminating entry */
160};
161
162/* Structure to hold all of our device specific stuff */
163struct redrat3_dev {
164 /* core device bits */
165 struct rc_dev *rc;
166 struct device *dev;
167
bf139726
SY
168 /* led control */
169 struct led_classdev led;
170 atomic_t flash;
171 struct usb_ctrlrequest flash_control;
172 struct urb *flash_urb;
173 u8 flash_in_buf;
174
2154be65
JW
175 /* save off the usb device pointer */
176 struct usb_device *udev;
177
178 /* the receive endpoint */
179 struct usb_endpoint_descriptor *ep_in;
180 /* the buffer to receive data */
4c055a5a 181 void *bulk_in_buf;
2154be65
JW
182 /* urb used to read ir data */
183 struct urb *read_urb;
184
185 /* the send endpoint */
186 struct usb_endpoint_descriptor *ep_out;
2154be65
JW
187
188 /* usb dma */
189 dma_addr_t dma_in;
2154be65 190
2154be65
JW
191 /* rx signal timeout timer */
192 struct timer_list rx_timeout;
c53f9f00 193 u32 hw_timeout;
2154be65 194
2154be65
JW
195 /* Is the device currently transmitting?*/
196 bool transmitting;
197
198 /* store for current packet */
4c055a5a 199 struct redrat3_irdata irdata;
2154be65 200 u16 bytes_read;
2154be65
JW
201
202 u32 carrier;
203
4c055a5a 204 char name[64];
2154be65
JW
205 char phys[64];
206};
207
2154be65
JW
208/*
209 * redrat3_issue_async
210 *
211 * Issues an async read to the ir data in port..
212 * sets the callback to be redrat3_handle_async
213 */
214static void redrat3_issue_async(struct redrat3_dev *rr3)
215{
216 int res;
217
2154be65
JW
218 res = usb_submit_urb(rr3->read_urb, GFP_ATOMIC);
219 if (res)
3228bf81
GKH
220 dev_dbg(rr3->dev,
221 "%s: receive request FAILED! (res %d, len %d)\n",
222 __func__, res, rr3->read_urb->transfer_buffer_length);
2154be65
JW
223}
224
225static void redrat3_dump_fw_error(struct redrat3_dev *rr3, int code)
226{
227 if (!rr3->transmitting && (code != 0x40))
228 dev_info(rr3->dev, "fw error code 0x%02x: ", code);
229
230 switch (code) {
231 case 0x00:
232 pr_cont("No Error\n");
233 break;
234
235 /* Codes 0x20 through 0x2f are IR Firmware Errors */
236 case 0x20:
237 pr_cont("Initial signal pulse not long enough "
238 "to measure carrier frequency\n");
239 break;
240 case 0x21:
241 pr_cont("Not enough length values allocated for signal\n");
242 break;
243 case 0x22:
244 pr_cont("Not enough memory allocated for signal data\n");
245 break;
246 case 0x23:
247 pr_cont("Too many signal repeats\n");
248 break;
249 case 0x28:
250 pr_cont("Insufficient memory available for IR signal "
251 "data memory allocation\n");
252 break;
253 case 0x29:
254 pr_cont("Insufficient memory available "
255 "for IrDa signal data memory allocation\n");
256 break;
257
258 /* Codes 0x30 through 0x3f are USB Firmware Errors */
259 case 0x30:
260 pr_cont("Insufficient memory available for bulk "
261 "transfer structure\n");
262 break;
263
264 /*
265 * Other error codes... These are primarily errors that can occur in
266 * the control messages sent to the redrat
267 */
268 case 0x40:
269 if (!rr3->transmitting)
270 pr_cont("Signal capture has been terminated\n");
271 break;
272 case 0x41:
273 pr_cont("Attempt to set/get and unknown signal I/O "
274 "algorithm parameter\n");
275 break;
276 case 0x42:
277 pr_cont("Signal capture already started\n");
278 break;
279
280 default:
281 pr_cont("Unknown Error\n");
282 break;
283 }
284}
285
4c055a5a 286static u32 redrat3_val_to_mod_freq(struct redrat3_irdata *irdata)
2154be65
JW
287{
288 u32 mod_freq = 0;
4c055a5a 289 u16 mod_freq_count = be16_to_cpu(irdata->mod_freq_count);
2154be65 290
4c055a5a
SY
291 if (mod_freq_count != 0)
292 mod_freq = (RR3_CLK * be16_to_cpu(irdata->num_periods)) /
293 (mod_freq_count * RR3_CLK_PER_COUNT);
2154be65
JW
294
295 return mod_freq;
296}
297
298/* this function scales down the figures for the same result... */
299static u32 redrat3_len_to_us(u32 length)
300{
301 u32 biglen = length * 1000;
302 u32 divisor = (RR3_CLK_CONV_FACTOR) / 1000;
303 u32 result = (u32) (biglen / divisor);
304
305 /* don't allow zero lengths to go back, breaks lirc */
306 return result ? result : 1;
307}
308
309/*
310 * convert us back into redrat3 lengths
311 *
312 * length * 1000 length * 1000000
313 * ------------- = ---------------- = micro
314 * rr3clk / 1000 rr3clk
315
316 * 6 * 2 4 * 3 micro * rr3clk micro * rr3clk / 1000
317 * ----- = 4 ----- = 6 -------------- = len ---------------------
318 * 3 2 1000000 1000
319 */
320static u32 redrat3_us_to_len(u32 microsec)
321{
322 u32 result;
323 u32 divisor;
324
325 microsec &= IR_MAX_DURATION;
326 divisor = (RR3_CLK_CONV_FACTOR / 1000);
327 result = (u32)(microsec * divisor) / 1000;
328
329 /* don't allow zero lengths to go back, breaks lirc */
330 return result ? result : 1;
2154be65
JW
331}
332
68b2a69d 333/* timer callback to send reset event */
2154be65
JW
334static void redrat3_rx_timeout(unsigned long data)
335{
336 struct redrat3_dev *rr3 = (struct redrat3_dev *)data;
2154be65 337
3228bf81 338 dev_dbg(rr3->dev, "calling ir_raw_event_reset\n");
2154be65
JW
339 ir_raw_event_reset(rr3->rc);
340}
341
342static void redrat3_process_ir_data(struct redrat3_dev *rr3)
343{
344 DEFINE_IR_RAW_EVENT(rawir);
2154be65 345 struct device *dev;
fa7b9ac2 346 unsigned i, trailer = 0;
4c055a5a 347 unsigned sig_size, single_len, offset, val;
2154be65 348 unsigned long delay;
4c055a5a 349 u32 mod_freq;
2154be65
JW
350
351 if (!rr3) {
352 pr_err("%s called with no context!\n", __func__);
353 return;
354 }
355
2154be65 356 dev = rr3->dev;
2154be65 357
c53f9f00
JW
358 /* Make sure we reset the IR kfifo after a bit of inactivity */
359 delay = usecs_to_jiffies(rr3->hw_timeout);
2154be65
JW
360 mod_timer(&rr3->rx_timeout, jiffies + delay);
361
4c055a5a 362 mod_freq = redrat3_val_to_mod_freq(&rr3->irdata);
3228bf81 363 dev_dbg(dev, "Got mod_freq of %u\n", mod_freq);
2154be65 364
2154be65 365 /* process each rr3 encoded byte into an int */
4c055a5a
SY
366 sig_size = be16_to_cpu(rr3->irdata.sig_size);
367 for (i = 0; i < sig_size; i++) {
368 offset = rr3->irdata.sigdata[i];
369 val = get_unaligned_be16(&rr3->irdata.lens[offset]);
370 single_len = redrat3_len_to_us(val);
2154be65 371
2154be65
JW
372 /* we should always get pulse/space/pulse/space samples */
373 if (i % 2)
374 rawir.pulse = false;
375 else
376 rawir.pulse = true;
377
378 rawir.duration = US_TO_NS(single_len);
c53f9f00
JW
379 /* Save initial pulse length to fudge trailer */
380 if (i == 0)
381 trailer = rawir.duration;
2c594ffa
JW
382 /* cap the value to IR_MAX_DURATION */
383 rawir.duration &= IR_MAX_DURATION;
384
3228bf81 385 dev_dbg(dev, "storing %s with duration %d (i: %d)\n",
2154be65
JW
386 rawir.pulse ? "pulse" : "space", rawir.duration, i);
387 ir_raw_event_store_with_filter(rr3->rc, &rawir);
388 }
389
390 /* add a trailing space, if need be */
391 if (i % 2) {
392 rawir.pulse = false;
393 /* this duration is made up, and may not be ideal... */
c53f9f00
JW
394 if (trailer < US_TO_NS(1000))
395 rawir.duration = US_TO_NS(2800);
396 else
397 rawir.duration = trailer;
3228bf81 398 dev_dbg(dev, "storing trailing space with duration %d\n",
2154be65
JW
399 rawir.duration);
400 ir_raw_event_store_with_filter(rr3->rc, &rawir);
401 }
402
3228bf81 403 dev_dbg(dev, "calling ir_raw_event_handle\n");
2154be65 404 ir_raw_event_handle(rr3->rc);
2154be65
JW
405}
406
407/* Util fn to send rr3 cmds */
408static u8 redrat3_send_cmd(int cmd, struct redrat3_dev *rr3)
409{
410 struct usb_device *udev;
411 u8 *data;
412 int res;
413
414 data = kzalloc(sizeof(u8), GFP_KERNEL);
415 if (!data)
416 return -ENOMEM;
417
418 udev = rr3->udev;
419 res = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), cmd,
420 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
421 0x0000, 0x0000, data, sizeof(u8), HZ * 10);
422
423 if (res < 0) {
424 dev_err(rr3->dev, "%s: Error sending rr3 cmd res %d, data %d",
425 __func__, res, *data);
426 res = -EIO;
427 } else
4c055a5a 428 res = data[0];
2154be65
JW
429
430 kfree(data);
431
432 return res;
433}
434
435/* Enables the long range detector and starts async receive */
436static int redrat3_enable_detector(struct redrat3_dev *rr3)
437{
438 struct device *dev = rr3->dev;
439 u8 ret;
440
2154be65
JW
441 ret = redrat3_send_cmd(RR3_RC_DET_ENABLE, rr3);
442 if (ret != 0)
443 dev_dbg(dev, "%s: unexpected ret of %d\n",
444 __func__, ret);
445
446 ret = redrat3_send_cmd(RR3_RC_DET_STATUS, rr3);
447 if (ret != 1) {
448 dev_err(dev, "%s: detector status: %d, should be 1\n",
449 __func__, ret);
450 return -EIO;
451 }
452
2154be65
JW
453 redrat3_issue_async(rr3);
454
455 return 0;
456}
457
2154be65
JW
458static inline void redrat3_delete(struct redrat3_dev *rr3,
459 struct usb_device *udev)
460{
2154be65 461 usb_kill_urb(rr3->read_urb);
bf139726 462 usb_kill_urb(rr3->flash_urb);
2154be65 463 usb_free_urb(rr3->read_urb);
bf139726 464 usb_free_urb(rr3->flash_urb);
fa7b9ac2 465 usb_free_coherent(udev, le16_to_cpu(rr3->ep_in->wMaxPacketSize),
2154be65 466 rr3->bulk_in_buf, rr3->dma_in);
2154be65
JW
467
468 kfree(rr3);
469}
470
c53f9f00 471static u32 redrat3_get_timeout(struct redrat3_dev *rr3)
2154be65 472{
801b69f2 473 __be32 *tmp;
c53f9f00 474 u32 timeout = MS_TO_US(150); /* a sane default, if things go haywire */
2154be65
JW
475 int len, ret, pipe;
476
477 len = sizeof(*tmp);
478 tmp = kzalloc(len, GFP_KERNEL);
479 if (!tmp) {
c53f9f00 480 dev_warn(rr3->dev, "Memory allocation faillure\n");
2154be65
JW
481 return timeout;
482 }
483
c53f9f00
JW
484 pipe = usb_rcvctrlpipe(rr3->udev, 0);
485 ret = usb_control_msg(rr3->udev, pipe, RR3_GET_IR_PARAM,
2154be65
JW
486 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
487 RR3_IR_IO_SIG_TIMEOUT, 0, tmp, len, HZ * 5);
801b69f2 488 if (ret != len)
c53f9f00 489 dev_warn(rr3->dev, "Failed to read timeout from hardware\n");
801b69f2
SY
490 else {
491 timeout = redrat3_len_to_us(be32_to_cpup(tmp));
492
3228bf81 493 dev_dbg(rr3->dev, "Got timeout of %d ms\n", timeout / 1000);
2154be65
JW
494 }
495
801b69f2 496 kfree(tmp);
2154be65 497
2154be65
JW
498 return timeout;
499}
500
501static void redrat3_reset(struct redrat3_dev *rr3)
502{
503 struct usb_device *udev = rr3->udev;
504 struct device *dev = rr3->dev;
505 int rc, rxpipe, txpipe;
506 u8 *val;
507 int len = sizeof(u8);
508
2154be65
JW
509 rxpipe = usb_rcvctrlpipe(udev, 0);
510 txpipe = usb_sndctrlpipe(udev, 0);
511
fa7b9ac2 512 val = kmalloc(len, GFP_KERNEL);
2154be65
JW
513 if (!val) {
514 dev_err(dev, "Memory allocation failure\n");
515 return;
516 }
517
518 *val = 0x01;
519 rc = usb_control_msg(udev, rxpipe, RR3_RESET,
520 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
521 RR3_CPUCS_REG_ADDR, 0, val, len, HZ * 25);
3228bf81 522 dev_dbg(dev, "reset returned 0x%02x\n", rc);
2154be65
JW
523
524 *val = 5;
525 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,
526 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
527 RR3_IR_IO_LENGTH_FUZZ, 0, val, len, HZ * 25);
3228bf81 528 dev_dbg(dev, "set ir parm len fuzz %d rc 0x%02x\n", *val, rc);
2154be65
JW
529
530 *val = RR3_DRIVER_MAXLENS;
531 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,
532 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
533 RR3_IR_IO_MAX_LENGTHS, 0, val, len, HZ * 25);
3228bf81 534 dev_dbg(dev, "set ir parm max lens %d rc 0x%02x\n", *val, rc);
2154be65
JW
535
536 kfree(val);
537}
538
539static void redrat3_get_firmware_rev(struct redrat3_dev *rr3)
540{
541 int rc = 0;
542 char *buffer;
543
2154be65
JW
544 buffer = kzalloc(sizeof(char) * (RR3_FW_VERSION_LEN + 1), GFP_KERNEL);
545 if (!buffer) {
546 dev_err(rr3->dev, "Memory allocation failure\n");
547 return;
548 }
549
550 rc = usb_control_msg(rr3->udev, usb_rcvctrlpipe(rr3->udev, 0),
551 RR3_FW_VERSION,
552 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
553 0, 0, buffer, RR3_FW_VERSION_LEN, HZ * 5);
554
555 if (rc >= 0)
556 dev_info(rr3->dev, "Firmware rev: %s", buffer);
557 else
558 dev_err(rr3->dev, "Problem fetching firmware ID\n");
559
560 kfree(buffer);
2154be65
JW
561}
562
fa7b9ac2 563static void redrat3_read_packet_start(struct redrat3_dev *rr3, unsigned len)
2154be65 564{
4c055a5a
SY
565 struct redrat3_header *header = rr3->bulk_in_buf;
566 unsigned pktlen, pkttype;
2154be65 567
2154be65 568 /* grab the Length and type of transfer */
4c055a5a
SY
569 pktlen = be16_to_cpu(header->length);
570 pkttype = be16_to_cpu(header->transfer_type);
2154be65 571
4c055a5a
SY
572 if (pktlen > sizeof(rr3->irdata)) {
573 dev_warn(rr3->dev, "packet length %u too large\n", pktlen);
574 return;
575 }
2154be65 576
4c055a5a 577 switch (pkttype) {
2154be65 578 case RR3_ERROR:
4c055a5a
SY
579 if (len >= sizeof(struct redrat3_error)) {
580 struct redrat3_error *error = rr3->bulk_in_buf;
581 unsigned fw_error = be16_to_cpu(error->fw_error);
582 redrat3_dump_fw_error(rr3, fw_error);
583 }
2154be65
JW
584 break;
585
586 case RR3_MOD_SIGNAL_IN:
4c055a5a 587 memcpy(&rr3->irdata, rr3->bulk_in_buf, len);
2154be65 588 rr3->bytes_read = len;
3228bf81 589 dev_dbg(rr3->dev, "bytes_read %d, pktlen %d\n",
4c055a5a 590 rr3->bytes_read, pktlen);
2154be65
JW
591 break;
592
593 default:
3228bf81 594 dev_dbg(rr3->dev, "ignoring packet with type 0x%02x, len of %d, 0x%02x\n",
4c055a5a 595 pkttype, len, pktlen);
2154be65
JW
596 break;
597 }
598}
599
fa7b9ac2 600static void redrat3_read_packet_continue(struct redrat3_dev *rr3, unsigned len)
2154be65 601{
4c055a5a
SY
602 void *irdata = &rr3->irdata;
603
4c055a5a
SY
604 if (len + rr3->bytes_read > sizeof(rr3->irdata)) {
605 dev_warn(rr3->dev, "too much data for packet\n");
606 rr3->bytes_read = 0;
607 return;
608 }
609
610 memcpy(irdata + rr3->bytes_read, rr3->bulk_in_buf, len);
2154be65
JW
611
612 rr3->bytes_read += len;
3228bf81 613 dev_dbg(rr3->dev, "bytes_read %d, pktlen %d\n", rr3->bytes_read,
4c055a5a 614 be16_to_cpu(rr3->irdata.header.length));
2154be65
JW
615}
616
617/* gather IR data from incoming urb, process it when we have enough */
fa7b9ac2 618static int redrat3_get_ir_data(struct redrat3_dev *rr3, unsigned len)
2154be65
JW
619{
620 struct device *dev = rr3->dev;
4c055a5a 621 unsigned pkttype;
2154be65
JW
622 int ret = 0;
623
4c055a5a 624 if (rr3->bytes_read == 0 && len >= sizeof(struct redrat3_header)) {
2154be65
JW
625 redrat3_read_packet_start(rr3, len);
626 } else if (rr3->bytes_read != 0) {
627 redrat3_read_packet_continue(rr3, len);
628 } else if (rr3->bytes_read == 0) {
629 dev_err(dev, "error: no packet data read\n");
630 ret = -ENODATA;
631 goto out;
632 }
633
38e35a85
SY
634 if (rr3->bytes_read < be16_to_cpu(rr3->irdata.header.length) +
635 sizeof(struct redrat3_header))
2154be65
JW
636 /* we're still accumulating data */
637 return 0;
638
639 /* if we get here, we've got IR data to decode */
4c055a5a
SY
640 pkttype = be16_to_cpu(rr3->irdata.header.transfer_type);
641 if (pkttype == RR3_MOD_SIGNAL_IN)
2154be65
JW
642 redrat3_process_ir_data(rr3);
643 else
3228bf81 644 dev_dbg(dev, "discarding non-signal data packet (type 0x%02x)\n",
4c055a5a 645 pkttype);
2154be65
JW
646
647out:
648 rr3->bytes_read = 0;
2154be65
JW
649 return ret;
650}
651
652/* callback function from USB when async USB request has completed */
801b69f2 653static void redrat3_handle_async(struct urb *urb)
2154be65
JW
654{
655 struct redrat3_dev *rr3;
dbea1880 656 int ret;
2154be65
JW
657
658 if (!urb)
659 return;
660
661 rr3 = urb->context;
662 if (!rr3) {
663 pr_err("%s called with invalid context!\n", __func__);
664 usb_unlink_urb(urb);
665 return;
666 }
667
2154be65
JW
668 switch (urb->status) {
669 case 0:
dbea1880
AV
670 ret = redrat3_get_ir_data(rr3, urb->actual_length);
671 if (!ret) {
672 /* no error, prepare to read more */
673 redrat3_issue_async(rr3);
674 }
2154be65
JW
675 break;
676
677 case -ECONNRESET:
678 case -ENOENT:
679 case -ESHUTDOWN:
680 usb_unlink_urb(urb);
681 return;
682
683 case -EPIPE:
684 default:
685 dev_warn(rr3->dev, "Error: urb status = %d\n", urb->status);
686 rr3->bytes_read = 0;
2154be65
JW
687 break;
688 }
2154be65
JW
689}
690
2154be65
JW
691static u16 mod_freq_to_val(unsigned int mod_freq)
692{
693 int mult = 6000000;
694
695 /* Clk used in mod. freq. generation is CLK24/4. */
4c055a5a 696 return 65536 - (mult / mod_freq);
2154be65
JW
697}
698
dbea1880 699static int redrat3_set_tx_carrier(struct rc_dev *rcdev, u32 carrier)
2154be65 700{
dbea1880
AV
701 struct redrat3_dev *rr3 = rcdev->priv;
702 struct device *dev = rr3->dev;
2154be65 703
3228bf81 704 dev_dbg(dev, "Setting modulation frequency to %u", carrier);
48cafec9
DC
705 if (carrier == 0)
706 return -EINVAL;
707
2154be65
JW
708 rr3->carrier = carrier;
709
710 return carrier;
711}
712
dbea1880
AV
713static int redrat3_transmit_ir(struct rc_dev *rcdev, unsigned *txbuf,
714 unsigned count)
2154be65
JW
715{
716 struct redrat3_dev *rr3 = rcdev->priv;
717 struct device *dev = rr3->dev;
4c055a5a 718 struct redrat3_irdata *irdata = NULL;
fa7b9ac2 719 int ret, ret_len;
2154be65 720 int lencheck, cur_sample_len, pipe;
2154be65 721 int *sample_lens = NULL;
2154be65 722 u8 curlencheck = 0;
fa7b9ac2 723 unsigned i, sendbuf_len;
2154be65 724
2154be65
JW
725 if (rr3->transmitting) {
726 dev_warn(dev, "%s: transmitter already in use\n", __func__);
727 return -EAGAIN;
728 }
729
671ea670
SY
730 if (count > RR3_MAX_SIG_SIZE - RR3_TX_TRAILER_LEN)
731 return -EINVAL;
2154be65 732
dbea1880 733 /* rr3 will disable rc detector on transmit */
2154be65
JW
734 rr3->transmitting = true;
735
2154be65
JW
736 sample_lens = kzalloc(sizeof(int) * RR3_DRIVER_MAXLENS, GFP_KERNEL);
737 if (!sample_lens) {
738 ret = -ENOMEM;
739 goto out;
740 }
741
4c055a5a
SY
742 irdata = kzalloc(sizeof(*irdata), GFP_KERNEL);
743 if (!irdata) {
801b69f2
SY
744 ret = -ENOMEM;
745 goto out;
746 }
747
2154be65 748 for (i = 0; i < count; i++) {
06eae25f 749 cur_sample_len = redrat3_us_to_len(txbuf[i]);
801b69f2
SY
750 if (cur_sample_len > 0xffff) {
751 dev_warn(dev, "transmit period of %uus truncated to %uus\n",
752 txbuf[i], redrat3_len_to_us(0xffff));
753 cur_sample_len = 0xffff;
754 }
2154be65 755 for (lencheck = 0; lencheck < curlencheck; lencheck++) {
2154be65
JW
756 if (sample_lens[lencheck] == cur_sample_len)
757 break;
758 }
759 if (lencheck == curlencheck) {
3228bf81 760 dev_dbg(dev, "txbuf[%d]=%u, pos %d, enc %u\n",
2154be65 761 i, txbuf[i], curlencheck, cur_sample_len);
06eae25f 762 if (curlencheck < RR3_DRIVER_MAXLENS) {
2154be65
JW
763 /* now convert the value to a proper
764 * rr3 value.. */
765 sample_lens[curlencheck] = cur_sample_len;
4c055a5a
SY
766 put_unaligned_be16(cur_sample_len,
767 &irdata->lens[curlencheck]);
2154be65
JW
768 curlencheck++;
769 } else {
671ea670
SY
770 ret = -EINVAL;
771 goto out;
2154be65
JW
772 }
773 }
4c055a5a 774 irdata->sigdata[i] = lencheck;
2154be65
JW
775 }
776
4c055a5a
SY
777 irdata->sigdata[count] = RR3_END_OF_SIGNAL;
778 irdata->sigdata[count + 1] = RR3_END_OF_SIGNAL;
2154be65 779
4c055a5a
SY
780 sendbuf_len = offsetof(struct redrat3_irdata,
781 sigdata[count + RR3_TX_TRAILER_LEN]);
2154be65 782 /* fill in our packet header */
4c055a5a
SY
783 irdata->header.length = cpu_to_be16(sendbuf_len -
784 sizeof(struct redrat3_header));
785 irdata->header.transfer_type = cpu_to_be16(RR3_MOD_SIGNAL_OUT);
786 irdata->pause = cpu_to_be32(redrat3_len_to_us(100));
787 irdata->mod_freq_count = cpu_to_be16(mod_freq_to_val(rr3->carrier));
788 irdata->no_lengths = curlencheck;
789 irdata->sig_size = cpu_to_be16(count + RR3_TX_TRAILER_LEN);
2154be65
JW
790
791 pipe = usb_sndbulkpipe(rr3->udev, rr3->ep_out->bEndpointAddress);
4c055a5a 792 ret = usb_bulk_msg(rr3->udev, pipe, irdata,
2154be65 793 sendbuf_len, &ret_len, 10 * HZ);
3228bf81 794 dev_dbg(dev, "sent %d bytes, (ret %d)\n", ret_len, ret);
2154be65
JW
795
796 /* now tell the hardware to transmit what we sent it */
797 pipe = usb_rcvctrlpipe(rr3->udev, 0);
798 ret = usb_control_msg(rr3->udev, pipe, RR3_TX_SEND_SIGNAL,
799 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
4c055a5a 800 0, 0, irdata, 2, HZ * 10);
2154be65
JW
801
802 if (ret < 0)
803 dev_err(dev, "Error: control msg send failed, rc %d\n", ret);
804 else
dbea1880 805 ret = count;
2154be65
JW
806
807out:
808 kfree(sample_lens);
4c055a5a 809 kfree(irdata);
2154be65
JW
810
811 rr3->transmitting = false;
dbea1880 812 /* rr3 re-enables rc detector because it was enabled before */
2154be65
JW
813
814 return ret;
815}
816
bf139726
SY
817static void redrat3_brightness_set(struct led_classdev *led_dev, enum
818 led_brightness brightness)
819{
820 struct redrat3_dev *rr3 = container_of(led_dev, struct redrat3_dev,
821 led);
822
823 if (brightness != LED_OFF && atomic_cmpxchg(&rr3->flash, 0, 1) == 0) {
824 int ret = usb_submit_urb(rr3->flash_urb, GFP_ATOMIC);
825 if (ret != 0) {
826 dev_dbg(rr3->dev, "%s: unexpected ret of %d\n",
827 __func__, ret);
828 atomic_set(&rr3->flash, 0);
829 }
830 }
831}
832
833static void redrat3_led_complete(struct urb *urb)
834{
835 struct redrat3_dev *rr3 = urb->context;
836
837 switch (urb->status) {
838 case 0:
839 break;
840 case -ECONNRESET:
841 case -ENOENT:
842 case -ESHUTDOWN:
843 usb_unlink_urb(urb);
844 return;
845 case -EPIPE:
846 default:
847 dev_dbg(rr3->dev, "Error: urb status = %d\n", urb->status);
848 break;
849 }
850
851 rr3->led.brightness = LED_OFF;
852 atomic_dec(&rr3->flash);
853}
854
2154be65
JW
855static struct rc_dev *redrat3_init_rc_dev(struct redrat3_dev *rr3)
856{
857 struct device *dev = rr3->dev;
858 struct rc_dev *rc;
859 int ret = -ENODEV;
860 u16 prod = le16_to_cpu(rr3->udev->descriptor.idProduct);
861
862 rc = rc_allocate_device();
863 if (!rc) {
864 dev_err(dev, "remote input dev allocation failed\n");
865 goto out;
866 }
867
868 snprintf(rr3->name, sizeof(rr3->name), "RedRat3%s "
869 "Infrared Remote Transceiver (%04x:%04x)",
870 prod == USB_RR3IIUSB_PRODUCT_ID ? "-II" : "",
871 le16_to_cpu(rr3->udev->descriptor.idVendor), prod);
872
873 usb_make_path(rr3->udev, rr3->phys, sizeof(rr3->phys));
874
875 rc->input_name = rr3->name;
876 rc->input_phys = rr3->phys;
877 usb_to_input_id(rr3->udev, &rc->input_id);
878 rc->dev.parent = dev;
879 rc->priv = rr3;
880 rc->driver_type = RC_DRIVER_IR_RAW;
1a1934fa 881 rc_set_allowed_protocols(rc, RC_BIT_ALL);
c53f9f00 882 rc->timeout = US_TO_NS(2750);
2154be65
JW
883 rc->tx_ir = redrat3_transmit_ir;
884 rc->s_tx_carrier = redrat3_set_tx_carrier;
885 rc->driver_name = DRIVER_NAME;
06eae25f 886 rc->rx_resolution = US_TO_NS(2);
2154be65
JW
887 rc->map_name = RC_MAP_HAUPPAUGE;
888
889 ret = rc_register_device(rc);
890 if (ret < 0) {
891 dev_err(dev, "remote dev registration failed\n");
892 goto out;
893 }
894
895 return rc;
896
897out:
898 rc_free_device(rc);
899 return NULL;
900}
901
4c62e976
GKH
902static int redrat3_dev_probe(struct usb_interface *intf,
903 const struct usb_device_id *id)
2154be65
JW
904{
905 struct usb_device *udev = interface_to_usbdev(intf);
906 struct device *dev = &intf->dev;
907 struct usb_host_interface *uhi;
908 struct redrat3_dev *rr3;
909 struct usb_endpoint_descriptor *ep;
910 struct usb_endpoint_descriptor *ep_in = NULL;
911 struct usb_endpoint_descriptor *ep_out = NULL;
912 u8 addr, attrs;
913 int pipe, i;
914 int retval = -ENOMEM;
915
2154be65
JW
916 uhi = intf->cur_altsetting;
917
918 /* find our bulk-in and bulk-out endpoints */
919 for (i = 0; i < uhi->desc.bNumEndpoints; ++i) {
920 ep = &uhi->endpoint[i].desc;
921 addr = ep->bEndpointAddress;
922 attrs = ep->bmAttributes;
923
924 if ((ep_in == NULL) &&
925 ((addr & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&
926 ((attrs & USB_ENDPOINT_XFERTYPE_MASK) ==
927 USB_ENDPOINT_XFER_BULK)) {
3228bf81 928 dev_dbg(dev, "found bulk-in endpoint at 0x%02x\n",
2154be65
JW
929 ep->bEndpointAddress);
930 /* data comes in on 0x82, 0x81 is for other data... */
931 if (ep->bEndpointAddress == RR3_BULK_IN_EP_ADDR)
932 ep_in = ep;
933 }
934
935 if ((ep_out == NULL) &&
936 ((addr & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&
937 ((attrs & USB_ENDPOINT_XFERTYPE_MASK) ==
938 USB_ENDPOINT_XFER_BULK)) {
3228bf81 939 dev_dbg(dev, "found bulk-out endpoint at 0x%02x\n",
2154be65
JW
940 ep->bEndpointAddress);
941 ep_out = ep;
942 }
943 }
944
945 if (!ep_in || !ep_out) {
946 dev_err(dev, "Couldn't find both in and out endpoints\n");
947 retval = -ENODEV;
948 goto no_endpoints;
949 }
950
951 /* allocate memory for our device state and initialize it */
952 rr3 = kzalloc(sizeof(*rr3), GFP_KERNEL);
953 if (rr3 == NULL) {
954 dev_err(dev, "Memory allocation failure\n");
7eb75715 955 goto no_endpoints;
2154be65
JW
956 }
957
958 rr3->dev = &intf->dev;
959
960 /* set up bulk-in endpoint */
961 rr3->read_urb = usb_alloc_urb(0, GFP_KERNEL);
962 if (!rr3->read_urb) {
963 dev_err(dev, "Read urb allocation failure\n");
964 goto error;
965 }
966
967 rr3->ep_in = ep_in;
fa7b9ac2
SY
968 rr3->bulk_in_buf = usb_alloc_coherent(udev,
969 le16_to_cpu(ep_in->wMaxPacketSize), GFP_ATOMIC, &rr3->dma_in);
2154be65
JW
970 if (!rr3->bulk_in_buf) {
971 dev_err(dev, "Read buffer allocation failure\n");
972 goto error;
973 }
974
975 pipe = usb_rcvbulkpipe(udev, ep_in->bEndpointAddress);
fa7b9ac2
SY
976 usb_fill_bulk_urb(rr3->read_urb, udev, pipe, rr3->bulk_in_buf,
977 le16_to_cpu(ep_in->wMaxPacketSize), redrat3_handle_async, rr3);
2154be65
JW
978
979 rr3->ep_out = ep_out;
2154be65
JW
980 rr3->udev = udev;
981
982 redrat3_reset(rr3);
983 redrat3_get_firmware_rev(rr3);
984
985 /* might be all we need to do? */
986 retval = redrat3_enable_detector(rr3);
987 if (retval < 0)
988 goto error;
989
c53f9f00
JW
990 /* store current hardware timeout, in us, will use for kfifo resets */
991 rr3->hw_timeout = redrat3_get_timeout(rr3);
992
2154be65
JW
993 /* default.. will get overridden by any sends with a freq defined */
994 rr3->carrier = 38000;
995
bf139726
SY
996 /* led control */
997 rr3->led.name = "redrat3:red:feedback";
998 rr3->led.default_trigger = "rc-feedback";
999 rr3->led.brightness_set = redrat3_brightness_set;
1000 retval = led_classdev_register(&intf->dev, &rr3->led);
1001 if (retval)
1002 goto error;
1003
1004 atomic_set(&rr3->flash, 0);
1005 rr3->flash_urb = usb_alloc_urb(0, GFP_KERNEL);
1006 if (!rr3->flash_urb) {
1007 retval = -ENOMEM;
1008 goto led_free_error;
1009 }
1010
1011 /* setup packet is 'c0 b9 0000 0000 0001' */
1012 rr3->flash_control.bRequestType = 0xc0;
1013 rr3->flash_control.bRequest = RR3_BLINK_LED;
1014 rr3->flash_control.wLength = cpu_to_le16(1);
1015
1016 usb_fill_control_urb(rr3->flash_urb, udev, usb_rcvctrlpipe(udev, 0),
1017 (unsigned char *)&rr3->flash_control,
1018 &rr3->flash_in_buf, sizeof(rr3->flash_in_buf),
1019 redrat3_led_complete, rr3);
1020
2154be65 1021 rr3->rc = redrat3_init_rc_dev(rr3);
6ea7cf76
PST
1022 if (!rr3->rc) {
1023 retval = -ENOMEM;
bf139726 1024 goto led_free_error;
6ea7cf76 1025 }
2154be65
JW
1026 setup_timer(&rr3->rx_timeout, redrat3_rx_timeout, (unsigned long)rr3);
1027
1028 /* we can register the device now, as it is ready */
1029 usb_set_intfdata(intf, rr3);
1030
2154be65
JW
1031 return 0;
1032
bf139726
SY
1033led_free_error:
1034 led_classdev_unregister(&rr3->led);
2154be65
JW
1035error:
1036 redrat3_delete(rr3, rr3->udev);
1037
1038no_endpoints:
1039 dev_err(dev, "%s: retval = %x", __func__, retval);
1040
1041 return retval;
1042}
1043
4c62e976 1044static void redrat3_dev_disconnect(struct usb_interface *intf)
2154be65
JW
1045{
1046 struct usb_device *udev = interface_to_usbdev(intf);
1047 struct redrat3_dev *rr3 = usb_get_intfdata(intf);
1048
2154be65
JW
1049 if (!rr3)
1050 return;
1051
2154be65
JW
1052 usb_set_intfdata(intf, NULL);
1053 rc_unregister_device(rr3->rc);
bf139726 1054 led_classdev_unregister(&rr3->led);
c53f9f00 1055 del_timer_sync(&rr3->rx_timeout);
2154be65 1056 redrat3_delete(rr3, udev);
2154be65
JW
1057}
1058
1059static int redrat3_dev_suspend(struct usb_interface *intf, pm_message_t message)
1060{
1061 struct redrat3_dev *rr3 = usb_get_intfdata(intf);
a36d5b61 1062
bf139726 1063 led_classdev_suspend(&rr3->led);
2154be65 1064 usb_kill_urb(rr3->read_urb);
bf139726 1065 usb_kill_urb(rr3->flash_urb);
2154be65
JW
1066 return 0;
1067}
1068
1069static int redrat3_dev_resume(struct usb_interface *intf)
1070{
1071 struct redrat3_dev *rr3 = usb_get_intfdata(intf);
a36d5b61 1072
2154be65
JW
1073 if (usb_submit_urb(rr3->read_urb, GFP_ATOMIC))
1074 return -EIO;
bf139726 1075 led_classdev_resume(&rr3->led);
2154be65
JW
1076 return 0;
1077}
1078
1079static struct usb_driver redrat3_dev_driver = {
1080 .name = DRIVER_NAME,
1081 .probe = redrat3_dev_probe,
4c62e976 1082 .disconnect = redrat3_dev_disconnect,
2154be65
JW
1083 .suspend = redrat3_dev_suspend,
1084 .resume = redrat3_dev_resume,
1085 .reset_resume = redrat3_dev_resume,
1086 .id_table = redrat3_dev_table
1087};
1088
ecb3b2b3 1089module_usb_driver(redrat3_dev_driver);
2154be65
JW
1090
1091MODULE_DESCRIPTION(DRIVER_DESC);
1092MODULE_AUTHOR(DRIVER_AUTHOR);
1093MODULE_AUTHOR(DRIVER_AUTHOR2);
1094MODULE_LICENSE("GPL");
1095MODULE_DEVICE_TABLE(usb, redrat3_dev_table);
This page took 0.324437 seconds and 5 git commands to generate.