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 */
194 /* Is the device currently transmitting?*/
197 /* store for current packet */
198 struct redrat3_irdata irdata
;
208 * redrat3_issue_async
210 * Issues an async read to the ir data in port..
211 * sets the callback to be redrat3_handle_async
213 static void redrat3_issue_async(struct redrat3_dev
*rr3
)
217 res
= usb_submit_urb(rr3
->read_urb
, GFP_ATOMIC
);
220 "%s: receive request FAILED! (res %d, len %d)\n",
221 __func__
, res
, rr3
->read_urb
->transfer_buffer_length
);
224 static void redrat3_dump_fw_error(struct redrat3_dev
*rr3
, int code
)
226 if (!rr3
->transmitting
&& (code
!= 0x40))
227 dev_info(rr3
->dev
, "fw error code 0x%02x: ", code
);
231 pr_cont("No Error\n");
234 /* Codes 0x20 through 0x2f are IR Firmware Errors */
236 pr_cont("Initial signal pulse not long enough "
237 "to measure carrier frequency\n");
240 pr_cont("Not enough length values allocated for signal\n");
243 pr_cont("Not enough memory allocated for signal data\n");
246 pr_cont("Too many signal repeats\n");
249 pr_cont("Insufficient memory available for IR signal "
250 "data memory allocation\n");
253 pr_cont("Insufficient memory available "
254 "for IrDa signal data memory allocation\n");
257 /* Codes 0x30 through 0x3f are USB Firmware Errors */
259 pr_cont("Insufficient memory available for bulk "
260 "transfer structure\n");
264 * Other error codes... These are primarily errors that can occur in
265 * the control messages sent to the redrat
268 if (!rr3
->transmitting
)
269 pr_cont("Signal capture has been terminated\n");
272 pr_cont("Attempt to set/get and unknown signal I/O "
273 "algorithm parameter\n");
276 pr_cont("Signal capture already started\n");
280 pr_cont("Unknown Error\n");
285 static u32
redrat3_val_to_mod_freq(struct redrat3_irdata
*irdata
)
288 u16 mod_freq_count
= be16_to_cpu(irdata
->mod_freq_count
);
290 if (mod_freq_count
!= 0)
291 mod_freq
= (RR3_CLK
* be16_to_cpu(irdata
->num_periods
)) /
292 (mod_freq_count
* RR3_CLK_PER_COUNT
);
297 /* this function scales down the figures for the same result... */
298 static u32
redrat3_len_to_us(u32 length
)
300 u32 biglen
= length
* 1000;
301 u32 divisor
= (RR3_CLK_CONV_FACTOR
) / 1000;
302 u32 result
= (u32
) (biglen
/ divisor
);
304 /* don't allow zero lengths to go back, breaks lirc */
305 return result
? result
: 1;
309 * convert us back into redrat3 lengths
311 * length * 1000 length * 1000000
312 * ------------- = ---------------- = micro
313 * rr3clk / 1000 rr3clk
315 * 6 * 2 4 * 3 micro * rr3clk micro * rr3clk / 1000
316 * ----- = 4 ----- = 6 -------------- = len ---------------------
319 static u32
redrat3_us_to_len(u32 microsec
)
324 microsec
= (microsec
> IR_MAX_DURATION
) ? IR_MAX_DURATION
: microsec
;
325 divisor
= (RR3_CLK_CONV_FACTOR
/ 1000);
326 result
= (u32
)(microsec
* divisor
) / 1000;
328 /* don't allow zero lengths to go back, breaks lirc */
329 return result
? result
: 1;
332 static void redrat3_process_ir_data(struct redrat3_dev
*rr3
)
334 DEFINE_IR_RAW_EVENT(rawir
);
336 unsigned int i
, sig_size
, single_len
, offset
, val
;
340 pr_err("%s called with no context!\n", __func__
);
346 mod_freq
= redrat3_val_to_mod_freq(&rr3
->irdata
);
347 dev_dbg(dev
, "Got mod_freq of %u\n", mod_freq
);
349 /* process each rr3 encoded byte into an int */
350 sig_size
= be16_to_cpu(rr3
->irdata
.sig_size
);
351 for (i
= 0; i
< sig_size
; i
++) {
352 offset
= rr3
->irdata
.sigdata
[i
];
353 val
= get_unaligned_be16(&rr3
->irdata
.lens
[offset
]);
354 single_len
= redrat3_len_to_us(val
);
356 /* we should always get pulse/space/pulse/space samples */
362 rawir
.duration
= US_TO_NS(single_len
);
363 /* cap the value to IR_MAX_DURATION */
364 rawir
.duration
= (rawir
.duration
> IR_MAX_DURATION
) ?
365 IR_MAX_DURATION
: rawir
.duration
;
367 dev_dbg(dev
, "storing %s with duration %d (i: %d)\n",
368 rawir
.pulse
? "pulse" : "space", rawir
.duration
, i
);
369 ir_raw_event_store_with_filter(rr3
->rc
, &rawir
);
372 /* add a trailing space */
374 rawir
.timeout
= true;
375 rawir
.duration
= US_TO_NS(rr3
->hw_timeout
);
376 dev_dbg(dev
, "storing trailing timeout with duration %d\n",
378 ir_raw_event_store_with_filter(rr3
->rc
, &rawir
);
380 dev_dbg(dev
, "calling ir_raw_event_handle\n");
381 ir_raw_event_handle(rr3
->rc
);
384 /* Util fn to send rr3 cmds */
385 static int redrat3_send_cmd(int cmd
, struct redrat3_dev
*rr3
)
387 struct usb_device
*udev
;
391 data
= kzalloc(sizeof(u8
), GFP_KERNEL
);
396 res
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0), cmd
,
397 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
398 0x0000, 0x0000, data
, sizeof(u8
), HZ
* 10);
401 dev_err(rr3
->dev
, "%s: Error sending rr3 cmd res %d, data %d",
402 __func__
, res
, *data
);
412 /* Enables the long range detector and starts async receive */
413 static int redrat3_enable_detector(struct redrat3_dev
*rr3
)
415 struct device
*dev
= rr3
->dev
;
418 ret
= redrat3_send_cmd(RR3_RC_DET_ENABLE
, rr3
);
420 dev_dbg(dev
, "%s: unexpected ret of %d\n",
423 ret
= redrat3_send_cmd(RR3_RC_DET_STATUS
, rr3
);
425 dev_err(dev
, "%s: detector status: %d, should be 1\n",
430 redrat3_issue_async(rr3
);
435 static inline void redrat3_delete(struct redrat3_dev
*rr3
,
436 struct usb_device
*udev
)
438 usb_kill_urb(rr3
->read_urb
);
439 usb_kill_urb(rr3
->flash_urb
);
440 usb_free_urb(rr3
->read_urb
);
441 usb_free_urb(rr3
->flash_urb
);
442 usb_free_coherent(udev
, le16_to_cpu(rr3
->ep_in
->wMaxPacketSize
),
443 rr3
->bulk_in_buf
, rr3
->dma_in
);
448 static u32
redrat3_get_timeout(struct redrat3_dev
*rr3
)
451 u32 timeout
= MS_TO_US(150); /* a sane default, if things go haywire */
455 tmp
= kzalloc(len
, GFP_KERNEL
);
457 dev_warn(rr3
->dev
, "Memory allocation faillure\n");
461 pipe
= usb_rcvctrlpipe(rr3
->udev
, 0);
462 ret
= usb_control_msg(rr3
->udev
, pipe
, RR3_GET_IR_PARAM
,
463 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
464 RR3_IR_IO_SIG_TIMEOUT
, 0, tmp
, len
, HZ
* 5);
466 dev_warn(rr3
->dev
, "Failed to read timeout from hardware\n");
468 timeout
= redrat3_len_to_us(be32_to_cpup(tmp
));
470 dev_dbg(rr3
->dev
, "Got timeout of %d ms\n", timeout
/ 1000);
478 static int redrat3_set_timeout(struct rc_dev
*rc_dev
, unsigned int timeoutns
)
480 struct redrat3_dev
*rr3
= rc_dev
->priv
;
481 struct usb_device
*udev
= rr3
->udev
;
482 struct device
*dev
= rr3
->dev
;
486 timeout
= kmalloc(sizeof(*timeout
), GFP_KERNEL
);
490 *timeout
= cpu_to_be32(redrat3_us_to_len(timeoutns
/ 1000));
491 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0), RR3_SET_IR_PARAM
,
492 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_OUT
,
493 RR3_IR_IO_SIG_TIMEOUT
, 0, timeout
, sizeof(*timeout
),
495 dev_dbg(dev
, "set ir parm timeout %d ret 0x%02x\n",
496 be32_to_cpu(*timeout
), ret
);
498 if (ret
== sizeof(*timeout
)) {
499 rr3
->hw_timeout
= timeoutns
/ 1000;
509 static void redrat3_reset(struct redrat3_dev
*rr3
)
511 struct usb_device
*udev
= rr3
->udev
;
512 struct device
*dev
= rr3
->dev
;
513 int rc
, rxpipe
, txpipe
;
515 int len
= sizeof(u8
);
517 rxpipe
= usb_rcvctrlpipe(udev
, 0);
518 txpipe
= usb_sndctrlpipe(udev
, 0);
520 val
= kmalloc(len
, GFP_KERNEL
);
522 dev_err(dev
, "Memory allocation failure\n");
527 rc
= usb_control_msg(udev
, rxpipe
, RR3_RESET
,
528 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
529 RR3_CPUCS_REG_ADDR
, 0, val
, len
, HZ
* 25);
530 dev_dbg(dev
, "reset returned 0x%02x\n", rc
);
533 rc
= usb_control_msg(udev
, txpipe
, RR3_SET_IR_PARAM
,
534 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_OUT
,
535 RR3_IR_IO_LENGTH_FUZZ
, 0, val
, len
, HZ
* 25);
536 dev_dbg(dev
, "set ir parm len fuzz %d rc 0x%02x\n", *val
, rc
);
538 *val
= RR3_DRIVER_MAXLENS
;
539 rc
= usb_control_msg(udev
, txpipe
, RR3_SET_IR_PARAM
,
540 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_OUT
,
541 RR3_IR_IO_MAX_LENGTHS
, 0, val
, len
, HZ
* 25);
542 dev_dbg(dev
, "set ir parm max lens %d rc 0x%02x\n", *val
, rc
);
547 static void redrat3_get_firmware_rev(struct redrat3_dev
*rr3
)
552 buffer
= kzalloc(sizeof(char) * (RR3_FW_VERSION_LEN
+ 1), GFP_KERNEL
);
554 dev_err(rr3
->dev
, "Memory allocation failure\n");
558 rc
= usb_control_msg(rr3
->udev
, usb_rcvctrlpipe(rr3
->udev
, 0),
560 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
561 0, 0, buffer
, RR3_FW_VERSION_LEN
, HZ
* 5);
564 dev_info(rr3
->dev
, "Firmware rev: %s", buffer
);
566 dev_err(rr3
->dev
, "Problem fetching firmware ID\n");
571 static void redrat3_read_packet_start(struct redrat3_dev
*rr3
, unsigned len
)
573 struct redrat3_header
*header
= rr3
->bulk_in_buf
;
574 unsigned pktlen
, pkttype
;
576 /* grab the Length and type of transfer */
577 pktlen
= be16_to_cpu(header
->length
);
578 pkttype
= be16_to_cpu(header
->transfer_type
);
580 if (pktlen
> sizeof(rr3
->irdata
)) {
581 dev_warn(rr3
->dev
, "packet length %u too large\n", pktlen
);
587 if (len
>= sizeof(struct redrat3_error
)) {
588 struct redrat3_error
*error
= rr3
->bulk_in_buf
;
589 unsigned fw_error
= be16_to_cpu(error
->fw_error
);
590 redrat3_dump_fw_error(rr3
, fw_error
);
594 case RR3_MOD_SIGNAL_IN
:
595 memcpy(&rr3
->irdata
, rr3
->bulk_in_buf
, len
);
596 rr3
->bytes_read
= len
;
597 dev_dbg(rr3
->dev
, "bytes_read %d, pktlen %d\n",
598 rr3
->bytes_read
, pktlen
);
602 dev_dbg(rr3
->dev
, "ignoring packet with type 0x%02x, len of %d, 0x%02x\n",
603 pkttype
, len
, pktlen
);
608 static void redrat3_read_packet_continue(struct redrat3_dev
*rr3
, unsigned len
)
610 void *irdata
= &rr3
->irdata
;
612 if (len
+ rr3
->bytes_read
> sizeof(rr3
->irdata
)) {
613 dev_warn(rr3
->dev
, "too much data for packet\n");
618 memcpy(irdata
+ rr3
->bytes_read
, rr3
->bulk_in_buf
, len
);
620 rr3
->bytes_read
+= len
;
621 dev_dbg(rr3
->dev
, "bytes_read %d, pktlen %d\n", rr3
->bytes_read
,
622 be16_to_cpu(rr3
->irdata
.header
.length
));
625 /* gather IR data from incoming urb, process it when we have enough */
626 static int redrat3_get_ir_data(struct redrat3_dev
*rr3
, unsigned len
)
628 struct device
*dev
= rr3
->dev
;
632 if (rr3
->bytes_read
== 0 && len
>= sizeof(struct redrat3_header
)) {
633 redrat3_read_packet_start(rr3
, len
);
634 } else if (rr3
->bytes_read
!= 0) {
635 redrat3_read_packet_continue(rr3
, len
);
636 } else if (rr3
->bytes_read
== 0) {
637 dev_err(dev
, "error: no packet data read\n");
642 if (rr3
->bytes_read
< be16_to_cpu(rr3
->irdata
.header
.length
) +
643 sizeof(struct redrat3_header
))
644 /* we're still accumulating data */
647 /* if we get here, we've got IR data to decode */
648 pkttype
= be16_to_cpu(rr3
->irdata
.header
.transfer_type
);
649 if (pkttype
== RR3_MOD_SIGNAL_IN
)
650 redrat3_process_ir_data(rr3
);
652 dev_dbg(dev
, "discarding non-signal data packet (type 0x%02x)\n",
660 /* callback function from USB when async USB request has completed */
661 static void redrat3_handle_async(struct urb
*urb
)
663 struct redrat3_dev
*rr3
;
671 pr_err("%s called with invalid context!\n", __func__
);
676 switch (urb
->status
) {
678 ret
= redrat3_get_ir_data(rr3
, urb
->actual_length
);
680 /* no error, prepare to read more */
681 redrat3_issue_async(rr3
);
693 dev_warn(rr3
->dev
, "Error: urb status = %d\n", urb
->status
);
699 static u16
mod_freq_to_val(unsigned int mod_freq
)
703 /* Clk used in mod. freq. generation is CLK24/4. */
704 return 65536 - (mult
/ mod_freq
);
707 static int redrat3_set_tx_carrier(struct rc_dev
*rcdev
, u32 carrier
)
709 struct redrat3_dev
*rr3
= rcdev
->priv
;
710 struct device
*dev
= rr3
->dev
;
712 dev_dbg(dev
, "Setting modulation frequency to %u", carrier
);
716 rr3
->carrier
= carrier
;
721 static int redrat3_transmit_ir(struct rc_dev
*rcdev
, unsigned *txbuf
,
724 struct redrat3_dev
*rr3
= rcdev
->priv
;
725 struct device
*dev
= rr3
->dev
;
726 struct redrat3_irdata
*irdata
= NULL
;
728 int lencheck
, cur_sample_len
, pipe
;
729 int *sample_lens
= NULL
;
731 unsigned i
, sendbuf_len
;
733 if (rr3
->transmitting
) {
734 dev_warn(dev
, "%s: transmitter already in use\n", __func__
);
738 if (count
> RR3_MAX_SIG_SIZE
- RR3_TX_TRAILER_LEN
)
741 /* rr3 will disable rc detector on transmit */
742 rr3
->transmitting
= true;
744 sample_lens
= kzalloc(sizeof(int) * RR3_DRIVER_MAXLENS
, GFP_KERNEL
);
750 irdata
= kzalloc(sizeof(*irdata
), GFP_KERNEL
);
756 for (i
= 0; i
< count
; i
++) {
757 cur_sample_len
= redrat3_us_to_len(txbuf
[i
]);
758 if (cur_sample_len
> 0xffff) {
759 dev_warn(dev
, "transmit period of %uus truncated to %uus\n",
760 txbuf
[i
], redrat3_len_to_us(0xffff));
761 cur_sample_len
= 0xffff;
763 for (lencheck
= 0; lencheck
< curlencheck
; lencheck
++) {
764 if (sample_lens
[lencheck
] == cur_sample_len
)
767 if (lencheck
== curlencheck
) {
768 dev_dbg(dev
, "txbuf[%d]=%u, pos %d, enc %u\n",
769 i
, txbuf
[i
], curlencheck
, cur_sample_len
);
770 if (curlencheck
< RR3_DRIVER_MAXLENS
) {
771 /* now convert the value to a proper
773 sample_lens
[curlencheck
] = cur_sample_len
;
774 put_unaligned_be16(cur_sample_len
,
775 &irdata
->lens
[curlencheck
]);
782 irdata
->sigdata
[i
] = lencheck
;
785 irdata
->sigdata
[count
] = RR3_END_OF_SIGNAL
;
786 irdata
->sigdata
[count
+ 1] = RR3_END_OF_SIGNAL
;
788 sendbuf_len
= offsetof(struct redrat3_irdata
,
789 sigdata
[count
+ RR3_TX_TRAILER_LEN
]);
790 /* fill in our packet header */
791 irdata
->header
.length
= cpu_to_be16(sendbuf_len
-
792 sizeof(struct redrat3_header
));
793 irdata
->header
.transfer_type
= cpu_to_be16(RR3_MOD_SIGNAL_OUT
);
794 irdata
->pause
= cpu_to_be32(redrat3_len_to_us(100));
795 irdata
->mod_freq_count
= cpu_to_be16(mod_freq_to_val(rr3
->carrier
));
796 irdata
->no_lengths
= curlencheck
;
797 irdata
->sig_size
= cpu_to_be16(count
+ RR3_TX_TRAILER_LEN
);
799 pipe
= usb_sndbulkpipe(rr3
->udev
, rr3
->ep_out
->bEndpointAddress
);
800 ret
= usb_bulk_msg(rr3
->udev
, pipe
, irdata
,
801 sendbuf_len
, &ret_len
, 10 * HZ
);
802 dev_dbg(dev
, "sent %d bytes, (ret %d)\n", ret_len
, ret
);
804 /* now tell the hardware to transmit what we sent it */
805 pipe
= usb_rcvctrlpipe(rr3
->udev
, 0);
806 ret
= usb_control_msg(rr3
->udev
, pipe
, RR3_TX_SEND_SIGNAL
,
807 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
808 0, 0, irdata
, 2, HZ
* 10);
811 dev_err(dev
, "Error: control msg send failed, rc %d\n", ret
);
819 rr3
->transmitting
= false;
820 /* rr3 re-enables rc detector because it was enabled before */
825 static void redrat3_brightness_set(struct led_classdev
*led_dev
, enum
826 led_brightness brightness
)
828 struct redrat3_dev
*rr3
= container_of(led_dev
, struct redrat3_dev
,
831 if (brightness
!= LED_OFF
&& atomic_cmpxchg(&rr3
->flash
, 0, 1) == 0) {
832 int ret
= usb_submit_urb(rr3
->flash_urb
, GFP_ATOMIC
);
834 dev_dbg(rr3
->dev
, "%s: unexpected ret of %d\n",
836 atomic_set(&rr3
->flash
, 0);
841 static void redrat3_led_complete(struct urb
*urb
)
843 struct redrat3_dev
*rr3
= urb
->context
;
845 switch (urb
->status
) {
855 dev_dbg(rr3
->dev
, "Error: urb status = %d\n", urb
->status
);
859 rr3
->led
.brightness
= LED_OFF
;
860 atomic_dec(&rr3
->flash
);
863 static struct rc_dev
*redrat3_init_rc_dev(struct redrat3_dev
*rr3
)
865 struct device
*dev
= rr3
->dev
;
868 u16 prod
= le16_to_cpu(rr3
->udev
->descriptor
.idProduct
);
870 rc
= rc_allocate_device();
872 dev_err(dev
, "remote input dev allocation failed\n");
876 snprintf(rr3
->name
, sizeof(rr3
->name
), "RedRat3%s "
877 "Infrared Remote Transceiver (%04x:%04x)",
878 prod
== USB_RR3IIUSB_PRODUCT_ID
? "-II" : "",
879 le16_to_cpu(rr3
->udev
->descriptor
.idVendor
), prod
);
881 usb_make_path(rr3
->udev
, rr3
->phys
, sizeof(rr3
->phys
));
883 rc
->input_name
= rr3
->name
;
884 rc
->input_phys
= rr3
->phys
;
885 usb_to_input_id(rr3
->udev
, &rc
->input_id
);
886 rc
->dev
.parent
= dev
;
888 rc
->driver_type
= RC_DRIVER_IR_RAW
;
889 rc
->allowed_protocols
= RC_BIT_ALL
;
890 rc
->min_timeout
= MS_TO_NS(RR3_RX_MIN_TIMEOUT
);
891 rc
->max_timeout
= MS_TO_NS(RR3_RX_MAX_TIMEOUT
);
892 rc
->timeout
= US_TO_NS(rr3
->hw_timeout
);
893 rc
->s_timeout
= redrat3_set_timeout
;
894 rc
->tx_ir
= redrat3_transmit_ir
;
895 rc
->s_tx_carrier
= redrat3_set_tx_carrier
;
896 rc
->driver_name
= DRIVER_NAME
;
897 rc
->rx_resolution
= US_TO_NS(2);
898 rc
->map_name
= RC_MAP_HAUPPAUGE
;
900 ret
= rc_register_device(rc
);
902 dev_err(dev
, "remote dev registration failed\n");
913 static int redrat3_dev_probe(struct usb_interface
*intf
,
914 const struct usb_device_id
*id
)
916 struct usb_device
*udev
= interface_to_usbdev(intf
);
917 struct device
*dev
= &intf
->dev
;
918 struct usb_host_interface
*uhi
;
919 struct redrat3_dev
*rr3
;
920 struct usb_endpoint_descriptor
*ep
;
921 struct usb_endpoint_descriptor
*ep_in
= NULL
;
922 struct usb_endpoint_descriptor
*ep_out
= NULL
;
925 int retval
= -ENOMEM
;
927 uhi
= intf
->cur_altsetting
;
929 /* find our bulk-in and bulk-out endpoints */
930 for (i
= 0; i
< uhi
->desc
.bNumEndpoints
; ++i
) {
931 ep
= &uhi
->endpoint
[i
].desc
;
932 addr
= ep
->bEndpointAddress
;
933 attrs
= ep
->bmAttributes
;
935 if ((ep_in
== NULL
) &&
936 ((addr
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
) &&
937 ((attrs
& USB_ENDPOINT_XFERTYPE_MASK
) ==
938 USB_ENDPOINT_XFER_BULK
)) {
939 dev_dbg(dev
, "found bulk-in endpoint at 0x%02x\n",
940 ep
->bEndpointAddress
);
941 /* data comes in on 0x82, 0x81 is for other data... */
942 if (ep
->bEndpointAddress
== RR3_BULK_IN_EP_ADDR
)
946 if ((ep_out
== NULL
) &&
947 ((addr
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) &&
948 ((attrs
& USB_ENDPOINT_XFERTYPE_MASK
) ==
949 USB_ENDPOINT_XFER_BULK
)) {
950 dev_dbg(dev
, "found bulk-out endpoint at 0x%02x\n",
951 ep
->bEndpointAddress
);
956 if (!ep_in
|| !ep_out
) {
957 dev_err(dev
, "Couldn't find both in and out endpoints\n");
962 /* allocate memory for our device state and initialize it */
963 rr3
= kzalloc(sizeof(*rr3
), GFP_KERNEL
);
965 dev_err(dev
, "Memory allocation failure\n");
969 rr3
->dev
= &intf
->dev
;
971 /* set up bulk-in endpoint */
972 rr3
->read_urb
= usb_alloc_urb(0, GFP_KERNEL
);
973 if (!rr3
->read_urb
) {
974 dev_err(dev
, "Read urb allocation failure\n");
979 rr3
->bulk_in_buf
= usb_alloc_coherent(udev
,
980 le16_to_cpu(ep_in
->wMaxPacketSize
), GFP_KERNEL
, &rr3
->dma_in
);
981 if (!rr3
->bulk_in_buf
) {
982 dev_err(dev
, "Read buffer allocation failure\n");
986 pipe
= usb_rcvbulkpipe(udev
, ep_in
->bEndpointAddress
);
987 usb_fill_bulk_urb(rr3
->read_urb
, udev
, pipe
, rr3
->bulk_in_buf
,
988 le16_to_cpu(ep_in
->wMaxPacketSize
), redrat3_handle_async
, rr3
);
989 rr3
->read_urb
->transfer_dma
= rr3
->dma_in
;
990 rr3
->read_urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
992 rr3
->ep_out
= ep_out
;
996 redrat3_get_firmware_rev(rr3
);
998 /* might be all we need to do? */
999 retval
= redrat3_enable_detector(rr3
);
1003 /* store current hardware timeout, in µs */
1004 rr3
->hw_timeout
= redrat3_get_timeout(rr3
);
1006 /* default.. will get overridden by any sends with a freq defined */
1007 rr3
->carrier
= 38000;
1010 rr3
->led
.name
= "redrat3:red:feedback";
1011 rr3
->led
.default_trigger
= "rc-feedback";
1012 rr3
->led
.brightness_set
= redrat3_brightness_set
;
1013 retval
= led_classdev_register(&intf
->dev
, &rr3
->led
);
1017 atomic_set(&rr3
->flash
, 0);
1018 rr3
->flash_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1019 if (!rr3
->flash_urb
) {
1021 goto led_free_error
;
1024 /* setup packet is 'c0 b9 0000 0000 0001' */
1025 rr3
->flash_control
.bRequestType
= 0xc0;
1026 rr3
->flash_control
.bRequest
= RR3_BLINK_LED
;
1027 rr3
->flash_control
.wLength
= cpu_to_le16(1);
1029 usb_fill_control_urb(rr3
->flash_urb
, udev
, usb_rcvctrlpipe(udev
, 0),
1030 (unsigned char *)&rr3
->flash_control
,
1031 &rr3
->flash_in_buf
, sizeof(rr3
->flash_in_buf
),
1032 redrat3_led_complete
, rr3
);
1034 rr3
->rc
= redrat3_init_rc_dev(rr3
);
1037 goto led_free_error
;
1040 /* we can register the device now, as it is ready */
1041 usb_set_intfdata(intf
, rr3
);
1046 led_classdev_unregister(&rr3
->led
);
1048 redrat3_delete(rr3
, rr3
->udev
);
1051 dev_err(dev
, "%s: retval = %x", __func__
, retval
);
1056 static void redrat3_dev_disconnect(struct usb_interface
*intf
)
1058 struct usb_device
*udev
= interface_to_usbdev(intf
);
1059 struct redrat3_dev
*rr3
= usb_get_intfdata(intf
);
1064 usb_set_intfdata(intf
, NULL
);
1065 rc_unregister_device(rr3
->rc
);
1066 led_classdev_unregister(&rr3
->led
);
1067 redrat3_delete(rr3
, udev
);
1070 static int redrat3_dev_suspend(struct usb_interface
*intf
, pm_message_t message
)
1072 struct redrat3_dev
*rr3
= usb_get_intfdata(intf
);
1074 led_classdev_suspend(&rr3
->led
);
1075 usb_kill_urb(rr3
->read_urb
);
1076 usb_kill_urb(rr3
->flash_urb
);
1080 static int redrat3_dev_resume(struct usb_interface
*intf
)
1082 struct redrat3_dev
*rr3
= usb_get_intfdata(intf
);
1084 if (usb_submit_urb(rr3
->read_urb
, GFP_ATOMIC
))
1086 led_classdev_resume(&rr3
->led
);
1090 static struct usb_driver redrat3_dev_driver
= {
1091 .name
= DRIVER_NAME
,
1092 .probe
= redrat3_dev_probe
,
1093 .disconnect
= redrat3_dev_disconnect
,
1094 .suspend
= redrat3_dev_suspend
,
1095 .resume
= redrat3_dev_resume
,
1096 .reset_resume
= redrat3_dev_resume
,
1097 .id_table
= redrat3_dev_table
1100 module_usb_driver(redrat3_dev_driver
);
1102 MODULE_DESCRIPTION(DRIVER_DESC
);
1103 MODULE_AUTHOR(DRIVER_AUTHOR
);
1104 MODULE_AUTHOR(DRIVER_AUTHOR2
);
1105 MODULE_LICENSE("GPL");
1106 MODULE_DEVICE_TABLE(usb
, redrat3_dev_table
);