1// SPDX-License-Identifier: GPL-2.0 2/* 3 * Native support for the I/O-Warrior USB devices 4 * 5 * Copyright (c) 2003-2005, 2020 Code Mercenaries GmbH 6 * written by Christian Lucht <lucht@codemercs.com> and 7 * Christoph Jung <jung@codemercs.com> 8 * 9 * based on 10 11 * usb-skeleton.c by Greg Kroah-Hartman <greg@kroah.com> 12 * brlvger.c by Stephane Dalton <sdalton@videotron.ca> 13 * and Stephane Doyon <s.doyon@videotron.ca> 14 * 15 * Released under the GPLv2. 16 */ 17 18#include <linux/module.h> 19#include <linux/usb.h> 20#include <linux/slab.h> 21#include <linux/sched.h> 22#include <linux/mutex.h> 23#include <linux/poll.h> 24#include <linux/usb/iowarrior.h> 25 26#define DRIVER_AUTHOR "Christian Lucht <lucht@codemercs.com>" 27#define DRIVER_DESC "USB IO-Warrior driver" 28 29#define USB_VENDOR_ID_CODEMERCS 1984 30/* low speed iowarrior */ 31#define USB_DEVICE_ID_CODEMERCS_IOW40 0x1500 32#define USB_DEVICE_ID_CODEMERCS_IOW24 0x1501 33#define USB_DEVICE_ID_CODEMERCS_IOWPV1 0x1511 34#define USB_DEVICE_ID_CODEMERCS_IOWPV2 0x1512 35/* full speed iowarrior */ 36#define USB_DEVICE_ID_CODEMERCS_IOW56 0x1503 37/* fuller speed iowarrior */ 38#define USB_DEVICE_ID_CODEMERCS_IOW28 0x1504 39#define USB_DEVICE_ID_CODEMERCS_IOW28L 0x1505 40#define USB_DEVICE_ID_CODEMERCS_IOW100 0x1506 41 42/* OEMed devices */ 43#define USB_DEVICE_ID_CODEMERCS_IOW24SAG 0x158a 44#define USB_DEVICE_ID_CODEMERCS_IOW56AM 0x158b 45 46/* Get a minor range for your devices from the usb maintainer */ 47#ifdef CONFIG_USB_DYNAMIC_MINORS 48#define IOWARRIOR_MINOR_BASE 0 49#else 50#define IOWARRIOR_MINOR_BASE 208 // SKELETON_MINOR_BASE 192 + 16, not official yet 51#endif 52 53/* interrupt input queue size */ 54#define MAX_INTERRUPT_BUFFER 16 55/* 56 maximum number of urbs that are submitted for writes at the same time, 57 this applies to the IOWarrior56 only! 58 IOWarrior24 and IOWarrior40 use synchronous usb_control_msg calls. 59*/ 60#define MAX_WRITES_IN_FLIGHT 4 61 62MODULE_AUTHOR(DRIVER_AUTHOR); 63MODULE_DESCRIPTION(DRIVER_DESC); 64MODULE_LICENSE("GPL"); 65 66static struct usb_driver iowarrior_driver; 67 68/*--------------*/ 69/* data */ 70/*--------------*/ 71 72/* Structure to hold all of our device specific stuff */ 73struct iowarrior { 74 struct mutex mutex; /* locks this structure */ 75 struct usb_device *udev; /* save off the usb device pointer */ 76 struct usb_interface *interface; /* the interface for this device */ 77 unsigned char minor; /* the starting minor number for this device */ 78 struct usb_endpoint_descriptor *int_out_endpoint; /* endpoint for reading (needed for IOW56 only) */ 79 struct usb_endpoint_descriptor *int_in_endpoint; /* endpoint for reading */ 80 struct urb *int_in_urb; /* the urb for reading data */ 81 unsigned char *int_in_buffer; /* buffer for data to be read */ 82 unsigned char serial_number; /* to detect lost packages */ 83 unsigned char *read_queue; /* size is MAX_INTERRUPT_BUFFER * packet size */ 84 wait_queue_head_t read_wait; 85 wait_queue_head_t write_wait; /* wait-queue for writing to the device */ 86 atomic_t write_busy; /* number of write-urbs submitted */ 87 atomic_t read_idx; 88 atomic_t intr_idx; 89 atomic_t overflow_flag; /* signals an index 'rollover' */ 90 int present; /* this is 1 as long as the device is connected */ 91 int opened; /* this is 1 if the device is currently open */ 92 char chip_serial[9]; /* the serial number string of the chip connected */ 93 int report_size; /* number of bytes in a report */ 94 u16 product_id; 95 struct usb_anchor submitted; 96}; 97 98/*--------------*/ 99/* globals */ 100/*--------------*/ 101 102#define USB_REQ_GET_REPORT 0x01 103//#if 0 104static int usb_get_report(struct usb_device *dev, 105 struct usb_host_interface *inter, unsigned char type, 106 unsigned char id, void *buf, int size) 107{ 108 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 109 USB_REQ_GET_REPORT, 110 USB_DIR_IN | USB_TYPE_CLASS | 111 USB_RECIP_INTERFACE, (type << 8) + id, 112 inter->desc.bInterfaceNumber, buf, size, 113 USB_CTRL_GET_TIMEOUT); 114} 115//#endif 116 117#define USB_REQ_SET_REPORT 0x09 118 119static int usb_set_report(struct usb_interface *intf, unsigned char type, 120 unsigned char id, void *buf, int size) 121{ 122 return usb_control_msg(interface_to_usbdev(intf), 123 usb_sndctrlpipe(interface_to_usbdev(intf), 0), 124 USB_REQ_SET_REPORT, 125 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 126 (type << 8) + id, 127 intf->cur_altsetting->desc.bInterfaceNumber, buf, 128 size, 1000); 129} 130 131/*---------------------*/ 132/* driver registration */ 133/*---------------------*/ 134/* table of devices that work with this driver */ 135static const struct usb_device_id iowarrior_ids[] = { 136 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW40)}, 137 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24)}, 138 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOWPV1)}, 139 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOWPV2)}, 140 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW56)}, 141 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW24SAG)}, 142 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW56AM)}, 143 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28)}, 144 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW28L)}, 145 {USB_DEVICE(USB_VENDOR_ID_CODEMERCS, USB_DEVICE_ID_CODEMERCS_IOW100)}, 146 {} /* Terminating entry */ 147}; 148MODULE_DEVICE_TABLE(usb, iowarrior_ids); 149 150/* 151 * USB callback handler for reading data 152 */ 153static void iowarrior_callback(struct urb *urb) 154{ 155 struct iowarrior *dev = urb->context; 156 int intr_idx; 157 int read_idx; 158 int aux_idx; 159 int offset; 160 int status = urb->status; 161 int retval; 162 163 switch (status) { 164 case 0: 165 /* success */ 166 break; 167 case -ECONNRESET: 168 case -ENOENT: 169 case -ESHUTDOWN: 170 return; 171 default: 172 goto exit; 173 } 174 175 intr_idx = atomic_read(&dev->intr_idx); 176 /* aux_idx become previous intr_idx */ 177 aux_idx = (intr_idx == 0) ? (MAX_INTERRUPT_BUFFER - 1) : (intr_idx - 1); 178 read_idx = atomic_read(&dev->read_idx); 179 180 /* queue is not empty and it's interface 0 */ 181 if ((intr_idx != read_idx) 182 && (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0)) { 183 /* + 1 for serial number */ 184 offset = aux_idx * (dev->report_size + 1); 185 if (!memcmp 186 (dev->read_queue + offset, urb->transfer_buffer, 187 dev->report_size)) { 188 /* equal values on interface 0 will be ignored */ 189 goto exit; 190 } 191 } 192 193 /* aux_idx become next intr_idx */ 194 aux_idx = (intr_idx == (MAX_INTERRUPT_BUFFER - 1)) ? 0 : (intr_idx + 1); 195 if (read_idx == aux_idx) { 196 /* queue full, dropping oldest input */ 197 read_idx = (++read_idx == MAX_INTERRUPT_BUFFER) ? 0 : read_idx; 198 atomic_set(&dev->read_idx, read_idx); 199 atomic_set(&dev->overflow_flag, 1); 200 } 201 202 /* +1 for serial number */ 203 offset = intr_idx * (dev->report_size + 1); 204 memcpy(dev->read_queue + offset, urb->transfer_buffer, 205 dev->report_size); 206 *(dev->read_queue + offset + (dev->report_size)) = dev->serial_number++; 207 208 atomic_set(&dev->intr_idx, aux_idx); 209 /* tell the blocking read about the new data */ 210 wake_up_interruptible(&dev->read_wait); 211 212exit: 213 retval = usb_submit_urb(urb, GFP_ATOMIC); 214 if (retval) 215 dev_err(&dev->interface->dev, "%s - usb_submit_urb failed with result %d\n", 216 __func__, retval); 217 218} 219 220/* 221 * USB Callback handler for write-ops 222 */ 223static void iowarrior_write_callback(struct urb *urb) 224{ 225 struct iowarrior *dev; 226 int status = urb->status; 227 228 dev = urb->context; 229 /* sync/async unlink faults aren't errors */ 230 if (status && 231 !(status == -ENOENT || 232 status == -ECONNRESET || status == -ESHUTDOWN)) { 233 dev_dbg(&dev->interface->dev, 234 "nonzero write bulk status received: %d\n", status); 235 } 236 /* free up our allocated buffer */ 237 usb_free_coherent(urb->dev, urb->transfer_buffer_length, 238 urb->transfer_buffer, urb->transfer_dma); 239 /* tell a waiting writer the interrupt-out-pipe is available again */ 240 atomic_dec(&dev->write_busy); 241 wake_up_interruptible(&dev->write_wait); 242} 243 244/* 245 * iowarrior_delete 246 */ 247static inline void iowarrior_delete(struct iowarrior *dev) 248{ 249 dev_dbg(&dev->interface->dev, "minor %d\n", dev->minor); 250 kfree(dev->int_in_buffer); 251 usb_free_urb(dev->int_in_urb); 252 kfree(dev->read_queue); 253 usb_put_intf(dev->interface); 254 kfree(dev); 255} 256 257/*---------------------*/ 258/* fops implementation */ 259/*---------------------*/ 260 261static int read_index(struct iowarrior *dev) 262{ 263 int intr_idx, read_idx; 264 265 read_idx = atomic_read(&dev->read_idx); 266 intr_idx = atomic_read(&dev->intr_idx); 267 268 return (read_idx == intr_idx ? -1 : read_idx); 269} 270 271/* 272 * iowarrior_read 273 */ 274static ssize_t iowarrior_read(struct file *file, char __user *buffer, 275 size_t count, loff_t *ppos) 276{ 277 struct iowarrior *dev; 278 int read_idx; 279 int offset; 280 281 dev = file->private_data; 282 283 /* verify that the device wasn't unplugged */ 284 if (!dev || !dev->present) 285 return -ENODEV; 286 287 dev_dbg(&dev->interface->dev, "minor %d, count = %zd\n", 288 dev->minor, count); 289 290 /* read count must be packet size (+ time stamp) */ 291 if ((count != dev->report_size) 292 && (count != (dev->report_size + 1))) 293 return -EINVAL; 294 295 /* repeat until no buffer overrun in callback handler occur */ 296 do { 297 atomic_set(&dev->overflow_flag, 0); 298 if ((read_idx = read_index(dev)) == -1) { 299 /* queue empty */ 300 if (file->f_flags & O_NONBLOCK) 301 return -EAGAIN; 302 else { 303 //next line will return when there is either new data, or the device is unplugged 304 int r = wait_event_interruptible(dev->read_wait, 305 (!dev->present 306 || (read_idx = 307 read_index 308 (dev)) != 309 -1)); 310 if (r) { 311 //we were interrupted by a signal 312 return -ERESTART; 313 } 314 if (!dev->present) { 315 //The device was unplugged 316 return -ENODEV; 317 } 318 if (read_idx == -1) { 319 // Can this happen ??? 320 return 0; 321 } 322 } 323 } 324 325 offset = read_idx * (dev->report_size + 1); 326 if (copy_to_user(buffer, dev->read_queue + offset, count)) { 327 return -EFAULT; 328 } 329 } while (atomic_read(&dev->overflow_flag)); 330 331 read_idx = ++read_idx == MAX_INTERRUPT_BUFFER ? 0 : read_idx; 332 atomic_set(&dev->read_idx, read_idx); 333 return count; 334} 335 336/* 337 * iowarrior_write 338 */ 339static ssize_t iowarrior_write(struct file *file, 340 const char __user *user_buffer, 341 size_t count, loff_t *ppos) 342{ 343 struct iowarrior *dev; 344 int retval = 0; 345 char *buf = NULL; /* for IOW24 and IOW56 we need a buffer */ 346 struct urb *int_out_urb = NULL; 347 348 dev = file->private_data; 349 350 mutex_lock(&dev->mutex); 351 /* verify that the device wasn't unplugged */ 352 if (!dev->present) { 353 retval = -ENODEV; 354 goto exit; 355 } 356 dev_dbg(&dev->interface->dev, "minor %d, count = %zd\n", 357 dev->minor, count); 358 /* if count is 0 we're already done */ 359 if (count == 0) { 360 retval = 0; 361 goto exit; 362 } 363 /* We only accept full reports */ 364 if (count != dev->report_size) { 365 retval = -EINVAL; 366 goto exit; 367 } 368 switch (dev->product_id) { 369 case USB_DEVICE_ID_CODEMERCS_IOW24: 370 case USB_DEVICE_ID_CODEMERCS_IOW24SAG: 371 case USB_DEVICE_ID_CODEMERCS_IOWPV1: 372 case USB_DEVICE_ID_CODEMERCS_IOWPV2: 373 case USB_DEVICE_ID_CODEMERCS_IOW40: 374 /* IOW24 and IOW40 use a synchronous call */ 375 buf = memdup_user(user_buffer, count); 376 if (IS_ERR(buf)) { 377 retval = PTR_ERR(buf); 378 goto exit; 379 } 380 retval = usb_set_report(dev->interface, 2, 0, buf, count); 381 kfree(buf); 382 goto exit; 383 case USB_DEVICE_ID_CODEMERCS_IOW56: 384 case USB_DEVICE_ID_CODEMERCS_IOW56AM: 385 case USB_DEVICE_ID_CODEMERCS_IOW28: 386 case USB_DEVICE_ID_CODEMERCS_IOW28L: 387 case USB_DEVICE_ID_CODEMERCS_IOW100: 388 /* The IOW56 uses asynchronous IO and more urbs */ 389 if (atomic_read(&dev->write_busy) == MAX_WRITES_IN_FLIGHT) { 390 /* Wait until we are below the limit for submitted urbs */ 391 if (file->f_flags & O_NONBLOCK) { 392 retval = -EAGAIN; 393 goto exit; 394 } else { 395 retval = wait_event_interruptible(dev->write_wait, 396 (!dev->present || (atomic_read (&dev-> write_busy) < MAX_WRITES_IN_FLIGHT))); 397 if (retval) { 398 /* we were interrupted by a signal */ 399 retval = -ERESTART; 400 goto exit; 401 } 402 if (!dev->present) { 403 /* The device was unplugged */ 404 retval = -ENODEV; 405 goto exit; 406 } 407 if (!dev->opened) { 408 /* We were closed while waiting for an URB */ 409 retval = -ENODEV; 410 goto exit; 411 } 412 } 413 } 414 atomic_inc(&dev->write_busy); 415 int_out_urb = usb_alloc_urb(0, GFP_KERNEL); 416 if (!int_out_urb) { 417 retval = -ENOMEM; 418 goto error_no_urb; 419 } 420 buf = usb_alloc_coherent(dev->udev, dev->report_size, 421 GFP_KERNEL, &int_out_urb->transfer_dma); 422 if (!buf) { 423 retval = -ENOMEM; 424 dev_dbg(&dev->interface->dev, 425 "Unable to allocate buffer\n"); 426 goto error_no_buffer; 427 } 428 usb_fill_int_urb(int_out_urb, dev->udev, 429 usb_sndintpipe(dev->udev, 430 dev->int_out_endpoint->bEndpointAddress), 431 buf, dev->report_size, 432 iowarrior_write_callback, dev, 433 dev->int_out_endpoint->bInterval); 434 int_out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 435 if (copy_from_user(buf, user_buffer, count)) { 436 retval = -EFAULT; 437 goto error; 438 } 439 usb_anchor_urb(int_out_urb, &dev->submitted); 440 retval = usb_submit_urb(int_out_urb, GFP_KERNEL); 441 if (retval) { 442 dev_dbg(&dev->interface->dev, 443 "submit error %d for urb nr.%d\n", 444 retval, atomic_read(&dev->write_busy)); 445 usb_unanchor_urb(int_out_urb); 446 goto error; 447 } 448 /* submit was ok */ 449 retval = count; 450 usb_free_urb(int_out_urb); 451 goto exit; 452 default: 453 /* what do we have here ? An unsupported Product-ID ? */ 454 dev_err(&dev->interface->dev, "%s - not supported for product=0x%x\n", 455 __func__, dev->product_id); 456 retval = -EFAULT; 457 goto exit; 458 } 459error: 460 usb_free_coherent(dev->udev, dev->report_size, buf, 461 int_out_urb->transfer_dma); 462error_no_buffer: 463 usb_free_urb(int_out_urb); 464error_no_urb: 465 atomic_dec(&dev->write_busy); 466 wake_up_interruptible(&dev->write_wait); 467exit: 468 mutex_unlock(&dev->mutex); 469 return retval; 470} 471 472/* 473 * iowarrior_ioctl 474 */ 475static long iowarrior_ioctl(struct file *file, unsigned int cmd, 476 unsigned long arg) 477{ 478 struct iowarrior *dev = NULL; 479 __u8 *buffer; 480 __u8 __user *user_buffer; 481 int retval; 482 int io_res; /* checks for bytes read/written and copy_to/from_user results */ 483 484 dev = file->private_data; 485 if (!dev) 486 return -ENODEV; 487 488 buffer = kzalloc(dev->report_size, GFP_KERNEL); 489 if (!buffer) 490 return -ENOMEM; 491 492 mutex_lock(&dev->mutex); 493 494 /* verify that the device wasn't unplugged */ 495 if (!dev->present) { 496 retval = -ENODEV; 497 goto error_out; 498 } 499 500 dev_dbg(&dev->interface->dev, "minor %d, cmd 0x%.4x, arg %ld\n", 501 dev->minor, cmd, arg); 502 503 retval = 0; 504 switch (cmd) { 505 case IOW_WRITE: 506 if (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW24 || 507 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW24SAG || 508 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOWPV1 || 509 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOWPV2 || 510 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW40) { 511 user_buffer = (__u8 __user *)arg; 512 io_res = copy_from_user(buffer, user_buffer, 513 dev->report_size); 514 if (io_res) { 515 retval = -EFAULT; 516 } else { 517 io_res = usb_set_report(dev->interface, 2, 0, 518 buffer, 519 dev->report_size); 520 if (io_res < 0) 521 retval = io_res; 522 } 523 } else { 524 retval = -EINVAL; 525 dev_err(&dev->interface->dev, 526 "ioctl 'IOW_WRITE' is not supported for product=0x%x.\n", 527 dev->product_id); 528 } 529 break; 530 case IOW_READ: 531 user_buffer = (__u8 __user *)arg; 532 io_res = usb_get_report(dev->udev, 533 dev->interface->cur_altsetting, 1, 0, 534 buffer, dev->report_size); 535 if (io_res < 0) 536 retval = io_res; 537 else { 538 io_res = copy_to_user(user_buffer, buffer, dev->report_size); 539 if (io_res) 540 retval = -EFAULT; 541 } 542 break; 543 case IOW_GETINFO: 544 { 545 /* Report available information for the device */ 546 struct iowarrior_info info; 547 /* needed for power consumption */ 548 struct usb_config_descriptor *cfg_descriptor = &dev->udev->actconfig->desc; 549 550 memset(&info, 0, sizeof(info)); 551 /* directly from the descriptor */ 552 info.vendor = le16_to_cpu(dev->udev->descriptor.idVendor); 553 info.product = dev->product_id; 554 info.revision = le16_to_cpu(dev->udev->descriptor.bcdDevice); 555 556 /* 0==UNKNOWN, 1==LOW(usb1.1) ,2=FULL(usb1.1), 3=HIGH(usb2.0) */ 557 info.speed = dev->udev->speed; 558 info.if_num = dev->interface->cur_altsetting->desc.bInterfaceNumber; 559 info.report_size = dev->report_size; 560 561 /* serial number string has been read earlier 8 chars or empty string */ 562 memcpy(info.serial, dev->chip_serial, 563 sizeof(dev->chip_serial)); 564 if (cfg_descriptor == NULL) { 565 info.power = -1; /* no information available */ 566 } else { 567 /* the MaxPower is stored in units of 2mA to make it fit into a byte-value */ 568 info.power = cfg_descriptor->bMaxPower * 2; 569 } 570 io_res = copy_to_user((struct iowarrior_info __user *)arg, &info, 571 sizeof(struct iowarrior_info)); 572 if (io_res) 573 retval = -EFAULT; 574 break; 575 } 576 default: 577 /* return that we did not understand this ioctl call */ 578 retval = -ENOTTY; 579 break; 580 } 581error_out: 582 /* unlock the device */ 583 mutex_unlock(&dev->mutex); 584 kfree(buffer); 585 return retval; 586} 587 588/* 589 * iowarrior_open 590 */ 591static int iowarrior_open(struct inode *inode, struct file *file) 592{ 593 struct iowarrior *dev = NULL; 594 struct usb_interface *interface; 595 int subminor; 596 int retval = 0; 597 598 subminor = iminor(inode); 599 600 interface = usb_find_interface(&iowarrior_driver, subminor); 601 if (!interface) { 602 pr_err("%s - error, can't find device for minor %d\n", 603 __func__, subminor); 604 return -ENODEV; 605 } 606 607 dev = usb_get_intfdata(interface); 608 if (!dev) 609 return -ENODEV; 610 611 mutex_lock(&dev->mutex); 612 613 /* Only one process can open each device, no sharing. */ 614 if (dev->opened) { 615 retval = -EBUSY; 616 goto out; 617 } 618 619 /* setup interrupt handler for receiving values */ 620 if ((retval = usb_submit_urb(dev->int_in_urb, GFP_KERNEL)) < 0) { 621 dev_err(&interface->dev, "Error %d while submitting URB\n", retval); 622 retval = -EFAULT; 623 goto out; 624 } 625 /* increment our usage count for the driver */ 626 ++dev->opened; 627 /* save our object in the file's private structure */ 628 file->private_data = dev; 629 retval = 0; 630 631out: 632 mutex_unlock(&dev->mutex); 633 return retval; 634} 635 636/* 637 * iowarrior_release 638 */ 639static int iowarrior_release(struct inode *inode, struct file *file) 640{ 641 struct iowarrior *dev; 642 int retval = 0; 643 644 dev = file->private_data; 645 if (!dev) 646 return -ENODEV; 647 648 dev_dbg(&dev->interface->dev, "minor %d\n", dev->minor); 649 650 /* lock our device */ 651 mutex_lock(&dev->mutex); 652 653 if (dev->opened <= 0) { 654 retval = -ENODEV; /* close called more than once */ 655 mutex_unlock(&dev->mutex); 656 } else { 657 dev->opened = 0; /* we're closing now */ 658 retval = 0; 659 if (dev->present) { 660 /* 661 The device is still connected so we only shutdown 662 pending read-/write-ops. 663 */ 664 usb_kill_urb(dev->int_in_urb); 665 wake_up_interruptible(&dev->read_wait); 666 wake_up_interruptible(&dev->write_wait); 667 mutex_unlock(&dev->mutex); 668 } else { 669 /* The device was unplugged, cleanup resources */ 670 mutex_unlock(&dev->mutex); 671 iowarrior_delete(dev); 672 } 673 } 674 return retval; 675} 676 677static __poll_t iowarrior_poll(struct file *file, poll_table * wait) 678{ 679 struct iowarrior *dev = file->private_data; 680 __poll_t mask = 0; 681 682 if (!dev->present) 683 return EPOLLERR | EPOLLHUP; 684 685 poll_wait(file, &dev->read_wait, wait); 686 poll_wait(file, &dev->write_wait, wait); 687 688 if (!dev->present) 689 return EPOLLERR | EPOLLHUP; 690 691 if (read_index(dev) != -1) 692 mask |= EPOLLIN | EPOLLRDNORM; 693 694 if (atomic_read(&dev->write_busy) < MAX_WRITES_IN_FLIGHT) 695 mask |= EPOLLOUT | EPOLLWRNORM; 696 return mask; 697} 698 699/* 700 * File operations needed when we register this driver. 701 * This assumes that this driver NEEDS file operations, 702 * of course, which means that the driver is expected 703 * to have a node in the /dev directory. If the USB 704 * device were for a network interface then the driver 705 * would use "struct net_driver" instead, and a serial 706 * device would use "struct tty_driver". 707 */ 708static const struct file_operations iowarrior_fops = { 709 .owner = THIS_MODULE, 710 .write = iowarrior_write, 711 .read = iowarrior_read, 712 .unlocked_ioctl = iowarrior_ioctl, 713 .open = iowarrior_open, 714 .release = iowarrior_release, 715 .poll = iowarrior_poll, 716 .llseek = noop_llseek, 717}; 718 719static char *iowarrior_devnode(const struct device *dev, umode_t *mode) 720{ 721 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev)); 722} 723 724/* 725 * usb class driver info in order to get a minor number from the usb core, 726 * and to have the device registered with devfs and the driver core 727 */ 728static struct usb_class_driver iowarrior_class = { 729 .name = "iowarrior%d", 730 .devnode = iowarrior_devnode, 731 .fops = &iowarrior_fops, 732 .minor_base = IOWARRIOR_MINOR_BASE, 733}; 734 735/*---------------------------------*/ 736/* probe and disconnect functions */ 737/*---------------------------------*/ 738/* 739 * iowarrior_probe 740 * 741 * Called by the usb core when a new device is connected that it thinks 742 * this driver might be interested in. 743 */ 744static int iowarrior_probe(struct usb_interface *interface, 745 const struct usb_device_id *id) 746{ 747 struct usb_device *udev = interface_to_usbdev(interface); 748 struct iowarrior *dev = NULL; 749 struct usb_host_interface *iface_desc; 750 int retval = -ENOMEM; 751 int res; 752 753 /* allocate memory for our device state and initialize it */ 754 dev = kzalloc(sizeof(struct iowarrior), GFP_KERNEL); 755 if (!dev) 756 return retval; 757 758 mutex_init(&dev->mutex); 759 760 atomic_set(&dev->intr_idx, 0); 761 atomic_set(&dev->read_idx, 0); 762 atomic_set(&dev->overflow_flag, 0); 763 init_waitqueue_head(&dev->read_wait); 764 atomic_set(&dev->write_busy, 0); 765 init_waitqueue_head(&dev->write_wait); 766 767 dev->udev = udev; 768 dev->interface = usb_get_intf(interface); 769 770 iface_desc = interface->cur_altsetting; 771 dev->product_id = le16_to_cpu(udev->descriptor.idProduct); 772 773 init_usb_anchor(&dev->submitted); 774 775 res = usb_find_last_int_in_endpoint(iface_desc, &dev->int_in_endpoint); 776 if (res) { 777 dev_err(&interface->dev, "no interrupt-in endpoint found\n"); 778 retval = res; 779 goto error; 780 } 781 782 if ((dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW56) || 783 (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW56AM) || 784 (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW28) || 785 (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW28L) || 786 (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW100)) { 787 res = usb_find_last_int_out_endpoint(iface_desc, 788 &dev->int_out_endpoint); 789 if (res) { 790 dev_err(&interface->dev, "no interrupt-out endpoint found\n"); 791 retval = res; 792 goto error; 793 } 794 } 795 796 /* we have to check the report_size often, so remember it in the endianness suitable for our machine */ 797 dev->report_size = usb_endpoint_maxp(dev->int_in_endpoint); 798 799 /* 800 * Some devices need the report size to be different than the 801 * endpoint size. 802 */ 803 if (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0) { 804 switch (dev->product_id) { 805 case USB_DEVICE_ID_CODEMERCS_IOW56: 806 case USB_DEVICE_ID_CODEMERCS_IOW56AM: 807 dev->report_size = 7; 808 break; 809 810 case USB_DEVICE_ID_CODEMERCS_IOW28: 811 case USB_DEVICE_ID_CODEMERCS_IOW28L: 812 dev->report_size = 4; 813 break; 814 815 case USB_DEVICE_ID_CODEMERCS_IOW100: 816 dev->report_size = 12; 817 break; 818 } 819 } 820 821 /* create the urb and buffer for reading */ 822 dev->int_in_urb = usb_alloc_urb(0, GFP_KERNEL); 823 if (!dev->int_in_urb) 824 goto error; 825 dev->int_in_buffer = kmalloc(dev->report_size, GFP_KERNEL); 826 if (!dev->int_in_buffer) 827 goto error; 828 usb_fill_int_urb(dev->int_in_urb, dev->udev, 829 usb_rcvintpipe(dev->udev, 830 dev->int_in_endpoint->bEndpointAddress), 831 dev->int_in_buffer, dev->report_size, 832 iowarrior_callback, dev, 833 dev->int_in_endpoint->bInterval); 834 /* create an internal buffer for interrupt data from the device */ 835 dev->read_queue = 836 kmalloc_array(dev->report_size + 1, MAX_INTERRUPT_BUFFER, 837 GFP_KERNEL); 838 if (!dev->read_queue) 839 goto error; 840 /* Get the serial-number of the chip */ 841 memset(dev->chip_serial, 0x00, sizeof(dev->chip_serial)); 842 usb_string(udev, udev->descriptor.iSerialNumber, dev->chip_serial, 843 sizeof(dev->chip_serial)); 844 if (strlen(dev->chip_serial) != 8) 845 memset(dev->chip_serial, 0x00, sizeof(dev->chip_serial)); 846 847 /* Set the idle timeout to 0, if this is interface 0 */ 848 if (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0) { 849 usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 850 0x0A, 851 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0, 852 0, NULL, 0, USB_CTRL_SET_TIMEOUT); 853 } 854 /* allow device read and ioctl */ 855 dev->present = 1; 856 857 /* we can register the device now, as it is ready */ 858 usb_set_intfdata(interface, dev); 859 860 retval = usb_register_dev(interface, &iowarrior_class); 861 if (retval) { 862 /* something prevented us from registering this driver */ 863 dev_err(&interface->dev, "Not able to get a minor for this device.\n"); 864 goto error; 865 } 866 867 dev->minor = interface->minor; 868 869 /* let the user know what node this device is now attached to */ 870 dev_info(&interface->dev, "IOWarrior product=0x%x, serial=%s interface=%d " 871 "now attached to iowarrior%d\n", dev->product_id, dev->chip_serial, 872 iface_desc->desc.bInterfaceNumber, dev->minor - IOWARRIOR_MINOR_BASE); 873 return retval; 874 875error: 876 iowarrior_delete(dev); 877 return retval; 878} 879 880/* 881 * iowarrior_disconnect 882 * 883 * Called by the usb core when the device is removed from the system. 884 */ 885static void iowarrior_disconnect(struct usb_interface *interface) 886{ 887 struct iowarrior *dev = usb_get_intfdata(interface); 888 int minor = dev->minor; 889 890 usb_deregister_dev(interface, &iowarrior_class); 891 892 mutex_lock(&dev->mutex); 893 894 /* prevent device read, write and ioctl */ 895 dev->present = 0; 896 897 if (dev->opened) { 898 /* There is a process that holds a filedescriptor to the device , 899 so we only shutdown read-/write-ops going on. 900 Deleting the device is postponed until close() was called. 901 */ 902 usb_kill_urb(dev->int_in_urb); 903 usb_kill_anchored_urbs(&dev->submitted); 904 wake_up_interruptible(&dev->read_wait); 905 wake_up_interruptible(&dev->write_wait); 906 mutex_unlock(&dev->mutex); 907 } else { 908 /* no process is using the device, cleanup now */ 909 mutex_unlock(&dev->mutex); 910 iowarrior_delete(dev); 911 } 912 913 dev_info(&interface->dev, "I/O-Warror #%d now disconnected\n", 914 minor - IOWARRIOR_MINOR_BASE); 915} 916 917/* usb specific object needed to register this driver with the usb subsystem */ 918static struct usb_driver iowarrior_driver = { 919 .name = "iowarrior", 920 .probe = iowarrior_probe, 921 .disconnect = iowarrior_disconnect, 922 .id_table = iowarrior_ids, 923}; 924 925module_usb_driver(iowarrior_driver); 926