aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/usb/usb-skeleton.c
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/usb/usb-skeleton.c')
-rw-r--r--drivers/usb/usb-skeleton.c102
1 files changed, 66 insertions, 36 deletions
diff --git a/drivers/usb/usb-skeleton.c b/drivers/usb/usb-skeleton.c
index 4de9fb56ebfc..1b51d3187a95 100644
--- a/drivers/usb/usb-skeleton.c
+++ b/drivers/usb/usb-skeleton.c
@@ -1,5 +1,5 @@
1/* 1/*
2 * USB Skeleton driver - 2.0 2 * USB Skeleton driver - 2.2
3 * 3 *
4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com) 4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
5 * 5 *
@@ -7,13 +7,11 @@
7 * modify it under the terms of the GNU General Public License as 7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation, version 2. 8 * published by the Free Software Foundation, version 2.
9 * 9 *
10 * This driver is based on the 2.6.3 version of drivers/usb/usb-skeleton.c 10 * This driver is based on the 2.6.3 version of drivers/usb/usb-skeleton.c
11 * but has been rewritten to be easy to read and use, as no locks are now 11 * but has been rewritten to be easier to read and use.
12 * needed anymore.
13 * 12 *
14 */ 13 */
15 14
16#include <linux/config.h>
17#include <linux/kernel.h> 15#include <linux/kernel.h>
18#include <linux/errno.h> 16#include <linux/errno.h>
19#include <linux/init.h> 17#include <linux/init.h>
@@ -22,6 +20,7 @@
22#include <linux/kref.h> 20#include <linux/kref.h>
23#include <asm/uaccess.h> 21#include <asm/uaccess.h>
24#include <linux/usb.h> 22#include <linux/usb.h>
23#include <linux/mutex.h>
25 24
26 25
27/* Define these values to match your devices */ 26/* Define these values to match your devices */
@@ -33,38 +32,39 @@ static struct usb_device_id skel_table [] = {
33 { USB_DEVICE(USB_SKEL_VENDOR_ID, USB_SKEL_PRODUCT_ID) }, 32 { USB_DEVICE(USB_SKEL_VENDOR_ID, USB_SKEL_PRODUCT_ID) },
34 { } /* Terminating entry */ 33 { } /* Terminating entry */
35}; 34};
36MODULE_DEVICE_TABLE (usb, skel_table); 35MODULE_DEVICE_TABLE(usb, skel_table);
37 36
38 37
39/* Get a minor range for your devices from the usb maintainer */ 38/* Get a minor range for your devices from the usb maintainer */
40#define USB_SKEL_MINOR_BASE 192 39#define USB_SKEL_MINOR_BASE 192
41 40
42/* our private defines. if this grows any larger, use your own .h file */ 41/* our private defines. if this grows any larger, use your own .h file */
43#define MAX_TRANSFER ( PAGE_SIZE - 512 ) 42#define MAX_TRANSFER (PAGE_SIZE - 512)
44#define WRITES_IN_FLIGHT 8 43#define WRITES_IN_FLIGHT 8
45 44
46/* Structure to hold all of our device specific stuff */ 45/* Structure to hold all of our device specific stuff */
47struct usb_skel { 46struct usb_skel {
48 struct usb_device * udev; /* the usb device for this device */ 47 struct usb_device *dev; /* the usb device for this device */
49 struct usb_interface * interface; /* the interface for this device */ 48 struct usb_interface *interface; /* the interface for this device */
50 struct semaphore limit_sem; /* limiting the number of writes in progress */ 49 struct semaphore limit_sem; /* limiting the number of writes in progress */
51 unsigned char * bulk_in_buffer; /* the buffer to receive data */ 50 unsigned char *bulk_in_buffer; /* the buffer to receive data */
52 size_t bulk_in_size; /* the size of the receive buffer */ 51 size_t bulk_in_size; /* the size of the receive buffer */
53 __u8 bulk_in_endpointAddr; /* the address of the bulk in endpoint */ 52 __u8 bulk_in_endpointAddr; /* the address of the bulk in endpoint */
54 __u8 bulk_out_endpointAddr; /* the address of the bulk out endpoint */ 53 __u8 bulk_out_endpointAddr; /* the address of the bulk out endpoint */
55 struct kref kref; 54 struct kref kref;
55 struct mutex io_mutex; /* synchronize I/O with disconnect */
56}; 56};
57#define to_skel_dev(d) container_of(d, struct usb_skel, kref) 57#define to_skel_dev(d) container_of(d, struct usb_skel, kref)
58 58
59static struct usb_driver skel_driver; 59static struct usb_driver skel_driver;
60 60
61static void skel_delete(struct kref *kref) 61static void skel_delete(struct kref *kref)
62{ 62{
63 struct usb_skel *dev = to_skel_dev(kref); 63 struct usb_skel *dev = to_skel_dev(kref);
64 64
65 usb_put_dev(dev->udev); 65 usb_put_dev(dev->udev);
66 kfree (dev->bulk_in_buffer); 66 kfree(dev->bulk_in_buffer);
67 kfree (dev); 67 kfree(dev);
68} 68}
69 69
70static int skel_open(struct inode *inode, struct file *file) 70static int skel_open(struct inode *inode, struct file *file)
@@ -90,6 +90,11 @@ static int skel_open(struct inode *inode, struct file *file)
90 goto exit; 90 goto exit;
91 } 91 }
92 92
93 /* prevent the device from being autosuspended */
94 retval = usb_autopm_get_interface(interface);
95 if (retval)
96 goto exit;
97
93 /* increment our usage count for the device */ 98 /* increment our usage count for the device */
94 kref_get(&dev->kref); 99 kref_get(&dev->kref);
95 100
@@ -108,6 +113,12 @@ static int skel_release(struct inode *inode, struct file *file)
108 if (dev == NULL) 113 if (dev == NULL)
109 return -ENODEV; 114 return -ENODEV;
110 115
116 /* allow the device to be autosuspended */
117 mutex_lock(&dev->io_mutex);
118 if (dev->interface)
119 usb_autopm_put_interface(dev->interface);
120 mutex_unlock(&dev->io_mutex);
121
111 /* decrement the count on our device */ 122 /* decrement the count on our device */
112 kref_put(&dev->kref, skel_delete); 123 kref_put(&dev->kref, skel_delete);
113 return 0; 124 return 0;
@@ -116,11 +127,17 @@ static int skel_release(struct inode *inode, struct file *file)
116static ssize_t skel_read(struct file *file, char *buffer, size_t count, loff_t *ppos) 127static ssize_t skel_read(struct file *file, char *buffer, size_t count, loff_t *ppos)
117{ 128{
118 struct usb_skel *dev; 129 struct usb_skel *dev;
119 int retval = 0; 130 int retval;
120 int bytes_read; 131 int bytes_read;
121 132
122 dev = (struct usb_skel *)file->private_data; 133 dev = (struct usb_skel *)file->private_data;
123 134
135 mutex_lock(&dev->io_mutex);
136 if (!dev->interface) { /* disconnect() was called */
137 retval = -ENODEV;
138 goto exit;
139 }
140
124 /* do a blocking bulk read to get data from the device */ 141 /* do a blocking bulk read to get data from the device */
125 retval = usb_bulk_msg(dev->udev, 142 retval = usb_bulk_msg(dev->udev,
126 usb_rcvbulkpipe(dev->udev, dev->bulk_in_endpointAddr), 143 usb_rcvbulkpipe(dev->udev, dev->bulk_in_endpointAddr),
@@ -136,6 +153,8 @@ static ssize_t skel_read(struct file *file, char *buffer, size_t count, loff_t *
136 retval = bytes_read; 153 retval = bytes_read;
137 } 154 }
138 155
156exit:
157 mutex_unlock(&dev->io_mutex);
139 return retval; 158 return retval;
140} 159}
141 160
@@ -146,16 +165,16 @@ static void skel_write_bulk_callback(struct urb *urb, struct pt_regs *regs)
146 dev = (struct usb_skel *)urb->context; 165 dev = (struct usb_skel *)urb->context;
147 166
148 /* sync/async unlink faults aren't errors */ 167 /* sync/async unlink faults aren't errors */
149 if (urb->status && 168 if (urb->status &&
150 !(urb->status == -ENOENT || 169 !(urb->status == -ENOENT ||
151 urb->status == -ECONNRESET || 170 urb->status == -ECONNRESET ||
152 urb->status == -ESHUTDOWN)) { 171 urb->status == -ESHUTDOWN)) {
153 dbg("%s - nonzero write bulk status received: %d", 172 err("%s - nonzero write bulk status received: %d",
154 __FUNCTION__, urb->status); 173 __FUNCTION__, urb->status);
155 } 174 }
156 175
157 /* free up our allocated buffer */ 176 /* free up our allocated buffer */
158 usb_buffer_free(urb->dev, urb->transfer_buffer_length, 177 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
159 urb->transfer_buffer, urb->transfer_dma); 178 urb->transfer_buffer, urb->transfer_dma);
160 up(&dev->limit_sem); 179 up(&dev->limit_sem);
161} 180}
@@ -180,6 +199,12 @@ static ssize_t skel_write(struct file *file, const char *user_buffer, size_t cou
180 goto exit; 199 goto exit;
181 } 200 }
182 201
202 mutex_lock(&dev->io_mutex);
203 if (!dev->interface) { /* disconnect() was called */
204 retval = -ENODEV;
205 goto error;
206 }
207
183 /* create a urb, and a buffer for it, and copy the data to the urb */ 208 /* create a urb, and a buffer for it, and copy the data to the urb */
184 urb = usb_alloc_urb(0, GFP_KERNEL); 209 urb = usb_alloc_urb(0, GFP_KERNEL);
185 if (!urb) { 210 if (!urb) {
@@ -214,17 +239,22 @@ static ssize_t skel_write(struct file *file, const char *user_buffer, size_t cou
214 /* release our reference to this urb, the USB core will eventually free it entirely */ 239 /* release our reference to this urb, the USB core will eventually free it entirely */
215 usb_free_urb(urb); 240 usb_free_urb(urb);
216 241
217exit: 242 mutex_unlock(&dev->io_mutex);
218 return writesize; 243 return writesize;
219 244
220error: 245error:
221 usb_buffer_free(dev->udev, writesize, buf, urb->transfer_dma); 246 if (urb) {
222 usb_free_urb(urb); 247 usb_buffer_free(dev->udev, writesize, buf, urb->transfer_dma);
248 usb_free_urb(urb);
249 }
250 mutex_unlock(&dev->io_mutex);
223 up(&dev->limit_sem); 251 up(&dev->limit_sem);
252
253exit:
224 return retval; 254 return retval;
225} 255}
226 256
227static struct file_operations skel_fops = { 257static const struct file_operations skel_fops = {
228 .owner = THIS_MODULE, 258 .owner = THIS_MODULE,
229 .read = skel_read, 259 .read = skel_read,
230 .write = skel_write, 260 .write = skel_write,
@@ -232,7 +262,7 @@ static struct file_operations skel_fops = {
232 .release = skel_release, 262 .release = skel_release,
233}; 263};
234 264
235/* 265/*
236 * usb class driver info in order to get a minor number from the usb core, 266 * usb class driver info in order to get a minor number from the usb core,
237 * and to have the device registered with the driver core 267 * and to have the device registered with the driver core
238 */ 268 */
@@ -244,7 +274,7 @@ static struct usb_class_driver skel_class = {
244 274
245static int skel_probe(struct usb_interface *interface, const struct usb_device_id *id) 275static int skel_probe(struct usb_interface *interface, const struct usb_device_id *id)
246{ 276{
247 struct usb_skel *dev = NULL; 277 struct usb_skel *dev;
248 struct usb_host_interface *iface_desc; 278 struct usb_host_interface *iface_desc;
249 struct usb_endpoint_descriptor *endpoint; 279 struct usb_endpoint_descriptor *endpoint;
250 size_t buffer_size; 280 size_t buffer_size;
@@ -253,12 +283,13 @@ static int skel_probe(struct usb_interface *interface, const struct usb_device_i
253 283
254 /* allocate memory for our device state and initialize it */ 284 /* allocate memory for our device state and initialize it */
255 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 285 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
256 if (dev == NULL) { 286 if (!dev) {
257 err("Out of memory"); 287 err("Out of memory");
258 goto error; 288 goto error;
259 } 289 }
260 kref_init(&dev->kref); 290 kref_init(&dev->kref);
261 sema_init(&dev->limit_sem, WRITES_IN_FLIGHT); 291 sema_init(&dev->limit_sem, WRITES_IN_FLIGHT);
292 mutex_init(&dev->io_mutex);
262 293
263 dev->udev = usb_get_dev(interface_to_usbdev(interface)); 294 dev->udev = usb_get_dev(interface_to_usbdev(interface));
264 dev->interface = interface; 295 dev->interface = interface;
@@ -270,10 +301,7 @@ static int skel_probe(struct usb_interface *interface, const struct usb_device_i
270 endpoint = &iface_desc->endpoint[i].desc; 301 endpoint = &iface_desc->endpoint[i].desc;
271 302
272 if (!dev->bulk_in_endpointAddr && 303 if (!dev->bulk_in_endpointAddr &&
273 ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) 304 usb_endpoint_is_bulk_in(endpoint)) {
274 == USB_DIR_IN) &&
275 ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
276 == USB_ENDPOINT_XFER_BULK)) {
277 /* we found a bulk in endpoint */ 305 /* we found a bulk in endpoint */
278 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize); 306 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
279 dev->bulk_in_size = buffer_size; 307 dev->bulk_in_size = buffer_size;
@@ -286,10 +314,7 @@ static int skel_probe(struct usb_interface *interface, const struct usb_device_i
286 } 314 }
287 315
288 if (!dev->bulk_out_endpointAddr && 316 if (!dev->bulk_out_endpointAddr &&
289 ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) 317 usb_endpoint_is_bulk_out(endpoint)) {
290 == USB_DIR_OUT) &&
291 ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
292 == USB_ENDPOINT_XFER_BULK)) {
293 /* we found a bulk out endpoint */ 318 /* we found a bulk out endpoint */
294 dev->bulk_out_endpointAddr = endpoint->bEndpointAddress; 319 dev->bulk_out_endpointAddr = endpoint->bEndpointAddress;
295 } 320 }
@@ -335,6 +360,11 @@ static void skel_disconnect(struct usb_interface *interface)
335 /* give back our minor */ 360 /* give back our minor */
336 usb_deregister_dev(interface, &skel_class); 361 usb_deregister_dev(interface, &skel_class);
337 362
363 /* prevent more I/O from starting */
364 mutex_lock(&dev->io_mutex);
365 dev->interface = NULL;
366 mutex_unlock(&dev->io_mutex);
367
338 unlock_kernel(); 368 unlock_kernel();
339 369
340 /* decrement our usage count */ 370 /* decrement our usage count */
@@ -368,7 +398,7 @@ static void __exit usb_skel_exit(void)
368 usb_deregister(&skel_driver); 398 usb_deregister(&skel_driver);
369} 399}
370 400
371module_init (usb_skel_init); 401module_init(usb_skel_init);
372module_exit (usb_skel_exit); 402module_exit(usb_skel_exit);
373 403
374MODULE_LICENSE("GPL"); 404MODULE_LICENSE("GPL");