drivers/usb/misc/yurex.c

   1 /*
   2  * Driver for Meywa-Denki & KAYAC YUREX
   3  *
   4  * Copyright (C) 2010 Tomoki Sekiyama (tomoki.sekiyama@gmail.com)
   5  *
   6  *      This program is free software; you can redistribute it and/or
   7  *      modify it under the terms of the GNU General Public License as
   8  *      published by the Free Software Foundation, version 2.
   9  *
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/errno.h>
  14 #include <linux/slab.h>
  15 #include <linux/module.h>
  16 #include <linux/kref.h>
  17 #include <linux/mutex.h>
  18 #include <linux/uaccess.h>
  19 #include <linux/usb.h>
  20 #include <linux/hid.h>
  21
  22 #define DRIVER_AUTHOR "Tomoki Sekiyama"
  23 #define DRIVER_DESC "Driver for Meywa-Denki & KAYAC YUREX"
  24
  25 #define YUREX_VENDOR_ID         0x0c45
  26 #define YUREX_PRODUCT_ID        0x1010
  27
  28 #define CMD_ACK         '!'
  29 #define CMD_ANIMATE     'A'
  30 #define CMD_COUNT       'C'
  31 #define CMD_LED         'L'
  32 #define CMD_READ        'R'
  33 #define CMD_SET         'S'
  34 #define CMD_VERSION     'V'
  35 #define CMD_EOF         0x0d
  36 #define CMD_PADDING     0xff
  37
  38 #define YUREX_BUF_SIZE          8
  39 #define YUREX_WRITE_TIMEOUT     (HZ*2)
  40
  41 /* table of devices that work with this driver */
  42 static struct usb_device_id yurex_table[] = {
  43         { USB_DEVICE(YUREX_VENDOR_ID, YUREX_PRODUCT_ID) },
  44         { }                                     /* Terminating entry */
  45 };
  46 MODULE_DEVICE_TABLE(usb, yurex_table);
  47
  48 #ifdef CONFIG_USB_DYNAMIC_MINORS
  49 #define YUREX_MINOR_BASE        0
  50 #else
  51 #define YUREX_MINOR_BASE        192
  52 #endif
  53
  54 /* Structure to hold all of our device specific stuff */
  55 struct usb_yurex {
  56         struct usb_device       *udev;
  57         struct usb_interface    *interface;
  58         __u8                    int_in_endpointAddr;
  59         struct urb              *urb;           /* URB for interrupt in */
  60         unsigned char           *int_buffer;    /* buffer for intterupt in */
  61         struct urb              *cntl_urb;      /* URB for control msg */
  62         struct usb_ctrlrequest  *cntl_req;      /* req for control msg */
  63         unsigned char           *cntl_buffer;   /* buffer for control msg */
  64
  65         struct kref             kref;
  66         struct mutex            io_mutex;
  67         unsigned long           disconnected:1;
  68         struct fasync_struct    *async_queue;
  69         wait_queue_head_t       waitq;
  70
  71         spinlock_t              lock;
  72         __s64                   bbu;            /* BBU from device */
  73 };
  74 #define to_yurex_dev(d) container_of(d, struct usb_yurex, kref)
  75
  76 static struct usb_driver yurex_driver;
  77 static const struct file_operations yurex_fops;
  78
  79
  80 static void yurex_control_callback(struct urb *urb)
  81 {
  82         struct usb_yurex *dev = urb->context;
  83         int status = urb->status;
  84
  85         if (status) {
  86                 dev_err(&urb->dev->dev, "%s - control failed: %d\n",
  87                         __func__, status);
  88                 wake_up_interruptible(&dev->waitq);
  89                 return;
  90         }
  91         /* on success, sender woken up by CMD_ACK int in, or timeout */
  92 }
  93
  94 static void yurex_delete(struct kref *kref)
  95 {
  96         struct usb_yurex *dev = to_yurex_dev(kref);
  97
  98         dev_dbg(&dev->interface->dev, "%s\n", __func__);
  99
 100         if (dev->cntl_urb) {
 101                 usb_kill_urb(dev->cntl_urb);
 102                 kfree(dev->cntl_req);
 103                 if (dev->cntl_buffer)
 104                         usb_free_coherent(dev->udev, YUREX_BUF_SIZE,
 105                                 dev->cntl_buffer, dev->cntl_urb->transfer_dma);
 106                 usb_free_urb(dev->cntl_urb);
 107         }
 108         if (dev->urb) {
 109                 usb_kill_urb(dev->urb);
 110                 if (dev->int_buffer)
 111                         usb_free_coherent(dev->udev, YUREX_BUF_SIZE,
 112                                 dev->int_buffer, dev->urb->transfer_dma);
 113                 usb_free_urb(dev->urb);
 114         }
 115         usb_put_intf(dev->interface);
 116         usb_put_dev(dev->udev);
 117         kfree(dev);
 118 }
 119
 120 /*
 121  * usb class driver info in order to get a minor number from the usb core,
 122  * and to have the device registered with the driver core
 123  */
 124 static struct usb_class_driver yurex_class = {
 125         .name =         "yurex%d",
 126         .fops =         &yurex_fops,
 127         .minor_base =   YUREX_MINOR_BASE,
 128 };
 129
 130 static void yurex_interrupt(struct urb *urb)
 131 {
 132         struct usb_yurex *dev = urb->context;
 133         unsigned char *buf = dev->int_buffer;
 134         int status = urb->status;
 135         unsigned long flags;
 136         int retval, i;
 137
 138         switch (status) {
 139         case 0: /*success*/
 140                 break;
 141         /* The device is terminated or messed up, give up */
 142         case -EOVERFLOW:
 143                 dev_err(&dev->interface->dev,
 144                         "%s - overflow with length %d, actual length is %d\n",
 145                         __func__, YUREX_BUF_SIZE, dev->urb->actual_length);
 146         case -ECONNRESET:
 147         case -ENOENT:
 148         case -ESHUTDOWN:
 149         case -EILSEQ:
 150         case -EPROTO:
 151         case -ETIME:
 152                 return;
 153         default:
 154                 dev_err(&dev->interface->dev,
 155                         "%s - unknown status received: %d\n", __func__, status);
 156                 return;
 157         }
 158
 159         /* handle received message */
 160         switch (buf[0]) {
 161         case CMD_COUNT:
 162         case CMD_READ:
 163                 if (buf[6] == CMD_EOF) {
 164                         spin_lock_irqsave(&dev->lock, flags);
 165                         dev->bbu = 0;
 166                         for (i = 1; i < 6; i++) {
 167                                 dev->bbu += buf[i];
 168                                 if (i != 5)
 169                                         dev->bbu <<= 8;
 170                         }
 171                         dev_dbg(&dev->interface->dev, "%s count: %lld\n",
 172                                 __func__, dev->bbu);
 173                         spin_unlock_irqrestore(&dev->lock, flags);
 174
 175                         kill_fasync(&dev->async_queue, SIGIO, POLL_IN);
 176                 }
 177                 else
 178                         dev_dbg(&dev->interface->dev,
 179                                 "data format error - no EOF\n");
 180                 break;
 181         case CMD_ACK:
 182                 dev_dbg(&dev->interface->dev, "%s ack: %c\n",
 183                         __func__, buf[1]);
 184                 wake_up_interruptible(&dev->waitq);
 185                 break;
 186         }
 187
 188         retval = usb_submit_urb(dev->urb, GFP_ATOMIC);
 189         if (retval) {
 190                 dev_err(&dev->interface->dev, "%s - usb_submit_urb failed: %d\n",
 191                         __func__, retval);
 192         }
 193 }
 194
 195 static int yurex_probe(struct usb_interface *interface, const struct usb_device_id *id)
 196 {
 197         struct usb_yurex *dev;
 198         struct usb_host_interface *iface_desc;
 199         struct usb_endpoint_descriptor *endpoint;
 200         int retval = -ENOMEM;
 201         int i;
 202         DEFINE_WAIT(wait);
 203
 204         /* allocate memory for our device state and initialize it */
 205         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 206         if (!dev)
 207                 goto error;
 208         kref_init(&dev->kref);
 209         mutex_init(&dev->io_mutex);
 210         spin_lock_init(&dev->lock);
 211         init_waitqueue_head(&dev->waitq);
 212
 213         dev->udev = usb_get_dev(interface_to_usbdev(interface));
 214         dev->interface = usb_get_intf(interface);
 215
 216         /* set up the endpoint information */
 217         iface_desc = interface->cur_altsetting;
 218         for (i = 0; i < iface_desc->desc.bNumEndpoints; i++) {
 219                 endpoint = &iface_desc->endpoint[i].desc;
 220
 221                 if (usb_endpoint_is_int_in(endpoint)) {
 222                         dev->int_in_endpointAddr = endpoint->bEndpointAddress;
 223                         break;
 224                 }
 225         }
 226         if (!dev->int_in_endpointAddr) {
 227                 retval = -ENODEV;
 228                 dev_err(&interface->dev, "Could not find endpoints\n");
 229                 goto error;
 230         }
 231
 232
 233         /* allocate control URB */
 234         dev->cntl_urb = usb_alloc_urb(0, GFP_KERNEL);
 235         if (!dev->cntl_urb)
 236                 goto error;
 237
 238         /* allocate buffer for control req */
 239         dev->cntl_req = kmalloc(YUREX_BUF_SIZE, GFP_KERNEL);
 240         if (!dev->cntl_req)
 241                 goto error;
 242
 243         /* allocate buffer for control msg */
 244         dev->cntl_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE,
 245                                               GFP_KERNEL,
 246                                               &dev->cntl_urb->transfer_dma);
 247         if (!dev->cntl_buffer) {
 248                 dev_err(&interface->dev, "Could not allocate cntl_buffer\n");
 249                 goto error;
 250         }
 251
 252         /* configure control URB */
 253         dev->cntl_req->bRequestType = USB_DIR_OUT | USB_TYPE_CLASS |
 254                                       USB_RECIP_INTERFACE;
 255         dev->cntl_req->bRequest = HID_REQ_SET_REPORT;
 256         dev->cntl_req->wValue   = cpu_to_le16((HID_OUTPUT_REPORT + 1) << 8);
 257         dev->cntl_req->wIndex   = cpu_to_le16(iface_desc->desc.bInterfaceNumber);
 258         dev->cntl_req->wLength  = cpu_to_le16(YUREX_BUF_SIZE);
 259
 260         usb_fill_control_urb(dev->cntl_urb, dev->udev,
 261                              usb_sndctrlpipe(dev->udev, 0),
 262                              (void *)dev->cntl_req, dev->cntl_buffer,
 263                              YUREX_BUF_SIZE, yurex_control_callback, dev);
 264         dev->cntl_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 265
 266
 267         /* allocate interrupt URB */
 268         dev->urb = usb_alloc_urb(0, GFP_KERNEL);
 269         if (!dev->urb)
 270                 goto error;
 271
 272         /* allocate buffer for interrupt in */
 273         dev->int_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE,
 274                                         GFP_KERNEL, &dev->urb->transfer_dma);
 275         if (!dev->int_buffer) {
 276                 dev_err(&interface->dev, "Could not allocate int_buffer\n");
 277                 goto error;
 278         }
 279
 280         /* configure interrupt URB */
 281         usb_fill_int_urb(dev->urb, dev->udev,
 282                          usb_rcvintpipe(dev->udev, dev->int_in_endpointAddr),
 283                          dev->int_buffer, YUREX_BUF_SIZE, yurex_interrupt,
 284                          dev, 1);
 285         dev->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 286         if (usb_submit_urb(dev->urb, GFP_KERNEL)) {
 287                 retval = -EIO;
 288                 dev_err(&interface->dev, "Could not submitting URB\n");
 289                 goto error;
 290         }
 291
 292         /* save our data pointer in this interface device */
 293         usb_set_intfdata(interface, dev);
 294         dev->bbu = -1;
 295
 296         /* we can register the device now, as it is ready */
 297         retval = usb_register_dev(interface, &yurex_class);
 298         if (retval) {
 299                 dev_err(&interface->dev,
 300                         "Not able to get a minor for this device.\n");
 301                 usb_set_intfdata(interface, NULL);
 302                 goto error;
 303         }
 304
 305         dev_info(&interface->dev,
 306                  "USB YUREX device now attached to Yurex #%d\n",
 307                  interface->minor);
 308
 309         return 0;
 310
 311 error:
 312         if (dev)
 313                 /* this frees allocated memory */
 314                 kref_put(&dev->kref, yurex_delete);
 315         return retval;
 316 }
 317
 318 static void yurex_disconnect(struct usb_interface *interface)
 319 {
 320         struct usb_yurex *dev;
 321         int minor = interface->minor;
 322
 323         dev = usb_get_intfdata(interface);
 324         usb_set_intfdata(interface, NULL);
 325
 326         /* give back our minor */
 327         usb_deregister_dev(interface, &yurex_class);
 328
 329         /* prevent more I/O from starting */
 330         usb_poison_urb(dev->urb);
 331         usb_poison_urb(dev->cntl_urb);
 332         mutex_lock(&dev->io_mutex);
 333         dev->disconnected = 1;
 334         mutex_unlock(&dev->io_mutex);
 335
 336         /* wakeup waiters */
 337         kill_fasync(&dev->async_queue, SIGIO, POLL_IN);
 338         wake_up_interruptible(&dev->waitq);
 339
 340         /* decrement our usage count */
 341         kref_put(&dev->kref, yurex_delete);
 342
 343         dev_info(&interface->dev, "USB YUREX #%d now disconnected\n", minor);
 344 }
 345
 346 static struct usb_driver yurex_driver = {
 347         .name =         "yurex",
 348         .probe =        yurex_probe,
 349         .disconnect =   yurex_disconnect,
 350         .id_table =     yurex_table,
 351 };
 352
 353
 354 static int yurex_fasync(int fd, struct file *file, int on)
 355 {
 356         struct usb_yurex *dev;
 357
 358         dev = file->private_data;
 359         return fasync_helper(fd, file, on, &dev->async_queue);
 360 }
 361
 362 static int yurex_open(struct inode *inode, struct file *file)
 363 {
 364         struct usb_yurex *dev;
 365         struct usb_interface *interface;
 366         int subminor;
 367         int retval = 0;
 368
 369         subminor = iminor(inode);
 370
 371         interface = usb_find_interface(&yurex_driver, subminor);
 372         if (!interface) {
 373                 printk(KERN_ERR "%s - error, can't find device for minor %d",
 374                        __func__, subminor);
 375                 retval = -ENODEV;
 376                 goto exit;
 377         }
 378
 379         dev = usb_get_intfdata(interface);
 380         if (!dev) {
 381                 retval = -ENODEV;
 382                 goto exit;
 383         }
 384
 385         /* increment our usage count for the device */
 386         kref_get(&dev->kref);
 387
 388         /* save our object in the file's private structure */
 389         mutex_lock(&dev->io_mutex);
 390         file->private_data = dev;
 391         mutex_unlock(&dev->io_mutex);
 392
 393 exit:
 394         return retval;
 395 }
 396
 397 static int yurex_release(struct inode *inode, struct file *file)
 398 {
 399         struct usb_yurex *dev;
 400
 401         dev = file->private_data;
 402         if (dev == NULL)
 403                 return -ENODEV;
 404
 405         /* decrement the count on our device */
 406         kref_put(&dev->kref, yurex_delete);
 407         return 0;
 408 }
 409
 410 static ssize_t yurex_read(struct file *file, char __user *buffer, size_t count,
 411                           loff_t *ppos)
 412 {
 413         struct usb_yurex *dev;
 414         int len = 0;
 415         char in_buffer[20];
 416         unsigned long flags;
 417
 418         dev = file->private_data;
 419
 420         mutex_lock(&dev->io_mutex);
 421         if (dev->disconnected) {                /* already disconnected */
 422                 mutex_unlock(&dev->io_mutex);
 423                 return -ENODEV;
 424         }
 425
 426         spin_lock_irqsave(&dev->lock, flags);
 427         len = snprintf(in_buffer, 20, "%lld\n", dev->bbu);
 428         spin_unlock_irqrestore(&dev->lock, flags);
 429         mutex_unlock(&dev->io_mutex);
 430
 431         if (WARN_ON_ONCE(len >= sizeof(in_buffer)))
 432                 return -EIO;
 433
 434         return simple_read_from_buffer(buffer, count, ppos, in_buffer, len);
 435 }
 436
 437 static ssize_t yurex_write(struct file *file, const char __user *user_buffer,
 438                            size_t count, loff_t *ppos)
 439 {
 440         struct usb_yurex *dev;
 441         int i, set = 0, retval = 0;
 442         char buffer[16 + 1];
 443         char *data = buffer;
 444         unsigned long long c, c2 = 0;
 445         signed long timeout = 0;
 446         DEFINE_WAIT(wait);
 447
 448         count = min(sizeof(buffer) - 1, count);
 449         dev = file->private_data;
 450
 451         /* verify that we actually have some data to write */
 452         if (count == 0)
 453                 goto error;
 454
 455         mutex_lock(&dev->io_mutex);
 456         if (dev->disconnected) {                /* already disconnected */
 457                 mutex_unlock(&dev->io_mutex);
 458                 retval = -ENODEV;
 459                 goto error;
 460         }
 461
 462         if (copy_from_user(buffer, user_buffer, count)) {
 463                 mutex_unlock(&dev->io_mutex);
 464                 retval = -EFAULT;
 465                 goto error;
 466         }
 467         buffer[count] = 0;
 468         memset(dev->cntl_buffer, CMD_PADDING, YUREX_BUF_SIZE);
 469
 470         switch (buffer[0]) {
 471         case CMD_ANIMATE:
 472         case CMD_LED:
 473                 dev->cntl_buffer[0] = buffer[0];
 474                 dev->cntl_buffer[1] = buffer[1];
 475                 dev->cntl_buffer[2] = CMD_EOF;
 476                 break;
 477         case CMD_READ:
 478         case CMD_VERSION:
 479                 dev->cntl_buffer[0] = buffer[0];
 480                 dev->cntl_buffer[1] = 0x00;
 481                 dev->cntl_buffer[2] = CMD_EOF;
 482                 break;
 483         case CMD_SET:
 484                 data++;
 485                 /* FALL THROUGH */
 486         case '0' ... '9':
 487                 set = 1;
 488                 c = c2 = simple_strtoull(data, NULL, 0);
 489                 dev->cntl_buffer[0] = CMD_SET;
 490                 for (i = 1; i < 6; i++) {
 491                         dev->cntl_buffer[i] = (c>>32) & 0xff;
 492                         c <<= 8;
 493                 }
 494                 buffer[6] = CMD_EOF;
 495                 break;
 496         default:
 497                 mutex_unlock(&dev->io_mutex);
 498                 return -EINVAL;
 499         }
 500
 501         /* send the data as the control msg */
 502         prepare_to_wait(&dev->waitq, &wait, TASK_INTERRUPTIBLE);
 503         dev_dbg(&dev->interface->dev, "%s - submit %c\n", __func__,
 504                 dev->cntl_buffer[0]);
 505         retval = usb_submit_urb(dev->cntl_urb, GFP_ATOMIC);
 506         if (retval >= 0)
 507                 timeout = schedule_timeout(YUREX_WRITE_TIMEOUT);
 508         finish_wait(&dev->waitq, &wait);
 509
 510         /* make sure URB is idle after timeout or (spurious) CMD_ACK */
 511         usb_kill_urb(dev->cntl_urb);
 512
 513         mutex_unlock(&dev->io_mutex);
 514
 515         if (retval < 0) {
 516                 dev_err(&dev->interface->dev,
 517                         "%s - failed to send bulk msg, error %d\n",
 518                         __func__, retval);
 519                 goto error;
 520         }
 521         if (set && timeout)
 522                 dev->bbu = c2;
 523         return timeout ? count : -EIO;
 524
 525 error:
 526         return retval;
 527 }
 528
 529 static const struct file_operations yurex_fops = {
 530         .owner =        THIS_MODULE,
 531         .read =         yurex_read,
 532         .write =        yurex_write,
 533         .open =         yurex_open,
 534         .release =      yurex_release,
 535         .fasync =       yurex_fasync,
 536         .llseek =       default_llseek,
 537 };
 538
 539 module_usb_driver(yurex_driver);
 540
 541 MODULE_LICENSE("GPL");