2 * USB RedRat3 IR Transceiver rc-core driver
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.
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
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.
18 * - fix lirc not showing repeats properly
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.
26 * http://www.redrat.co.uk/
28 * It uses its own little protocol to communicate, the required
29 * parts of which are embedded within this driver.
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.
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.
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
48 #include <linux/device.h>
49 #include <linux/module.h>
50 #include <linux/slab.h>
51 #include <linux/usb.h>
52 #include <linux/usb/input.h>
53 #include <media/rc-core.h>
55 /* Driver Information */
56 #define DRIVER_VERSION "0.70"
57 #define DRIVER_AUTHOR "Jarod Wilson <jarod@redhat.com>"
58 #define DRIVER_AUTHOR2 "The Dweller, Stephen Cox"
59 #define DRIVER_DESC "RedRat3 USB IR Transceiver Driver"
60 #define DRIVER_NAME "redrat3"
62 /* module parameters */
63 #ifdef CONFIG_USB_DEBUG
69 #define RR3_DEBUG_STANDARD 0x1
70 #define RR3_DEBUG_FUNCTION_TRACE 0x2
72 #define rr3_dbg(dev, fmt, ...) \
74 if (debug & RR3_DEBUG_STANDARD) \
75 dev_info(dev, fmt, ## __VA_ARGS__); \
78 #define rr3_ftr(dev, fmt, ...) \
80 if (debug & RR3_DEBUG_FUNCTION_TRACE) \
81 dev_info(dev, fmt, ## __VA_ARGS__); \
84 /* bulk data transfer types */
85 #define RR3_ERROR 0x01
86 #define RR3_MOD_SIGNAL_IN 0x20
87 #define RR3_MOD_SIGNAL_OUT 0x21
89 /* Get the RR firmware version */
90 #define RR3_FW_VERSION 0xb1
91 #define RR3_FW_VERSION_LEN 64
92 /* Send encoded signal bulk-sent earlier*/
93 #define RR3_TX_SEND_SIGNAL 0xb3
94 #define RR3_SET_IR_PARAM 0xb7
95 #define RR3_GET_IR_PARAM 0xb8
96 /* Blink the red LED on the device */
97 #define RR3_BLINK_LED 0xb9
98 /* Read serial number of device */
99 #define RR3_READ_SER_NO 0xba
100 #define RR3_SER_NO_LEN 4
101 /* Start capture with the RC receiver */
102 #define RR3_RC_DET_ENABLE 0xbb
103 /* Stop capture with the RC receiver */
104 #define RR3_RC_DET_DISABLE 0xbc
105 /* Return the status of RC detector capture */
106 #define RR3_RC_DET_STATUS 0xbd
108 #define RR3_RESET 0xa0
110 /* Max number of lengths in the signal. */
111 #define RR3_IR_IO_MAX_LENGTHS 0x01
112 /* Periods to measure mod. freq. */
113 #define RR3_IR_IO_PERIODS_MF 0x02
114 /* Size of memory for main signal data */
115 #define RR3_IR_IO_SIG_MEM_SIZE 0x03
116 /* Delta value when measuring lengths */
117 #define RR3_IR_IO_LENGTH_FUZZ 0x04
118 /* Timeout for end of signal detection */
119 #define RR3_IR_IO_SIG_TIMEOUT 0x05
120 /* Minumum value for pause recognition. */
121 #define RR3_IR_IO_MIN_PAUSE 0x06
123 /* Clock freq. of EZ-USB chip */
124 #define RR3_CLK 24000000
125 /* Clock periods per timer count */
126 #define RR3_CLK_PER_COUNT 12
127 /* (RR3_CLK / RR3_CLK_PER_COUNT) */
128 #define RR3_CLK_CONV_FACTOR 2000000
129 /* USB bulk-in IR data endpoint address */
130 #define RR3_BULK_IN_EP_ADDR 0x82
132 /* Raw Modulated signal data value offsets */
133 #define RR3_PAUSE_OFFSET 0
134 #define RR3_FREQ_COUNT_OFFSET 4
135 #define RR3_NUM_PERIOD_OFFSET 6
136 #define RR3_MAX_LENGTHS_OFFSET 8
137 #define RR3_NUM_LENGTHS_OFFSET 9
138 #define RR3_MAX_SIGS_OFFSET 10
139 #define RR3_NUM_SIGS_OFFSET 12
140 #define RR3_REPEATS_OFFSET 14
142 /* Size of the fixed-length portion of the signal */
143 #define RR3_HEADER_LENGTH 15
144 #define RR3_DRIVER_MAXLENS 128
145 #define RR3_MAX_SIG_SIZE 512
146 #define RR3_MAX_BUF_SIZE \
147 ((2 * RR3_HEADER_LENGTH) + RR3_DRIVER_MAXLENS + RR3_MAX_SIG_SIZE)
148 #define RR3_TIME_UNIT 50
149 #define RR3_END_OF_SIGNAL 0x7f
150 #define RR3_TX_HEADER_OFFSET 4
151 #define RR3_TX_TRAILER_LEN 2
152 #define RR3_RX_MIN_TIMEOUT 5
153 #define RR3_RX_MAX_TIMEOUT 2000
155 /* The 8051's CPUCS Register address */
156 #define RR3_CPUCS_REG_ADDR 0x7f92
158 #define USB_RR3USB_VENDOR_ID 0x112a
159 #define USB_RR3USB_PRODUCT_ID 0x0001
160 #define USB_RR3IIUSB_PRODUCT_ID 0x0005
162 /* table of devices that work with this driver */
163 static struct usb_device_id redrat3_dev_table[] = {
164 /* Original version of the RedRat3 */
165 {USB_DEVICE(USB_RR3USB_VENDOR_ID, USB_RR3USB_PRODUCT_ID)},
166 /* Second Version/release of the RedRat3 - RetRat3-II */
167 {USB_DEVICE(USB_RR3USB_VENDOR_ID, USB_RR3IIUSB_PRODUCT_ID)},
168 {} /* Terminating entry */
171 /* Structure to hold all of our device specific stuff */
173 /* core device bits */
177 /* save off the usb device pointer */
178 struct usb_device *udev;
180 /* the receive endpoint */
181 struct usb_endpoint_descriptor *ep_in;
182 /* the buffer to receive data */
183 unsigned char *bulk_in_buf;
184 /* urb used to read ir data */
185 struct urb *read_urb;
187 /* the send endpoint */
188 struct usb_endpoint_descriptor *ep_out;
189 /* the buffer to send data */
190 unsigned char *bulk_out_buf;
191 /* the urb used to send data */
192 struct urb *write_urb;
198 /* locks this structure */
201 /* rx signal timeout timer */
202 struct timer_list rx_timeout;
205 /* is the detector enabled*/
207 /* Is the device currently transmitting?*/
210 /* store for current packet */
211 char pbuf[RR3_MAX_BUF_SIZE];
215 /* indicate whether we are going to reprocess
216 * the USB callback with a bigger buffer */
226 /* All incoming data buffers adhere to a very specific data format */
227 struct redrat3_signal_header {
228 u16 length; /* Length of data being transferred */
229 u16 transfer_type; /* Type of data transferred */
230 u32 pause; /* Pause between main and repeat signals */
231 u16 mod_freq_count; /* Value of timer on mod. freq. measurement */
232 u16 no_periods; /* No. of periods over which mod. freq. is measured */
233 u8 max_lengths; /* Max no. of lengths (i.e. size of array) */
234 u8 no_lengths; /* Actual no. of elements in lengths array */
235 u16 max_sig_size; /* Max no. of values in signal data array */
236 u16 sig_size; /* Acuto no. of values in signal data array */
237 u8 no_repeats; /* No. of repeats of repeat signal section */
238 /* Here forward is the lengths and signal data */
241 static void redrat3_dump_signal_header(struct redrat3_signal_header *header)
243 pr_info("%s:\n", __func__);
244 pr_info(" * length: %u, transfer_type: 0x%02x\n",
245 header->length, header->transfer_type);
246 pr_info(" * pause: %u, freq_count: %u, no_periods: %u\n",
247 header->pause, header->mod_freq_count, header->no_periods);
248 pr_info(" * lengths: %u (max: %u)\n",
249 header->no_lengths, header->max_lengths);
250 pr_info(" * sig_size: %u (max: %u)\n",
251 header->sig_size, header->max_sig_size);
252 pr_info(" * repeats: %u\n", header->no_repeats);
255 static void redrat3_dump_signal_data(char *buffer, u16 len)
260 pr_info("%s:", __func__);
262 offset = RR3_TX_HEADER_OFFSET + RR3_HEADER_LENGTH
263 + (RR3_DRIVER_MAXLENS * sizeof(u16));
265 /* read RR3_DRIVER_MAXLENS from ctrl msg */
266 data_vals = buffer + offset;
268 for (i = 0; i < len; i++) {
271 pr_cont("%02x ", *data_vals++);
278 * redrat3_issue_async
280 * Issues an async read to the ir data in port..
281 * sets the callback to be redrat3_handle_async
283 static void redrat3_issue_async(struct redrat3_dev *rr3)
287 rr3_ftr(rr3->dev, "Entering %s\n", __func__);
289 memset(rr3->bulk_in_buf, 0, rr3->ep_in->wMaxPacketSize);
290 res = usb_submit_urb(rr3->read_urb, GFP_ATOMIC);
292 rr3_dbg(rr3->dev, "%s: receive request FAILED! "
293 "(res %d, len %d)\n", __func__, res,
294 rr3->read_urb->transfer_buffer_length);
297 static void redrat3_dump_fw_error(struct redrat3_dev *rr3, int code)
299 if (!rr3->transmitting && (code != 0x40))
300 dev_info(rr3->dev, "fw error code 0x%02x: ", code);
304 pr_cont("No Error\n");
307 /* Codes 0x20 through 0x2f are IR Firmware Errors */
309 pr_cont("Initial signal pulse not long enough "
310 "to measure carrier frequency\n");
313 pr_cont("Not enough length values allocated for signal\n");
316 pr_cont("Not enough memory allocated for signal data\n");
319 pr_cont("Too many signal repeats\n");
322 pr_cont("Insufficient memory available for IR signal "
323 "data memory allocation\n");
326 pr_cont("Insufficient memory available "
327 "for IrDa signal data memory allocation\n");
330 /* Codes 0x30 through 0x3f are USB Firmware Errors */
332 pr_cont("Insufficient memory available for bulk "
333 "transfer structure\n");
337 * Other error codes... These are primarily errors that can occur in
338 * the control messages sent to the redrat
341 if (!rr3->transmitting)
342 pr_cont("Signal capture has been terminated\n");
345 pr_cont("Attempt to set/get and unknown signal I/O "
346 "algorithm parameter\n");
349 pr_cont("Signal capture already started\n");
353 pr_cont("Unknown Error\n");
358 static u32 redrat3_val_to_mod_freq(struct redrat3_signal_header *ph)
362 if (ph->mod_freq_count != 0)
363 mod_freq = (RR3_CLK * ph->no_periods) /
364 (ph->mod_freq_count * RR3_CLK_PER_COUNT);
369 /* this function scales down the figures for the same result... */
370 static u32 redrat3_len_to_us(u32 length)
372 u32 biglen = length * 1000;
373 u32 divisor = (RR3_CLK_CONV_FACTOR) / 1000;
374 u32 result = (u32) (biglen / divisor);
376 /* don't allow zero lengths to go back, breaks lirc */
377 return result ? result : 1;
381 * convert us back into redrat3 lengths
383 * length * 1000 length * 1000000
384 * ------------- = ---------------- = micro
385 * rr3clk / 1000 rr3clk
387 * 6 * 2 4 * 3 micro * rr3clk micro * rr3clk / 1000
388 * ----- = 4 ----- = 6 -------------- = len ---------------------
391 static u32 redrat3_us_to_len(u32 microsec)
396 microsec &= IR_MAX_DURATION;
397 divisor = (RR3_CLK_CONV_FACTOR / 1000);
398 result = (u32)(microsec * divisor) / 1000;
400 /* don't allow zero lengths to go back, breaks lirc */
401 return result ? result : 1;
405 /* timer callback to send reset event */
406 static void redrat3_rx_timeout(unsigned long data)
408 struct redrat3_dev *rr3 = (struct redrat3_dev *)data;
410 rr3_dbg(rr3->dev, "calling ir_raw_event_reset\n");
411 ir_raw_event_reset(rr3->rc);
414 static void redrat3_process_ir_data(struct redrat3_dev *rr3)
416 DEFINE_IR_RAW_EVENT(rawir);
417 struct redrat3_signal_header header;
421 u32 mod_freq, single_len;
429 pr_err("%s called with no context!\n", __func__);
433 rr3_ftr(rr3->dev, "Entered %s\n", __func__);
436 sig_data = rr3->pbuf;
438 header.length = rr3->pktlen;
439 header.transfer_type = rr3->pkttype;
442 if (!(header.length >= RR3_HEADER_LENGTH))
443 dev_warn(dev, "read returned less than rr3 header len\n");
445 /* Make sure we reset the IR kfifo after a bit of inactivity */
446 delay = usecs_to_jiffies(rr3->hw_timeout);
447 mod_timer(&rr3->rx_timeout, jiffies + delay);
449 memcpy(&tmp32, sig_data + RR3_PAUSE_OFFSET, sizeof(tmp32));
450 header.pause = be32_to_cpu(tmp32);
452 memcpy(&tmp16, sig_data + RR3_FREQ_COUNT_OFFSET, sizeof(tmp16));
453 header.mod_freq_count = be16_to_cpu(tmp16);
455 memcpy(&tmp16, sig_data + RR3_NUM_PERIOD_OFFSET, sizeof(tmp16));
456 header.no_periods = be16_to_cpu(tmp16);
458 header.max_lengths = sig_data[RR3_MAX_LENGTHS_OFFSET];
459 header.no_lengths = sig_data[RR3_NUM_LENGTHS_OFFSET];
461 memcpy(&tmp16, sig_data + RR3_MAX_SIGS_OFFSET, sizeof(tmp16));
462 header.max_sig_size = be16_to_cpu(tmp16);
464 memcpy(&tmp16, sig_data + RR3_NUM_SIGS_OFFSET, sizeof(tmp16));
465 header.sig_size = be16_to_cpu(tmp16);
467 header.no_repeats= sig_data[RR3_REPEATS_OFFSET];
470 redrat3_dump_signal_header(&header);
471 redrat3_dump_signal_data(sig_data, header.sig_size);
474 mod_freq = redrat3_val_to_mod_freq(&header);
475 rr3_dbg(dev, "Got mod_freq of %u\n", mod_freq);
477 /* Here we pull out the 'length' values from the signal */
478 len_vals = (u16 *)(sig_data + RR3_HEADER_LENGTH);
480 data_vals = sig_data + RR3_HEADER_LENGTH +
481 (header.max_lengths * sizeof(u16));
483 /* process each rr3 encoded byte into an int */
484 for (i = 0; i < header.sig_size; i++) {
485 u16 val = len_vals[data_vals[i]];
486 single_len = redrat3_len_to_us((u32)be16_to_cpu(val));
488 /* we should always get pulse/space/pulse/space samples */
494 rawir.duration = US_TO_NS(single_len);
495 /* Save initial pulse length to fudge trailer */
497 trailer = rawir.duration;
498 /* cap the value to IR_MAX_DURATION */
499 rawir.duration &= IR_MAX_DURATION;
501 rr3_dbg(dev, "storing %s with duration %d (i: %d)\n",
502 rawir.pulse ? "pulse" : "space", rawir.duration, i);
503 ir_raw_event_store_with_filter(rr3->rc, &rawir);
506 /* add a trailing space, if need be */
509 /* this duration is made up, and may not be ideal... */
510 if (trailer < US_TO_NS(1000))
511 rawir.duration = US_TO_NS(2800);
513 rawir.duration = trailer;
514 rr3_dbg(dev, "storing trailing space with duration %d\n",
516 ir_raw_event_store_with_filter(rr3->rc, &rawir);
519 rr3_dbg(dev, "calling ir_raw_event_handle\n");
520 ir_raw_event_handle(rr3->rc);
525 /* Util fn to send rr3 cmds */
526 static u8 redrat3_send_cmd(int cmd, struct redrat3_dev *rr3)
528 struct usb_device *udev;
532 data = kzalloc(sizeof(u8), GFP_KERNEL);
537 res = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), cmd,
538 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
539 0x0000, 0x0000, data, sizeof(u8), HZ * 10);
542 dev_err(rr3->dev, "%s: Error sending rr3 cmd res %d, data %d",
543 __func__, res, *data);
553 /* Enables the long range detector and starts async receive */
554 static int redrat3_enable_detector(struct redrat3_dev *rr3)
556 struct device *dev = rr3->dev;
559 rr3_ftr(dev, "Entering %s\n", __func__);
561 ret = redrat3_send_cmd(RR3_RC_DET_ENABLE, rr3);
563 dev_dbg(dev, "%s: unexpected ret of %d\n",
566 ret = redrat3_send_cmd(RR3_RC_DET_STATUS, rr3);
568 dev_err(dev, "%s: detector status: %d, should be 1\n",
573 rr3->det_enabled = true;
574 redrat3_issue_async(rr3);
579 /* Disables the rr3 long range detector */
580 static void redrat3_disable_detector(struct redrat3_dev *rr3)
582 struct device *dev = rr3->dev;
585 rr3_ftr(dev, "Entering %s\n", __func__);
587 ret = redrat3_send_cmd(RR3_RC_DET_DISABLE, rr3);
589 dev_err(dev, "%s: failure!\n", __func__);
591 ret = redrat3_send_cmd(RR3_RC_DET_STATUS, rr3);
593 dev_warn(dev, "%s: detector status: %d, should be 0\n",
596 rr3->det_enabled = false;
599 static inline void redrat3_delete(struct redrat3_dev *rr3,
600 struct usb_device *udev)
602 rr3_ftr(rr3->dev, "%s cleaning up\n", __func__);
603 usb_kill_urb(rr3->read_urb);
604 usb_kill_urb(rr3->write_urb);
606 usb_free_urb(rr3->read_urb);
607 usb_free_urb(rr3->write_urb);
609 usb_free_coherent(udev, rr3->ep_in->wMaxPacketSize,
610 rr3->bulk_in_buf, rr3->dma_in);
611 usb_free_coherent(udev, rr3->ep_out->wMaxPacketSize,
612 rr3->bulk_out_buf, rr3->dma_out);
617 static u32 redrat3_get_timeout(struct redrat3_dev *rr3)
620 u32 timeout = MS_TO_US(150); /* a sane default, if things go haywire */
624 tmp = kzalloc(len, GFP_KERNEL);
626 dev_warn(rr3->dev, "Memory allocation faillure\n");
630 pipe = usb_rcvctrlpipe(rr3->udev, 0);
631 ret = usb_control_msg(rr3->udev, pipe, RR3_GET_IR_PARAM,
632 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
633 RR3_IR_IO_SIG_TIMEOUT, 0, tmp, len, HZ * 5);
635 dev_warn(rr3->dev, "Failed to read timeout from hardware\n");
639 timeout = redrat3_len_to_us(be32_to_cpu(*tmp));
641 rr3_dbg(rr3->dev, "Got timeout of %d ms\n", timeout / 1000);
645 static void redrat3_reset(struct redrat3_dev *rr3)
647 struct usb_device *udev = rr3->udev;
648 struct device *dev = rr3->dev;
649 int rc, rxpipe, txpipe;
651 int len = sizeof(u8);
653 rr3_ftr(dev, "Entering %s\n", __func__);
655 rxpipe = usb_rcvctrlpipe(udev, 0);
656 txpipe = usb_sndctrlpipe(udev, 0);
658 val = kzalloc(len, GFP_KERNEL);
660 dev_err(dev, "Memory allocation failure\n");
665 rc = usb_control_msg(udev, rxpipe, RR3_RESET,
666 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
667 RR3_CPUCS_REG_ADDR, 0, val, len, HZ * 25);
668 rr3_dbg(dev, "reset returned 0x%02x\n", rc);
671 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,
672 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
673 RR3_IR_IO_LENGTH_FUZZ, 0, val, len, HZ * 25);
674 rr3_dbg(dev, "set ir parm len fuzz %d rc 0x%02x\n", *val, rc);
676 *val = RR3_DRIVER_MAXLENS;
677 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,
678 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
679 RR3_IR_IO_MAX_LENGTHS, 0, val, len, HZ * 25);
680 rr3_dbg(dev, "set ir parm max lens %d rc 0x%02x\n", *val, rc);
685 static void redrat3_get_firmware_rev(struct redrat3_dev *rr3)
690 rr3_ftr(rr3->dev, "Entering %s\n", __func__);
692 buffer = kzalloc(sizeof(char) * (RR3_FW_VERSION_LEN + 1), GFP_KERNEL);
694 dev_err(rr3->dev, "Memory allocation failure\n");
698 rc = usb_control_msg(rr3->udev, usb_rcvctrlpipe(rr3->udev, 0),
700 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
701 0, 0, buffer, RR3_FW_VERSION_LEN, HZ * 5);
704 dev_info(rr3->dev, "Firmware rev: %s", buffer);
706 dev_err(rr3->dev, "Problem fetching firmware ID\n");
709 rr3_ftr(rr3->dev, "Exiting %s\n", __func__);
712 static void redrat3_read_packet_start(struct redrat3_dev *rr3, int len)
717 rr3_ftr(rr3->dev, "Entering %s\n", __func__);
719 /* grab the Length and type of transfer */
720 memcpy(&(rr3->pktlen), (unsigned char *) rr3->bulk_in_buf,
721 sizeof(rr3->pktlen));
722 memcpy(&(rr3->pkttype), ((unsigned char *) rr3->bulk_in_buf +
723 sizeof(rr3->pktlen)),
724 sizeof(rr3->pkttype));
726 /*data needs conversion to know what its real values are*/
727 rr3->pktlen = be16_to_cpu(rr3->pktlen);
728 rr3->pkttype = be16_to_cpu(rr3->pkttype);
730 switch (rr3->pkttype) {
732 memcpy(&tx_error, ((unsigned char *)rr3->bulk_in_buf
733 + (sizeof(rr3->pktlen) + sizeof(rr3->pkttype))),
735 tx_error = be16_to_cpu(tx_error);
736 redrat3_dump_fw_error(rr3, tx_error);
739 case RR3_MOD_SIGNAL_IN:
740 hdrlen = sizeof(rr3->pktlen) + sizeof(rr3->pkttype);
741 rr3->bytes_read = len;
742 rr3->bytes_read -= hdrlen;
743 rr3->datap = &(rr3->pbuf[0]);
745 memcpy(rr3->datap, ((unsigned char *)rr3->bulk_in_buf + hdrlen),
747 rr3->datap += rr3->bytes_read;
748 rr3_dbg(rr3->dev, "bytes_read %d, pktlen %d\n",
749 rr3->bytes_read, rr3->pktlen);
753 rr3_dbg(rr3->dev, "ignoring packet with type 0x%02x, "
754 "len of %d, 0x%02x\n", rr3->pkttype, len, rr3->pktlen);
759 static void redrat3_read_packet_continue(struct redrat3_dev *rr3, int len)
762 rr3_ftr(rr3->dev, "Entering %s\n", __func__);
764 memcpy(rr3->datap, (unsigned char *)rr3->bulk_in_buf, len);
767 rr3->bytes_read += len;
768 rr3_dbg(rr3->dev, "bytes_read %d, pktlen %d\n",
769 rr3->bytes_read, rr3->pktlen);
772 /* gather IR data from incoming urb, process it when we have enough */
773 static int redrat3_get_ir_data(struct redrat3_dev *rr3, int len)
775 struct device *dev = rr3->dev;
778 rr3_ftr(dev, "Entering %s\n", __func__);
780 if (rr3->pktlen > RR3_MAX_BUF_SIZE) {
781 dev_err(rr3->dev, "error: packet larger than buffer\n");
786 if ((rr3->bytes_read == 0) &&
787 (len >= (sizeof(rr3->pkttype) + sizeof(rr3->pktlen)))) {
788 redrat3_read_packet_start(rr3, len);
789 } else if (rr3->bytes_read != 0) {
790 redrat3_read_packet_continue(rr3, len);
791 } else if (rr3->bytes_read == 0) {
792 dev_err(dev, "error: no packet data read\n");
797 if (rr3->bytes_read > rr3->pktlen) {
798 dev_err(dev, "bytes_read (%d) greater than pktlen (%d)\n",
799 rr3->bytes_read, rr3->pktlen);
802 } else if (rr3->bytes_read < rr3->pktlen)
803 /* we're still accumulating data */
806 /* if we get here, we've got IR data to decode */
807 if (rr3->pkttype == RR3_MOD_SIGNAL_IN)
808 redrat3_process_ir_data(rr3);
810 rr3_dbg(dev, "discarding non-signal data packet "
811 "(type 0x%02x)\n", rr3->pkttype);
820 /* callback function from USB when async USB request has completed */
821 static void redrat3_handle_async(struct urb *urb, struct pt_regs *regs)
823 struct redrat3_dev *rr3;
831 pr_err("%s called with invalid context!\n", __func__);
836 rr3_ftr(rr3->dev, "Entering %s\n", __func__);
838 switch (urb->status) {
840 ret = redrat3_get_ir_data(rr3, urb->actual_length);
842 /* no error, prepare to read more */
843 redrat3_issue_async(rr3);
855 dev_warn(rr3->dev, "Error: urb status = %d\n", urb->status);
863 static void redrat3_write_bulk_callback(struct urb *urb, struct pt_regs *regs)
865 struct redrat3_dev *rr3;
873 len = urb->actual_length;
874 rr3_ftr(rr3->dev, "%s: called (status=%d len=%d)\n",
875 __func__, urb->status, len);
879 static u16 mod_freq_to_val(unsigned int mod_freq)
883 /* Clk used in mod. freq. generation is CLK24/4. */
884 return (u16)(65536 - (mult / mod_freq));
887 static int redrat3_set_tx_carrier(struct rc_dev *rcdev, u32 carrier)
889 struct redrat3_dev *rr3 = rcdev->priv;
890 struct device *dev = rr3->dev;
892 rr3_dbg(dev, "Setting modulation frequency to %u", carrier);
896 rr3->carrier = carrier;
901 static int redrat3_transmit_ir(struct rc_dev *rcdev, unsigned *txbuf,
904 struct redrat3_dev *rr3 = rcdev->priv;
905 struct device *dev = rr3->dev;
906 struct redrat3_signal_header header;
907 int i, j, ret, ret_len, offset;
908 int lencheck, cur_sample_len, pipe;
909 char *buffer = NULL, *sigdata = NULL;
910 int *sample_lens = NULL;
918 rr3_ftr(dev, "Entering %s\n", __func__);
920 if (rr3->transmitting) {
921 dev_warn(dev, "%s: transmitter already in use\n", __func__);
925 if (count > (RR3_DRIVER_MAXLENS * 2))
928 /* rr3 will disable rc detector on transmit */
929 rr3->det_enabled = false;
930 rr3->transmitting = true;
932 sample_lens = kzalloc(sizeof(int) * RR3_DRIVER_MAXLENS, GFP_KERNEL);
938 for (i = 0; i < count; i++) {
939 for (lencheck = 0; lencheck < curlencheck; lencheck++) {
940 cur_sample_len = redrat3_us_to_len(txbuf[i]);
941 if (sample_lens[lencheck] == cur_sample_len)
944 if (lencheck == curlencheck) {
945 cur_sample_len = redrat3_us_to_len(txbuf[i]);
946 rr3_dbg(dev, "txbuf[%d]=%u, pos %d, enc %u\n",
947 i, txbuf[i], curlencheck, cur_sample_len);
948 if (curlencheck < 255) {
949 /* now convert the value to a proper
951 sample_lens[curlencheck] = cur_sample_len;
954 dev_err(dev, "signal too long\n");
961 sigdata = kzalloc((count + RR3_TX_TRAILER_LEN), GFP_KERNEL);
967 sigdata[count] = RR3_END_OF_SIGNAL;
968 sigdata[count + 1] = RR3_END_OF_SIGNAL;
969 for (i = 0; i < count; i++) {
970 for (j = 0; j < curlencheck; j++) {
971 if (sample_lens[j] == redrat3_us_to_len(txbuf[i]))
976 offset = RR3_TX_HEADER_OFFSET;
977 sendbuf_len = RR3_HEADER_LENGTH + (sizeof(u16) * RR3_DRIVER_MAXLENS)
978 + count + RR3_TX_TRAILER_LEN + offset;
980 buffer = kzalloc(sendbuf_len, GFP_KERNEL);
986 /* fill in our packet header */
987 header.length = sendbuf_len - offset;
988 header.transfer_type = RR3_MOD_SIGNAL_OUT;
989 header.pause = redrat3_len_to_us(100);
990 header.mod_freq_count = mod_freq_to_val(rr3->carrier);
991 header.no_periods = 0; /* n/a to transmit */
992 header.max_lengths = RR3_DRIVER_MAXLENS;
993 header.no_lengths = curlencheck;
994 header.max_sig_size = RR3_MAX_SIG_SIZE;
995 header.sig_size = count + RR3_TX_TRAILER_LEN;
996 /* we currently rely on repeat handling in the IR encoding source */
997 header.no_repeats = 0;
999 tmps = cpu_to_be16(header.length);
1000 memcpy(buffer, &tmps, 2);
1002 tmps = cpu_to_be16(header.transfer_type);
1003 memcpy(buffer + 2, &tmps, 2);
1005 tmpi = cpu_to_be32(header.pause);
1006 memcpy(buffer + offset, &tmpi, sizeof(tmpi));
1008 tmps = cpu_to_be16(header.mod_freq_count);
1009 memcpy(buffer + offset + RR3_FREQ_COUNT_OFFSET, &tmps, 2);
1011 buffer[offset + RR3_NUM_LENGTHS_OFFSET] = header.no_lengths;
1013 tmps = cpu_to_be16(header.sig_size);
1014 memcpy(buffer + offset + RR3_NUM_SIGS_OFFSET, &tmps, 2);
1016 buffer[offset + RR3_REPEATS_OFFSET] = header.no_repeats;
1018 lengths_ptr = (u16 *)(buffer + offset + RR3_HEADER_LENGTH);
1019 for (i = 0; i < curlencheck; ++i)
1020 lengths_ptr[i] = cpu_to_be16(sample_lens[i]);
1022 datap = (u8 *)(buffer + offset + RR3_HEADER_LENGTH +
1023 (sizeof(u16) * RR3_DRIVER_MAXLENS));
1024 memcpy(datap, sigdata, (count + RR3_TX_TRAILER_LEN));
1027 redrat3_dump_signal_header(&header);
1028 redrat3_dump_signal_data(buffer, header.sig_size);
1031 pipe = usb_sndbulkpipe(rr3->udev, rr3->ep_out->bEndpointAddress);
1032 tmps = usb_bulk_msg(rr3->udev, pipe, buffer,
1033 sendbuf_len, &ret_len, 10 * HZ);
1034 rr3_dbg(dev, "sent %d bytes, (ret %d)\n", ret_len, tmps);
1036 /* now tell the hardware to transmit what we sent it */
1037 pipe = usb_rcvctrlpipe(rr3->udev, 0);
1038 ret = usb_control_msg(rr3->udev, pipe, RR3_TX_SEND_SIGNAL,
1039 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
1040 0, 0, buffer, 2, HZ * 10);
1043 dev_err(dev, "Error: control msg send failed, rc %d\n", ret);
1052 rr3->transmitting = false;
1053 /* rr3 re-enables rc detector because it was enabled before */
1054 rr3->det_enabled = true;
1059 static struct rc_dev *redrat3_init_rc_dev(struct redrat3_dev *rr3)
1061 struct device *dev = rr3->dev;
1064 u16 prod = le16_to_cpu(rr3->udev->descriptor.idProduct);
1066 rc = rc_allocate_device();
1068 dev_err(dev, "remote input dev allocation failed\n");
1072 snprintf(rr3->name, sizeof(rr3->name), "RedRat3%s "
1073 "Infrared Remote Transceiver (%04x:%04x)",
1074 prod == USB_RR3IIUSB_PRODUCT_ID ? "-II" : "",
1075 le16_to_cpu(rr3->udev->descriptor.idVendor), prod);
1077 usb_make_path(rr3->udev, rr3->phys, sizeof(rr3->phys));
1079 rc->input_name = rr3->name;
1080 rc->input_phys = rr3->phys;
1081 usb_to_input_id(rr3->udev, &rc->input_id);
1082 rc->dev.parent = dev;
1084 rc->driver_type = RC_DRIVER_IR_RAW;
1085 rc->allowed_protos = RC_BIT_ALL;
1086 rc->timeout = US_TO_NS(2750);
1087 rc->tx_ir = redrat3_transmit_ir;
1088 rc->s_tx_carrier = redrat3_set_tx_carrier;
1089 rc->driver_name = DRIVER_NAME;
1090 rc->map_name = RC_MAP_HAUPPAUGE;
1092 ret = rc_register_device(rc);
1094 dev_err(dev, "remote dev registration failed\n");
1105 static int __devinit redrat3_dev_probe(struct usb_interface *intf,
1106 const struct usb_device_id *id)
1108 struct usb_device *udev = interface_to_usbdev(intf);
1109 struct device *dev = &intf->dev;
1110 struct usb_host_interface *uhi;
1111 struct redrat3_dev *rr3;
1112 struct usb_endpoint_descriptor *ep;
1113 struct usb_endpoint_descriptor *ep_in = NULL;
1114 struct usb_endpoint_descriptor *ep_out = NULL;
1117 int retval = -ENOMEM;
1119 rr3_ftr(dev, "%s called\n", __func__);
1121 uhi = intf->cur_altsetting;
1123 /* find our bulk-in and bulk-out endpoints */
1124 for (i = 0; i < uhi->desc.bNumEndpoints; ++i) {
1125 ep = &uhi->endpoint[i].desc;
1126 addr = ep->bEndpointAddress;
1127 attrs = ep->bmAttributes;
1129 if ((ep_in == NULL) &&
1130 ((addr & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&
1131 ((attrs & USB_ENDPOINT_XFERTYPE_MASK) ==
1132 USB_ENDPOINT_XFER_BULK)) {
1133 rr3_dbg(dev, "found bulk-in endpoint at 0x%02x\n",
1134 ep->bEndpointAddress);
1135 /* data comes in on 0x82, 0x81 is for other data... */
1136 if (ep->bEndpointAddress == RR3_BULK_IN_EP_ADDR)
1140 if ((ep_out == NULL) &&
1141 ((addr & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&
1142 ((attrs & USB_ENDPOINT_XFERTYPE_MASK) ==
1143 USB_ENDPOINT_XFER_BULK)) {
1144 rr3_dbg(dev, "found bulk-out endpoint at 0x%02x\n",
1145 ep->bEndpointAddress);
1150 if (!ep_in || !ep_out) {
1151 dev_err(dev, "Couldn't find both in and out endpoints\n");
1156 /* allocate memory for our device state and initialize it */
1157 rr3 = kzalloc(sizeof(*rr3), GFP_KERNEL);
1159 dev_err(dev, "Memory allocation failure\n");
1163 rr3->dev = &intf->dev;
1165 /* set up bulk-in endpoint */
1166 rr3->read_urb = usb_alloc_urb(0, GFP_KERNEL);
1167 if (!rr3->read_urb) {
1168 dev_err(dev, "Read urb allocation failure\n");
1173 rr3->bulk_in_buf = usb_alloc_coherent(udev, ep_in->wMaxPacketSize,
1174 GFP_ATOMIC, &rr3->dma_in);
1175 if (!rr3->bulk_in_buf) {
1176 dev_err(dev, "Read buffer allocation failure\n");
1180 pipe = usb_rcvbulkpipe(udev, ep_in->bEndpointAddress);
1181 usb_fill_bulk_urb(rr3->read_urb, udev, pipe,
1182 rr3->bulk_in_buf, ep_in->wMaxPacketSize,
1183 (usb_complete_t)redrat3_handle_async, rr3);
1185 /* set up bulk-out endpoint*/
1186 rr3->write_urb = usb_alloc_urb(0, GFP_KERNEL);
1187 if (!rr3->write_urb) {
1188 dev_err(dev, "Write urb allocation failure\n");
1192 rr3->ep_out = ep_out;
1193 rr3->bulk_out_buf = usb_alloc_coherent(udev, ep_out->wMaxPacketSize,
1194 GFP_ATOMIC, &rr3->dma_out);
1195 if (!rr3->bulk_out_buf) {
1196 dev_err(dev, "Write buffer allocation failure\n");
1200 pipe = usb_sndbulkpipe(udev, ep_out->bEndpointAddress);
1201 usb_fill_bulk_urb(rr3->write_urb, udev, pipe,
1202 rr3->bulk_out_buf, ep_out->wMaxPacketSize,
1203 (usb_complete_t)redrat3_write_bulk_callback, rr3);
1205 mutex_init(&rr3->lock);
1209 redrat3_get_firmware_rev(rr3);
1211 /* might be all we need to do? */
1212 retval = redrat3_enable_detector(rr3);
1216 /* store current hardware timeout, in us, will use for kfifo resets */
1217 rr3->hw_timeout = redrat3_get_timeout(rr3);
1219 /* default.. will get overridden by any sends with a freq defined */
1220 rr3->carrier = 38000;
1222 rr3->rc = redrat3_init_rc_dev(rr3);
1227 setup_timer(&rr3->rx_timeout, redrat3_rx_timeout, (unsigned long)rr3);
1229 /* we can register the device now, as it is ready */
1230 usb_set_intfdata(intf, rr3);
1232 rr3_ftr(dev, "Exiting %s\n", __func__);
1236 redrat3_delete(rr3, rr3->udev);
1239 dev_err(dev, "%s: retval = %x", __func__, retval);
1244 static void __devexit redrat3_dev_disconnect(struct usb_interface *intf)
1246 struct usb_device *udev = interface_to_usbdev(intf);
1247 struct redrat3_dev *rr3 = usb_get_intfdata(intf);
1249 rr3_ftr(&intf->dev, "Entering %s\n", __func__);
1254 redrat3_disable_detector(rr3);
1256 usb_set_intfdata(intf, NULL);
1257 rc_unregister_device(rr3->rc);
1258 del_timer_sync(&rr3->rx_timeout);
1259 redrat3_delete(rr3, udev);
1261 rr3_ftr(&intf->dev, "RedRat3 IR Transceiver now disconnected\n");
1264 static int redrat3_dev_suspend(struct usb_interface *intf, pm_message_t message)
1266 struct redrat3_dev *rr3 = usb_get_intfdata(intf);
1267 rr3_ftr(rr3->dev, "suspend\n");
1268 usb_kill_urb(rr3->read_urb);
1272 static int redrat3_dev_resume(struct usb_interface *intf)
1274 struct redrat3_dev *rr3 = usb_get_intfdata(intf);
1275 rr3_ftr(rr3->dev, "resume\n");
1276 if (usb_submit_urb(rr3->read_urb, GFP_ATOMIC))
1281 static struct usb_driver redrat3_dev_driver = {
1282 .name = DRIVER_NAME,
1283 .probe = redrat3_dev_probe,
1284 .disconnect = __devexit_p(redrat3_dev_disconnect),
1285 .suspend = redrat3_dev_suspend,
1286 .resume = redrat3_dev_resume,
1287 .reset_resume = redrat3_dev_resume,
1288 .id_table = redrat3_dev_table
1291 module_usb_driver(redrat3_dev_driver);
1293 MODULE_DESCRIPTION(DRIVER_DESC);
1294 MODULE_AUTHOR(DRIVER_AUTHOR);
1295 MODULE_AUTHOR(DRIVER_AUTHOR2);
1296 MODULE_LICENSE("GPL");
1297 MODULE_DEVICE_TABLE(usb, redrat3_dev_table);
1299 module_param(debug, int, S_IRUGO | S_IWUSR);
1300 MODULE_PARM_DESC(debug, "Enable module debug spew. 0 = no debugging (default) "
1301 "0x1 = standard debug messages, 0x2 = function tracing debug. "
1302 "Flag bits are addative (i.e., 0x3 for both debug types).");