media/rc/ttusbir.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * TechnoTrend USB IR Receiver
0004  *
0005  * Copyright (C) 2012 Sean Young <sean@mess.org>
0006  */
0007
0008 #include <linux/module.h>
0009 #include <linux/usb.h>
0010 #include <linux/usb/input.h>
0011 #include <linux/slab.h>
0012 #include <linux/leds.h>
0013 #include <media/rc-core.h>
0014
0015 #define DRIVER_NAME "ttusbir"
0016 #define DRIVER_DESC "TechnoTrend USB IR Receiver"
0017 /*
0018  * The Windows driver uses 8 URBS, the original lirc drivers has a
0019  * configurable amount (2 default, 4 max). This device generates about 125
0020  * messages per second (!), whether IR is idle or not.
0021  */
0022 #define NUM_URBS    4
0023 #define US_PER_BYTE 62
0024 #define US_PER_BIT  (US_PER_BYTE / 8)
0025
0026 struct ttusbir {
0027     struct rc_dev *rc;
0028     struct device *dev;
0029     struct usb_device *udev;
0030
0031     struct urb *urb[NUM_URBS];
0032
0033     struct led_classdev led;
0034     struct urb *bulk_urb;
0035     uint8_t bulk_buffer[5];
0036     int bulk_out_endp, iso_in_endp;
0037     bool led_on, is_led_on;
0038     atomic_t led_complete;
0039
0040     char phys[64];
0041 };
0042
0043 static enum led_brightness ttusbir_brightness_get(struct led_classdev *led_dev)
0044 {
0045     struct ttusbir *tt = container_of(led_dev, struct ttusbir, led);
0046
0047     return tt->led_on ? LED_FULL : LED_OFF;
0048 }
0049
0050 static void ttusbir_set_led(struct ttusbir *tt)
0051 {
0052     int ret;
0053
0054     smp_mb();
0055
0056     if (tt->led_on != tt->is_led_on && tt->udev &&
0057                 atomic_add_unless(&tt->led_complete, 1, 1)) {
0058         tt->bulk_buffer[4] = tt->is_led_on = tt->led_on;
0059         ret = usb_submit_urb(tt->bulk_urb, GFP_ATOMIC);
0060         if (ret) {
0061             dev_warn(tt->dev, "failed to submit bulk urb: %d\n",
0062                                     ret);
0063             atomic_dec(&tt->led_complete);
0064         }
0065     }
0066 }
0067
0068 static void ttusbir_brightness_set(struct led_classdev *led_dev, enum
0069                         led_brightness brightness)
0070 {
0071     struct ttusbir *tt = container_of(led_dev, struct ttusbir, led);
0072
0073     tt->led_on = brightness != LED_OFF;
0074
0075     ttusbir_set_led(tt);
0076 }
0077
0078 /*
0079  * The urb cannot be reused until the urb completes
0080  */
0081 static void ttusbir_bulk_complete(struct urb *urb)
0082 {
0083     struct ttusbir *tt = urb->context;
0084
0085     atomic_dec(&tt->led_complete);
0086
0087     switch (urb->status) {
0088     case 0:
0089         break;
0090     case -ECONNRESET:
0091     case -ENOENT:
0092     case -ESHUTDOWN:
0093         return;
0094     case -EPIPE:
0095     default:
0096         dev_dbg(tt->dev, "Error: urb status = %d\n", urb->status);
0097         break;
0098     }
0099
0100     ttusbir_set_led(tt);
0101 }
0102
0103 /*
0104  * The data is one bit per sample, a set bit signifying silence and samples
0105  * being MSB first. Bit 0 can contain garbage so take it to be whatever
0106  * bit 1 is, so we don't have unexpected edges.
0107  */
0108 static void ttusbir_process_ir_data(struct ttusbir *tt, uint8_t *buf)
0109 {
0110     struct ir_raw_event rawir = {};
0111     unsigned i, v, b;
0112     bool event = false;
0113
0114     for (i = 0; i < 128; i++) {
0115         v = buf[i] & 0xfe;
0116         switch (v) {
0117         case 0xfe:
0118             rawir.pulse = false;
0119             rawir.duration = US_PER_BYTE;
0120             if (ir_raw_event_store_with_filter(tt->rc, &rawir))
0121                 event = true;
0122             break;
0123         case 0:
0124             rawir.pulse = true;
0125             rawir.duration = US_PER_BYTE;
0126             if (ir_raw_event_store_with_filter(tt->rc, &rawir))
0127                 event = true;
0128             break;
0129         default:
0130             /* one edge per byte */
0131             if (v & 2) {
0132                 b = ffz(v | 1);
0133                 rawir.pulse = true;
0134             } else {
0135                 b = ffs(v) - 1;
0136                 rawir.pulse = false;
0137             }
0138
0139             rawir.duration = US_PER_BIT * (8 - b);
0140             if (ir_raw_event_store_with_filter(tt->rc, &rawir))
0141                 event = true;
0142
0143             rawir.pulse = !rawir.pulse;
0144             rawir.duration = US_PER_BIT * b;
0145             if (ir_raw_event_store_with_filter(tt->rc, &rawir))
0146                 event = true;
0147             break;
0148         }
0149     }
0150
0151     /* don't wakeup when there's nothing to do */
0152     if (event)
0153         ir_raw_event_handle(tt->rc);
0154 }
0155
0156 static void ttusbir_urb_complete(struct urb *urb)
0157 {
0158     struct ttusbir *tt = urb->context;
0159     int rc;
0160
0161     switch (urb->status) {
0162     case 0:
0163         ttusbir_process_ir_data(tt, urb->transfer_buffer);
0164         break;
0165     case -ECONNRESET:
0166     case -ENOENT:
0167     case -ESHUTDOWN:
0168         return;
0169     case -EPIPE:
0170     default:
0171         dev_dbg(tt->dev, "Error: urb status = %d\n", urb->status);
0172         break;
0173     }
0174
0175     rc = usb_submit_urb(urb, GFP_ATOMIC);
0176     if (rc && rc != -ENODEV)
0177         dev_warn(tt->dev, "failed to resubmit urb: %d\n", rc);
0178 }
0179
0180 static int ttusbir_probe(struct usb_interface *intf,
0181              const struct usb_device_id *id)
0182 {
0183     struct ttusbir *tt;
0184     struct usb_interface_descriptor *idesc;
0185     struct usb_endpoint_descriptor *desc;
0186     struct rc_dev *rc;
0187     int i, j, ret;
0188     int altsetting = -1;
0189
0190     tt = kzalloc(sizeof(*tt), GFP_KERNEL);
0191     rc = rc_allocate_device(RC_DRIVER_IR_RAW);
0192     if (!tt || !rc) {
0193         ret = -ENOMEM;
0194         goto out;
0195     }
0196
0197     /* find the correct alt setting */
0198     for (i = 0; i < intf->num_altsetting && altsetting == -1; i++) {
0199         int max_packet, bulk_out_endp = -1, iso_in_endp = -1;
0200
0201         idesc = &intf->altsetting[i].desc;
0202
0203         for (j = 0; j < idesc->bNumEndpoints; j++) {
0204             desc = &intf->altsetting[i].endpoint[j].desc;
0205             max_packet = le16_to_cpu(desc->wMaxPacketSize);
0206             if (usb_endpoint_dir_in(desc) &&
0207                     usb_endpoint_xfer_isoc(desc) &&
0208                     max_packet == 0x10)
0209                 iso_in_endp = j;
0210             else if (usb_endpoint_dir_out(desc) &&
0211                     usb_endpoint_xfer_bulk(desc) &&
0212                     max_packet == 0x20)
0213                 bulk_out_endp = j;
0214
0215             if (bulk_out_endp != -1 && iso_in_endp != -1) {
0216                 tt->bulk_out_endp = bulk_out_endp;
0217                 tt->iso_in_endp = iso_in_endp;
0218                 altsetting = i;
0219                 break;
0220             }
0221         }
0222     }
0223
0224     if (altsetting == -1) {
0225         dev_err(&intf->dev, "cannot find expected altsetting\n");
0226         ret = -ENODEV;
0227         goto out;
0228     }
0229
0230     tt->dev = &intf->dev;
0231     tt->udev = interface_to_usbdev(intf);
0232     tt->rc = rc;
0233
0234     ret = usb_set_interface(tt->udev, 0, altsetting);
0235     if (ret)
0236         goto out;
0237
0238     for (i = 0; i < NUM_URBS; i++) {
0239         struct urb *urb = usb_alloc_urb(8, GFP_KERNEL);
0240         void *buffer;
0241
0242         if (!urb) {
0243             ret = -ENOMEM;
0244             goto out;
0245         }
0246
0247         urb->dev = tt->udev;
0248         urb->context = tt;
0249         urb->pipe = usb_rcvisocpipe(tt->udev, tt->iso_in_endp);
0250         urb->interval = 1;
0251         buffer = usb_alloc_coherent(tt->udev, 128, GFP_KERNEL,
0252                         &urb->transfer_dma);
0253         if (!buffer) {
0254             usb_free_urb(urb);
0255             ret = -ENOMEM;
0256             goto out;
0257         }
0258         urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP | URB_ISO_ASAP;
0259         urb->transfer_buffer = buffer;
0260         urb->complete = ttusbir_urb_complete;
0261         urb->number_of_packets = 8;
0262         urb->transfer_buffer_length = 128;
0263
0264         for (j = 0; j < 8; j++) {
0265             urb->iso_frame_desc[j].offset = j * 16;
0266             urb->iso_frame_desc[j].length = 16;
0267         }
0268
0269         tt->urb[i] = urb;
0270     }
0271
0272     tt->bulk_urb = usb_alloc_urb(0, GFP_KERNEL);
0273     if (!tt->bulk_urb) {
0274         ret = -ENOMEM;
0275         goto out;
0276     }
0277
0278     tt->bulk_buffer[0] = 0xaa;
0279     tt->bulk_buffer[1] = 0x01;
0280     tt->bulk_buffer[2] = 0x05;
0281     tt->bulk_buffer[3] = 0x01;
0282
0283     usb_fill_bulk_urb(tt->bulk_urb, tt->udev, usb_sndbulkpipe(tt->udev,
0284         tt->bulk_out_endp), tt->bulk_buffer, sizeof(tt->bulk_buffer),
0285                         ttusbir_bulk_complete, tt);
0286
0287     tt->led.name = "ttusbir:green:power";
0288     tt->led.default_trigger = "rc-feedback";
0289     tt->led.brightness_set = ttusbir_brightness_set;
0290     tt->led.brightness_get = ttusbir_brightness_get;
0291     tt->is_led_on = tt->led_on = true;
0292     atomic_set(&tt->led_complete, 0);
0293     ret = led_classdev_register(&intf->dev, &tt->led);
0294     if (ret)
0295         goto out;
0296
0297     usb_make_path(tt->udev, tt->phys, sizeof(tt->phys));
0298
0299     rc->device_name = DRIVER_DESC;
0300     rc->input_phys = tt->phys;
0301     usb_to_input_id(tt->udev, &rc->input_id);
0302     rc->dev.parent = &intf->dev;
0303     rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
0304     rc->priv = tt;
0305     rc->driver_name = DRIVER_NAME;
0306     rc->map_name = RC_MAP_TT_1500;
0307     rc->min_timeout = 1;
0308     rc->timeout = IR_DEFAULT_TIMEOUT;
0309     rc->max_timeout = 10 * IR_DEFAULT_TIMEOUT;
0310
0311     /*
0312      * The precision is US_PER_BIT, but since every 8th bit can be
0313      * overwritten with garbage the accuracy is at best 2 * US_PER_BIT.
0314      */
0315     rc->rx_resolution = 2 * US_PER_BIT;
0316
0317     ret = rc_register_device(rc);
0318     if (ret) {
0319         dev_err(&intf->dev, "failed to register rc device %d\n", ret);
0320         goto out2;
0321     }
0322
0323     usb_set_intfdata(intf, tt);
0324
0325     for (i = 0; i < NUM_URBS; i++) {
0326         ret = usb_submit_urb(tt->urb[i], GFP_KERNEL);
0327         if (ret) {
0328             dev_err(tt->dev, "failed to submit urb %d\n", ret);
0329             goto out3;
0330         }
0331     }
0332
0333     return 0;
0334 out3:
0335     rc_unregister_device(rc);
0336     rc = NULL;
0337 out2:
0338     led_classdev_unregister(&tt->led);
0339 out:
0340     if (tt) {
0341         for (i = 0; i < NUM_URBS && tt->urb[i]; i++) {
0342             struct urb *urb = tt->urb[i];
0343
0344             usb_kill_urb(urb);
0345             usb_free_coherent(tt->udev, 128, urb->transfer_buffer,
0346                             urb->transfer_dma);
0347             usb_free_urb(urb);
0348         }
0349         usb_kill_urb(tt->bulk_urb);
0350         usb_free_urb(tt->bulk_urb);
0351         kfree(tt);
0352     }
0353     rc_free_device(rc);
0354
0355     return ret;
0356 }
0357
0358 static void ttusbir_disconnect(struct usb_interface *intf)
0359 {
0360     struct ttusbir *tt = usb_get_intfdata(intf);
0361     struct usb_device *udev = tt->udev;
0362     int i;
0363
0364     tt->udev = NULL;
0365
0366     rc_unregister_device(tt->rc);
0367     led_classdev_unregister(&tt->led);
0368     for (i = 0; i < NUM_URBS; i++) {
0369         usb_kill_urb(tt->urb[i]);
0370         usb_free_coherent(udev, 128, tt->urb[i]->transfer_buffer,
0371                         tt->urb[i]->transfer_dma);
0372         usb_free_urb(tt->urb[i]);
0373     }
0374     usb_kill_urb(tt->bulk_urb);
0375     usb_free_urb(tt->bulk_urb);
0376     usb_set_intfdata(intf, NULL);
0377     kfree(tt);
0378 }
0379
0380 static int ttusbir_suspend(struct usb_interface *intf, pm_message_t message)
0381 {
0382     struct ttusbir *tt = usb_get_intfdata(intf);
0383     int i;
0384
0385     for (i = 0; i < NUM_URBS; i++)
0386         usb_kill_urb(tt->urb[i]);
0387
0388     led_classdev_suspend(&tt->led);
0389     usb_kill_urb(tt->bulk_urb);
0390
0391     return 0;
0392 }
0393
0394 static int ttusbir_resume(struct usb_interface *intf)
0395 {
0396     struct ttusbir *tt = usb_get_intfdata(intf);
0397     int i, rc;
0398
0399     tt->is_led_on = true;
0400     led_classdev_resume(&tt->led);
0401
0402     for (i = 0; i < NUM_URBS; i++) {
0403         rc = usb_submit_urb(tt->urb[i], GFP_NOIO);
0404         if (rc) {
0405             dev_warn(tt->dev, "failed to submit urb: %d\n", rc);
0406             break;
0407         }
0408     }
0409
0410     return rc;
0411 }
0412
0413 static const struct usb_device_id ttusbir_table[] = {
0414     { USB_DEVICE(0x0b48, 0x2003) },
0415     { }
0416 };
0417
0418 static struct usb_driver ttusbir_driver = {
0419     .name = DRIVER_NAME,
0420     .id_table = ttusbir_table,
0421     .probe = ttusbir_probe,
0422     .suspend = ttusbir_suspend,
0423     .resume = ttusbir_resume,
0424     .reset_resume = ttusbir_resume,
0425     .disconnect = ttusbir_disconnect,
0426 };
0427
0428 module_usb_driver(ttusbir_driver);
0429
0430 MODULE_DESCRIPTION(DRIVER_DESC);
0431 MODULE_AUTHOR("Sean Young <sean@mess.org>");
0432 MODULE_LICENSE("GPL");
0433 MODULE_DEVICE_TABLE(usb, ttusbir_table);
0434