1183 lines · c
1// SPDX-License-Identifier: GPL-2.0-or-later2/*3 * USB RedRat3 IR Transceiver rc-core driver4 *5 * Copyright (c) 2011 by Jarod Wilson <jarod@redhat.com>6 * based heavily on the work of Stephen Cox, with additional7 * help from RedRat Ltd.8 *9 * This driver began life based on an old version of the first-generation10 * lirc_mceusb driver from the lirc 0.7.2 distribution. It was then11 * significantly rewritten by Stephen Cox with the aid of RedRat Ltd's12 * Chris Dodge.13 *14 * The driver was then ported to rc-core and significantly rewritten again,15 * by Jarod, using the in-kernel mceusb driver as a guide, after an initial16 * port effort was started by Stephen.17 *18 * TODO LIST:19 * - fix lirc not showing repeats properly20 * --21 *22 * The RedRat3 is a USB transceiver with both send & receive,23 * with 2 separate sensors available for receive to enable24 * both good long range reception for general use, and good25 * short range reception when required for learning a signal.26 *27 * http://www.redrat.co.uk/28 *29 * It uses its own little protocol to communicate, the required30 * parts of which are embedded within this driver.31 * --32 */33 34#include <linux/unaligned.h>35#include <linux/device.h>36#include <linux/leds.h>37#include <linux/module.h>38#include <linux/slab.h>39#include <linux/usb.h>40#include <linux/usb/input.h>41#include <media/rc-core.h>42 43/* Driver Information */44#define DRIVER_AUTHOR "Jarod Wilson <jarod@redhat.com>"45#define DRIVER_AUTHOR2 "The Dweller, Stephen Cox"46#define DRIVER_DESC "RedRat3 USB IR Transceiver Driver"47#define DRIVER_NAME "redrat3"48 49/* bulk data transfer types */50#define RR3_ERROR 0x0151#define RR3_MOD_SIGNAL_IN 0x2052#define RR3_MOD_SIGNAL_OUT 0x2153 54/* Get the RR firmware version */55#define RR3_FW_VERSION 0xb156#define RR3_FW_VERSION_LEN 6457/* Send encoded signal bulk-sent earlier*/58#define RR3_TX_SEND_SIGNAL 0xb359#define RR3_SET_IR_PARAM 0xb760#define RR3_GET_IR_PARAM 0xb861/* Blink the red LED on the device */62#define RR3_BLINK_LED 0xb963/* Read serial number of device */64#define RR3_READ_SER_NO 0xba65#define RR3_SER_NO_LEN 466/* Start capture with the RC receiver */67#define RR3_RC_DET_ENABLE 0xbb68/* Stop capture with the RC receiver */69#define RR3_RC_DET_DISABLE 0xbc70/* Start capture with the wideband receiver */71#define RR3_MODSIG_CAPTURE 0xb272/* Return the status of RC detector capture */73#define RR3_RC_DET_STATUS 0xbd74/* Reset redrat */75#define RR3_RESET 0xa076 77/* Max number of lengths in the signal. */78#define RR3_IR_IO_MAX_LENGTHS 0x0179/* Periods to measure mod. freq. */80#define RR3_IR_IO_PERIODS_MF 0x0281/* Size of memory for main signal data */82#define RR3_IR_IO_SIG_MEM_SIZE 0x0383/* Delta value when measuring lengths */84#define RR3_IR_IO_LENGTH_FUZZ 0x0485/* Timeout for end of signal detection */86#define RR3_IR_IO_SIG_TIMEOUT 0x0587/* Minimum value for pause recognition. */88#define RR3_IR_IO_MIN_PAUSE 0x0689 90/* Clock freq. of EZ-USB chip */91#define RR3_CLK 2400000092/* Clock periods per timer count */93#define RR3_CLK_PER_COUNT 1294/* (RR3_CLK / RR3_CLK_PER_COUNT) */95#define RR3_CLK_CONV_FACTOR 200000096/* USB bulk-in wideband IR data endpoint address */97#define RR3_WIDE_IN_EP_ADDR 0x8198/* USB bulk-in narrowband IR data endpoint address */99#define RR3_NARROW_IN_EP_ADDR 0x82100 101/* Size of the fixed-length portion of the signal */102#define RR3_DRIVER_MAXLENS 255103#define RR3_MAX_SIG_SIZE 512104#define RR3_TIME_UNIT 50105#define RR3_END_OF_SIGNAL 0x7f106#define RR3_TX_TRAILER_LEN 2107#define RR3_RX_MIN_TIMEOUT 5108#define RR3_RX_MAX_TIMEOUT 2000109 110/* The 8051's CPUCS Register address */111#define RR3_CPUCS_REG_ADDR 0x7f92112 113#define USB_RR3USB_VENDOR_ID 0x112a114#define USB_RR3USB_PRODUCT_ID 0x0001115#define USB_RR3IIUSB_PRODUCT_ID 0x0005116 117 118/*119 * The redrat3 encodes an IR signal as set of different lengths and a set120 * of indices into those lengths. This sets how much two lengths must121 * differ before they are considered distinct, the value is specified122 * in microseconds.123 * Default 5, value 0 to 127.124 */125static int length_fuzz = 5;126module_param(length_fuzz, uint, 0644);127MODULE_PARM_DESC(length_fuzz, "Length Fuzz (0-127)");128 129/*130 * When receiving a continuous ir stream (for example when a user is131 * holding a button down on a remote), this specifies the minimum size132 * of a space when the redrat3 sends a irdata packet to the host. Specified133 * in milliseconds. Default value 18ms.134 * The value can be between 2 and 30 inclusive.135 */136static int minimum_pause = 18;137module_param(minimum_pause, uint, 0644);138MODULE_PARM_DESC(minimum_pause, "Minimum Pause in ms (2-30)");139 140/*141 * The carrier frequency is measured during the first pulse of the IR142 * signal. The larger the number of periods used To measure, the more143 * accurate the result is likely to be, however some signals have short144 * initial pulses, so in some case it may be necessary to reduce this value.145 * Default 8, value 1 to 255.146 */147static int periods_measure_carrier = 8;148module_param(periods_measure_carrier, uint, 0644);149MODULE_PARM_DESC(periods_measure_carrier, "Number of Periods to Measure Carrier (1-255)");150 151 152struct redrat3_header {153 __be16 length;154 __be16 transfer_type;155} __packed;156 157/* sending and receiving irdata */158struct redrat3_irdata {159 struct redrat3_header header;160 __be32 pause;161 __be16 mod_freq_count;162 __be16 num_periods;163 __u8 max_lengths;164 __u8 no_lengths;165 __be16 max_sig_size;166 __be16 sig_size;167 __u8 no_repeats;168 __be16 lens[RR3_DRIVER_MAXLENS]; /* not aligned */169 __u8 sigdata[RR3_MAX_SIG_SIZE];170} __packed;171 172/* firmware errors */173struct redrat3_error {174 struct redrat3_header header;175 __be16 fw_error;176} __packed;177 178/* table of devices that work with this driver */179static const struct usb_device_id redrat3_dev_table[] = {180 /* Original version of the RedRat3 */181 {USB_DEVICE(USB_RR3USB_VENDOR_ID, USB_RR3USB_PRODUCT_ID)},182 /* Second Version/release of the RedRat3 - RetRat3-II */183 {USB_DEVICE(USB_RR3USB_VENDOR_ID, USB_RR3IIUSB_PRODUCT_ID)},184 {} /* Terminating entry */185};186 187/* Structure to hold all of our device specific stuff */188struct redrat3_dev {189 /* core device bits */190 struct rc_dev *rc;191 struct device *dev;192 193 /* led control */194 struct led_classdev led;195 atomic_t flash;196 struct usb_ctrlrequest flash_control;197 struct urb *flash_urb;198 u8 flash_in_buf;199 200 /* learning */201 bool wideband;202 struct usb_ctrlrequest learn_control;203 struct urb *learn_urb;204 u8 learn_buf;205 206 /* save off the usb device pointer */207 struct usb_device *udev;208 209 /* the receive endpoint */210 struct usb_endpoint_descriptor *ep_narrow;211 /* the buffer to receive data */212 void *bulk_in_buf;213 /* urb used to read ir data */214 struct urb *narrow_urb;215 struct urb *wide_urb;216 217 /* the send endpoint */218 struct usb_endpoint_descriptor *ep_out;219 220 /* usb dma */221 dma_addr_t dma_in;222 223 /* Is the device currently transmitting?*/224 bool transmitting;225 226 /* store for current packet */227 struct redrat3_irdata irdata;228 u16 bytes_read;229 230 u32 carrier;231 232 char name[64];233 char phys[64];234};235 236static void redrat3_dump_fw_error(struct redrat3_dev *rr3, int code)237{238 if (!rr3->transmitting && (code != 0x40))239 dev_info(rr3->dev, "fw error code 0x%02x: ", code);240 241 switch (code) {242 case 0x00:243 pr_cont("No Error\n");244 break;245 246 /* Codes 0x20 through 0x2f are IR Firmware Errors */247 case 0x20:248 pr_cont("Initial signal pulse not long enough to measure carrier frequency\n");249 break;250 case 0x21:251 pr_cont("Not enough length values allocated for signal\n");252 break;253 case 0x22:254 pr_cont("Not enough memory allocated for signal data\n");255 break;256 case 0x23:257 pr_cont("Too many signal repeats\n");258 break;259 case 0x28:260 pr_cont("Insufficient memory available for IR signal data memory allocation\n");261 break;262 case 0x29:263 pr_cont("Insufficient memory available for IrDa signal data memory allocation\n");264 break;265 266 /* Codes 0x30 through 0x3f are USB Firmware Errors */267 case 0x30:268 pr_cont("Insufficient memory available for bulk transfer structure\n");269 break;270 271 /*272 * Other error codes... These are primarily errors that can occur in273 * the control messages sent to the redrat274 */275 case 0x40:276 if (!rr3->transmitting)277 pr_cont("Signal capture has been terminated\n");278 break;279 case 0x41:280 pr_cont("Attempt to set/get and unknown signal I/O algorithm parameter\n");281 break;282 case 0x42:283 pr_cont("Signal capture already started\n");284 break;285 286 default:287 pr_cont("Unknown Error\n");288 break;289 }290}291 292static u32 redrat3_val_to_mod_freq(struct redrat3_irdata *irdata)293{294 u32 mod_freq = 0;295 u16 mod_freq_count = be16_to_cpu(irdata->mod_freq_count);296 297 if (mod_freq_count != 0)298 mod_freq = (RR3_CLK * be16_to_cpu(irdata->num_periods)) /299 (mod_freq_count * RR3_CLK_PER_COUNT);300 301 return mod_freq;302}303 304/* this function scales down the figures for the same result... */305static u32 redrat3_len_to_us(u32 length)306{307 u32 biglen = length * 1000;308 u32 divisor = (RR3_CLK_CONV_FACTOR) / 1000;309 u32 result = (u32) (biglen / divisor);310 311 /* don't allow zero lengths to go back, breaks lirc */312 return result ? result : 1;313}314 315/*316 * convert us back into redrat3 lengths317 *318 * length * 1000 length * 1000000319 * ------------- = ---------------- = micro320 * rr3clk / 1000 rr3clk321 322 * 6 * 2 4 * 3 micro * rr3clk micro * rr3clk / 1000323 * ----- = 4 ----- = 6 -------------- = len ---------------------324 * 3 2 1000000 1000325 */326static u32 redrat3_us_to_len(u32 microsec)327{328 u32 result;329 u32 divisor;330 331 microsec = (microsec > IR_MAX_DURATION) ? IR_MAX_DURATION : microsec;332 divisor = (RR3_CLK_CONV_FACTOR / 1000);333 result = (u32)(microsec * divisor) / 1000;334 335 /* don't allow zero lengths to go back, breaks lirc */336 return result ? result : 1;337}338 339static void redrat3_process_ir_data(struct redrat3_dev *rr3)340{341 struct ir_raw_event rawir = {};342 struct device *dev;343 unsigned int i, sig_size, offset, val;344 u32 mod_freq;345 346 dev = rr3->dev;347 348 mod_freq = redrat3_val_to_mod_freq(&rr3->irdata);349 dev_dbg(dev, "Got mod_freq of %u\n", mod_freq);350 if (mod_freq && rr3->wideband) {351 struct ir_raw_event ev = {352 .carrier_report = 1,353 .carrier = mod_freq354 };355 356 ir_raw_event_store(rr3->rc, &ev);357 }358 359 /* process each rr3 encoded byte into an int */360 sig_size = be16_to_cpu(rr3->irdata.sig_size);361 for (i = 0; i < sig_size; i++) {362 offset = rr3->irdata.sigdata[i];363 val = get_unaligned_be16(&rr3->irdata.lens[offset]);364 365 /* we should always get pulse/space/pulse/space samples */366 if (i % 2)367 rawir.pulse = false;368 else369 rawir.pulse = true;370 371 rawir.duration = redrat3_len_to_us(val);372 /* cap the value to IR_MAX_DURATION */373 rawir.duration = (rawir.duration > IR_MAX_DURATION) ?374 IR_MAX_DURATION : rawir.duration;375 376 dev_dbg(dev, "storing %s with duration %d (i: %d)\n",377 rawir.pulse ? "pulse" : "space", rawir.duration, i);378 ir_raw_event_store_with_filter(rr3->rc, &rawir);379 }380 381 /* add a trailing space */382 rawir.pulse = false;383 rawir.timeout = true;384 rawir.duration = rr3->rc->timeout;385 dev_dbg(dev, "storing trailing timeout with duration %d\n",386 rawir.duration);387 ir_raw_event_store_with_filter(rr3->rc, &rawir);388 389 dev_dbg(dev, "calling ir_raw_event_handle\n");390 ir_raw_event_handle(rr3->rc);391}392 393/* Util fn to send rr3 cmds */394static int redrat3_send_cmd(int cmd, struct redrat3_dev *rr3)395{396 struct usb_device *udev;397 u8 *data;398 int res;399 400 data = kzalloc(sizeof(u8), GFP_KERNEL);401 if (!data)402 return -ENOMEM;403 404 udev = rr3->udev;405 res = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), cmd,406 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,407 0x0000, 0x0000, data, sizeof(u8), 10000);408 409 if (res < 0) {410 dev_err(rr3->dev, "%s: Error sending rr3 cmd res %d, data %d",411 __func__, res, *data);412 res = -EIO;413 } else414 res = data[0];415 416 kfree(data);417 418 return res;419}420 421/* Enables the long range detector and starts async receive */422static int redrat3_enable_detector(struct redrat3_dev *rr3)423{424 struct device *dev = rr3->dev;425 u8 ret;426 427 ret = redrat3_send_cmd(RR3_RC_DET_ENABLE, rr3);428 if (ret != 0)429 dev_dbg(dev, "%s: unexpected ret of %d\n",430 __func__, ret);431 432 ret = redrat3_send_cmd(RR3_RC_DET_STATUS, rr3);433 if (ret != 1) {434 dev_err(dev, "%s: detector status: %d, should be 1\n",435 __func__, ret);436 return -EIO;437 }438 439 ret = usb_submit_urb(rr3->narrow_urb, GFP_KERNEL);440 if (ret) {441 dev_err(rr3->dev, "narrow band urb failed: %d", ret);442 return ret;443 }444 445 ret = usb_submit_urb(rr3->wide_urb, GFP_KERNEL);446 if (ret)447 dev_err(rr3->dev, "wide band urb failed: %d", ret);448 449 return ret;450}451 452static inline void redrat3_delete(struct redrat3_dev *rr3,453 struct usb_device *udev)454{455 usb_kill_urb(rr3->narrow_urb);456 usb_kill_urb(rr3->wide_urb);457 usb_kill_urb(rr3->flash_urb);458 usb_kill_urb(rr3->learn_urb);459 usb_free_urb(rr3->narrow_urb);460 usb_free_urb(rr3->wide_urb);461 usb_free_urb(rr3->flash_urb);462 usb_free_urb(rr3->learn_urb);463 usb_free_coherent(udev, le16_to_cpu(rr3->ep_narrow->wMaxPacketSize),464 rr3->bulk_in_buf, rr3->dma_in);465 466 kfree(rr3);467}468 469static u32 redrat3_get_timeout(struct redrat3_dev *rr3)470{471 __be32 *tmp;472 u32 timeout = MS_TO_US(150); /* a sane default, if things go haywire */473 int len, ret, pipe;474 475 len = sizeof(*tmp);476 tmp = kzalloc(len, GFP_KERNEL);477 if (!tmp)478 return timeout;479 480 pipe = usb_rcvctrlpipe(rr3->udev, 0);481 ret = usb_control_msg(rr3->udev, pipe, RR3_GET_IR_PARAM,482 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,483 RR3_IR_IO_SIG_TIMEOUT, 0, tmp, len, 5000);484 if (ret != len)485 dev_warn(rr3->dev, "Failed to read timeout from hardware\n");486 else {487 timeout = redrat3_len_to_us(be32_to_cpup(tmp));488 489 dev_dbg(rr3->dev, "Got timeout of %d ms\n", timeout / 1000);490 }491 492 kfree(tmp);493 494 return timeout;495}496 497static int redrat3_set_timeout(struct rc_dev *rc_dev, unsigned int timeoutus)498{499 struct redrat3_dev *rr3 = rc_dev->priv;500 struct usb_device *udev = rr3->udev;501 struct device *dev = rr3->dev;502 __be32 *timeout;503 int ret;504 505 timeout = kmalloc(sizeof(*timeout), GFP_KERNEL);506 if (!timeout)507 return -ENOMEM;508 509 *timeout = cpu_to_be32(redrat3_us_to_len(timeoutus));510 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), RR3_SET_IR_PARAM,511 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,512 RR3_IR_IO_SIG_TIMEOUT, 0, timeout, sizeof(*timeout),513 25000);514 dev_dbg(dev, "set ir parm timeout %d ret 0x%02x\n",515 be32_to_cpu(*timeout), ret);516 517 if (ret == sizeof(*timeout))518 ret = 0;519 else if (ret >= 0)520 ret = -EIO;521 522 kfree(timeout);523 524 return ret;525}526 527static void redrat3_reset(struct redrat3_dev *rr3)528{529 struct usb_device *udev = rr3->udev;530 struct device *dev = rr3->dev;531 int rc, rxpipe, txpipe;532 u8 *val;533 size_t const len = sizeof(*val);534 535 rxpipe = usb_rcvctrlpipe(udev, 0);536 txpipe = usb_sndctrlpipe(udev, 0);537 538 val = kmalloc(len, GFP_KERNEL);539 if (!val)540 return;541 542 *val = 0x01;543 rc = usb_control_msg(udev, rxpipe, RR3_RESET,544 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,545 RR3_CPUCS_REG_ADDR, 0, val, len, 25000);546 dev_dbg(dev, "reset returned 0x%02x\n", rc);547 548 *val = length_fuzz;549 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,550 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,551 RR3_IR_IO_LENGTH_FUZZ, 0, val, len, 25000);552 dev_dbg(dev, "set ir parm len fuzz %d rc 0x%02x\n", *val, rc);553 554 *val = (65536 - (minimum_pause * 2000)) / 256;555 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,556 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,557 RR3_IR_IO_MIN_PAUSE, 0, val, len, 25000);558 dev_dbg(dev, "set ir parm min pause %d rc 0x%02x\n", *val, rc);559 560 *val = periods_measure_carrier;561 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,562 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,563 RR3_IR_IO_PERIODS_MF, 0, val, len, 25000);564 dev_dbg(dev, "set ir parm periods measure carrier %d rc 0x%02x", *val,565 rc);566 567 *val = RR3_DRIVER_MAXLENS;568 rc = usb_control_msg(udev, txpipe, RR3_SET_IR_PARAM,569 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,570 RR3_IR_IO_MAX_LENGTHS, 0, val, len, 25000);571 dev_dbg(dev, "set ir parm max lens %d rc 0x%02x\n", *val, rc);572 573 kfree(val);574}575 576static void redrat3_get_firmware_rev(struct redrat3_dev *rr3)577{578 int rc;579 char *buffer;580 581 buffer = kcalloc(RR3_FW_VERSION_LEN + 1, sizeof(*buffer), GFP_KERNEL);582 if (!buffer)583 return;584 585 rc = usb_control_msg(rr3->udev, usb_rcvctrlpipe(rr3->udev, 0),586 RR3_FW_VERSION,587 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,588 0, 0, buffer, RR3_FW_VERSION_LEN, 5000);589 590 if (rc >= 0)591 dev_info(rr3->dev, "Firmware rev: %s", buffer);592 else593 dev_err(rr3->dev, "Problem fetching firmware ID\n");594 595 kfree(buffer);596}597 598static void redrat3_read_packet_start(struct redrat3_dev *rr3, unsigned len)599{600 struct redrat3_header *header = rr3->bulk_in_buf;601 unsigned pktlen, pkttype;602 603 /* grab the Length and type of transfer */604 pktlen = be16_to_cpu(header->length);605 pkttype = be16_to_cpu(header->transfer_type);606 607 if (pktlen > sizeof(rr3->irdata)) {608 dev_warn(rr3->dev, "packet length %u too large\n", pktlen);609 return;610 }611 612 switch (pkttype) {613 case RR3_ERROR:614 if (len >= sizeof(struct redrat3_error)) {615 struct redrat3_error *error = rr3->bulk_in_buf;616 unsigned fw_error = be16_to_cpu(error->fw_error);617 redrat3_dump_fw_error(rr3, fw_error);618 }619 break;620 621 case RR3_MOD_SIGNAL_IN:622 memcpy(&rr3->irdata, rr3->bulk_in_buf, len);623 rr3->bytes_read = len;624 dev_dbg(rr3->dev, "bytes_read %d, pktlen %d\n",625 rr3->bytes_read, pktlen);626 break;627 628 default:629 dev_dbg(rr3->dev, "ignoring packet with type 0x%02x, len of %d, 0x%02x\n",630 pkttype, len, pktlen);631 break;632 }633}634 635static void redrat3_read_packet_continue(struct redrat3_dev *rr3, unsigned len)636{637 void *irdata = &rr3->irdata;638 639 if (len + rr3->bytes_read > sizeof(rr3->irdata)) {640 dev_warn(rr3->dev, "too much data for packet\n");641 rr3->bytes_read = 0;642 return;643 }644 645 memcpy(irdata + rr3->bytes_read, rr3->bulk_in_buf, len);646 647 rr3->bytes_read += len;648 dev_dbg(rr3->dev, "bytes_read %d, pktlen %d\n", rr3->bytes_read,649 be16_to_cpu(rr3->irdata.header.length));650}651 652/* gather IR data from incoming urb, process it when we have enough */653static int redrat3_get_ir_data(struct redrat3_dev *rr3, unsigned len)654{655 struct device *dev = rr3->dev;656 unsigned pkttype;657 int ret = 0;658 659 if (rr3->bytes_read == 0 && len >= sizeof(struct redrat3_header)) {660 redrat3_read_packet_start(rr3, len);661 } else if (rr3->bytes_read != 0) {662 redrat3_read_packet_continue(rr3, len);663 } else if (rr3->bytes_read == 0) {664 dev_err(dev, "error: no packet data read\n");665 ret = -ENODATA;666 goto out;667 }668 669 if (rr3->bytes_read < be16_to_cpu(rr3->irdata.header.length) +670 sizeof(struct redrat3_header))671 /* we're still accumulating data */672 return 0;673 674 /* if we get here, we've got IR data to decode */675 pkttype = be16_to_cpu(rr3->irdata.header.transfer_type);676 if (pkttype == RR3_MOD_SIGNAL_IN)677 redrat3_process_ir_data(rr3);678 else679 dev_dbg(dev, "discarding non-signal data packet (type 0x%02x)\n",680 pkttype);681 682out:683 rr3->bytes_read = 0;684 return ret;685}686 687/* callback function from USB when async USB request has completed */688static void redrat3_handle_async(struct urb *urb)689{690 struct redrat3_dev *rr3 = urb->context;691 int ret;692 693 switch (urb->status) {694 case 0:695 ret = redrat3_get_ir_data(rr3, urb->actual_length);696 if (!ret && rr3->wideband && !rr3->learn_urb->hcpriv) {697 ret = usb_submit_urb(rr3->learn_urb, GFP_ATOMIC);698 if (ret)699 dev_err(rr3->dev, "Failed to submit learning urb: %d",700 ret);701 }702 703 if (!ret) {704 /* no error, prepare to read more */705 ret = usb_submit_urb(urb, GFP_ATOMIC);706 if (ret)707 dev_err(rr3->dev, "Failed to resubmit urb: %d",708 ret);709 }710 break;711 712 case -ECONNRESET:713 case -ENOENT:714 case -ESHUTDOWN:715 usb_unlink_urb(urb);716 return;717 718 case -EPIPE:719 default:720 dev_warn(rr3->dev, "Error: urb status = %d\n", urb->status);721 rr3->bytes_read = 0;722 break;723 }724}725 726static u16 mod_freq_to_val(unsigned int mod_freq)727{728 int mult = 6000000;729 730 /* Clk used in mod. freq. generation is CLK24/4. */731 return 65536 - (mult / mod_freq);732}733 734static int redrat3_set_tx_carrier(struct rc_dev *rcdev, u32 carrier)735{736 struct redrat3_dev *rr3 = rcdev->priv;737 struct device *dev = rr3->dev;738 739 dev_dbg(dev, "Setting modulation frequency to %u", carrier);740 if (carrier == 0)741 return -EINVAL;742 743 rr3->carrier = carrier;744 745 return 0;746}747 748static int redrat3_transmit_ir(struct rc_dev *rcdev, unsigned *txbuf,749 unsigned count)750{751 struct redrat3_dev *rr3 = rcdev->priv;752 struct device *dev = rr3->dev;753 struct redrat3_irdata *irdata = NULL;754 int ret, ret_len;755 int lencheck, cur_sample_len, pipe;756 int *sample_lens = NULL;757 u8 curlencheck = 0;758 unsigned i, sendbuf_len;759 760 if (rr3->transmitting) {761 dev_warn(dev, "%s: transmitter already in use\n", __func__);762 return -EAGAIN;763 }764 765 if (count > RR3_MAX_SIG_SIZE - RR3_TX_TRAILER_LEN)766 return -EINVAL;767 768 /* rr3 will disable rc detector on transmit */769 rr3->transmitting = true;770 771 sample_lens = kcalloc(RR3_DRIVER_MAXLENS,772 sizeof(*sample_lens),773 GFP_KERNEL);774 if (!sample_lens)775 return -ENOMEM;776 777 irdata = kzalloc(sizeof(*irdata), GFP_KERNEL);778 if (!irdata) {779 ret = -ENOMEM;780 goto out;781 }782 783 for (i = 0; i < count; i++) {784 cur_sample_len = redrat3_us_to_len(txbuf[i]);785 if (cur_sample_len > 0xffff) {786 dev_warn(dev, "transmit period of %uus truncated to %uus\n",787 txbuf[i], redrat3_len_to_us(0xffff));788 cur_sample_len = 0xffff;789 }790 for (lencheck = 0; lencheck < curlencheck; lencheck++) {791 if (sample_lens[lencheck] == cur_sample_len)792 break;793 }794 if (lencheck == curlencheck) {795 dev_dbg(dev, "txbuf[%d]=%u, pos %d, enc %u\n",796 i, txbuf[i], curlencheck, cur_sample_len);797 if (curlencheck < RR3_DRIVER_MAXLENS) {798 /* now convert the value to a proper799 * rr3 value.. */800 sample_lens[curlencheck] = cur_sample_len;801 put_unaligned_be16(cur_sample_len,802 &irdata->lens[curlencheck]);803 curlencheck++;804 } else {805 ret = -EINVAL;806 goto out;807 }808 }809 irdata->sigdata[i] = lencheck;810 }811 812 irdata->sigdata[count] = RR3_END_OF_SIGNAL;813 irdata->sigdata[count + 1] = RR3_END_OF_SIGNAL;814 815 sendbuf_len = offsetof(struct redrat3_irdata,816 sigdata[count + RR3_TX_TRAILER_LEN]);817 /* fill in our packet header */818 irdata->header.length = cpu_to_be16(sendbuf_len -819 sizeof(struct redrat3_header));820 irdata->header.transfer_type = cpu_to_be16(RR3_MOD_SIGNAL_OUT);821 irdata->pause = cpu_to_be32(redrat3_len_to_us(100));822 irdata->mod_freq_count = cpu_to_be16(mod_freq_to_val(rr3->carrier));823 irdata->no_lengths = curlencheck;824 irdata->sig_size = cpu_to_be16(count + RR3_TX_TRAILER_LEN);825 826 pipe = usb_sndbulkpipe(rr3->udev, rr3->ep_out->bEndpointAddress);827 ret = usb_bulk_msg(rr3->udev, pipe, irdata,828 sendbuf_len, &ret_len, 10000);829 dev_dbg(dev, "sent %d bytes, (ret %d)\n", ret_len, ret);830 831 /* now tell the hardware to transmit what we sent it */832 pipe = usb_rcvctrlpipe(rr3->udev, 0);833 ret = usb_control_msg(rr3->udev, pipe, RR3_TX_SEND_SIGNAL,834 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,835 0, 0, irdata, 2, 10000);836 837 if (ret < 0)838 dev_err(dev, "Error: control msg send failed, rc %d\n", ret);839 else840 ret = count;841 842out:843 kfree(irdata);844 kfree(sample_lens);845 846 rr3->transmitting = false;847 /* rr3 re-enables rc detector because it was enabled before */848 849 return ret;850}851 852static void redrat3_brightness_set(struct led_classdev *led_dev, enum853 led_brightness brightness)854{855 struct redrat3_dev *rr3 = container_of(led_dev, struct redrat3_dev,856 led);857 858 if (brightness != LED_OFF && atomic_cmpxchg(&rr3->flash, 0, 1) == 0) {859 int ret = usb_submit_urb(rr3->flash_urb, GFP_ATOMIC);860 if (ret != 0) {861 dev_dbg(rr3->dev, "%s: unexpected ret of %d\n",862 __func__, ret);863 atomic_set(&rr3->flash, 0);864 }865 }866}867 868static int redrat3_wideband_receiver(struct rc_dev *rcdev, int enable)869{870 struct redrat3_dev *rr3 = rcdev->priv;871 int ret = 0;872 873 rr3->wideband = enable != 0;874 875 if (enable) {876 ret = usb_submit_urb(rr3->learn_urb, GFP_KERNEL);877 if (ret)878 dev_err(rr3->dev, "Failed to submit learning urb: %d",879 ret);880 }881 882 return ret;883}884 885static void redrat3_learn_complete(struct urb *urb)886{887 struct redrat3_dev *rr3 = urb->context;888 889 switch (urb->status) {890 case 0:891 break;892 case -ECONNRESET:893 case -ENOENT:894 case -ESHUTDOWN:895 usb_unlink_urb(urb);896 return;897 case -EPIPE:898 default:899 dev_err(rr3->dev, "Error: learn urb status = %d", urb->status);900 break;901 }902}903 904static void redrat3_led_complete(struct urb *urb)905{906 struct redrat3_dev *rr3 = urb->context;907 908 switch (urb->status) {909 case 0:910 break;911 case -ECONNRESET:912 case -ENOENT:913 case -ESHUTDOWN:914 usb_unlink_urb(urb);915 return;916 case -EPIPE:917 default:918 dev_dbg(rr3->dev, "Error: urb status = %d\n", urb->status);919 break;920 }921 922 rr3->led.brightness = LED_OFF;923 atomic_dec(&rr3->flash);924}925 926static struct rc_dev *redrat3_init_rc_dev(struct redrat3_dev *rr3)927{928 struct device *dev = rr3->dev;929 struct rc_dev *rc;930 int ret;931 u16 prod = le16_to_cpu(rr3->udev->descriptor.idProduct);932 933 rc = rc_allocate_device(RC_DRIVER_IR_RAW);934 if (!rc)935 return NULL;936 937 snprintf(rr3->name, sizeof(rr3->name),938 "RedRat3%s Infrared Remote Transceiver",939 prod == USB_RR3IIUSB_PRODUCT_ID ? "-II" : "");940 941 usb_make_path(rr3->udev, rr3->phys, sizeof(rr3->phys));942 943 rc->device_name = rr3->name;944 rc->input_phys = rr3->phys;945 usb_to_input_id(rr3->udev, &rc->input_id);946 rc->dev.parent = dev;947 rc->priv = rr3;948 rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;949 rc->min_timeout = MS_TO_US(RR3_RX_MIN_TIMEOUT);950 rc->max_timeout = MS_TO_US(RR3_RX_MAX_TIMEOUT);951 rc->timeout = redrat3_get_timeout(rr3);952 rc->s_timeout = redrat3_set_timeout;953 rc->tx_ir = redrat3_transmit_ir;954 rc->s_tx_carrier = redrat3_set_tx_carrier;955 rc->s_carrier_report = redrat3_wideband_receiver;956 rc->driver_name = DRIVER_NAME;957 rc->rx_resolution = 2;958 rc->map_name = RC_MAP_HAUPPAUGE;959 960 ret = rc_register_device(rc);961 if (ret < 0) {962 dev_err(dev, "remote dev registration failed\n");963 goto out;964 }965 966 return rc;967 968out:969 rc_free_device(rc);970 return NULL;971}972 973static int redrat3_dev_probe(struct usb_interface *intf,974 const struct usb_device_id *id)975{976 struct usb_device *udev = interface_to_usbdev(intf);977 struct device *dev = &intf->dev;978 struct usb_host_interface *uhi;979 struct redrat3_dev *rr3;980 struct usb_endpoint_descriptor *ep;981 struct usb_endpoint_descriptor *ep_narrow = NULL;982 struct usb_endpoint_descriptor *ep_wide = NULL;983 struct usb_endpoint_descriptor *ep_out = NULL;984 u8 addr, attrs;985 int pipe, i;986 int retval = -ENOMEM;987 988 uhi = intf->cur_altsetting;989 990 /* find our bulk-in and bulk-out endpoints */991 for (i = 0; i < uhi->desc.bNumEndpoints; ++i) {992 ep = &uhi->endpoint[i].desc;993 addr = ep->bEndpointAddress;994 attrs = ep->bmAttributes;995 996 if (((addr & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&997 ((attrs & USB_ENDPOINT_XFERTYPE_MASK) ==998 USB_ENDPOINT_XFER_BULK)) {999 dev_dbg(dev, "found bulk-in endpoint at 0x%02x\n",1000 ep->bEndpointAddress);1001 /* data comes in on 0x82, 0x81 is for learning */1002 if (ep->bEndpointAddress == RR3_NARROW_IN_EP_ADDR)1003 ep_narrow = ep;1004 if (ep->bEndpointAddress == RR3_WIDE_IN_EP_ADDR)1005 ep_wide = ep;1006 }1007 1008 if ((ep_out == NULL) &&1009 ((addr & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&1010 ((attrs & USB_ENDPOINT_XFERTYPE_MASK) ==1011 USB_ENDPOINT_XFER_BULK)) {1012 dev_dbg(dev, "found bulk-out endpoint at 0x%02x\n",1013 ep->bEndpointAddress);1014 ep_out = ep;1015 }1016 }1017 1018 if (!ep_narrow || !ep_out || !ep_wide) {1019 dev_err(dev, "Couldn't find all endpoints\n");1020 retval = -ENODEV;1021 goto no_endpoints;1022 }1023 1024 /* allocate memory for our device state and initialize it */1025 rr3 = kzalloc(sizeof(*rr3), GFP_KERNEL);1026 if (!rr3)1027 goto no_endpoints;1028 1029 rr3->dev = &intf->dev;1030 rr3->ep_narrow = ep_narrow;1031 rr3->ep_out = ep_out;1032 rr3->udev = udev;1033 1034 /* set up bulk-in endpoint */1035 rr3->narrow_urb = usb_alloc_urb(0, GFP_KERNEL);1036 if (!rr3->narrow_urb)1037 goto redrat_free;1038 1039 rr3->wide_urb = usb_alloc_urb(0, GFP_KERNEL);1040 if (!rr3->wide_urb)1041 goto redrat_free;1042 1043 rr3->bulk_in_buf = usb_alloc_coherent(udev,1044 le16_to_cpu(ep_narrow->wMaxPacketSize),1045 GFP_KERNEL, &rr3->dma_in);1046 if (!rr3->bulk_in_buf)1047 goto redrat_free;1048 1049 pipe = usb_rcvbulkpipe(udev, ep_narrow->bEndpointAddress);1050 usb_fill_bulk_urb(rr3->narrow_urb, udev, pipe, rr3->bulk_in_buf,1051 le16_to_cpu(ep_narrow->wMaxPacketSize),1052 redrat3_handle_async, rr3);1053 rr3->narrow_urb->transfer_dma = rr3->dma_in;1054 rr3->narrow_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;1055 1056 pipe = usb_rcvbulkpipe(udev, ep_wide->bEndpointAddress);1057 usb_fill_bulk_urb(rr3->wide_urb, udev, pipe, rr3->bulk_in_buf,1058 le16_to_cpu(ep_narrow->wMaxPacketSize),1059 redrat3_handle_async, rr3);1060 rr3->wide_urb->transfer_dma = rr3->dma_in;1061 rr3->wide_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;1062 1063 redrat3_reset(rr3);1064 redrat3_get_firmware_rev(rr3);1065 1066 /* default.. will get overridden by any sends with a freq defined */1067 rr3->carrier = 38000;1068 1069 atomic_set(&rr3->flash, 0);1070 rr3->flash_urb = usb_alloc_urb(0, GFP_KERNEL);1071 if (!rr3->flash_urb)1072 goto redrat_free;1073 1074 /* learn urb */1075 rr3->learn_urb = usb_alloc_urb(0, GFP_KERNEL);1076 if (!rr3->learn_urb)1077 goto redrat_free;1078 1079 /* setup packet is 'c0 b2 0000 0000 0001' */1080 rr3->learn_control.bRequestType = 0xc0;1081 rr3->learn_control.bRequest = RR3_MODSIG_CAPTURE;1082 rr3->learn_control.wLength = cpu_to_le16(1);1083 1084 usb_fill_control_urb(rr3->learn_urb, udev, usb_rcvctrlpipe(udev, 0),1085 (unsigned char *)&rr3->learn_control,1086 &rr3->learn_buf, sizeof(rr3->learn_buf),1087 redrat3_learn_complete, rr3);1088 1089 /* setup packet is 'c0 b9 0000 0000 0001' */1090 rr3->flash_control.bRequestType = 0xc0;1091 rr3->flash_control.bRequest = RR3_BLINK_LED;1092 rr3->flash_control.wLength = cpu_to_le16(1);1093 1094 usb_fill_control_urb(rr3->flash_urb, udev, usb_rcvctrlpipe(udev, 0),1095 (unsigned char *)&rr3->flash_control,1096 &rr3->flash_in_buf, sizeof(rr3->flash_in_buf),1097 redrat3_led_complete, rr3);1098 1099 /* led control */1100 rr3->led.name = "redrat3:red:feedback";1101 rr3->led.default_trigger = "rc-feedback";1102 rr3->led.brightness_set = redrat3_brightness_set;1103 retval = led_classdev_register(&intf->dev, &rr3->led);1104 if (retval)1105 goto redrat_free;1106 1107 rr3->rc = redrat3_init_rc_dev(rr3);1108 if (!rr3->rc) {1109 retval = -ENOMEM;1110 goto led_free;1111 }1112 1113 /* might be all we need to do? */1114 retval = redrat3_enable_detector(rr3);1115 if (retval < 0)1116 goto led_free;1117 1118 /* we can register the device now, as it is ready */1119 usb_set_intfdata(intf, rr3);1120 1121 return 0;1122 1123led_free:1124 led_classdev_unregister(&rr3->led);1125redrat_free:1126 redrat3_delete(rr3, rr3->udev);1127 1128no_endpoints:1129 return retval;1130}1131 1132static void redrat3_dev_disconnect(struct usb_interface *intf)1133{1134 struct usb_device *udev = interface_to_usbdev(intf);1135 struct redrat3_dev *rr3 = usb_get_intfdata(intf);1136 1137 usb_set_intfdata(intf, NULL);1138 rc_unregister_device(rr3->rc);1139 led_classdev_unregister(&rr3->led);1140 redrat3_delete(rr3, udev);1141}1142 1143static int redrat3_dev_suspend(struct usb_interface *intf, pm_message_t message)1144{1145 struct redrat3_dev *rr3 = usb_get_intfdata(intf);1146 1147 led_classdev_suspend(&rr3->led);1148 usb_kill_urb(rr3->narrow_urb);1149 usb_kill_urb(rr3->wide_urb);1150 usb_kill_urb(rr3->flash_urb);1151 return 0;1152}1153 1154static int redrat3_dev_resume(struct usb_interface *intf)1155{1156 struct redrat3_dev *rr3 = usb_get_intfdata(intf);1157 1158 if (usb_submit_urb(rr3->narrow_urb, GFP_NOIO))1159 return -EIO;1160 if (usb_submit_urb(rr3->wide_urb, GFP_NOIO))1161 return -EIO;1162 led_classdev_resume(&rr3->led);1163 return 0;1164}1165 1166static struct usb_driver redrat3_dev_driver = {1167 .name = DRIVER_NAME,1168 .probe = redrat3_dev_probe,1169 .disconnect = redrat3_dev_disconnect,1170 .suspend = redrat3_dev_suspend,1171 .resume = redrat3_dev_resume,1172 .reset_resume = redrat3_dev_resume,1173 .id_table = redrat3_dev_table1174};1175 1176module_usb_driver(redrat3_dev_driver);1177 1178MODULE_DESCRIPTION(DRIVER_DESC);1179MODULE_AUTHOR(DRIVER_AUTHOR);1180MODULE_AUTHOR(DRIVER_AUTHOR2);1181MODULE_LICENSE("GPL");1182MODULE_DEVICE_TABLE(usb, redrat3_dev_table);1183