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