USB: use usb_endpoint_maxp() instead of le16_to_cpu()
[linux-2.6-block.git] / drivers / usb / misc / usblcd.c
CommitLineData
1da177e4
LT
1/*****************************************************************************
2 * USBLCD Kernel Driver *
3 * Version 1.05 *
4 * (C) 2005 Georges Toth <g.toth@e-biz.lu> *
5 * *
6 * This file is licensed under the GPL. See COPYING in the package. *
7 * Based on usb-skeleton.c 2.0 by Greg Kroah-Hartman (greg@kroah.com) *
8 * *
9 * *
10 * 28.02.05 Complete rewrite of the original usblcd.c driver, *
11 * based on usb_skeleton.c. *
12 * This new driver allows more than one USB-LCD to be connected *
13 * and controlled, at once *
14 *****************************************************************************/
15#include <linux/module.h>
16#include <linux/kernel.h>
17#include <linux/init.h>
18#include <linux/slab.h>
19#include <linux/errno.h>
d5d1ceac 20#include <linux/mutex.h>
507a3ea7 21#include <linux/uaccess.h>
1da177e4
LT
22#include <linux/usb.h>
23
24#define DRIVER_VERSION "USBLCD Driver Version 1.05"
25
26#define USBLCD_MINOR 144
27
28#define IOCTL_GET_HARD_VERSION 1
29#define IOCTL_GET_DRV_VERSION 2
30
31
925ce689 32static DEFINE_MUTEX(lcd_mutex);
33b9e162 33static const struct usb_device_id id_table[] = {
1da177e4
LT
34 { .idVendor = 0x10D2, .match_flags = USB_DEVICE_ID_MATCH_VENDOR, },
35 { },
36};
507a3ea7 37MODULE_DEVICE_TABLE(usb, id_table);
1da177e4 38
d5d1ceac
ON
39static DEFINE_MUTEX(open_disc_mutex);
40
1da177e4
LT
41
42struct usb_lcd {
507a3ea7
ZP
43 struct usb_device *udev; /* init: probe_lcd */
44 struct usb_interface *interface; /* the interface for
45 this device */
46 unsigned char *bulk_in_buffer; /* the buffer to receive
47 data */
48 size_t bulk_in_size; /* the size of the
49 receive buffer */
50 __u8 bulk_in_endpointAddr; /* the address of the
51 bulk in endpoint */
52 __u8 bulk_out_endpointAddr; /* the address of the
53 bulk out endpoint */
5afeb104 54 struct kref kref;
507a3ea7
ZP
55 struct semaphore limit_sem; /* to stop writes at
56 full throttle from
57 using up all RAM */
58 struct usb_anchor submitted; /* URBs to wait for
59 before suspend */
1da177e4
LT
60};
61#define to_lcd_dev(d) container_of(d, struct usb_lcd, kref)
62
5afeb104
ON
63#define USB_LCD_CONCURRENT_WRITES 5
64
1da177e4
LT
65static struct usb_driver lcd_driver;
66
67
68static void lcd_delete(struct kref *kref)
69{
70 struct usb_lcd *dev = to_lcd_dev(kref);
71
72 usb_put_dev(dev->udev);
507a3ea7
ZP
73 kfree(dev->bulk_in_buffer);
74 kfree(dev);
1da177e4
LT
75}
76
77
78static int lcd_open(struct inode *inode, struct file *file)
79{
80 struct usb_lcd *dev;
81 struct usb_interface *interface;
7bbe990c 82 int subminor, r;
1da177e4 83
925ce689 84 mutex_lock(&lcd_mutex);
1da177e4
LT
85 subminor = iminor(inode);
86
87 interface = usb_find_interface(&lcd_driver, subminor);
88 if (!interface) {
925ce689 89 mutex_unlock(&lcd_mutex);
507a3ea7 90 err("USBLCD: %s - error, can't find device for minor %d",
441b62c1 91 __func__, subminor);
d4ead16f 92 return -ENODEV;
1da177e4
LT
93 }
94
d5d1ceac 95 mutex_lock(&open_disc_mutex);
1da177e4 96 dev = usb_get_intfdata(interface);
d5d1ceac
ON
97 if (!dev) {
98 mutex_unlock(&open_disc_mutex);
925ce689 99 mutex_unlock(&lcd_mutex);
d4ead16f 100 return -ENODEV;
d5d1ceac 101 }
1da177e4
LT
102
103 /* increment our usage count for the device */
104 kref_get(&dev->kref);
d5d1ceac 105 mutex_unlock(&open_disc_mutex);
1da177e4 106
7bbe990c
ON
107 /* grab a power reference */
108 r = usb_autopm_get_interface(interface);
109 if (r < 0) {
110 kref_put(&dev->kref, lcd_delete);
925ce689 111 mutex_unlock(&lcd_mutex);
7bbe990c
ON
112 return r;
113 }
114
1da177e4
LT
115 /* save our object in the file's private structure */
116 file->private_data = dev;
925ce689 117 mutex_unlock(&lcd_mutex);
1da177e4 118
d4ead16f 119 return 0;
1da177e4
LT
120}
121
122static int lcd_release(struct inode *inode, struct file *file)
123{
124 struct usb_lcd *dev;
125
5bd6e8b3 126 dev = file->private_data;
1da177e4
LT
127 if (dev == NULL)
128 return -ENODEV;
129
130 /* decrement the count on our device */
7bbe990c 131 usb_autopm_put_interface(dev->interface);
1da177e4
LT
132 kref_put(&dev->kref, lcd_delete);
133 return 0;
134}
135
507a3ea7
ZP
136static ssize_t lcd_read(struct file *file, char __user * buffer,
137 size_t count, loff_t *ppos)
1da177e4
LT
138{
139 struct usb_lcd *dev;
140 int retval = 0;
141 int bytes_read;
142
5bd6e8b3 143 dev = file->private_data;
1da177e4
LT
144
145 /* do a blocking bulk read to get data from the device */
507a3ea7
ZP
146 retval = usb_bulk_msg(dev->udev,
147 usb_rcvbulkpipe(dev->udev,
148 dev->bulk_in_endpointAddr),
1da177e4
LT
149 dev->bulk_in_buffer,
150 min(dev->bulk_in_size, count),
151 &bytes_read, 10000);
152
153 /* if the read was successful, copy the data to userspace */
154 if (!retval) {
155 if (copy_to_user(buffer, dev->bulk_in_buffer, bytes_read))
156 retval = -EFAULT;
157 else
158 retval = bytes_read;
159 }
160
161 return retval;
162}
163
5cb4aeca 164static long lcd_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1da177e4
LT
165{
166 struct usb_lcd *dev;
167 u16 bcdDevice;
168 char buf[30];
169
5bd6e8b3 170 dev = file->private_data;
1da177e4
LT
171 if (dev == NULL)
172 return -ENODEV;
507a3ea7 173
1da177e4
LT
174 switch (cmd) {
175 case IOCTL_GET_HARD_VERSION:
925ce689 176 mutex_lock(&lcd_mutex);
1da177e4 177 bcdDevice = le16_to_cpu((dev->udev)->descriptor.bcdDevice);
507a3ea7 178 sprintf(buf, "%1d%1d.%1d%1d",
1da177e4
LT
179 (bcdDevice & 0xF000)>>12,
180 (bcdDevice & 0xF00)>>8,
181 (bcdDevice & 0xF0)>>4,
182 (bcdDevice & 0xF));
925ce689 183 mutex_unlock(&lcd_mutex);
507a3ea7 184 if (copy_to_user((void __user *)arg, buf, strlen(buf)) != 0)
1da177e4
LT
185 return -EFAULT;
186 break;
187 case IOCTL_GET_DRV_VERSION:
507a3ea7
ZP
188 sprintf(buf, DRIVER_VERSION);
189 if (copy_to_user((void __user *)arg, buf, strlen(buf)) != 0)
1da177e4
LT
190 return -EFAULT;
191 break;
192 default:
193 return -ENOTTY;
194 break;
195 }
196
197 return 0;
198}
199
7d12e780 200static void lcd_write_bulk_callback(struct urb *urb)
1da177e4
LT
201{
202 struct usb_lcd *dev;
0723af13 203 int status = urb->status;
1da177e4 204
cdc97792 205 dev = urb->context;
1da177e4
LT
206
207 /* sync/async unlink faults aren't errors */
0723af13
GKH
208 if (status &&
209 !(status == -ENOENT ||
210 status == -ECONNRESET ||
507a3ea7 211 status == -ESHUTDOWN)) {
1da177e4 212 dbg("USBLCD: %s - nonzero write bulk status received: %d",
441b62c1 213 __func__, status);
1da177e4
LT
214 }
215
216 /* free up our allocated buffer */
997ea58e
DM
217 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
218 urb->transfer_buffer, urb->transfer_dma);
5afeb104 219 up(&dev->limit_sem);
1da177e4
LT
220}
221
507a3ea7
ZP
222static ssize_t lcd_write(struct file *file, const char __user * user_buffer,
223 size_t count, loff_t *ppos)
1da177e4
LT
224{
225 struct usb_lcd *dev;
507a3ea7 226 int retval = 0, r;
1da177e4
LT
227 struct urb *urb = NULL;
228 char *buf = NULL;
507a3ea7 229
5bd6e8b3 230 dev = file->private_data;
507a3ea7 231
1da177e4
LT
232 /* verify that we actually have some data to write */
233 if (count == 0)
234 goto exit;
235
5afeb104
ON
236 r = down_interruptible(&dev->limit_sem);
237 if (r < 0)
238 return -EINTR;
239
1da177e4
LT
240 /* create a urb, and a buffer for it, and copy the data to the urb */
241 urb = usb_alloc_urb(0, GFP_KERNEL);
5afeb104
ON
242 if (!urb) {
243 retval = -ENOMEM;
244 goto err_no_buf;
245 }
507a3ea7
ZP
246
247 buf = usb_alloc_coherent(dev->udev, count, GFP_KERNEL,
248 &urb->transfer_dma);
1da177e4
LT
249 if (!buf) {
250 retval = -ENOMEM;
251 goto error;
252 }
507a3ea7 253
1da177e4
LT
254 if (copy_from_user(buf, user_buffer, count)) {
255 retval = -EFAULT;
256 goto error;
257 }
507a3ea7 258
1da177e4
LT
259 /* initialize the urb properly */
260 usb_fill_bulk_urb(urb, dev->udev,
507a3ea7
ZP
261 usb_sndbulkpipe(dev->udev,
262 dev->bulk_out_endpointAddr),
1da177e4
LT
263 buf, count, lcd_write_bulk_callback, dev);
264 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
7bbe990c
ON
265
266 usb_anchor_urb(urb, &dev->submitted);
507a3ea7 267
1da177e4
LT
268 /* send the data out the bulk port */
269 retval = usb_submit_urb(urb, GFP_KERNEL);
270 if (retval) {
507a3ea7
ZP
271 err("USBLCD: %s - failed submitting write urb, error %d",
272 __func__, retval);
7bbe990c 273 goto error_unanchor;
1da177e4 274 }
507a3ea7
ZP
275
276 /* release our reference to this urb,
277 the USB core will eventually free it entirely */
1da177e4
LT
278 usb_free_urb(urb);
279
280exit:
281 return count;
7bbe990c
ON
282error_unanchor:
283 usb_unanchor_urb(urb);
1da177e4 284error:
997ea58e 285 usb_free_coherent(dev->udev, count, buf, urb->transfer_dma);
1da177e4 286 usb_free_urb(urb);
5afeb104
ON
287err_no_buf:
288 up(&dev->limit_sem);
1da177e4
LT
289 return retval;
290}
291
066202dd 292static const struct file_operations lcd_fops = {
507a3ea7
ZP
293 .owner = THIS_MODULE,
294 .read = lcd_read,
295 .write = lcd_write,
296 .open = lcd_open,
5cb4aeca 297 .unlocked_ioctl = lcd_ioctl,
507a3ea7
ZP
298 .release = lcd_release,
299 .llseek = noop_llseek,
1da177e4
LT
300};
301
302/*
d6e5bcf4
GKH
303 * usb class driver info in order to get a minor number from the usb core,
304 * and to have the device registered with the driver core
305 */
1da177e4 306static struct usb_class_driver lcd_class = {
507a3ea7
ZP
307 .name = "lcd%d",
308 .fops = &lcd_fops,
309 .minor_base = USBLCD_MINOR,
1da177e4
LT
310};
311
507a3ea7
ZP
312static int lcd_probe(struct usb_interface *interface,
313 const struct usb_device_id *id)
1da177e4
LT
314{
315 struct usb_lcd *dev = NULL;
316 struct usb_host_interface *iface_desc;
317 struct usb_endpoint_descriptor *endpoint;
318 size_t buffer_size;
319 int i;
320 int retval = -ENOMEM;
321
322 /* allocate memory for our device state and initialize it */
80b6ca48 323 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1da177e4
LT
324 if (dev == NULL) {
325 err("Out of memory");
326 goto error;
327 }
1da177e4 328 kref_init(&dev->kref);
5afeb104 329 sema_init(&dev->limit_sem, USB_LCD_CONCURRENT_WRITES);
7bbe990c 330 init_usb_anchor(&dev->submitted);
1da177e4
LT
331
332 dev->udev = usb_get_dev(interface_to_usbdev(interface));
333 dev->interface = interface;
334
335 if (le16_to_cpu(dev->udev->descriptor.idProduct) != 0x0001) {
3b6004f3 336 dev_warn(&interface->dev, "USBLCD model not supported.\n");
696a4ace
JS
337 retval = -ENODEV;
338 goto error;
1da177e4 339 }
507a3ea7 340
1da177e4
LT
341 /* set up the endpoint information */
342 /* use only the first bulk-in and bulk-out endpoints */
343 iface_desc = interface->cur_altsetting;
344 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
345 endpoint = &iface_desc->endpoint[i].desc;
346
347 if (!dev->bulk_in_endpointAddr &&
b0b660b8 348 usb_endpoint_is_bulk_in(endpoint)) {
1da177e4 349 /* we found a bulk in endpoint */
29cc8897 350 buffer_size = usb_endpoint_maxp(endpoint);
1da177e4
LT
351 dev->bulk_in_size = buffer_size;
352 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
353 dev->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
354 if (!dev->bulk_in_buffer) {
355 err("Could not allocate bulk_in_buffer");
356 goto error;
357 }
358 }
359
360 if (!dev->bulk_out_endpointAddr &&
b0b660b8 361 usb_endpoint_is_bulk_out(endpoint)) {
1da177e4
LT
362 /* we found a bulk out endpoint */
363 dev->bulk_out_endpointAddr = endpoint->bEndpointAddress;
364 }
365 }
366 if (!(dev->bulk_in_endpointAddr && dev->bulk_out_endpointAddr)) {
367 err("Could not find both bulk-in and bulk-out endpoints");
368 goto error;
369 }
370
371 /* save our data pointer in this interface device */
372 usb_set_intfdata(interface, dev);
373
374 /* we can register the device now, as it is ready */
375 retval = usb_register_dev(interface, &lcd_class);
376 if (retval) {
377 /* something prevented us from registering this driver */
378 err("Not able to get a minor for this device.");
379 usb_set_intfdata(interface, NULL);
380 goto error;
381 }
382
383 i = le16_to_cpu(dev->udev->descriptor.bcdDevice);
384
1b29a375
GKH
385 dev_info(&interface->dev, "USBLCD Version %1d%1d.%1d%1d found "
386 "at address %d\n", (i & 0xF000)>>12, (i & 0xF00)>>8,
507a3ea7 387 (i & 0xF0)>>4, (i & 0xF), dev->udev->devnum);
1da177e4
LT
388
389 /* let the user know what node this device is now attached to */
1b29a375
GKH
390 dev_info(&interface->dev, "USB LCD device now attached to USBLCD-%d\n",
391 interface->minor);
1da177e4
LT
392 return 0;
393
394error:
395 if (dev)
396 kref_put(&dev->kref, lcd_delete);
397 return retval;
398}
399
7bbe990c
ON
400static void lcd_draw_down(struct usb_lcd *dev)
401{
402 int time;
403
404 time = usb_wait_anchor_empty_timeout(&dev->submitted, 1000);
405 if (!time)
406 usb_kill_anchored_urbs(&dev->submitted);
407}
408
409static int lcd_suspend(struct usb_interface *intf, pm_message_t message)
410{
411 struct usb_lcd *dev = usb_get_intfdata(intf);
412
413 if (!dev)
414 return 0;
415 lcd_draw_down(dev);
416 return 0;
417}
418
507a3ea7 419static int lcd_resume(struct usb_interface *intf)
7bbe990c
ON
420{
421 return 0;
422}
423
1da177e4
LT
424static void lcd_disconnect(struct usb_interface *interface)
425{
426 struct usb_lcd *dev;
507a3ea7 427 int minor = interface->minor;
1da177e4 428
d5d1ceac 429 mutex_lock(&open_disc_mutex);
507a3ea7
ZP
430 dev = usb_get_intfdata(interface);
431 usb_set_intfdata(interface, NULL);
d5d1ceac 432 mutex_unlock(&open_disc_mutex);
1da177e4 433
507a3ea7
ZP
434 /* give back our minor */
435 usb_deregister_dev(interface, &lcd_class);
436
1da177e4
LT
437 /* decrement our usage count */
438 kref_put(&dev->kref, lcd_delete);
439
1b29a375 440 dev_info(&interface->dev, "USB LCD #%d now disconnected\n", minor);
1da177e4
LT
441}
442
443static struct usb_driver lcd_driver = {
1da177e4
LT
444 .name = "usblcd",
445 .probe = lcd_probe,
446 .disconnect = lcd_disconnect,
7bbe990c
ON
447 .suspend = lcd_suspend,
448 .resume = lcd_resume,
1da177e4 449 .id_table = id_table,
7bbe990c 450 .supports_autosuspend = 1,
1da177e4
LT
451};
452
453static int __init usb_lcd_init(void)
454{
455 int result;
507a3ea7 456
1da177e4
LT
457 result = usb_register(&lcd_driver);
458 if (result)
459 err("usb_register failed. Error number %d", result);
460
461 return result;
462}
463
464
465static void __exit usb_lcd_exit(void)
466{
467 usb_deregister(&lcd_driver);
468}
469
470module_init(usb_lcd_init);
471module_exit(usb_lcd_exit);
472
473MODULE_AUTHOR("Georges Toth <g.toth@e-biz.lu>");
474MODULE_DESCRIPTION(DRIVER_VERSION);
475MODULE_LICENSE("GPL");