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 DEFINE_WAIT(wait); 199 int res; 200 201 /* allocate memory for our device state and initialize it */ 202 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 203 if (!dev) 204 goto error; 205 kref_init(&dev->kref); 206 mutex_init(&dev->io_mutex); 207 spin_lock_init(&dev->lock); 208 init_waitqueue_head(&dev->waitq); 209 210 dev->udev = usb_get_dev(interface_to_usbdev(interface)); 211 dev->interface = interface; 212 213 /* set up the endpoint information */ 214 iface_desc = interface->cur_altsetting; 215 res = usb_find_int_in_endpoint(iface_desc, &endpoint); 216 if (res) { 217 dev_err(&interface->dev, "Could not find endpoints\n"); 218 retval = res; 219 goto error; 220 } 221 222 dev->int_in_endpointAddr = endpoint->bEndpointAddress; 223 224 /* allocate control URB */ 225 dev->cntl_urb = usb_alloc_urb(0, GFP_KERNEL); 226 if (!dev->cntl_urb) 227 goto error; 228 229 /* allocate buffer for control req */ 230 dev->cntl_req = kmalloc(YUREX_BUF_SIZE, GFP_KERNEL); 231 if (!dev->cntl_req) 232 goto error; 233 234 /* allocate buffer for control msg */ 235 dev->cntl_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE, 236 GFP_KERNEL, 237 &dev->cntl_urb->transfer_dma); 238 if (!dev->cntl_buffer) { 239 dev_err(&interface->dev, "Could not allocate cntl_buffer\n"); 240 goto error; 241 } 242 243 /* configure control URB */ 244 dev->cntl_req->bRequestType = USB_DIR_OUT | USB_TYPE_CLASS | 245 USB_RECIP_INTERFACE; 246 dev->cntl_req->bRequest = HID_REQ_SET_REPORT; 247 dev->cntl_req->wValue = cpu_to_le16((HID_OUTPUT_REPORT + 1) << 8); 248 dev->cntl_req->wIndex = cpu_to_le16(iface_desc->desc.bInterfaceNumber); 249 dev->cntl_req->wLength = cpu_to_le16(YUREX_BUF_SIZE); 250 251 usb_fill_control_urb(dev->cntl_urb, dev->udev, 252 usb_sndctrlpipe(dev->udev, 0), 253 (void *)dev->cntl_req, dev->cntl_buffer, 254 YUREX_BUF_SIZE, yurex_control_callback, dev); 255 dev->cntl_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 256 257 258 /* allocate interrupt URB */ 259 dev->urb = usb_alloc_urb(0, GFP_KERNEL); 260 if (!dev->urb) 261 goto error; 262 263 /* allocate buffer for interrupt in */ 264 dev->int_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE, 265 GFP_KERNEL, &dev->urb->transfer_dma); 266 if (!dev->int_buffer) { 267 dev_err(&interface->dev, "Could not allocate int_buffer\n"); 268 goto error; 269 } 270 271 /* configure interrupt URB */ 272 usb_fill_int_urb(dev->urb, dev->udev, 273 usb_rcvintpipe(dev->udev, dev->int_in_endpointAddr), 274 dev->int_buffer, YUREX_BUF_SIZE, yurex_interrupt, 275 dev, 1); 276 dev->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 277 if (usb_submit_urb(dev->urb, GFP_KERNEL)) { 278 retval = -EIO; 279 dev_err(&interface->dev, "Could not submitting URB\n"); 280 goto error; 281 } 282 283 /* save our data pointer in this interface device */ 284 usb_set_intfdata(interface, dev); 285 dev->bbu = -1; 286 287 /* we can register the device now, as it is ready */ 288 retval = usb_register_dev(interface, &yurex_class); 289 if (retval) { 290 dev_err(&interface->dev, 291 "Not able to get a minor for this device.\n"); 292 usb_set_intfdata(interface, NULL); 293 goto error; 294 } 295 296 dev_info(&interface->dev, 297 "USB YUREX device now attached to Yurex #%d\n", 298 interface->minor); 299 300 return 0; 301 302 error: 303 if (dev) 304 /* this frees allocated memory */ 305 kref_put(&dev->kref, yurex_delete); 306 return retval; 307 } 308 309 static void yurex_disconnect(struct usb_interface *interface) 310 { 311 struct usb_yurex *dev; 312 int minor = interface->minor; 313 314 dev = usb_get_intfdata(interface); 315 usb_set_intfdata(interface, NULL); 316 317 /* give back our minor */ 318 usb_deregister_dev(interface, &yurex_class); 319 320 /* prevent more I/O from starting */ 321 mutex_lock(&dev->io_mutex); 322 dev->interface = NULL; 323 mutex_unlock(&dev->io_mutex); 324 325 /* wakeup waiters */ 326 kill_fasync(&dev->async_queue, SIGIO, POLL_IN); 327 wake_up_interruptible(&dev->waitq); 328 329 /* decrement our usage count */ 330 kref_put(&dev->kref, yurex_delete); 331 332 dev_info(&interface->dev, "USB YUREX #%d now disconnected\n", minor); 333 } 334 335 static struct usb_driver yurex_driver = { 336 .name = "yurex", 337 .probe = yurex_probe, 338 .disconnect = yurex_disconnect, 339 .id_table = yurex_table, 340 }; 341 342 343 static int yurex_fasync(int fd, struct file *file, int on) 344 { 345 struct usb_yurex *dev; 346 347 dev = file->private_data; 348 return fasync_helper(fd, file, on, &dev->async_queue); 349 } 350 351 static int yurex_open(struct inode *inode, struct file *file) 352 { 353 struct usb_yurex *dev; 354 struct usb_interface *interface; 355 int subminor; 356 int retval = 0; 357 358 subminor = iminor(inode); 359 360 interface = usb_find_interface(&yurex_driver, subminor); 361 if (!interface) { 362 printk(KERN_ERR "%s - error, can't find device for minor %d", 363 __func__, subminor); 364 retval = -ENODEV; 365 goto exit; 366 } 367 368 dev = usb_get_intfdata(interface); 369 if (!dev) { 370 retval = -ENODEV; 371 goto exit; 372 } 373 374 /* increment our usage count for the device */ 375 kref_get(&dev->kref); 376 377 /* save our object in the file's private structure */ 378 mutex_lock(&dev->io_mutex); 379 file->private_data = dev; 380 mutex_unlock(&dev->io_mutex); 381 382 exit: 383 return retval; 384 } 385 386 static int yurex_release(struct inode *inode, struct file *file) 387 { 388 struct usb_yurex *dev; 389 390 dev = file->private_data; 391 if (dev == NULL) 392 return -ENODEV; 393 394 /* decrement the count on our device */ 395 kref_put(&dev->kref, yurex_delete); 396 return 0; 397 } 398 399 static ssize_t yurex_read(struct file *file, char __user *buffer, size_t count, 400 loff_t *ppos) 401 { 402 struct usb_yurex *dev; 403 int retval = 0; 404 int bytes_read = 0; 405 char in_buffer[20]; 406 unsigned long flags; 407 408 dev = file->private_data; 409 410 mutex_lock(&dev->io_mutex); 411 if (!dev->interface) { /* already disconnected */ 412 retval = -ENODEV; 413 goto exit; 414 } 415 416 spin_lock_irqsave(&dev->lock, flags); 417 bytes_read = snprintf(in_buffer, 20, "%lld\n", dev->bbu); 418 spin_unlock_irqrestore(&dev->lock, flags); 419 420 if (*ppos < bytes_read) { 421 if (copy_to_user(buffer, in_buffer + *ppos, bytes_read - *ppos)) 422 retval = -EFAULT; 423 else { 424 retval = bytes_read - *ppos; 425 *ppos += bytes_read; 426 } 427 } 428 429 exit: 430 mutex_unlock(&dev->io_mutex); 431 return retval; 432 } 433 434 static ssize_t yurex_write(struct file *file, const char __user *user_buffer, 435 size_t count, loff_t *ppos) 436 { 437 struct usb_yurex *dev; 438 int i, set = 0, retval = 0; 439 char buffer[16]; 440 char *data = buffer; 441 unsigned long long c, c2 = 0; 442 signed long timeout = 0; 443 DEFINE_WAIT(wait); 444 445 count = min(sizeof(buffer), count); 446 dev = file->private_data; 447 448 /* verify that we actually have some data to write */ 449 if (count == 0) 450 goto error; 451 452 mutex_lock(&dev->io_mutex); 453 if (!dev->interface) { /* already disconnected */ 454 mutex_unlock(&dev->io_mutex); 455 retval = -ENODEV; 456 goto error; 457 } 458 459 if (copy_from_user(buffer, user_buffer, count)) { 460 mutex_unlock(&dev->io_mutex); 461 retval = -EFAULT; 462 goto error; 463 } 464 memset(dev->cntl_buffer, CMD_PADDING, YUREX_BUF_SIZE); 465 466 switch (buffer[0]) { 467 case CMD_ANIMATE: 468 case CMD_LED: 469 dev->cntl_buffer[0] = buffer[0]; 470 dev->cntl_buffer[1] = buffer[1]; 471 dev->cntl_buffer[2] = CMD_EOF; 472 break; 473 case CMD_READ: 474 case CMD_VERSION: 475 dev->cntl_buffer[0] = buffer[0]; 476 dev->cntl_buffer[1] = 0x00; 477 dev->cntl_buffer[2] = CMD_EOF; 478 break; 479 case CMD_SET: 480 data++; 481 /* FALL THROUGH */ 482 case '0' ... '9': 483 set = 1; 484 c = c2 = simple_strtoull(data, NULL, 0); 485 dev->cntl_buffer[0] = CMD_SET; 486 for (i = 1; i < 6; i++) { 487 dev->cntl_buffer[i] = (c>>32) & 0xff; 488 c <<= 8; 489 } 490 buffer[6] = CMD_EOF; 491 break; 492 default: 493 mutex_unlock(&dev->io_mutex); 494 return -EINVAL; 495 } 496 497 /* send the data as the control msg */ 498 prepare_to_wait(&dev->waitq, &wait, TASK_INTERRUPTIBLE); 499 dev_dbg(&dev->interface->dev, "%s - submit %c\n", __func__, 500 dev->cntl_buffer[0]); 501 retval = usb_submit_urb(dev->cntl_urb, GFP_KERNEL); 502 if (retval >= 0) 503 timeout = schedule_timeout(YUREX_WRITE_TIMEOUT); 504 finish_wait(&dev->waitq, &wait); 505 506 mutex_unlock(&dev->io_mutex); 507 508 if (retval < 0) { 509 dev_err(&dev->interface->dev, 510 "%s - failed to send bulk msg, error %d\n", 511 __func__, retval); 512 goto error; 513 } 514 if (set && timeout) 515 dev->bbu = c2; 516 return timeout ? count : -EIO; 517 518 error: 519 return retval; 520 } 521 522 static const struct file_operations yurex_fops = { 523 .owner = THIS_MODULE, 524 .read = yurex_read, 525 .write = yurex_write, 526 .open = yurex_open, 527 .release = yurex_release, 528 .fasync = yurex_fasync, 529 .llseek = default_llseek, 530 }; 531 532 module_usb_driver(yurex_driver); 533 534 MODULE_LICENSE("GPL"); 535