2 * USB Skeleton driver - 2.2
4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
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.
10 * This driver is based on the 2.6.3 version of drivers/usb/usb-skeleton.c
11 * but has been rewritten to be easier to read and use.
15 #include <linux/kernel.h>
16 #include <linux/errno.h>
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/module.h>
20 #include <linux/kref.h>
21 #include <linux/smp_lock.h>
22 #include <linux/uaccess.h>
23 #include <linux/usb.h>
24 #include <linux/mutex.h>
27 /* Define these values to match your devices */
28 #define USB_SKEL_VENDOR_ID 0xfff0
29 #define USB_SKEL_PRODUCT_ID 0xfff0
31 /* table of devices that work with this driver */
32 static const struct usb_device_id skel_table[] = {
33 { USB_DEVICE(USB_SKEL_VENDOR_ID, USB_SKEL_PRODUCT_ID) },
34 { } /* Terminating entry */
36 MODULE_DEVICE_TABLE(usb, skel_table);
39 /* Get a minor range for your devices from the usb maintainer */
40 #define USB_SKEL_MINOR_BASE 192
42 /* our private defines. if this grows any larger, use your own .h file */
43 #define MAX_TRANSFER (PAGE_SIZE - 512)
44 /* MAX_TRANSFER is chosen so that the VM is not stressed by
45 allocations > PAGE_SIZE and the number of packets in a page
46 is an integer 512 is the largest possible packet on EHCI */
47 #define WRITES_IN_FLIGHT 8
48 /* arbitrarily chosen */
50 /* Structure to hold all of our device specific stuff */
52 struct usb_device *udev; /* the usb device for this device */
53 struct usb_interface *interface; /* the interface for this device */
54 struct semaphore limit_sem; /* limiting the number of writes in progress */
55 struct usb_anchor submitted; /* in case we need to retract our submissions */
56 struct urb *bulk_in_urb; /* the urb to read data with */
57 unsigned char *bulk_in_buffer; /* the buffer to receive data */
58 size_t bulk_in_size; /* the size of the receive buffer */
59 size_t bulk_in_filled; /* number of bytes in the buffer */
60 size_t bulk_in_copied; /* already copied to user space */
61 __u8 bulk_in_endpointAddr; /* the address of the bulk in endpoint */
62 __u8 bulk_out_endpointAddr; /* the address of the bulk out endpoint */
63 int errors; /* the last request tanked */
64 int open_count; /* count the number of openers */
65 bool ongoing_read; /* a read is going on */
66 bool processed_urb; /* indicates we haven't processed the urb */
67 spinlock_t err_lock; /* lock for errors */
69 struct mutex io_mutex; /* synchronize I/O with disconnect */
70 struct completion bulk_in_completion; /* to wait for an ongoing read */
72 #define to_skel_dev(d) container_of(d, struct usb_skel, kref)
74 static struct usb_driver skel_driver;
75 static void skel_draw_down(struct usb_skel *dev);
77 static void skel_delete(struct kref *kref)
79 struct usb_skel *dev = to_skel_dev(kref);
81 usb_free_urb(dev->bulk_in_urb);
82 usb_put_dev(dev->udev);
83 kfree(dev->bulk_in_buffer);
87 static int skel_open(struct inode *inode, struct file *file)
90 struct usb_interface *interface;
95 subminor = iminor(inode);
97 interface = usb_find_interface(&skel_driver, subminor);
99 err("%s - error, can't find device for minor %d",
105 dev = usb_get_intfdata(interface);
111 /* increment our usage count for the device */
112 kref_get(&dev->kref);
114 /* lock the device to allow correctly handling errors
116 mutex_lock(&dev->io_mutex);
118 if (!dev->open_count++) {
119 retval = usb_autopm_get_interface(interface);
122 mutex_unlock(&dev->io_mutex);
123 kref_put(&dev->kref, skel_delete);
126 } /* else { //uncomment this block if you want exclusive open
129 mutex_unlock(&dev->io_mutex);
130 kref_put(&dev->kref, skel_delete);
133 /* prevent the device from being autosuspended */
135 /* save our object in the file's private structure */
136 file->private_data = dev;
137 mutex_unlock(&dev->io_mutex);
144 static int skel_release(struct inode *inode, struct file *file)
146 struct usb_skel *dev;
148 dev = (struct usb_skel *)file->private_data;
152 /* allow the device to be autosuspended */
153 mutex_lock(&dev->io_mutex);
154 if (!--dev->open_count && dev->interface)
155 usb_autopm_put_interface(dev->interface);
156 mutex_unlock(&dev->io_mutex);
158 /* decrement the count on our device */
159 kref_put(&dev->kref, skel_delete);
163 static int skel_flush(struct file *file, fl_owner_t id)
165 struct usb_skel *dev;
168 dev = (struct usb_skel *)file->private_data;
172 /* wait for io to stop */
173 mutex_lock(&dev->io_mutex);
176 /* read out errors, leave subsequent opens a clean slate */
177 spin_lock_irq(&dev->err_lock);
178 res = dev->errors ? (dev->errors == -EPIPE ? -EPIPE : -EIO) : 0;
180 spin_unlock_irq(&dev->err_lock);
182 mutex_unlock(&dev->io_mutex);
187 static void skel_read_bulk_callback(struct urb *urb)
189 struct usb_skel *dev;
193 spin_lock(&dev->err_lock);
194 /* sync/async unlink faults aren't errors */
196 if (!(urb->status == -ENOENT ||
197 urb->status == -ECONNRESET ||
198 urb->status == -ESHUTDOWN))
199 err("%s - nonzero write bulk status received: %d",
200 __func__, urb->status);
202 dev->errors = urb->status;
204 dev->bulk_in_filled = urb->actual_length;
206 dev->ongoing_read = 0;
207 spin_unlock(&dev->err_lock);
209 complete(&dev->bulk_in_completion);
212 static int skel_do_read_io(struct usb_skel *dev, size_t count)
217 usb_fill_bulk_urb(dev->bulk_in_urb,
219 usb_rcvbulkpipe(dev->udev,
220 dev->bulk_in_endpointAddr),
222 min(dev->bulk_in_size, count),
223 skel_read_bulk_callback,
225 /* tell everybody to leave the URB alone */
226 spin_lock_irq(&dev->err_lock);
227 dev->ongoing_read = 1;
228 spin_unlock_irq(&dev->err_lock);
231 rv = usb_submit_urb(dev->bulk_in_urb, GFP_KERNEL);
233 err("%s - failed submitting read urb, error %d",
235 dev->bulk_in_filled = 0;
236 rv = (rv == -ENOMEM) ? rv : -EIO;
237 spin_lock_irq(&dev->err_lock);
238 dev->ongoing_read = 0;
239 spin_unlock_irq(&dev->err_lock);
245 static ssize_t skel_read(struct file *file, char *buffer, size_t count,
248 struct usb_skel *dev;
252 dev = (struct usb_skel *)file->private_data;
254 /* if we cannot read at all, return EOF */
255 if (!dev->bulk_in_urb || !count)
258 /* no concurrent readers */
259 rv = mutex_lock_interruptible(&dev->io_mutex);
263 if (!dev->interface) { /* disconnect() was called */
268 /* if IO is under way, we must not touch things */
270 spin_lock_irq(&dev->err_lock);
271 ongoing_io = dev->ongoing_read;
272 spin_unlock_irq(&dev->err_lock);
275 /* nonblocking IO shall not wait */
276 if (file->f_flags & O_NONBLOCK) {
281 * IO may take forever
282 * hence wait in an interruptible state
284 rv = wait_for_completion_interruptible(&dev->bulk_in_completion);
288 * by waiting we also semiprocessed the urb
291 dev->bulk_in_copied = 0;
292 dev->processed_urb = 1;
295 if (!dev->processed_urb) {
297 * the URB hasn't been processed
300 wait_for_completion(&dev->bulk_in_completion);
301 dev->bulk_in_copied = 0;
302 dev->processed_urb = 1;
305 /* errors must be reported */
308 /* any error is reported once */
310 /* to preserve notifications about reset */
311 rv = (rv == -EPIPE) ? rv : -EIO;
312 /* no data to deliver */
313 dev->bulk_in_filled = 0;
319 * if the buffer is filled we may satisfy the read
320 * else we need to start IO
323 if (dev->bulk_in_filled) {
324 /* we had read data */
325 size_t available = dev->bulk_in_filled - dev->bulk_in_copied;
326 size_t chunk = min(available, count);
330 * all data has been used
331 * actual IO needs to be done
333 rv = skel_do_read_io(dev, count);
341 * chunk tells us how much shall be copied
344 if (copy_to_user(buffer,
345 dev->bulk_in_buffer + dev->bulk_in_copied,
351 dev->bulk_in_copied += chunk;
354 * if we are asked for more than we have,
355 * we start IO but don't wait
357 if (available < count)
358 skel_do_read_io(dev, count - chunk);
360 /* no data in the buffer */
361 rv = skel_do_read_io(dev, count);
364 else if (!(file->f_flags & O_NONBLOCK))
369 mutex_unlock(&dev->io_mutex);
373 static void skel_write_bulk_callback(struct urb *urb)
375 struct usb_skel *dev;
379 /* sync/async unlink faults aren't errors */
381 if (!(urb->status == -ENOENT ||
382 urb->status == -ECONNRESET ||
383 urb->status == -ESHUTDOWN))
384 err("%s - nonzero write bulk status received: %d",
385 __func__, urb->status);
387 spin_lock(&dev->err_lock);
388 dev->errors = urb->status;
389 spin_unlock(&dev->err_lock);
392 /* free up our allocated buffer */
393 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
394 urb->transfer_buffer, urb->transfer_dma);
398 static ssize_t skel_write(struct file *file, const char *user_buffer,
399 size_t count, loff_t *ppos)
401 struct usb_skel *dev;
403 struct urb *urb = NULL;
405 size_t writesize = min(count, (size_t)MAX_TRANSFER);
407 dev = (struct usb_skel *)file->private_data;
409 /* verify that we actually have some data to write */
414 * limit the number of URBs in flight to stop a user from using up all
417 if (!(file->f_flags & O_NONBLOCK)) {
418 if (down_interruptible(&dev->limit_sem)) {
419 retval = -ERESTARTSYS;
423 if (down_trylock(&dev->limit_sem)) {
429 spin_lock_irq(&dev->err_lock);
430 retval = dev->errors;
432 /* any error is reported once */
434 /* to preserve notifications about reset */
435 retval = (retval == -EPIPE) ? retval : -EIO;
437 spin_unlock_irq(&dev->err_lock);
441 /* create a urb, and a buffer for it, and copy the data to the urb */
442 urb = usb_alloc_urb(0, GFP_KERNEL);
448 buf = usb_buffer_alloc(dev->udev, writesize, GFP_KERNEL,
455 if (copy_from_user(buf, user_buffer, writesize)) {
460 /* this lock makes sure we don't submit URBs to gone devices */
461 mutex_lock(&dev->io_mutex);
462 if (!dev->interface) { /* disconnect() was called */
463 mutex_unlock(&dev->io_mutex);
468 /* initialize the urb properly */
469 usb_fill_bulk_urb(urb, dev->udev,
470 usb_sndbulkpipe(dev->udev, dev->bulk_out_endpointAddr),
471 buf, writesize, skel_write_bulk_callback, dev);
472 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
473 usb_anchor_urb(urb, &dev->submitted);
475 /* send the data out the bulk port */
476 retval = usb_submit_urb(urb, GFP_KERNEL);
477 mutex_unlock(&dev->io_mutex);
479 err("%s - failed submitting write urb, error %d", __func__,
485 * release our reference to this urb, the USB core will eventually free
494 usb_unanchor_urb(urb);
497 usb_buffer_free(dev->udev, writesize, buf, urb->transfer_dma);
506 static const struct file_operations skel_fops = {
507 .owner = THIS_MODULE,
511 .release = skel_release,
516 * usb class driver info in order to get a minor number from the usb core,
517 * and to have the device registered with the driver core
519 static struct usb_class_driver skel_class = {
522 .minor_base = USB_SKEL_MINOR_BASE,
525 static int skel_probe(struct usb_interface *interface,
526 const struct usb_device_id *id)
528 struct usb_skel *dev;
529 struct usb_host_interface *iface_desc;
530 struct usb_endpoint_descriptor *endpoint;
533 int retval = -ENOMEM;
535 /* allocate memory for our device state and initialize it */
536 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
538 err("Out of memory");
541 kref_init(&dev->kref);
542 sema_init(&dev->limit_sem, WRITES_IN_FLIGHT);
543 mutex_init(&dev->io_mutex);
544 spin_lock_init(&dev->err_lock);
545 init_usb_anchor(&dev->submitted);
546 init_completion(&dev->bulk_in_completion);
548 dev->udev = usb_get_dev(interface_to_usbdev(interface));
549 dev->interface = interface;
551 /* set up the endpoint information */
552 /* use only the first bulk-in and bulk-out endpoints */
553 iface_desc = interface->cur_altsetting;
554 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
555 endpoint = &iface_desc->endpoint[i].desc;
557 if (!dev->bulk_in_endpointAddr &&
558 usb_endpoint_is_bulk_in(endpoint)) {
559 /* we found a bulk in endpoint */
560 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
561 dev->bulk_in_size = buffer_size;
562 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
563 dev->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
564 if (!dev->bulk_in_buffer) {
565 err("Could not allocate bulk_in_buffer");
568 dev->bulk_in_urb = usb_alloc_urb(0, GFP_KERNEL);
569 if (!dev->bulk_in_urb) {
570 err("Could not allocate bulk_in_urb");
575 if (!dev->bulk_out_endpointAddr &&
576 usb_endpoint_is_bulk_out(endpoint)) {
577 /* we found a bulk out endpoint */
578 dev->bulk_out_endpointAddr = endpoint->bEndpointAddress;
581 if (!(dev->bulk_in_endpointAddr && dev->bulk_out_endpointAddr)) {
582 err("Could not find both bulk-in and bulk-out endpoints");
586 /* save our data pointer in this interface device */
587 usb_set_intfdata(interface, dev);
589 /* we can register the device now, as it is ready */
590 retval = usb_register_dev(interface, &skel_class);
592 /* something prevented us from registering this driver */
593 err("Not able to get a minor for this device.");
594 usb_set_intfdata(interface, NULL);
598 /* let the user know what node this device is now attached to */
599 dev_info(&interface->dev,
600 "USB Skeleton device now attached to USBSkel-%d",
606 /* this frees allocated memory */
607 kref_put(&dev->kref, skel_delete);
611 static void skel_disconnect(struct usb_interface *interface)
613 struct usb_skel *dev;
614 int minor = interface->minor;
616 dev = usb_get_intfdata(interface);
617 usb_set_intfdata(interface, NULL);
619 /* give back our minor */
620 usb_deregister_dev(interface, &skel_class);
622 /* prevent more I/O from starting */
623 mutex_lock(&dev->io_mutex);
624 dev->interface = NULL;
625 mutex_unlock(&dev->io_mutex);
627 usb_kill_anchored_urbs(&dev->submitted);
629 /* decrement our usage count */
630 kref_put(&dev->kref, skel_delete);
632 dev_info(&interface->dev, "USB Skeleton #%d now disconnected", minor);
635 static void skel_draw_down(struct usb_skel *dev)
639 time = usb_wait_anchor_empty_timeout(&dev->submitted, 1000);
641 usb_kill_anchored_urbs(&dev->submitted);
642 usb_kill_urb(dev->bulk_in_urb);
645 static int skel_suspend(struct usb_interface *intf, pm_message_t message)
647 struct usb_skel *dev = usb_get_intfdata(intf);
655 static int skel_resume(struct usb_interface *intf)
660 static int skel_pre_reset(struct usb_interface *intf)
662 struct usb_skel *dev = usb_get_intfdata(intf);
664 mutex_lock(&dev->io_mutex);
670 static int skel_post_reset(struct usb_interface *intf)
672 struct usb_skel *dev = usb_get_intfdata(intf);
674 /* we are sure no URBs are active - no locking needed */
675 dev->errors = -EPIPE;
676 mutex_unlock(&dev->io_mutex);
681 static struct usb_driver skel_driver = {
684 .disconnect = skel_disconnect,
685 .suspend = skel_suspend,
686 .resume = skel_resume,
687 .pre_reset = skel_pre_reset,
688 .post_reset = skel_post_reset,
689 .id_table = skel_table,
690 .supports_autosuspend = 1,
693 static int __init usb_skel_init(void)
697 /* register this driver with the USB subsystem */
698 result = usb_register(&skel_driver);
700 err("usb_register failed. Error number %d", result);
705 static void __exit usb_skel_exit(void)
707 /* deregister this driver with the USB subsystem */
708 usb_deregister(&skel_driver);
711 module_init(usb_skel_init);
712 module_exit(usb_skel_exit);
714 MODULE_LICENSE("GPL");