Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * LEGO USB Tower driver | |
3 | * | |
4 | * Copyright (C) 2003 David Glance <davidgsf@sourceforge.net> | |
5 | * 2001-2004 Juergen Stuber <starblue@users.sourceforge.net> | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or | |
8 | * modify it under the terms of the GNU General Public License as | |
9 | * published by the Free Software Foundation; either version 2 of | |
10 | * the License, or (at your option) any later version. | |
11 | * | |
12 | * derived from USB Skeleton driver - 0.5 | |
13 | * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com) | |
14 | * | |
15 | * History: | |
16 | * | |
17 | * 2001-10-13 - 0.1 js | |
18 | * - first version | |
19 | * 2001-11-03 - 0.2 js | |
20 | * - simplified buffering, one-shot URBs for writing | |
21 | * 2001-11-10 - 0.3 js | |
22 | * - removed IOCTL (setting power/mode is more complicated, postponed) | |
23 | * 2001-11-28 - 0.4 js | |
24 | * - added vendor commands for mode of operation and power level in open | |
25 | * 2001-12-04 - 0.5 js | |
26 | * - set IR mode by default (by oversight 0.4 set VLL mode) | |
27 | * 2002-01-11 - 0.5? pcchan | |
28 | * - make read buffer reusable and work around bytes_to_write issue between | |
29 | * uhci and legusbtower | |
30 | * 2002-09-23 - 0.52 david (david@csse.uwa.edu.au) | |
31 | * - imported into lejos project | |
32 | * - changed wake_up to wake_up_interruptible | |
33 | * - changed to use lego0 rather than tower0 | |
441b62c1 | 34 | * - changed dbg() to use __func__ rather than deprecated __func__ |
1da177e4 LT |
35 | * 2003-01-12 - 0.53 david (david@csse.uwa.edu.au) |
36 | * - changed read and write to write everything or | |
37 | * timeout (from a patch by Chris Riesen and Brett Thaeler driver) | |
38 | * - added ioctl functionality to set timeouts | |
39 | * 2003-07-18 - 0.54 davidgsf (david@csse.uwa.edu.au) | |
40 | * - initial import into LegoUSB project | |
41 | * - merge of existing LegoUSB.c driver | |
42 | * 2003-07-18 - 0.56 davidgsf (david@csse.uwa.edu.au) | |
43 | * - port to 2.6 style driver | |
44 | * 2004-02-29 - 0.6 Juergen Stuber <starblue@users.sourceforge.net> | |
45 | * - fix locking | |
46 | * - unlink read URBs which are no longer needed | |
47 | * - allow increased buffer size, eliminates need for timeout on write | |
48 | * - have read URB running continuously | |
49 | * - added poll | |
50 | * - forbid seeking | |
51 | * - added nonblocking I/O | |
441b62c1 | 52 | * - changed back __func__ to __func__ |
1da177e4 LT |
53 | * - read and log tower firmware version |
54 | * - reset tower on probe, avoids failure of first write | |
55 | * 2004-03-09 - 0.7 Juergen Stuber <starblue@users.sourceforge.net> | |
56 | * - timeout read now only after inactivity, shorten default accordingly | |
57 | * 2004-03-11 - 0.8 Juergen Stuber <starblue@users.sourceforge.net> | |
58 | * - log major, minor instead of possibly confusing device filename | |
59 | * - whitespace cleanup | |
60 | * 2004-03-12 - 0.9 Juergen Stuber <starblue@users.sourceforge.net> | |
61 | * - normalize whitespace in debug messages | |
62 | * - take care about endianness in control message responses | |
63 | * 2004-03-13 - 0.91 Juergen Stuber <starblue@users.sourceforge.net> | |
64 | * - make default intervals longer to accommodate current EHCI driver | |
65 | * 2004-03-19 - 0.92 Juergen Stuber <starblue@users.sourceforge.net> | |
66 | * - replaced atomic_t by memory barriers | |
67 | * 2004-04-21 - 0.93 Juergen Stuber <starblue@users.sourceforge.net> | |
68 | * - wait for completion of write urb in release (needed for remotecontrol) | |
69 | * - corrected poll for write direction (missing negation) | |
70 | * 2004-04-22 - 0.94 Juergen Stuber <starblue@users.sourceforge.net> | |
71 | * - make device locking interruptible | |
72 | * 2004-04-30 - 0.95 Juergen Stuber <starblue@users.sourceforge.net> | |
73 | * - check for valid udev on resubmitting and unlinking urbs | |
74 | * 2004-08-03 - 0.96 Juergen Stuber <starblue@users.sourceforge.net> | |
75 | * - move reset into open to clean out spurious data | |
76 | */ | |
77 | ||
1da177e4 LT |
78 | #include <linux/kernel.h> |
79 | #include <linux/errno.h> | |
80 | #include <linux/init.h> | |
81 | #include <linux/slab.h> | |
82 | #include <linux/module.h> | |
1da177e4 | 83 | #include <linux/completion.h> |
4186ecf8 | 84 | #include <linux/mutex.h> |
1da177e4 LT |
85 | #include <asm/uaccess.h> |
86 | #include <linux/usb.h> | |
87 | #include <linux/poll.h> | |
88 | ||
89 | ||
1da177e4 LT |
90 | /* Version Information */ |
91 | #define DRIVER_VERSION "v0.96" | |
92 | #define DRIVER_AUTHOR "Juergen Stuber <starblue@sourceforge.net>" | |
93 | #define DRIVER_DESC "LEGO USB Tower Driver" | |
94 | ||
1da177e4 LT |
95 | |
96 | /* The defaults are chosen to work with the latest versions of leJOS and NQC. | |
97 | */ | |
98 | ||
99 | /* Some legacy software likes to receive packets in one piece. | |
100 | * In this case read_buffer_size should exceed the maximal packet length | |
101 | * (417 for datalog uploads), and packet_timeout should be set. | |
102 | */ | |
103 | static int read_buffer_size = 480; | |
104 | module_param(read_buffer_size, int, 0); | |
105 | MODULE_PARM_DESC(read_buffer_size, "Read buffer size"); | |
106 | ||
107 | /* Some legacy software likes to send packets in one piece. | |
108 | * In this case write_buffer_size should exceed the maximal packet length | |
109 | * (417 for firmware and program downloads). | |
110 | * A problem with long writes is that the following read may time out | |
111 | * if the software is not prepared to wait long enough. | |
112 | */ | |
113 | static int write_buffer_size = 480; | |
114 | module_param(write_buffer_size, int, 0); | |
115 | MODULE_PARM_DESC(write_buffer_size, "Write buffer size"); | |
116 | ||
117 | /* Some legacy software expects reads to contain whole LASM packets. | |
118 | * To achieve this, characters which arrive before a packet timeout | |
119 | * occurs will be returned in a single read operation. | |
120 | * A problem with long reads is that the software may time out | |
121 | * if it is not prepared to wait long enough. | |
122 | * The packet timeout should be greater than the time between the | |
123 | * reception of subsequent characters, which should arrive about | |
124 | * every 5ms for the standard 2400 baud. | |
125 | * Set it to 0 to disable. | |
126 | */ | |
127 | static int packet_timeout = 50; | |
128 | module_param(packet_timeout, int, 0); | |
129 | MODULE_PARM_DESC(packet_timeout, "Packet timeout in ms"); | |
130 | ||
131 | /* Some legacy software expects blocking reads to time out. | |
132 | * Timeout occurs after the specified time of read and write inactivity. | |
133 | * Set it to 0 to disable. | |
134 | */ | |
135 | static int read_timeout = 200; | |
136 | module_param(read_timeout, int, 0); | |
137 | MODULE_PARM_DESC(read_timeout, "Read timeout in ms"); | |
138 | ||
139 | /* As of kernel version 2.6.4 ehci-hcd uses an | |
140 | * "only one interrupt transfer per frame" shortcut | |
141 | * to simplify the scheduling of periodic transfers. | |
142 | * This conflicts with our standard 1ms intervals for in and out URBs. | |
143 | * We use default intervals of 2ms for in and 8ms for out transfers, | |
144 | * which is fast enough for 2400 baud and allows a small additional load. | |
145 | * Increase the interval to allow more devices that do interrupt transfers, | |
146 | * or set to 0 to use the standard interval from the endpoint descriptors. | |
147 | */ | |
148 | static int interrupt_in_interval = 2; | |
149 | module_param(interrupt_in_interval, int, 0); | |
150 | MODULE_PARM_DESC(interrupt_in_interval, "Interrupt in interval in ms"); | |
151 | ||
152 | static int interrupt_out_interval = 8; | |
153 | module_param(interrupt_out_interval, int, 0); | |
154 | MODULE_PARM_DESC(interrupt_out_interval, "Interrupt out interval in ms"); | |
155 | ||
156 | /* Define these values to match your device */ | |
157 | #define LEGO_USB_TOWER_VENDOR_ID 0x0694 | |
158 | #define LEGO_USB_TOWER_PRODUCT_ID 0x0001 | |
159 | ||
160 | /* Vendor requests */ | |
161 | #define LEGO_USB_TOWER_REQUEST_RESET 0x04 | |
162 | #define LEGO_USB_TOWER_REQUEST_GET_VERSION 0xFD | |
163 | ||
164 | struct tower_reset_reply { | |
165 | __le16 size; /* little-endian */ | |
166 | __u8 err_code; | |
167 | __u8 spare; | |
168 | } __attribute__ ((packed)); | |
169 | ||
170 | struct tower_get_version_reply { | |
171 | __le16 size; /* little-endian */ | |
172 | __u8 err_code; | |
173 | __u8 spare; | |
174 | __u8 major; | |
175 | __u8 minor; | |
176 | __le16 build_no; /* little-endian */ | |
177 | } __attribute__ ((packed)); | |
178 | ||
179 | ||
180 | /* table of devices that work with this driver */ | |
33b9e162 | 181 | static const struct usb_device_id tower_table[] = { |
1da177e4 LT |
182 | { USB_DEVICE(LEGO_USB_TOWER_VENDOR_ID, LEGO_USB_TOWER_PRODUCT_ID) }, |
183 | { } /* Terminating entry */ | |
184 | }; | |
185 | ||
186 | MODULE_DEVICE_TABLE (usb, tower_table); | |
78663ecc | 187 | static DEFINE_MUTEX(open_disc_mutex); |
1da177e4 LT |
188 | |
189 | #define LEGO_USB_TOWER_MINOR_BASE 160 | |
190 | ||
191 | ||
192 | /* Structure to hold all of our device specific stuff */ | |
193 | struct lego_usb_tower { | |
18bcbcfe | 194 | struct mutex lock; /* locks this structure */ |
1da177e4 LT |
195 | struct usb_device* udev; /* save off the usb device pointer */ |
196 | unsigned char minor; /* the starting minor number for this device */ | |
197 | ||
198 | int open_count; /* number of times this port has been opened */ | |
199 | ||
200 | char* read_buffer; | |
201 | size_t read_buffer_length; /* this much came in */ | |
202 | size_t read_packet_length; /* this much will be returned on read */ | |
203 | spinlock_t read_buffer_lock; | |
204 | int packet_timeout_jiffies; | |
205 | unsigned long read_last_arrival; | |
206 | ||
207 | wait_queue_head_t read_wait; | |
208 | wait_queue_head_t write_wait; | |
209 | ||
210 | char* interrupt_in_buffer; | |
211 | struct usb_endpoint_descriptor* interrupt_in_endpoint; | |
212 | struct urb* interrupt_in_urb; | |
213 | int interrupt_in_interval; | |
214 | int interrupt_in_running; | |
215 | int interrupt_in_done; | |
216 | ||
217 | char* interrupt_out_buffer; | |
218 | struct usb_endpoint_descriptor* interrupt_out_endpoint; | |
219 | struct urb* interrupt_out_urb; | |
220 | int interrupt_out_interval; | |
221 | int interrupt_out_busy; | |
222 | ||
223 | }; | |
224 | ||
225 | ||
226 | /* local function prototypes */ | |
227 | static ssize_t tower_read (struct file *file, char __user *buffer, size_t count, loff_t *ppos); | |
228 | static ssize_t tower_write (struct file *file, const char __user *buffer, size_t count, loff_t *ppos); | |
229 | static inline void tower_delete (struct lego_usb_tower *dev); | |
230 | static int tower_open (struct inode *inode, struct file *file); | |
231 | static int tower_release (struct inode *inode, struct file *file); | |
232 | static unsigned int tower_poll (struct file *file, poll_table *wait); | |
233 | static loff_t tower_llseek (struct file *file, loff_t off, int whence); | |
234 | ||
235 | static void tower_abort_transfers (struct lego_usb_tower *dev); | |
236 | static void tower_check_for_read_packet (struct lego_usb_tower *dev); | |
7d12e780 DH |
237 | static void tower_interrupt_in_callback (struct urb *urb); |
238 | static void tower_interrupt_out_callback (struct urb *urb); | |
1da177e4 LT |
239 | |
240 | static int tower_probe (struct usb_interface *interface, const struct usb_device_id *id); | |
241 | static void tower_disconnect (struct usb_interface *interface); | |
242 | ||
243 | ||
1da177e4 | 244 | /* file operations needed when we register this driver */ |
066202dd | 245 | static const struct file_operations tower_fops = { |
1da177e4 LT |
246 | .owner = THIS_MODULE, |
247 | .read = tower_read, | |
248 | .write = tower_write, | |
249 | .open = tower_open, | |
250 | .release = tower_release, | |
251 | .poll = tower_poll, | |
252 | .llseek = tower_llseek, | |
253 | }; | |
254 | ||
2c9ede55 | 255 | static char *legousbtower_devnode(struct device *dev, umode_t *mode) |
f7a386c5 KS |
256 | { |
257 | return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev)); | |
258 | } | |
259 | ||
1da177e4 LT |
260 | /* |
261 | * usb class driver info in order to get a minor number from the usb core, | |
d6e5bcf4 | 262 | * and to have the device registered with the driver core |
1da177e4 LT |
263 | */ |
264 | static struct usb_class_driver tower_class = { | |
d6e5bcf4 | 265 | .name = "legousbtower%d", |
e454cea2 | 266 | .devnode = legousbtower_devnode, |
1da177e4 | 267 | .fops = &tower_fops, |
1da177e4 LT |
268 | .minor_base = LEGO_USB_TOWER_MINOR_BASE, |
269 | }; | |
270 | ||
271 | ||
272 | /* usb specific object needed to register this driver with the usb subsystem */ | |
273 | static struct usb_driver tower_driver = { | |
1da177e4 LT |
274 | .name = "legousbtower", |
275 | .probe = tower_probe, | |
276 | .disconnect = tower_disconnect, | |
277 | .id_table = tower_table, | |
278 | }; | |
279 | ||
280 | ||
281 | /** | |
282 | * lego_usb_tower_debug_data | |
283 | */ | |
4dae9963 GKH |
284 | static inline void lego_usb_tower_debug_data(struct device *dev, |
285 | const char *function, int size, | |
286 | const unsigned char *data) | |
1da177e4 | 287 | { |
4dae9963 GKH |
288 | dev_dbg(dev, "%s - length = %d, data = %*ph\n", |
289 | function, size, size, data); | |
1da177e4 LT |
290 | } |
291 | ||
292 | ||
293 | /** | |
294 | * tower_delete | |
295 | */ | |
296 | static inline void tower_delete (struct lego_usb_tower *dev) | |
297 | { | |
1da177e4 LT |
298 | tower_abort_transfers (dev); |
299 | ||
300 | /* free data structures */ | |
f53510e8 MK |
301 | usb_free_urb(dev->interrupt_in_urb); |
302 | usb_free_urb(dev->interrupt_out_urb); | |
1da177e4 LT |
303 | kfree (dev->read_buffer); |
304 | kfree (dev->interrupt_in_buffer); | |
305 | kfree (dev->interrupt_out_buffer); | |
306 | kfree (dev); | |
1da177e4 LT |
307 | } |
308 | ||
309 | ||
310 | /** | |
311 | * tower_open | |
312 | */ | |
313 | static int tower_open (struct inode *inode, struct file *file) | |
314 | { | |
315 | struct lego_usb_tower *dev = NULL; | |
316 | int subminor; | |
317 | int retval = 0; | |
318 | struct usb_interface *interface; | |
319 | struct tower_reset_reply reset_reply; | |
320 | int result; | |
321 | ||
1da177e4 LT |
322 | nonseekable_open(inode, file); |
323 | subminor = iminor(inode); | |
324 | ||
1da177e4 LT |
325 | interface = usb_find_interface (&tower_driver, subminor); |
326 | ||
327 | if (!interface) { | |
9d974b2a GKH |
328 | printk(KERN_ERR "%s - error, can't find device for minor %d\n", |
329 | __func__, subminor); | |
1da177e4 | 330 | retval = -ENODEV; |
d4ead16f | 331 | goto exit; |
1da177e4 LT |
332 | } |
333 | ||
78663ecc | 334 | mutex_lock(&open_disc_mutex); |
1da177e4 LT |
335 | dev = usb_get_intfdata(interface); |
336 | ||
337 | if (!dev) { | |
78663ecc | 338 | mutex_unlock(&open_disc_mutex); |
1da177e4 | 339 | retval = -ENODEV; |
d4ead16f | 340 | goto exit; |
1da177e4 LT |
341 | } |
342 | ||
343 | /* lock this device */ | |
18bcbcfe | 344 | if (mutex_lock_interruptible(&dev->lock)) { |
78663ecc | 345 | mutex_unlock(&open_disc_mutex); |
1da177e4 | 346 | retval = -ERESTARTSYS; |
d4ead16f | 347 | goto exit; |
1da177e4 LT |
348 | } |
349 | ||
78663ecc | 350 | |
1da177e4 LT |
351 | /* allow opening only once */ |
352 | if (dev->open_count) { | |
78663ecc | 353 | mutex_unlock(&open_disc_mutex); |
1da177e4 LT |
354 | retval = -EBUSY; |
355 | goto unlock_exit; | |
356 | } | |
357 | dev->open_count = 1; | |
78663ecc | 358 | mutex_unlock(&open_disc_mutex); |
1da177e4 LT |
359 | |
360 | /* reset the tower */ | |
361 | result = usb_control_msg (dev->udev, | |
362 | usb_rcvctrlpipe(dev->udev, 0), | |
363 | LEGO_USB_TOWER_REQUEST_RESET, | |
364 | USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE, | |
365 | 0, | |
366 | 0, | |
367 | &reset_reply, | |
368 | sizeof(reset_reply), | |
369 | 1000); | |
370 | if (result < 0) { | |
9d974b2a GKH |
371 | dev_err(&dev->udev->dev, |
372 | "LEGO USB Tower reset control request failed\n"); | |
1da177e4 LT |
373 | retval = result; |
374 | goto unlock_exit; | |
375 | } | |
376 | ||
377 | /* initialize in direction */ | |
378 | dev->read_buffer_length = 0; | |
379 | dev->read_packet_length = 0; | |
380 | usb_fill_int_urb (dev->interrupt_in_urb, | |
381 | dev->udev, | |
382 | usb_rcvintpipe(dev->udev, dev->interrupt_in_endpoint->bEndpointAddress), | |
383 | dev->interrupt_in_buffer, | |
29cc8897 | 384 | usb_endpoint_maxp(dev->interrupt_in_endpoint), |
1da177e4 LT |
385 | tower_interrupt_in_callback, |
386 | dev, | |
387 | dev->interrupt_in_interval); | |
388 | ||
389 | dev->interrupt_in_running = 1; | |
390 | dev->interrupt_in_done = 0; | |
391 | mb(); | |
392 | ||
393 | retval = usb_submit_urb (dev->interrupt_in_urb, GFP_KERNEL); | |
394 | if (retval) { | |
9d974b2a GKH |
395 | dev_err(&dev->udev->dev, |
396 | "Couldn't submit interrupt_in_urb %d\n", retval); | |
1da177e4 LT |
397 | dev->interrupt_in_running = 0; |
398 | dev->open_count = 0; | |
399 | goto unlock_exit; | |
400 | } | |
401 | ||
402 | /* save device in the file's private structure */ | |
403 | file->private_data = dev; | |
404 | ||
405 | unlock_exit: | |
18bcbcfe | 406 | mutex_unlock(&dev->lock); |
1da177e4 | 407 | |
d4ead16f | 408 | exit: |
1da177e4 LT |
409 | return retval; |
410 | } | |
411 | ||
412 | /** | |
413 | * tower_release | |
414 | */ | |
415 | static int tower_release (struct inode *inode, struct file *file) | |
416 | { | |
417 | struct lego_usb_tower *dev; | |
418 | int retval = 0; | |
419 | ||
5bd6e8b3 | 420 | dev = file->private_data; |
1da177e4 LT |
421 | |
422 | if (dev == NULL) { | |
1da177e4 | 423 | retval = -ENODEV; |
78663ecc | 424 | goto exit_nolock; |
1da177e4 LT |
425 | } |
426 | ||
78663ecc | 427 | mutex_lock(&open_disc_mutex); |
18bcbcfe | 428 | if (mutex_lock_interruptible(&dev->lock)) { |
1da177e4 LT |
429 | retval = -ERESTARTSYS; |
430 | goto exit; | |
431 | } | |
432 | ||
433 | if (dev->open_count != 1) { | |
fef526ca GKH |
434 | dev_dbg(&dev->udev->dev, "%s: device not opened exactly once\n", |
435 | __func__); | |
1da177e4 LT |
436 | retval = -ENODEV; |
437 | goto unlock_exit; | |
438 | } | |
439 | if (dev->udev == NULL) { | |
440 | /* the device was unplugged before the file was released */ | |
18bcbcfe DW |
441 | |
442 | /* unlock here as tower_delete frees dev */ | |
443 | mutex_unlock(&dev->lock); | |
1da177e4 LT |
444 | tower_delete (dev); |
445 | goto exit; | |
446 | } | |
447 | ||
448 | /* wait until write transfer is finished */ | |
449 | if (dev->interrupt_out_busy) { | |
450 | wait_event_interruptible_timeout (dev->write_wait, !dev->interrupt_out_busy, 2 * HZ); | |
451 | } | |
452 | tower_abort_transfers (dev); | |
453 | dev->open_count = 0; | |
454 | ||
455 | unlock_exit: | |
18bcbcfe | 456 | mutex_unlock(&dev->lock); |
1da177e4 LT |
457 | |
458 | exit: | |
78663ecc ON |
459 | mutex_unlock(&open_disc_mutex); |
460 | exit_nolock: | |
1da177e4 LT |
461 | return retval; |
462 | } | |
463 | ||
464 | ||
465 | /** | |
466 | * tower_abort_transfers | |
467 | * aborts transfers and frees associated data structures | |
468 | */ | |
469 | static void tower_abort_transfers (struct lego_usb_tower *dev) | |
470 | { | |
fef526ca | 471 | if (dev == NULL) |
d26f6e57 | 472 | return; |
1da177e4 LT |
473 | |
474 | /* shutdown transfer */ | |
475 | if (dev->interrupt_in_running) { | |
476 | dev->interrupt_in_running = 0; | |
477 | mb(); | |
f53510e8 | 478 | if (dev->udev) |
1da177e4 | 479 | usb_kill_urb (dev->interrupt_in_urb); |
1da177e4 | 480 | } |
f53510e8 MK |
481 | if (dev->interrupt_out_busy && dev->udev) |
482 | usb_kill_urb(dev->interrupt_out_urb); | |
1da177e4 LT |
483 | } |
484 | ||
485 | ||
486 | /** | |
487 | * tower_check_for_read_packet | |
488 | * | |
489 | * To get correct semantics for signals and non-blocking I/O | |
490 | * with packetizing we pretend not to see any data in the read buffer | |
491 | * until it has been there unchanged for at least | |
492 | * dev->packet_timeout_jiffies, or until the buffer is full. | |
493 | */ | |
494 | static void tower_check_for_read_packet (struct lego_usb_tower *dev) | |
495 | { | |
496 | spin_lock_irq (&dev->read_buffer_lock); | |
497 | if (!packet_timeout | |
498 | || time_after(jiffies, dev->read_last_arrival + dev->packet_timeout_jiffies) | |
499 | || dev->read_buffer_length == read_buffer_size) { | |
500 | dev->read_packet_length = dev->read_buffer_length; | |
501 | } | |
502 | dev->interrupt_in_done = 0; | |
503 | spin_unlock_irq (&dev->read_buffer_lock); | |
504 | } | |
505 | ||
506 | ||
507 | /** | |
508 | * tower_poll | |
509 | */ | |
510 | static unsigned int tower_poll (struct file *file, poll_table *wait) | |
511 | { | |
512 | struct lego_usb_tower *dev; | |
513 | unsigned int mask = 0; | |
514 | ||
1da177e4 LT |
515 | dev = file->private_data; |
516 | ||
d35b4ce1 ON |
517 | if (!dev->udev) |
518 | return POLLERR | POLLHUP; | |
519 | ||
1da177e4 LT |
520 | poll_wait(file, &dev->read_wait, wait); |
521 | poll_wait(file, &dev->write_wait, wait); | |
522 | ||
523 | tower_check_for_read_packet(dev); | |
524 | if (dev->read_packet_length > 0) { | |
525 | mask |= POLLIN | POLLRDNORM; | |
526 | } | |
527 | if (!dev->interrupt_out_busy) { | |
528 | mask |= POLLOUT | POLLWRNORM; | |
529 | } | |
530 | ||
1da177e4 LT |
531 | return mask; |
532 | } | |
533 | ||
534 | ||
535 | /** | |
536 | * tower_llseek | |
537 | */ | |
538 | static loff_t tower_llseek (struct file *file, loff_t off, int whence) | |
539 | { | |
540 | return -ESPIPE; /* unseekable */ | |
541 | } | |
542 | ||
543 | ||
544 | /** | |
545 | * tower_read | |
546 | */ | |
547 | static ssize_t tower_read (struct file *file, char __user *buffer, size_t count, loff_t *ppos) | |
548 | { | |
549 | struct lego_usb_tower *dev; | |
550 | size_t bytes_to_read; | |
551 | int i; | |
552 | int retval = 0; | |
553 | unsigned long timeout = 0; | |
554 | ||
5bd6e8b3 | 555 | dev = file->private_data; |
1da177e4 LT |
556 | |
557 | /* lock this object */ | |
18bcbcfe | 558 | if (mutex_lock_interruptible(&dev->lock)) { |
1da177e4 LT |
559 | retval = -ERESTARTSYS; |
560 | goto exit; | |
561 | } | |
562 | ||
563 | /* verify that the device wasn't unplugged */ | |
564 | if (dev->udev == NULL) { | |
565 | retval = -ENODEV; | |
9d974b2a | 566 | printk(KERN_ERR "legousbtower: No device or device unplugged %d\n", retval); |
1da177e4 LT |
567 | goto unlock_exit; |
568 | } | |
569 | ||
570 | /* verify that we actually have some data to read */ | |
571 | if (count == 0) { | |
fef526ca | 572 | dev_dbg(&dev->udev->dev, "read request of 0 bytes\n"); |
1da177e4 LT |
573 | goto unlock_exit; |
574 | } | |
575 | ||
576 | if (read_timeout) { | |
577 | timeout = jiffies + read_timeout * HZ / 1000; | |
578 | } | |
579 | ||
580 | /* wait for data */ | |
581 | tower_check_for_read_packet (dev); | |
582 | while (dev->read_packet_length == 0) { | |
583 | if (file->f_flags & O_NONBLOCK) { | |
584 | retval = -EAGAIN; | |
585 | goto unlock_exit; | |
586 | } | |
587 | retval = wait_event_interruptible_timeout(dev->read_wait, dev->interrupt_in_done, dev->packet_timeout_jiffies); | |
588 | if (retval < 0) { | |
589 | goto unlock_exit; | |
590 | } | |
591 | ||
592 | /* reset read timeout during read or write activity */ | |
593 | if (read_timeout | |
594 | && (dev->read_buffer_length || dev->interrupt_out_busy)) { | |
595 | timeout = jiffies + read_timeout * HZ / 1000; | |
596 | } | |
597 | /* check for read timeout */ | |
598 | if (read_timeout && time_after (jiffies, timeout)) { | |
599 | retval = -ETIMEDOUT; | |
600 | goto unlock_exit; | |
601 | } | |
602 | tower_check_for_read_packet (dev); | |
603 | } | |
604 | ||
605 | /* copy the data from read_buffer into userspace */ | |
606 | bytes_to_read = min(count, dev->read_packet_length); | |
607 | ||
608 | if (copy_to_user (buffer, dev->read_buffer, bytes_to_read)) { | |
609 | retval = -EFAULT; | |
610 | goto unlock_exit; | |
611 | } | |
612 | ||
613 | spin_lock_irq (&dev->read_buffer_lock); | |
614 | dev->read_buffer_length -= bytes_to_read; | |
615 | dev->read_packet_length -= bytes_to_read; | |
616 | for (i=0; i<dev->read_buffer_length; i++) { | |
617 | dev->read_buffer[i] = dev->read_buffer[i+bytes_to_read]; | |
618 | } | |
619 | spin_unlock_irq (&dev->read_buffer_lock); | |
620 | ||
621 | retval = bytes_to_read; | |
622 | ||
623 | unlock_exit: | |
624 | /* unlock the device */ | |
18bcbcfe | 625 | mutex_unlock(&dev->lock); |
1da177e4 LT |
626 | |
627 | exit: | |
1da177e4 LT |
628 | return retval; |
629 | } | |
630 | ||
631 | ||
632 | /** | |
633 | * tower_write | |
634 | */ | |
635 | static ssize_t tower_write (struct file *file, const char __user *buffer, size_t count, loff_t *ppos) | |
636 | { | |
637 | struct lego_usb_tower *dev; | |
638 | size_t bytes_to_write; | |
639 | int retval = 0; | |
640 | ||
5bd6e8b3 | 641 | dev = file->private_data; |
1da177e4 LT |
642 | |
643 | /* lock this object */ | |
18bcbcfe | 644 | if (mutex_lock_interruptible(&dev->lock)) { |
1da177e4 LT |
645 | retval = -ERESTARTSYS; |
646 | goto exit; | |
647 | } | |
648 | ||
649 | /* verify that the device wasn't unplugged */ | |
650 | if (dev->udev == NULL) { | |
651 | retval = -ENODEV; | |
9d974b2a | 652 | printk(KERN_ERR "legousbtower: No device or device unplugged %d\n", retval); |
1da177e4 LT |
653 | goto unlock_exit; |
654 | } | |
655 | ||
656 | /* verify that we actually have some data to write */ | |
657 | if (count == 0) { | |
fef526ca | 658 | dev_dbg(&dev->udev->dev, "write request of 0 bytes\n"); |
1da177e4 LT |
659 | goto unlock_exit; |
660 | } | |
661 | ||
662 | /* wait until previous transfer is finished */ | |
663 | while (dev->interrupt_out_busy) { | |
664 | if (file->f_flags & O_NONBLOCK) { | |
665 | retval = -EAGAIN; | |
666 | goto unlock_exit; | |
667 | } | |
668 | retval = wait_event_interruptible (dev->write_wait, !dev->interrupt_out_busy); | |
669 | if (retval) { | |
670 | goto unlock_exit; | |
671 | } | |
672 | } | |
673 | ||
674 | /* write the data into interrupt_out_buffer from userspace */ | |
675 | bytes_to_write = min_t(int, count, write_buffer_size); | |
fef526ca GKH |
676 | dev_dbg(&dev->udev->dev, "%s: count = %Zd, bytes_to_write = %Zd\n", |
677 | __func__, count, bytes_to_write); | |
1da177e4 LT |
678 | |
679 | if (copy_from_user (dev->interrupt_out_buffer, buffer, bytes_to_write)) { | |
680 | retval = -EFAULT; | |
681 | goto unlock_exit; | |
682 | } | |
683 | ||
684 | /* send off the urb */ | |
685 | usb_fill_int_urb(dev->interrupt_out_urb, | |
686 | dev->udev, | |
687 | usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress), | |
688 | dev->interrupt_out_buffer, | |
689 | bytes_to_write, | |
690 | tower_interrupt_out_callback, | |
691 | dev, | |
692 | dev->interrupt_out_interval); | |
693 | ||
694 | dev->interrupt_out_busy = 1; | |
695 | wmb(); | |
696 | ||
697 | retval = usb_submit_urb (dev->interrupt_out_urb, GFP_KERNEL); | |
698 | if (retval) { | |
699 | dev->interrupt_out_busy = 0; | |
9d974b2a GKH |
700 | dev_err(&dev->udev->dev, |
701 | "Couldn't submit interrupt_out_urb %d\n", retval); | |
1da177e4 LT |
702 | goto unlock_exit; |
703 | } | |
704 | retval = bytes_to_write; | |
705 | ||
706 | unlock_exit: | |
707 | /* unlock the device */ | |
18bcbcfe | 708 | mutex_unlock(&dev->lock); |
1da177e4 LT |
709 | |
710 | exit: | |
1da177e4 LT |
711 | return retval; |
712 | } | |
713 | ||
714 | ||
715 | /** | |
716 | * tower_interrupt_in_callback | |
717 | */ | |
7d12e780 | 718 | static void tower_interrupt_in_callback (struct urb *urb) |
1da177e4 | 719 | { |
cdc97792 | 720 | struct lego_usb_tower *dev = urb->context; |
64771a0f | 721 | int status = urb->status; |
1da177e4 LT |
722 | int retval; |
723 | ||
4dae9963 GKH |
724 | lego_usb_tower_debug_data(&dev->udev->dev, __func__, |
725 | urb->actual_length, urb->transfer_buffer); | |
1da177e4 | 726 | |
64771a0f GKH |
727 | if (status) { |
728 | if (status == -ENOENT || | |
729 | status == -ECONNRESET || | |
730 | status == -ESHUTDOWN) { | |
1da177e4 LT |
731 | goto exit; |
732 | } else { | |
fef526ca GKH |
733 | dev_dbg(&dev->udev->dev, |
734 | "%s: nonzero status received: %d\n", __func__, | |
735 | status); | |
1da177e4 LT |
736 | goto resubmit; /* maybe we can recover */ |
737 | } | |
738 | } | |
739 | ||
740 | if (urb->actual_length > 0) { | |
741 | spin_lock (&dev->read_buffer_lock); | |
742 | if (dev->read_buffer_length + urb->actual_length < read_buffer_size) { | |
743 | memcpy (dev->read_buffer + dev->read_buffer_length, | |
744 | dev->interrupt_in_buffer, | |
745 | urb->actual_length); | |
746 | dev->read_buffer_length += urb->actual_length; | |
747 | dev->read_last_arrival = jiffies; | |
fef526ca GKH |
748 | dev_dbg(&dev->udev->dev, "%s: received %d bytes\n", |
749 | __func__, urb->actual_length); | |
1da177e4 | 750 | } else { |
441b62c1 | 751 | printk(KERN_WARNING "%s: read_buffer overflow, %d bytes dropped", __func__, urb->actual_length); |
1da177e4 LT |
752 | } |
753 | spin_unlock (&dev->read_buffer_lock); | |
754 | } | |
755 | ||
756 | resubmit: | |
757 | /* resubmit if we're still running */ | |
758 | if (dev->interrupt_in_running && dev->udev) { | |
759 | retval = usb_submit_urb (dev->interrupt_in_urb, GFP_ATOMIC); | |
9d974b2a GKH |
760 | if (retval) |
761 | dev_err(&dev->udev->dev, | |
762 | "%s: usb_submit_urb failed (%d)\n", | |
763 | __func__, retval); | |
1da177e4 LT |
764 | } |
765 | ||
766 | exit: | |
767 | dev->interrupt_in_done = 1; | |
768 | wake_up_interruptible (&dev->read_wait); | |
1da177e4 LT |
769 | } |
770 | ||
771 | ||
772 | /** | |
773 | * tower_interrupt_out_callback | |
774 | */ | |
7d12e780 | 775 | static void tower_interrupt_out_callback (struct urb *urb) |
1da177e4 | 776 | { |
cdc97792 | 777 | struct lego_usb_tower *dev = urb->context; |
64771a0f | 778 | int status = urb->status; |
1da177e4 | 779 | |
4dae9963 GKH |
780 | lego_usb_tower_debug_data(&dev->udev->dev, __func__, |
781 | urb->actual_length, urb->transfer_buffer); | |
1da177e4 LT |
782 | |
783 | /* sync/async unlink faults aren't errors */ | |
64771a0f GKH |
784 | if (status && !(status == -ENOENT || |
785 | status == -ECONNRESET || | |
786 | status == -ESHUTDOWN)) { | |
fef526ca GKH |
787 | dev_dbg(&dev->udev->dev, |
788 | "%s: nonzero write bulk status received: %d\n", __func__, | |
789 | status); | |
1da177e4 LT |
790 | } |
791 | ||
792 | dev->interrupt_out_busy = 0; | |
793 | wake_up_interruptible(&dev->write_wait); | |
1da177e4 LT |
794 | } |
795 | ||
796 | ||
797 | /** | |
798 | * tower_probe | |
799 | * | |
800 | * Called by the usb core when a new device is connected that it thinks | |
801 | * this driver might be interested in. | |
802 | */ | |
803 | static int tower_probe (struct usb_interface *interface, const struct usb_device_id *id) | |
804 | { | |
9d974b2a | 805 | struct device *idev = &interface->dev; |
1da177e4 LT |
806 | struct usb_device *udev = interface_to_usbdev(interface); |
807 | struct lego_usb_tower *dev = NULL; | |
808 | struct usb_host_interface *iface_desc; | |
809 | struct usb_endpoint_descriptor* endpoint; | |
810 | struct tower_get_version_reply get_version_reply; | |
811 | int i; | |
812 | int retval = -ENOMEM; | |
813 | int result; | |
814 | ||
093cf723 | 815 | /* allocate memory for our device state and initialize it */ |
1da177e4 LT |
816 | |
817 | dev = kmalloc (sizeof(struct lego_usb_tower), GFP_KERNEL); | |
818 | ||
819 | if (dev == NULL) { | |
9d974b2a | 820 | dev_err(idev, "Out of memory\n"); |
1da177e4 LT |
821 | goto exit; |
822 | } | |
823 | ||
18bcbcfe | 824 | mutex_init(&dev->lock); |
1da177e4 LT |
825 | |
826 | dev->udev = udev; | |
827 | dev->open_count = 0; | |
828 | ||
829 | dev->read_buffer = NULL; | |
830 | dev->read_buffer_length = 0; | |
831 | dev->read_packet_length = 0; | |
832 | spin_lock_init (&dev->read_buffer_lock); | |
833 | dev->packet_timeout_jiffies = packet_timeout * HZ / 1000; | |
834 | dev->read_last_arrival = jiffies; | |
835 | ||
836 | init_waitqueue_head (&dev->read_wait); | |
837 | init_waitqueue_head (&dev->write_wait); | |
838 | ||
839 | dev->interrupt_in_buffer = NULL; | |
840 | dev->interrupt_in_endpoint = NULL; | |
841 | dev->interrupt_in_urb = NULL; | |
842 | dev->interrupt_in_running = 0; | |
843 | dev->interrupt_in_done = 0; | |
844 | ||
845 | dev->interrupt_out_buffer = NULL; | |
846 | dev->interrupt_out_endpoint = NULL; | |
847 | dev->interrupt_out_urb = NULL; | |
848 | dev->interrupt_out_busy = 0; | |
849 | ||
850 | iface_desc = interface->cur_altsetting; | |
851 | ||
852 | /* set up the endpoint information */ | |
853 | for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { | |
854 | endpoint = &iface_desc->endpoint[i].desc; | |
855 | ||
240661c5 LFC |
856 | if (usb_endpoint_xfer_int(endpoint)) { |
857 | if (usb_endpoint_dir_in(endpoint)) | |
858 | dev->interrupt_in_endpoint = endpoint; | |
859 | else | |
860 | dev->interrupt_out_endpoint = endpoint; | |
1da177e4 LT |
861 | } |
862 | } | |
863 | if(dev->interrupt_in_endpoint == NULL) { | |
9d974b2a | 864 | dev_err(idev, "interrupt in endpoint not found\n"); |
1da177e4 LT |
865 | goto error; |
866 | } | |
867 | if (dev->interrupt_out_endpoint == NULL) { | |
9d974b2a | 868 | dev_err(idev, "interrupt out endpoint not found\n"); |
1da177e4 LT |
869 | goto error; |
870 | } | |
871 | ||
872 | dev->read_buffer = kmalloc (read_buffer_size, GFP_KERNEL); | |
873 | if (!dev->read_buffer) { | |
9d974b2a | 874 | dev_err(idev, "Couldn't allocate read_buffer\n"); |
1da177e4 LT |
875 | goto error; |
876 | } | |
29cc8897 | 877 | dev->interrupt_in_buffer = kmalloc (usb_endpoint_maxp(dev->interrupt_in_endpoint), GFP_KERNEL); |
1da177e4 | 878 | if (!dev->interrupt_in_buffer) { |
9d974b2a | 879 | dev_err(idev, "Couldn't allocate interrupt_in_buffer\n"); |
1da177e4 LT |
880 | goto error; |
881 | } | |
882 | dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL); | |
883 | if (!dev->interrupt_in_urb) { | |
9d974b2a | 884 | dev_err(idev, "Couldn't allocate interrupt_in_urb\n"); |
1da177e4 LT |
885 | goto error; |
886 | } | |
887 | dev->interrupt_out_buffer = kmalloc (write_buffer_size, GFP_KERNEL); | |
888 | if (!dev->interrupt_out_buffer) { | |
9d974b2a | 889 | dev_err(idev, "Couldn't allocate interrupt_out_buffer\n"); |
1da177e4 LT |
890 | goto error; |
891 | } | |
892 | dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL); | |
893 | if (!dev->interrupt_out_urb) { | |
9d974b2a | 894 | dev_err(idev, "Couldn't allocate interrupt_out_urb\n"); |
1da177e4 LT |
895 | goto error; |
896 | } | |
897 | dev->interrupt_in_interval = interrupt_in_interval ? interrupt_in_interval : dev->interrupt_in_endpoint->bInterval; | |
898 | dev->interrupt_out_interval = interrupt_out_interval ? interrupt_out_interval : dev->interrupt_out_endpoint->bInterval; | |
899 | ||
900 | /* we can register the device now, as it is ready */ | |
901 | usb_set_intfdata (interface, dev); | |
902 | ||
903 | retval = usb_register_dev (interface, &tower_class); | |
904 | ||
905 | if (retval) { | |
906 | /* something prevented us from registering this driver */ | |
9d974b2a | 907 | dev_err(idev, "Not able to get a minor for this device.\n"); |
1da177e4 LT |
908 | usb_set_intfdata (interface, NULL); |
909 | goto error; | |
910 | } | |
911 | dev->minor = interface->minor; | |
912 | ||
913 | /* let the user know what node this device is now attached to */ | |
1b29a375 GKH |
914 | dev_info(&interface->dev, "LEGO USB Tower #%d now attached to major " |
915 | "%d minor %d\n", (dev->minor - LEGO_USB_TOWER_MINOR_BASE), | |
916 | USB_MAJOR, dev->minor); | |
1da177e4 LT |
917 | |
918 | /* get the firmware version and log it */ | |
919 | result = usb_control_msg (udev, | |
920 | usb_rcvctrlpipe(udev, 0), | |
921 | LEGO_USB_TOWER_REQUEST_GET_VERSION, | |
922 | USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE, | |
923 | 0, | |
924 | 0, | |
925 | &get_version_reply, | |
926 | sizeof(get_version_reply), | |
927 | 1000); | |
928 | if (result < 0) { | |
9d974b2a | 929 | dev_err(idev, "LEGO USB Tower get version control request failed\n"); |
1da177e4 LT |
930 | retval = result; |
931 | goto error; | |
932 | } | |
1b29a375 GKH |
933 | dev_info(&interface->dev, "LEGO USB Tower firmware version is %d.%d " |
934 | "build %d\n", get_version_reply.major, | |
935 | get_version_reply.minor, | |
936 | le16_to_cpu(get_version_reply.build_no)); | |
1da177e4 LT |
937 | |
938 | ||
939 | exit: | |
1da177e4 LT |
940 | return retval; |
941 | ||
942 | error: | |
943 | tower_delete(dev); | |
944 | return retval; | |
945 | } | |
946 | ||
947 | ||
948 | /** | |
949 | * tower_disconnect | |
950 | * | |
951 | * Called by the usb core when the device is removed from the system. | |
952 | */ | |
953 | static void tower_disconnect (struct usb_interface *interface) | |
954 | { | |
955 | struct lego_usb_tower *dev; | |
956 | int minor; | |
957 | ||
1da177e4 | 958 | dev = usb_get_intfdata (interface); |
78663ecc | 959 | mutex_lock(&open_disc_mutex); |
1da177e4 LT |
960 | usb_set_intfdata (interface, NULL); |
961 | ||
1da177e4 LT |
962 | minor = dev->minor; |
963 | ||
964 | /* give back our minor */ | |
965 | usb_deregister_dev (interface, &tower_class); | |
966 | ||
18bcbcfe | 967 | mutex_lock(&dev->lock); |
78663ecc | 968 | mutex_unlock(&open_disc_mutex); |
d4ead16f | 969 | |
1da177e4 LT |
970 | /* if the device is not opened, then we clean up right now */ |
971 | if (!dev->open_count) { | |
18bcbcfe | 972 | mutex_unlock(&dev->lock); |
1da177e4 LT |
973 | tower_delete (dev); |
974 | } else { | |
975 | dev->udev = NULL; | |
d35b4ce1 ON |
976 | /* wake up pollers */ |
977 | wake_up_interruptible_all(&dev->read_wait); | |
978 | wake_up_interruptible_all(&dev->write_wait); | |
18bcbcfe | 979 | mutex_unlock(&dev->lock); |
1da177e4 LT |
980 | } |
981 | ||
1b29a375 GKH |
982 | dev_info(&interface->dev, "LEGO USB Tower #%d now disconnected\n", |
983 | (minor - LEGO_USB_TOWER_MINOR_BASE)); | |
1da177e4 LT |
984 | } |
985 | ||
65db4305 | 986 | module_usb_driver(tower_driver); |
1da177e4 LT |
987 | |
988 | MODULE_AUTHOR(DRIVER_AUTHOR); | |
989 | MODULE_DESCRIPTION(DRIVER_DESC); | |
990 | #ifdef MODULE_LICENSE | |
991 | MODULE_LICENSE("GPL"); | |
992 | #endif |