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 <asm/unaligned.h>
49 #include <linux/device.h>
50 #include <linux/leds.h>
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>
57 /* Driver Information */
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"
63 /* bulk data transfer types */
64 #define RR3_ERROR 0x01
65 #define RR3_MOD_SIGNAL_IN 0x20
66 #define RR3_MOD_SIGNAL_OUT 0x21
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
87 #define RR3_RESET 0xa0
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
99 /* Minimum value for pause recognition. */
100 #define RR3_IR_IO_MIN_PAUSE 0x06
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
111 /* Size of the fixed-length portion of the signal */
112 #define RR3_DRIVER_MAXLENS 128
113 #define RR3_MAX_SIG_SIZE 512
114 #define RR3_TIME_UNIT 50
115 #define RR3_END_OF_SIGNAL 0x7f
116 #define RR3_TX_TRAILER_LEN 2
117 #define RR3_RX_MIN_TIMEOUT 5
118 #define RR3_RX_MAX_TIMEOUT 2000
120 /* The 8051's CPUCS Register address */
121 #define RR3_CPUCS_REG_ADDR 0x7f92
123 #define USB_RR3USB_VENDOR_ID 0x112a
124 #define USB_RR3USB_PRODUCT_ID 0x0001
125 #define USB_RR3IIUSB_PRODUCT_ID 0x0005
127 struct redrat3_header
{
129 __be16 transfer_type
;
132 /* sending and receiving irdata */
133 struct redrat3_irdata
{
134 struct redrat3_header header
;
136 __be16 mod_freq_count
;
143 __be16 lens
[RR3_DRIVER_MAXLENS
]; /* not aligned */
144 __u8 sigdata
[RR3_MAX_SIG_SIZE
];
147 /* firmware errors */
148 struct redrat3_error
{
149 struct redrat3_header header
;
153 /* table of devices that work with this driver */
154 static 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 */
162 /* Structure to hold all of our device specific stuff */
164 /* core device bits */
169 struct led_classdev led
;
171 struct usb_ctrlrequest flash_control
;
172 struct urb
*flash_urb
;
175 /* save off the usb device pointer */
176 struct usb_device
*udev
;
178 /* the receive endpoint */
179 struct usb_endpoint_descriptor
*ep_in
;
180 /* the buffer to receive data */
182 /* urb used to read ir data */
183 struct urb
*read_urb
;
185 /* the send endpoint */
186 struct usb_endpoint_descriptor
*ep_out
;
191 /* rx signal timeout timer */
192 struct timer_list rx_timeout
;
195 /* Is the device currently transmitting?*/
198 /* store for current packet */
199 struct redrat3_irdata irdata
;
209 * redrat3_issue_async
211 * Issues an async read to the ir data in port..
212 * sets the callback to be redrat3_handle_async
214 static void redrat3_issue_async(struct redrat3_dev
*rr3
)
218 res
= usb_submit_urb(rr3
->read_urb
, GFP_ATOMIC
);
221 "%s: receive request FAILED! (res %d, len %d)\n",
222 __func__
, res
, rr3
->read_urb
->transfer_buffer_length
);
225 static void redrat3_dump_fw_error(struct redrat3_dev
*rr3
, int code
)
227 if (!rr3
->transmitting
&& (code
!= 0x40))
228 dev_info(rr3
->dev
, "fw error code 0x%02x: ", code
);
232 pr_cont("No Error\n");
235 /* Codes 0x20 through 0x2f are IR Firmware Errors */
237 pr_cont("Initial signal pulse not long enough "
238 "to measure carrier frequency\n");
241 pr_cont("Not enough length values allocated for signal\n");
244 pr_cont("Not enough memory allocated for signal data\n");
247 pr_cont("Too many signal repeats\n");
250 pr_cont("Insufficient memory available for IR signal "
251 "data memory allocation\n");
254 pr_cont("Insufficient memory available "
255 "for IrDa signal data memory allocation\n");
258 /* Codes 0x30 through 0x3f are USB Firmware Errors */
260 pr_cont("Insufficient memory available for bulk "
261 "transfer structure\n");
265 * Other error codes... These are primarily errors that can occur in
266 * the control messages sent to the redrat
269 if (!rr3
->transmitting
)
270 pr_cont("Signal capture has been terminated\n");
273 pr_cont("Attempt to set/get and unknown signal I/O "
274 "algorithm parameter\n");
277 pr_cont("Signal capture already started\n");
281 pr_cont("Unknown Error\n");
286 static u32
redrat3_val_to_mod_freq(struct redrat3_irdata
*irdata
)
289 u16 mod_freq_count
= be16_to_cpu(irdata
->mod_freq_count
);
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
);
298 /* this function scales down the figures for the same result... */
299 static u32
redrat3_len_to_us(u32 length
)
301 u32 biglen
= length
* 1000;
302 u32 divisor
= (RR3_CLK_CONV_FACTOR
) / 1000;
303 u32 result
= (u32
) (biglen
/ divisor
);
305 /* don't allow zero lengths to go back, breaks lirc */
306 return result
? result
: 1;
310 * convert us back into redrat3 lengths
312 * length * 1000 length * 1000000
313 * ------------- = ---------------- = micro
314 * rr3clk / 1000 rr3clk
316 * 6 * 2 4 * 3 micro * rr3clk micro * rr3clk / 1000
317 * ----- = 4 ----- = 6 -------------- = len ---------------------
320 static u32
redrat3_us_to_len(u32 microsec
)
325 microsec
&= IR_MAX_DURATION
;
326 divisor
= (RR3_CLK_CONV_FACTOR
/ 1000);
327 result
= (u32
)(microsec
* divisor
) / 1000;
329 /* don't allow zero lengths to go back, breaks lirc */
330 return result
? result
: 1;
333 /* timer callback to send reset event */
334 static void redrat3_rx_timeout(unsigned long data
)
336 struct redrat3_dev
*rr3
= (struct redrat3_dev
*)data
;
338 dev_dbg(rr3
->dev
, "calling ir_raw_event_reset\n");
339 ir_raw_event_reset(rr3
->rc
);
342 static void redrat3_process_ir_data(struct redrat3_dev
*rr3
)
344 DEFINE_IR_RAW_EVENT(rawir
);
346 unsigned i
, trailer
= 0;
347 unsigned sig_size
, single_len
, offset
, val
;
352 pr_err("%s called with no context!\n", __func__
);
358 /* Make sure we reset the IR kfifo after a bit of inactivity */
359 delay
= usecs_to_jiffies(rr3
->hw_timeout
);
360 mod_timer(&rr3
->rx_timeout
, jiffies
+ delay
);
362 mod_freq
= redrat3_val_to_mod_freq(&rr3
->irdata
);
363 dev_dbg(dev
, "Got mod_freq of %u\n", mod_freq
);
365 /* process each rr3 encoded byte into an int */
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
);
372 /* we should always get pulse/space/pulse/space samples */
378 rawir
.duration
= US_TO_NS(single_len
);
379 /* Save initial pulse length to fudge trailer */
381 trailer
= rawir
.duration
;
382 /* cap the value to IR_MAX_DURATION */
383 rawir
.duration
&= IR_MAX_DURATION
;
385 dev_dbg(dev
, "storing %s with duration %d (i: %d)\n",
386 rawir
.pulse
? "pulse" : "space", rawir
.duration
, i
);
387 ir_raw_event_store_with_filter(rr3
->rc
, &rawir
);
390 /* add a trailing space, if need be */
393 /* this duration is made up, and may not be ideal... */
394 if (trailer
< US_TO_NS(1000))
395 rawir
.duration
= US_TO_NS(2800);
397 rawir
.duration
= trailer
;
398 dev_dbg(dev
, "storing trailing space with duration %d\n",
400 ir_raw_event_store_with_filter(rr3
->rc
, &rawir
);
403 dev_dbg(dev
, "calling ir_raw_event_handle\n");
404 ir_raw_event_handle(rr3
->rc
);
407 /* Util fn to send rr3 cmds */
408 static u8
redrat3_send_cmd(int cmd
, struct redrat3_dev
*rr3
)
410 struct usb_device
*udev
;
414 data
= kzalloc(sizeof(u8
), GFP_KERNEL
);
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);
424 dev_err(rr3
->dev
, "%s: Error sending rr3 cmd res %d, data %d",
425 __func__
, res
, *data
);
435 /* Enables the long range detector and starts async receive */
436 static int redrat3_enable_detector(struct redrat3_dev
*rr3
)
438 struct device
*dev
= rr3
->dev
;
441 ret
= redrat3_send_cmd(RR3_RC_DET_ENABLE
, rr3
);
443 dev_dbg(dev
, "%s: unexpected ret of %d\n",
446 ret
= redrat3_send_cmd(RR3_RC_DET_STATUS
, rr3
);
448 dev_err(dev
, "%s: detector status: %d, should be 1\n",
453 redrat3_issue_async(rr3
);
458 static inline void redrat3_delete(struct redrat3_dev
*rr3
,
459 struct usb_device
*udev
)
461 usb_kill_urb(rr3
->read_urb
);
462 usb_kill_urb(rr3
->flash_urb
);
463 usb_free_urb(rr3
->read_urb
);
464 usb_free_urb(rr3
->flash_urb
);
465 usb_free_coherent(udev
, le16_to_cpu(rr3
->ep_in
->wMaxPacketSize
),
466 rr3
->bulk_in_buf
, rr3
->dma_in
);
471 static u32
redrat3_get_timeout(struct redrat3_dev
*rr3
)
474 u32 timeout
= MS_TO_US(150); /* a sane default, if things go haywire */
478 tmp
= kzalloc(len
, GFP_KERNEL
);
480 dev_warn(rr3
->dev
, "Memory allocation faillure\n");
484 pipe
= usb_rcvctrlpipe(rr3
->udev
, 0);
485 ret
= usb_control_msg(rr3
->udev
, pipe
, RR3_GET_IR_PARAM
,
486 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
487 RR3_IR_IO_SIG_TIMEOUT
, 0, tmp
, len
, HZ
* 5);
489 dev_warn(rr3
->dev
, "Failed to read timeout from hardware\n");
491 timeout
= redrat3_len_to_us(be32_to_cpup(tmp
));
493 dev_dbg(rr3
->dev
, "Got timeout of %d ms\n", timeout
/ 1000);
501 static void redrat3_reset(struct redrat3_dev
*rr3
)
503 struct usb_device
*udev
= rr3
->udev
;
504 struct device
*dev
= rr3
->dev
;
505 int rc
, rxpipe
, txpipe
;
507 int len
= sizeof(u8
);
509 rxpipe
= usb_rcvctrlpipe(udev
, 0);
510 txpipe
= usb_sndctrlpipe(udev
, 0);
512 val
= kmalloc(len
, GFP_KERNEL
);
514 dev_err(dev
, "Memory allocation failure\n");
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);
522 dev_dbg(dev
, "reset returned 0x%02x\n", rc
);
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);
528 dev_dbg(dev
, "set ir parm len fuzz %d rc 0x%02x\n", *val
, rc
);
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);
534 dev_dbg(dev
, "set ir parm max lens %d rc 0x%02x\n", *val
, rc
);
539 static void redrat3_get_firmware_rev(struct redrat3_dev
*rr3
)
544 buffer
= kzalloc(sizeof(char) * (RR3_FW_VERSION_LEN
+ 1), GFP_KERNEL
);
546 dev_err(rr3
->dev
, "Memory allocation failure\n");
550 rc
= usb_control_msg(rr3
->udev
, usb_rcvctrlpipe(rr3
->udev
, 0),
552 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
553 0, 0, buffer
, RR3_FW_VERSION_LEN
, HZ
* 5);
556 dev_info(rr3
->dev
, "Firmware rev: %s", buffer
);
558 dev_err(rr3
->dev
, "Problem fetching firmware ID\n");
563 static void redrat3_read_packet_start(struct redrat3_dev
*rr3
, unsigned len
)
565 struct redrat3_header
*header
= rr3
->bulk_in_buf
;
566 unsigned pktlen
, pkttype
;
568 /* grab the Length and type of transfer */
569 pktlen
= be16_to_cpu(header
->length
);
570 pkttype
= be16_to_cpu(header
->transfer_type
);
572 if (pktlen
> sizeof(rr3
->irdata
)) {
573 dev_warn(rr3
->dev
, "packet length %u too large\n", pktlen
);
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
);
586 case RR3_MOD_SIGNAL_IN
:
587 memcpy(&rr3
->irdata
, rr3
->bulk_in_buf
, len
);
588 rr3
->bytes_read
= len
;
589 dev_dbg(rr3
->dev
, "bytes_read %d, pktlen %d\n",
590 rr3
->bytes_read
, pktlen
);
594 dev_dbg(rr3
->dev
, "ignoring packet with type 0x%02x, len of %d, 0x%02x\n",
595 pkttype
, len
, pktlen
);
600 static void redrat3_read_packet_continue(struct redrat3_dev
*rr3
, unsigned len
)
602 void *irdata
= &rr3
->irdata
;
604 if (len
+ rr3
->bytes_read
> sizeof(rr3
->irdata
)) {
605 dev_warn(rr3
->dev
, "too much data for packet\n");
610 memcpy(irdata
+ rr3
->bytes_read
, rr3
->bulk_in_buf
, len
);
612 rr3
->bytes_read
+= len
;
613 dev_dbg(rr3
->dev
, "bytes_read %d, pktlen %d\n", rr3
->bytes_read
,
614 be16_to_cpu(rr3
->irdata
.header
.length
));
617 /* gather IR data from incoming urb, process it when we have enough */
618 static int redrat3_get_ir_data(struct redrat3_dev
*rr3
, unsigned len
)
620 struct device
*dev
= rr3
->dev
;
624 if (rr3
->bytes_read
== 0 && len
>= sizeof(struct redrat3_header
)) {
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");
634 if (rr3
->bytes_read
< be16_to_cpu(rr3
->irdata
.header
.length
) +
635 sizeof(struct redrat3_header
))
636 /* we're still accumulating data */
639 /* if we get here, we've got IR data to decode */
640 pkttype
= be16_to_cpu(rr3
->irdata
.header
.transfer_type
);
641 if (pkttype
== RR3_MOD_SIGNAL_IN
)
642 redrat3_process_ir_data(rr3
);
644 dev_dbg(dev
, "discarding non-signal data packet (type 0x%02x)\n",
652 /* callback function from USB when async USB request has completed */
653 static void redrat3_handle_async(struct urb
*urb
)
655 struct redrat3_dev
*rr3
;
663 pr_err("%s called with invalid context!\n", __func__
);
668 switch (urb
->status
) {
670 ret
= redrat3_get_ir_data(rr3
, urb
->actual_length
);
672 /* no error, prepare to read more */
673 redrat3_issue_async(rr3
);
685 dev_warn(rr3
->dev
, "Error: urb status = %d\n", urb
->status
);
691 static u16
mod_freq_to_val(unsigned int mod_freq
)
695 /* Clk used in mod. freq. generation is CLK24/4. */
696 return 65536 - (mult
/ mod_freq
);
699 static int redrat3_set_tx_carrier(struct rc_dev
*rcdev
, u32 carrier
)
701 struct redrat3_dev
*rr3
= rcdev
->priv
;
702 struct device
*dev
= rr3
->dev
;
704 dev_dbg(dev
, "Setting modulation frequency to %u", carrier
);
708 rr3
->carrier
= carrier
;
713 static int redrat3_transmit_ir(struct rc_dev
*rcdev
, unsigned *txbuf
,
716 struct redrat3_dev
*rr3
= rcdev
->priv
;
717 struct device
*dev
= rr3
->dev
;
718 struct redrat3_irdata
*irdata
= NULL
;
720 int lencheck
, cur_sample_len
, pipe
;
721 int *sample_lens
= NULL
;
723 unsigned i
, sendbuf_len
;
725 if (rr3
->transmitting
) {
726 dev_warn(dev
, "%s: transmitter already in use\n", __func__
);
730 if (count
> RR3_MAX_SIG_SIZE
- RR3_TX_TRAILER_LEN
)
733 /* rr3 will disable rc detector on transmit */
734 rr3
->transmitting
= true;
736 sample_lens
= kzalloc(sizeof(int) * RR3_DRIVER_MAXLENS
, GFP_KERNEL
);
742 irdata
= kzalloc(sizeof(*irdata
), GFP_KERNEL
);
748 for (i
= 0; i
< count
; i
++) {
749 cur_sample_len
= redrat3_us_to_len(txbuf
[i
]);
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;
755 for (lencheck
= 0; lencheck
< curlencheck
; lencheck
++) {
756 if (sample_lens
[lencheck
] == cur_sample_len
)
759 if (lencheck
== curlencheck
) {
760 dev_dbg(dev
, "txbuf[%d]=%u, pos %d, enc %u\n",
761 i
, txbuf
[i
], curlencheck
, cur_sample_len
);
762 if (curlencheck
< RR3_DRIVER_MAXLENS
) {
763 /* now convert the value to a proper
765 sample_lens
[curlencheck
] = cur_sample_len
;
766 put_unaligned_be16(cur_sample_len
,
767 &irdata
->lens
[curlencheck
]);
774 irdata
->sigdata
[i
] = lencheck
;
777 irdata
->sigdata
[count
] = RR3_END_OF_SIGNAL
;
778 irdata
->sigdata
[count
+ 1] = RR3_END_OF_SIGNAL
;
780 sendbuf_len
= offsetof(struct redrat3_irdata
,
781 sigdata
[count
+ RR3_TX_TRAILER_LEN
]);
782 /* fill in our packet header */
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
);
791 pipe
= usb_sndbulkpipe(rr3
->udev
, rr3
->ep_out
->bEndpointAddress
);
792 ret
= usb_bulk_msg(rr3
->udev
, pipe
, irdata
,
793 sendbuf_len
, &ret_len
, 10 * HZ
);
794 dev_dbg(dev
, "sent %d bytes, (ret %d)\n", ret_len
, ret
);
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
,
800 0, 0, irdata
, 2, HZ
* 10);
803 dev_err(dev
, "Error: control msg send failed, rc %d\n", ret
);
811 rr3
->transmitting
= false;
812 /* rr3 re-enables rc detector because it was enabled before */
817 static void redrat3_brightness_set(struct led_classdev
*led_dev
, enum
818 led_brightness brightness
)
820 struct redrat3_dev
*rr3
= container_of(led_dev
, struct redrat3_dev
,
823 if (brightness
!= LED_OFF
&& atomic_cmpxchg(&rr3
->flash
, 0, 1) == 0) {
824 int ret
= usb_submit_urb(rr3
->flash_urb
, GFP_ATOMIC
);
826 dev_dbg(rr3
->dev
, "%s: unexpected ret of %d\n",
828 atomic_set(&rr3
->flash
, 0);
833 static void redrat3_led_complete(struct urb
*urb
)
835 struct redrat3_dev
*rr3
= urb
->context
;
837 switch (urb
->status
) {
847 dev_dbg(rr3
->dev
, "Error: urb status = %d\n", urb
->status
);
851 rr3
->led
.brightness
= LED_OFF
;
852 atomic_dec(&rr3
->flash
);
855 static struct rc_dev
*redrat3_init_rc_dev(struct redrat3_dev
*rr3
)
857 struct device
*dev
= rr3
->dev
;
860 u16 prod
= le16_to_cpu(rr3
->udev
->descriptor
.idProduct
);
862 rc
= rc_allocate_device();
864 dev_err(dev
, "remote input dev allocation failed\n");
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
);
873 usb_make_path(rr3
->udev
, rr3
->phys
, sizeof(rr3
->phys
));
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
;
880 rc
->driver_type
= RC_DRIVER_IR_RAW
;
881 rc_set_allowed_protocols(rc
, RC_BIT_ALL
);
882 rc
->timeout
= US_TO_NS(2750);
883 rc
->tx_ir
= redrat3_transmit_ir
;
884 rc
->s_tx_carrier
= redrat3_set_tx_carrier
;
885 rc
->driver_name
= DRIVER_NAME
;
886 rc
->rx_resolution
= US_TO_NS(2);
887 rc
->map_name
= RC_MAP_HAUPPAUGE
;
889 ret
= rc_register_device(rc
);
891 dev_err(dev
, "remote dev registration failed\n");
902 static int redrat3_dev_probe(struct usb_interface
*intf
,
903 const struct usb_device_id
*id
)
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
;
914 int retval
= -ENOMEM
;
916 uhi
= intf
->cur_altsetting
;
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
;
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
)) {
928 dev_dbg(dev
, "found bulk-in endpoint at 0x%02x\n",
929 ep
->bEndpointAddress
);
930 /* data comes in on 0x82, 0x81 is for other data... */
931 if (ep
->bEndpointAddress
== RR3_BULK_IN_EP_ADDR
)
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
)) {
939 dev_dbg(dev
, "found bulk-out endpoint at 0x%02x\n",
940 ep
->bEndpointAddress
);
945 if (!ep_in
|| !ep_out
) {
946 dev_err(dev
, "Couldn't find both in and out endpoints\n");
951 /* allocate memory for our device state and initialize it */
952 rr3
= kzalloc(sizeof(*rr3
), GFP_KERNEL
);
954 dev_err(dev
, "Memory allocation failure\n");
958 rr3
->dev
= &intf
->dev
;
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");
968 rr3
->bulk_in_buf
= usb_alloc_coherent(udev
,
969 le16_to_cpu(ep_in
->wMaxPacketSize
), GFP_ATOMIC
, &rr3
->dma_in
);
970 if (!rr3
->bulk_in_buf
) {
971 dev_err(dev
, "Read buffer allocation failure\n");
975 pipe
= usb_rcvbulkpipe(udev
, ep_in
->bEndpointAddress
);
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
);
979 rr3
->ep_out
= ep_out
;
983 redrat3_get_firmware_rev(rr3
);
985 /* might be all we need to do? */
986 retval
= redrat3_enable_detector(rr3
);
990 /* store current hardware timeout, in us, will use for kfifo resets */
991 rr3
->hw_timeout
= redrat3_get_timeout(rr3
);
993 /* default.. will get overridden by any sends with a freq defined */
994 rr3
->carrier
= 38000;
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
);
1004 atomic_set(&rr3
->flash
, 0);
1005 rr3
->flash_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1006 if (!rr3
->flash_urb
) {
1008 goto led_free_error
;
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);
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
);
1021 rr3
->rc
= redrat3_init_rc_dev(rr3
);
1024 goto led_free_error
;
1026 setup_timer(&rr3
->rx_timeout
, redrat3_rx_timeout
, (unsigned long)rr3
);
1028 /* we can register the device now, as it is ready */
1029 usb_set_intfdata(intf
, rr3
);
1034 led_classdev_unregister(&rr3
->led
);
1036 redrat3_delete(rr3
, rr3
->udev
);
1039 dev_err(dev
, "%s: retval = %x", __func__
, retval
);
1044 static void redrat3_dev_disconnect(struct usb_interface
*intf
)
1046 struct usb_device
*udev
= interface_to_usbdev(intf
);
1047 struct redrat3_dev
*rr3
= usb_get_intfdata(intf
);
1052 usb_set_intfdata(intf
, NULL
);
1053 rc_unregister_device(rr3
->rc
);
1054 led_classdev_unregister(&rr3
->led
);
1055 del_timer_sync(&rr3
->rx_timeout
);
1056 redrat3_delete(rr3
, udev
);
1059 static int redrat3_dev_suspend(struct usb_interface
*intf
, pm_message_t message
)
1061 struct redrat3_dev
*rr3
= usb_get_intfdata(intf
);
1063 led_classdev_suspend(&rr3
->led
);
1064 usb_kill_urb(rr3
->read_urb
);
1065 usb_kill_urb(rr3
->flash_urb
);
1069 static int redrat3_dev_resume(struct usb_interface
*intf
)
1071 struct redrat3_dev
*rr3
= usb_get_intfdata(intf
);
1073 if (usb_submit_urb(rr3
->read_urb
, GFP_ATOMIC
))
1075 led_classdev_resume(&rr3
->led
);
1079 static struct usb_driver redrat3_dev_driver
= {
1080 .name
= DRIVER_NAME
,
1081 .probe
= redrat3_dev_probe
,
1082 .disconnect
= redrat3_dev_disconnect
,
1083 .suspend
= redrat3_dev_suspend
,
1084 .resume
= redrat3_dev_resume
,
1085 .reset_resume
= redrat3_dev_resume
,
1086 .id_table
= redrat3_dev_table
1089 module_usb_driver(redrat3_dev_driver
);
1091 MODULE_DESCRIPTION(DRIVER_DESC
);
1092 MODULE_AUTHOR(DRIVER_AUTHOR
);
1093 MODULE_AUTHOR(DRIVER_AUTHOR2
);
1094 MODULE_LICENSE("GPL");
1095 MODULE_DEVICE_TABLE(usb
, redrat3_dev_table
);