Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0
0002 /*
0003  * Driver for Meywa-Denki & KAYAC YUREX
0004  *
0005  * Copyright (C) 2010 Tomoki Sekiyama (tomoki.sekiyama@gmail.com)
0006  */
0007 
0008 #include <linux/kernel.h>
0009 #include <linux/errno.h>
0010 #include <linux/slab.h>
0011 #include <linux/module.h>
0012 #include <linux/kref.h>
0013 #include <linux/mutex.h>
0014 #include <linux/uaccess.h>
0015 #include <linux/usb.h>
0016 #include <linux/hid.h>
0017 
0018 #define DRIVER_AUTHOR "Tomoki Sekiyama"
0019 #define DRIVER_DESC "Driver for Meywa-Denki & KAYAC YUREX"
0020 
0021 #define YUREX_VENDOR_ID     0x0c45
0022 #define YUREX_PRODUCT_ID    0x1010
0023 
0024 #define CMD_ACK     '!'
0025 #define CMD_ANIMATE 'A'
0026 #define CMD_COUNT   'C'
0027 #define CMD_LED     'L'
0028 #define CMD_READ    'R'
0029 #define CMD_SET     'S'
0030 #define CMD_VERSION 'V'
0031 #define CMD_EOF     0x0d
0032 #define CMD_PADDING 0xff
0033 
0034 #define YUREX_BUF_SIZE      8
0035 #define YUREX_WRITE_TIMEOUT (HZ*2)
0036 
0037 /* table of devices that work with this driver */
0038 static struct usb_device_id yurex_table[] = {
0039     { USB_DEVICE(YUREX_VENDOR_ID, YUREX_PRODUCT_ID) },
0040     { }                 /* Terminating entry */
0041 };
0042 MODULE_DEVICE_TABLE(usb, yurex_table);
0043 
0044 #ifdef CONFIG_USB_DYNAMIC_MINORS
0045 #define YUREX_MINOR_BASE    0
0046 #else
0047 #define YUREX_MINOR_BASE    192
0048 #endif
0049 
0050 /* Structure to hold all of our device specific stuff */
0051 struct usb_yurex {
0052     struct usb_device   *udev;
0053     struct usb_interface    *interface;
0054     __u8            int_in_endpointAddr;
0055     struct urb      *urb;       /* URB for interrupt in */
0056     unsigned char           *int_buffer;    /* buffer for intterupt in */
0057     struct urb      *cntl_urb;  /* URB for control msg */
0058     struct usb_ctrlrequest  *cntl_req;  /* req for control msg */
0059     unsigned char       *cntl_buffer;   /* buffer for control msg */
0060 
0061     struct kref     kref;
0062     struct mutex        io_mutex;
0063     unsigned long       disconnected:1;
0064     struct fasync_struct    *async_queue;
0065     wait_queue_head_t   waitq;
0066 
0067     spinlock_t      lock;
0068     __s64           bbu;        /* BBU from device */
0069 };
0070 #define to_yurex_dev(d) container_of(d, struct usb_yurex, kref)
0071 
0072 static struct usb_driver yurex_driver;
0073 static const struct file_operations yurex_fops;
0074 
0075 
0076 static void yurex_control_callback(struct urb *urb)
0077 {
0078     struct usb_yurex *dev = urb->context;
0079     int status = urb->status;
0080 
0081     if (status) {
0082         dev_err(&urb->dev->dev, "%s - control failed: %d\n",
0083             __func__, status);
0084         wake_up_interruptible(&dev->waitq);
0085         return;
0086     }
0087     /* on success, sender woken up by CMD_ACK int in, or timeout */
0088 }
0089 
0090 static void yurex_delete(struct kref *kref)
0091 {
0092     struct usb_yurex *dev = to_yurex_dev(kref);
0093 
0094     dev_dbg(&dev->interface->dev, "%s\n", __func__);
0095 
0096     if (dev->cntl_urb) {
0097         usb_kill_urb(dev->cntl_urb);
0098         kfree(dev->cntl_req);
0099         usb_free_coherent(dev->udev, YUREX_BUF_SIZE,
0100                 dev->cntl_buffer, dev->cntl_urb->transfer_dma);
0101         usb_free_urb(dev->cntl_urb);
0102     }
0103     if (dev->urb) {
0104         usb_kill_urb(dev->urb);
0105         usb_free_coherent(dev->udev, YUREX_BUF_SIZE,
0106                 dev->int_buffer, dev->urb->transfer_dma);
0107         usb_free_urb(dev->urb);
0108     }
0109     usb_put_intf(dev->interface);
0110     usb_put_dev(dev->udev);
0111     kfree(dev);
0112 }
0113 
0114 /*
0115  * usb class driver info in order to get a minor number from the usb core,
0116  * and to have the device registered with the driver core
0117  */
0118 static struct usb_class_driver yurex_class = {
0119     .name =     "yurex%d",
0120     .fops =     &yurex_fops,
0121     .minor_base =   YUREX_MINOR_BASE,
0122 };
0123 
0124 static void yurex_interrupt(struct urb *urb)
0125 {
0126     struct usb_yurex *dev = urb->context;
0127     unsigned char *buf = dev->int_buffer;
0128     int status = urb->status;
0129     unsigned long flags;
0130     int retval, i;
0131 
0132     switch (status) {
0133     case 0: /*success*/
0134         break;
0135     /* The device is terminated or messed up, give up */
0136     case -EOVERFLOW:
0137         dev_err(&dev->interface->dev,
0138             "%s - overflow with length %d, actual length is %d\n",
0139             __func__, YUREX_BUF_SIZE, dev->urb->actual_length);
0140         return;
0141     case -ECONNRESET:
0142     case -ENOENT:
0143     case -ESHUTDOWN:
0144     case -EILSEQ:
0145     case -EPROTO:
0146     case -ETIME:
0147         return;
0148     default:
0149         dev_err(&dev->interface->dev,
0150             "%s - unknown status received: %d\n", __func__, status);
0151         return;
0152     }
0153 
0154     /* handle received message */
0155     switch (buf[0]) {
0156     case CMD_COUNT:
0157     case CMD_READ:
0158         if (buf[6] == CMD_EOF) {
0159             spin_lock_irqsave(&dev->lock, flags);
0160             dev->bbu = 0;
0161             for (i = 1; i < 6; i++) {
0162                 dev->bbu += buf[i];
0163                 if (i != 5)
0164                     dev->bbu <<= 8;
0165             }
0166             dev_dbg(&dev->interface->dev, "%s count: %lld\n",
0167                 __func__, dev->bbu);
0168             spin_unlock_irqrestore(&dev->lock, flags);
0169 
0170             kill_fasync(&dev->async_queue, SIGIO, POLL_IN);
0171         }
0172         else
0173             dev_dbg(&dev->interface->dev,
0174                 "data format error - no EOF\n");
0175         break;
0176     case CMD_ACK:
0177         dev_dbg(&dev->interface->dev, "%s ack: %c\n",
0178             __func__, buf[1]);
0179         wake_up_interruptible(&dev->waitq);
0180         break;
0181     }
0182 
0183     retval = usb_submit_urb(dev->urb, GFP_ATOMIC);
0184     if (retval) {
0185         dev_err(&dev->interface->dev, "%s - usb_submit_urb failed: %d\n",
0186             __func__, retval);
0187     }
0188 }
0189 
0190 static int yurex_probe(struct usb_interface *interface, const struct usb_device_id *id)
0191 {
0192     struct usb_yurex *dev;
0193     struct usb_host_interface *iface_desc;
0194     struct usb_endpoint_descriptor *endpoint;
0195     int retval = -ENOMEM;
0196     DEFINE_WAIT(wait);
0197     int res;
0198 
0199     /* allocate memory for our device state and initialize it */
0200     dev = kzalloc(sizeof(*dev), GFP_KERNEL);
0201     if (!dev)
0202         goto error;
0203     kref_init(&dev->kref);
0204     mutex_init(&dev->io_mutex);
0205     spin_lock_init(&dev->lock);
0206     init_waitqueue_head(&dev->waitq);
0207 
0208     dev->udev = usb_get_dev(interface_to_usbdev(interface));
0209     dev->interface = usb_get_intf(interface);
0210 
0211     /* set up the endpoint information */
0212     iface_desc = interface->cur_altsetting;
0213     res = usb_find_int_in_endpoint(iface_desc, &endpoint);
0214     if (res) {
0215         dev_err(&interface->dev, "Could not find endpoints\n");
0216         retval = res;
0217         goto error;
0218     }
0219 
0220     dev->int_in_endpointAddr = endpoint->bEndpointAddress;
0221 
0222     /* allocate control URB */
0223     dev->cntl_urb = usb_alloc_urb(0, GFP_KERNEL);
0224     if (!dev->cntl_urb)
0225         goto error;
0226 
0227     /* allocate buffer for control req */
0228     dev->cntl_req = kmalloc(YUREX_BUF_SIZE, GFP_KERNEL);
0229     if (!dev->cntl_req)
0230         goto error;
0231 
0232     /* allocate buffer for control msg */
0233     dev->cntl_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE,
0234                           GFP_KERNEL,
0235                           &dev->cntl_urb->transfer_dma);
0236     if (!dev->cntl_buffer) {
0237         dev_err(&interface->dev, "Could not allocate cntl_buffer\n");
0238         goto error;
0239     }
0240 
0241     /* configure control URB */
0242     dev->cntl_req->bRequestType = USB_DIR_OUT | USB_TYPE_CLASS |
0243                       USB_RECIP_INTERFACE;
0244     dev->cntl_req->bRequest = HID_REQ_SET_REPORT;
0245     dev->cntl_req->wValue   = cpu_to_le16((HID_OUTPUT_REPORT + 1) << 8);
0246     dev->cntl_req->wIndex   = cpu_to_le16(iface_desc->desc.bInterfaceNumber);
0247     dev->cntl_req->wLength  = cpu_to_le16(YUREX_BUF_SIZE);
0248 
0249     usb_fill_control_urb(dev->cntl_urb, dev->udev,
0250                  usb_sndctrlpipe(dev->udev, 0),
0251                  (void *)dev->cntl_req, dev->cntl_buffer,
0252                  YUREX_BUF_SIZE, yurex_control_callback, dev);
0253     dev->cntl_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
0254 
0255 
0256     /* allocate interrupt URB */
0257     dev->urb = usb_alloc_urb(0, GFP_KERNEL);
0258     if (!dev->urb)
0259         goto error;
0260 
0261     /* allocate buffer for interrupt in */
0262     dev->int_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE,
0263                     GFP_KERNEL, &dev->urb->transfer_dma);
0264     if (!dev->int_buffer) {
0265         dev_err(&interface->dev, "Could not allocate int_buffer\n");
0266         goto error;
0267     }
0268 
0269     /* configure interrupt URB */
0270     usb_fill_int_urb(dev->urb, dev->udev,
0271              usb_rcvintpipe(dev->udev, dev->int_in_endpointAddr),
0272              dev->int_buffer, YUREX_BUF_SIZE, yurex_interrupt,
0273              dev, 1);
0274     dev->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
0275     if (usb_submit_urb(dev->urb, GFP_KERNEL)) {
0276         retval = -EIO;
0277         dev_err(&interface->dev, "Could not submitting URB\n");
0278         goto error;
0279     }
0280 
0281     /* save our data pointer in this interface device */
0282     usb_set_intfdata(interface, dev);
0283     dev->bbu = -1;
0284 
0285     /* we can register the device now, as it is ready */
0286     retval = usb_register_dev(interface, &yurex_class);
0287     if (retval) {
0288         dev_err(&interface->dev,
0289             "Not able to get a minor for this device.\n");
0290         usb_set_intfdata(interface, NULL);
0291         goto error;
0292     }
0293 
0294     dev_info(&interface->dev,
0295          "USB YUREX device now attached to Yurex #%d\n",
0296          interface->minor);
0297 
0298     return 0;
0299 
0300 error:
0301     if (dev)
0302         /* this frees allocated memory */
0303         kref_put(&dev->kref, yurex_delete);
0304     return retval;
0305 }
0306 
0307 static void yurex_disconnect(struct usb_interface *interface)
0308 {
0309     struct usb_yurex *dev;
0310     int minor = interface->minor;
0311 
0312     dev = usb_get_intfdata(interface);
0313     usb_set_intfdata(interface, NULL);
0314 
0315     /* give back our minor */
0316     usb_deregister_dev(interface, &yurex_class);
0317 
0318     /* prevent more I/O from starting */
0319     usb_poison_urb(dev->urb);
0320     usb_poison_urb(dev->cntl_urb);
0321     mutex_lock(&dev->io_mutex);
0322     dev->disconnected = 1;
0323     mutex_unlock(&dev->io_mutex);
0324 
0325     /* wakeup waiters */
0326     kill_fasync(&dev->async_queue, SIGIO, POLL_IN);
0327     wake_up_interruptible(&dev->waitq);
0328 
0329     /* decrement our usage count */
0330     kref_put(&dev->kref, yurex_delete);
0331 
0332     dev_info(&interface->dev, "USB YUREX #%d now disconnected\n", minor);
0333 }
0334 
0335 static struct usb_driver yurex_driver = {
0336     .name =     "yurex",
0337     .probe =    yurex_probe,
0338     .disconnect =   yurex_disconnect,
0339     .id_table = yurex_table,
0340 };
0341 
0342 
0343 static int yurex_fasync(int fd, struct file *file, int on)
0344 {
0345     struct usb_yurex *dev;
0346 
0347     dev = file->private_data;
0348     return fasync_helper(fd, file, on, &dev->async_queue);
0349 }
0350 
0351 static int yurex_open(struct inode *inode, struct file *file)
0352 {
0353     struct usb_yurex *dev;
0354     struct usb_interface *interface;
0355     int subminor;
0356     int retval = 0;
0357 
0358     subminor = iminor(inode);
0359 
0360     interface = usb_find_interface(&yurex_driver, subminor);
0361     if (!interface) {
0362         printk(KERN_ERR "%s - error, can't find device for minor %d",
0363                __func__, subminor);
0364         retval = -ENODEV;
0365         goto exit;
0366     }
0367 
0368     dev = usb_get_intfdata(interface);
0369     if (!dev) {
0370         retval = -ENODEV;
0371         goto exit;
0372     }
0373 
0374     /* increment our usage count for the device */
0375     kref_get(&dev->kref);
0376 
0377     /* save our object in the file's private structure */
0378     mutex_lock(&dev->io_mutex);
0379     file->private_data = dev;
0380     mutex_unlock(&dev->io_mutex);
0381 
0382 exit:
0383     return retval;
0384 }
0385 
0386 static int yurex_release(struct inode *inode, struct file *file)
0387 {
0388     struct usb_yurex *dev;
0389 
0390     dev = file->private_data;
0391     if (dev == NULL)
0392         return -ENODEV;
0393 
0394     /* decrement the count on our device */
0395     kref_put(&dev->kref, yurex_delete);
0396     return 0;
0397 }
0398 
0399 static ssize_t yurex_read(struct file *file, char __user *buffer, size_t count,
0400               loff_t *ppos)
0401 {
0402     struct usb_yurex *dev;
0403     int len = 0;
0404     char in_buffer[20];
0405     unsigned long flags;
0406 
0407     dev = file->private_data;
0408 
0409     mutex_lock(&dev->io_mutex);
0410     if (dev->disconnected) {        /* already disconnected */
0411         mutex_unlock(&dev->io_mutex);
0412         return -ENODEV;
0413     }
0414 
0415     spin_lock_irqsave(&dev->lock, flags);
0416     len = snprintf(in_buffer, 20, "%lld\n", dev->bbu);
0417     spin_unlock_irqrestore(&dev->lock, flags);
0418     mutex_unlock(&dev->io_mutex);
0419 
0420     if (WARN_ON_ONCE(len >= sizeof(in_buffer)))
0421         return -EIO;
0422 
0423     return simple_read_from_buffer(buffer, count, ppos, in_buffer, len);
0424 }
0425 
0426 static ssize_t yurex_write(struct file *file, const char __user *user_buffer,
0427                size_t count, loff_t *ppos)
0428 {
0429     struct usb_yurex *dev;
0430     int i, set = 0, retval = 0;
0431     char buffer[16 + 1];
0432     char *data = buffer;
0433     unsigned long long c, c2 = 0;
0434     signed long timeout = 0;
0435     DEFINE_WAIT(wait);
0436 
0437     count = min(sizeof(buffer) - 1, count);
0438     dev = file->private_data;
0439 
0440     /* verify that we actually have some data to write */
0441     if (count == 0)
0442         goto error;
0443 
0444     mutex_lock(&dev->io_mutex);
0445     if (dev->disconnected) {        /* already disconnected */
0446         mutex_unlock(&dev->io_mutex);
0447         retval = -ENODEV;
0448         goto error;
0449     }
0450 
0451     if (copy_from_user(buffer, user_buffer, count)) {
0452         mutex_unlock(&dev->io_mutex);
0453         retval = -EFAULT;
0454         goto error;
0455     }
0456     buffer[count] = 0;
0457     memset(dev->cntl_buffer, CMD_PADDING, YUREX_BUF_SIZE);
0458 
0459     switch (buffer[0]) {
0460     case CMD_ANIMATE:
0461     case CMD_LED:
0462         dev->cntl_buffer[0] = buffer[0];
0463         dev->cntl_buffer[1] = buffer[1];
0464         dev->cntl_buffer[2] = CMD_EOF;
0465         break;
0466     case CMD_READ:
0467     case CMD_VERSION:
0468         dev->cntl_buffer[0] = buffer[0];
0469         dev->cntl_buffer[1] = 0x00;
0470         dev->cntl_buffer[2] = CMD_EOF;
0471         break;
0472     case CMD_SET:
0473         data++;
0474         fallthrough;
0475     case '0' ... '9':
0476         set = 1;
0477         c = c2 = simple_strtoull(data, NULL, 0);
0478         dev->cntl_buffer[0] = CMD_SET;
0479         for (i = 1; i < 6; i++) {
0480             dev->cntl_buffer[i] = (c>>32) & 0xff;
0481             c <<= 8;
0482         }
0483         buffer[6] = CMD_EOF;
0484         break;
0485     default:
0486         mutex_unlock(&dev->io_mutex);
0487         return -EINVAL;
0488     }
0489 
0490     /* send the data as the control msg */
0491     prepare_to_wait(&dev->waitq, &wait, TASK_INTERRUPTIBLE);
0492     dev_dbg(&dev->interface->dev, "%s - submit %c\n", __func__,
0493         dev->cntl_buffer[0]);
0494     retval = usb_submit_urb(dev->cntl_urb, GFP_ATOMIC);
0495     if (retval >= 0)
0496         timeout = schedule_timeout(YUREX_WRITE_TIMEOUT);
0497     finish_wait(&dev->waitq, &wait);
0498 
0499     /* make sure URB is idle after timeout or (spurious) CMD_ACK */
0500     usb_kill_urb(dev->cntl_urb);
0501 
0502     mutex_unlock(&dev->io_mutex);
0503 
0504     if (retval < 0) {
0505         dev_err(&dev->interface->dev,
0506             "%s - failed to send bulk msg, error %d\n",
0507             __func__, retval);
0508         goto error;
0509     }
0510     if (set && timeout)
0511         dev->bbu = c2;
0512     return timeout ? count : -EIO;
0513 
0514 error:
0515     return retval;
0516 }
0517 
0518 static const struct file_operations yurex_fops = {
0519     .owner =    THIS_MODULE,
0520     .read =     yurex_read,
0521     .write =    yurex_write,
0522     .open =     yurex_open,
0523     .release =  yurex_release,
0524     .fasync =   yurex_fasync,
0525     .llseek =   default_llseek,
0526 };
0527 
0528 module_usb_driver(yurex_driver);
0529 
0530 MODULE_LICENSE("GPL");
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!