blob: c6bfd13f6c92ff416688659b54600026cf382de1 [file] [log] [blame]
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -08001/*
2 * Native support for the I/O-Warrior USB devices
3 *
4 * Copyright (c) 2003-2005 Code Mercenaries GmbH
5 * written by Christian Lucht <lucht@codemercs.com>
6 *
7 * based on
8
9 * usb-skeleton.c by Greg Kroah-Hartman <greg@kroah.com>
10 * brlvger.c by Stephane Dalton <sdalton@videotron.ca>
11 * and St�hane Doyon <s.doyon@videotron.ca>
12 *
13 * Released under the GPLv2.
14 */
15
16#include <linux/module.h>
17#include <linux/usb.h>
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080018#include <linux/slab.h>
19#include <linux/sched.h>
Arnd Bergmann925ce682010-07-11 23:18:56 +020020#include <linux/mutex.h>
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080021#include <linux/poll.h>
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080022#include <linux/usb/iowarrior.h>
23
24/* Version Information */
25#define DRIVER_VERSION "v0.4.0"
26#define DRIVER_AUTHOR "Christian Lucht <lucht@codemercs.com>"
27#define DRIVER_DESC "USB IO-Warrior driver (Linux 2.6.x)"
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
38/* Get a minor range for your devices from the usb maintainer */
39#ifdef CONFIG_USB_DYNAMIC_MINORS
40#define IOWARRIOR_MINOR_BASE 0
41#else
Lucas De Marchi25985ed2011-03-30 22:57:33 -030042#define IOWARRIOR_MINOR_BASE 208 // SKELETON_MINOR_BASE 192 + 16, not official yet
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080043#endif
44
45/* interrupt input queue size */
46#define MAX_INTERRUPT_BUFFER 16
47/*
48 maximum number of urbs that are submitted for writes at the same time,
49 this applies to the IOWarrior56 only!
50 IOWarrior24 and IOWarrior40 use synchronous usb_control_msg calls.
51*/
52#define MAX_WRITES_IN_FLIGHT 4
53
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080054MODULE_AUTHOR(DRIVER_AUTHOR);
55MODULE_DESCRIPTION(DRIVER_DESC);
56MODULE_LICENSE("GPL");
57
58/* Module parameters */
Arnd Bergmann925ce682010-07-11 23:18:56 +020059static DEFINE_MUTEX(iowarrior_mutex);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080060
61static struct usb_driver iowarrior_driver;
Oliver Neukum03f36e82007-10-25 15:46:30 +020062static DEFINE_MUTEX(iowarrior_open_disc_lock);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080063
64/*--------------*/
65/* data */
66/*--------------*/
67
68/* Structure to hold all of our device specific stuff */
69struct iowarrior {
70 struct mutex mutex; /* locks this structure */
71 struct usb_device *udev; /* save off the usb device pointer */
72 struct usb_interface *interface; /* the interface for this device */
73 unsigned char minor; /* the starting minor number for this device */
74 struct usb_endpoint_descriptor *int_out_endpoint; /* endpoint for reading (needed for IOW56 only) */
75 struct usb_endpoint_descriptor *int_in_endpoint; /* endpoint for reading */
76 struct urb *int_in_urb; /* the urb for reading data */
77 unsigned char *int_in_buffer; /* buffer for data to be read */
78 unsigned char serial_number; /* to detect lost packages */
79 unsigned char *read_queue; /* size is MAX_INTERRUPT_BUFFER * packet size */
80 wait_queue_head_t read_wait;
81 wait_queue_head_t write_wait; /* wait-queue for writing to the device */
82 atomic_t write_busy; /* number of write-urbs submitted */
83 atomic_t read_idx;
84 atomic_t intr_idx;
85 spinlock_t intr_idx_lock; /* protects intr_idx */
86 atomic_t overflow_flag; /* signals an index 'rollover' */
87 int present; /* this is 1 as long as the device is connected */
88 int opened; /* this is 1 if the device is currently open */
89 char chip_serial[9]; /* the serial number string of the chip connected */
90 int report_size; /* number of bytes in a report */
91 u16 product_id;
92};
93
94/*--------------*/
95/* globals */
96/*--------------*/
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -080097
98/*
99 * USB spec identifies 5 second timeouts.
100 */
101#define GET_TIMEOUT 5
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,
Eberhard Fahle147c5a12007-04-05 11:13:21 +0200113 GET_TIMEOUT*HZ);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800114}
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,
Eberhard Fahle147c5a12007-04-05 11:13:21 +0200128 size, HZ);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800129}
130
131/*---------------------*/
132/* driver registration */
133/*---------------------*/
134/* table of devices that work with this driver */
Németh Márton33b9e162010-01-10 15:34:45 +0100135static const struct usb_device_id iowarrior_ids[] = {
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800136 {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 {} /* Terminating entry */
142};
143MODULE_DEVICE_TABLE(usb, iowarrior_ids);
144
145/*
146 * USB callback handler for reading data
147 */
148static void iowarrior_callback(struct urb *urb)
149{
Ming Leicdc97792008-02-24 18:41:47 +0800150 struct iowarrior *dev = urb->context;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800151 int intr_idx;
152 int read_idx;
153 int aux_idx;
154 int offset;
Greg Kroah-Hartmanfb3abee2007-07-18 10:58:02 -0700155 int status = urb->status;
156 int retval;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800157
Greg Kroah-Hartmanfb3abee2007-07-18 10:58:02 -0700158 switch (status) {
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800159 case 0:
160 /* success */
161 break;
162 case -ECONNRESET:
163 case -ENOENT:
164 case -ESHUTDOWN:
165 return;
166 default:
167 goto exit;
168 }
169
170 spin_lock(&dev->intr_idx_lock);
171 intr_idx = atomic_read(&dev->intr_idx);
172 /* aux_idx become previous intr_idx */
173 aux_idx = (intr_idx == 0) ? (MAX_INTERRUPT_BUFFER - 1) : (intr_idx - 1);
174 read_idx = atomic_read(&dev->read_idx);
175
176 /* queue is not empty and it's interface 0 */
177 if ((intr_idx != read_idx)
178 && (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0)) {
179 /* + 1 for serial number */
180 offset = aux_idx * (dev->report_size + 1);
181 if (!memcmp
182 (dev->read_queue + offset, urb->transfer_buffer,
183 dev->report_size)) {
184 /* equal values on interface 0 will be ignored */
185 spin_unlock(&dev->intr_idx_lock);
186 goto exit;
187 }
188 }
189
190 /* aux_idx become next intr_idx */
191 aux_idx = (intr_idx == (MAX_INTERRUPT_BUFFER - 1)) ? 0 : (intr_idx + 1);
192 if (read_idx == aux_idx) {
193 /* queue full, dropping oldest input */
194 read_idx = (++read_idx == MAX_INTERRUPT_BUFFER) ? 0 : read_idx;
195 atomic_set(&dev->read_idx, read_idx);
196 atomic_set(&dev->overflow_flag, 1);
197 }
198
199 /* +1 for serial number */
200 offset = intr_idx * (dev->report_size + 1);
201 memcpy(dev->read_queue + offset, urb->transfer_buffer,
202 dev->report_size);
203 *(dev->read_queue + offset + (dev->report_size)) = dev->serial_number++;
204
205 atomic_set(&dev->intr_idx, aux_idx);
206 spin_unlock(&dev->intr_idx_lock);
207 /* tell the blocking read about the new data */
208 wake_up_interruptible(&dev->read_wait);
209
210exit:
Greg Kroah-Hartmanfb3abee2007-07-18 10:58:02 -0700211 retval = usb_submit_urb(urb, GFP_ATOMIC);
212 if (retval)
Joe Perches898eb712007-10-18 03:06:30 -0700213 dev_err(&dev->interface->dev, "%s - usb_submit_urb failed with result %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800214 __func__, retval);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800215
216}
217
218/*
219 * USB Callback handler for write-ops
220 */
221static void iowarrior_write_callback(struct urb *urb)
222{
223 struct iowarrior *dev;
Greg Kroah-Hartmanfb3abee2007-07-18 10:58:02 -0700224 int status = urb->status;
225
Ming Leicdc97792008-02-24 18:41:47 +0800226 dev = urb->context;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800227 /* sync/async unlink faults aren't errors */
Greg Kroah-Hartmanfb3abee2007-07-18 10:58:02 -0700228 if (status &&
229 !(status == -ENOENT ||
230 status == -ECONNRESET || status == -ESHUTDOWN)) {
Joe Perches549e8352014-05-20 13:09:33 -0700231 dev_dbg(&dev->interface->dev,
232 "nonzero write bulk status received: %d\n", status);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800233 }
234 /* free up our allocated buffer */
Daniel Mack997ea582010-04-12 13:17:25 +0200235 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
236 urb->transfer_buffer, urb->transfer_dma);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800237 /* tell a waiting writer the interrupt-out-pipe is available again */
238 atomic_dec(&dev->write_busy);
239 wake_up_interruptible(&dev->write_wait);
240}
241
242/**
243 * iowarrior_delete
244 */
245static inline void iowarrior_delete(struct iowarrior *dev)
246{
Joe Perches549e8352014-05-20 13:09:33 -0700247 dev_dbg(&dev->interface->dev, "minor %d\n", dev->minor);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800248 kfree(dev->int_in_buffer);
249 usb_free_urb(dev->int_in_urb);
250 kfree(dev->read_queue);
251 kfree(dev);
252}
253
254/*---------------------*/
255/* fops implementation */
256/*---------------------*/
257
258static int read_index(struct iowarrior *dev)
259{
260 int intr_idx, read_idx;
261
262 read_idx = atomic_read(&dev->read_idx);
263 intr_idx = atomic_read(&dev->intr_idx);
264
265 return (read_idx == intr_idx ? -1 : read_idx);
266}
267
268/**
269 * iowarrior_read
270 */
271static ssize_t iowarrior_read(struct file *file, char __user *buffer,
272 size_t count, loff_t *ppos)
273{
274 struct iowarrior *dev;
275 int read_idx;
276 int offset;
277
Joe Perches5bd6e8b2010-07-12 13:50:12 -0700278 dev = file->private_data;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800279
280 /* verify that the device wasn't unplugged */
281 if (dev == NULL || !dev->present)
282 return -ENODEV;
283
Joe Perches549e8352014-05-20 13:09:33 -0700284 dev_dbg(&dev->interface->dev, "minor %d, count = %zd\n",
285 dev->minor, count);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800286
287 /* read count must be packet size (+ time stamp) */
288 if ((count != dev->report_size)
289 && (count != (dev->report_size + 1)))
290 return -EINVAL;
291
292 /* repeat until no buffer overrun in callback handler occur */
293 do {
294 atomic_set(&dev->overflow_flag, 0);
295 if ((read_idx = read_index(dev)) == -1) {
Rahul Bedarkarf38f1412013-12-30 20:00:54 +0530296 /* queue empty */
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800297 if (file->f_flags & O_NONBLOCK)
298 return -EAGAIN;
299 else {
300 //next line will return when there is either new data, or the device is unplugged
301 int r = wait_event_interruptible(dev->read_wait,
302 (!dev->present
303 || (read_idx =
304 read_index
305 (dev)) !=
306 -1));
307 if (r) {
308 //we were interrupted by a signal
309 return -ERESTART;
310 }
311 if (!dev->present) {
312 //The device was unplugged
313 return -ENODEV;
314 }
315 if (read_idx == -1) {
316 // Can this happen ???
317 return 0;
318 }
319 }
320 }
321
322 offset = read_idx * (dev->report_size + 1);
323 if (copy_to_user(buffer, dev->read_queue + offset, count)) {
324 return -EFAULT;
325 }
326 } while (atomic_read(&dev->overflow_flag));
327
328 read_idx = ++read_idx == MAX_INTERRUPT_BUFFER ? 0 : read_idx;
329 atomic_set(&dev->read_idx, read_idx);
330 return count;
331}
332
333/*
334 * iowarrior_write
335 */
336static ssize_t iowarrior_write(struct file *file,
337 const char __user *user_buffer,
338 size_t count, loff_t *ppos)
339{
340 struct iowarrior *dev;
341 int retval = 0;
342 char *buf = NULL; /* for IOW24 and IOW56 we need a buffer */
343 struct urb *int_out_urb = NULL;
344
Joe Perches5bd6e8b2010-07-12 13:50:12 -0700345 dev = file->private_data;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800346
347 mutex_lock(&dev->mutex);
348 /* verify that the device wasn't unplugged */
Adrian Bunke28c6a72007-10-18 12:52:50 +0200349 if (!dev->present) {
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800350 retval = -ENODEV;
351 goto exit;
352 }
Joe Perches549e8352014-05-20 13:09:33 -0700353 dev_dbg(&dev->interface->dev, "minor %d, count = %zd\n",
354 dev->minor, count);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800355 /* if count is 0 we're already done */
356 if (count == 0) {
357 retval = 0;
358 goto exit;
359 }
360 /* We only accept full reports */
361 if (count != dev->report_size) {
362 retval = -EINVAL;
363 goto exit;
364 }
365 switch (dev->product_id) {
366 case USB_DEVICE_ID_CODEMERCS_IOW24:
367 case USB_DEVICE_ID_CODEMERCS_IOWPV1:
368 case USB_DEVICE_ID_CODEMERCS_IOWPV2:
369 case USB_DEVICE_ID_CODEMERCS_IOW40:
370 /* IOW24 and IOW40 use a synchronous call */
Kees Cook3ed78012010-10-11 11:28:16 -0700371 buf = kmalloc(count, GFP_KERNEL);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800372 if (!buf) {
373 retval = -ENOMEM;
374 goto exit;
375 }
376 if (copy_from_user(buf, user_buffer, count)) {
377 retval = -EFAULT;
378 kfree(buf);
379 goto exit;
380 }
381 retval = usb_set_report(dev->interface, 2, 0, buf, count);
382 kfree(buf);
383 goto exit;
384 break;
385 case USB_DEVICE_ID_CODEMERCS_IOW56:
386 /* The IOW56 uses asynchronous IO and more urbs */
387 if (atomic_read(&dev->write_busy) == MAX_WRITES_IN_FLIGHT) {
388 /* Wait until we are below the limit for submitted urbs */
389 if (file->f_flags & O_NONBLOCK) {
390 retval = -EAGAIN;
391 goto exit;
392 } else {
393 retval = wait_event_interruptible(dev->write_wait,
394 (!dev->present || (atomic_read (&dev-> write_busy) < MAX_WRITES_IN_FLIGHT)));
395 if (retval) {
396 /* we were interrupted by a signal */
397 retval = -ERESTART;
398 goto exit;
399 }
400 if (!dev->present) {
401 /* The device was unplugged */
402 retval = -ENODEV;
403 goto exit;
404 }
405 if (!dev->opened) {
406 /* We were closed while waiting for an URB */
407 retval = -ENODEV;
408 goto exit;
409 }
410 }
411 }
412 atomic_inc(&dev->write_busy);
413 int_out_urb = usb_alloc_urb(0, GFP_KERNEL);
414 if (!int_out_urb) {
415 retval = -ENOMEM;
Joe Perches549e8352014-05-20 13:09:33 -0700416 dev_dbg(&dev->interface->dev,
417 "Unable to allocate urb\n");
Oliver Neukumf81ee4d2007-03-19 11:39:13 +0100418 goto error_no_urb;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800419 }
Daniel Mack997ea582010-04-12 13:17:25 +0200420 buf = usb_alloc_coherent(dev->udev, dev->report_size,
421 GFP_KERNEL, &int_out_urb->transfer_dma);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800422 if (!buf) {
423 retval = -ENOMEM;
Joe Perches549e8352014-05-20 13:09:33 -0700424 dev_dbg(&dev->interface->dev,
425 "Unable to allocate buffer\n");
Oliver Neukumf81ee4d2007-03-19 11:39:13 +0100426 goto error_no_buffer;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800427 }
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 retval = usb_submit_urb(int_out_urb, GFP_KERNEL);
440 if (retval) {
Joe Perches549e8352014-05-20 13:09:33 -0700441 dev_dbg(&dev->interface->dev,
442 "submit error %d for urb nr.%d\n",
443 retval, atomic_read(&dev->write_busy));
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800444 goto error;
445 }
446 /* submit was ok */
447 retval = count;
448 usb_free_urb(int_out_urb);
449 goto exit;
450 break;
451 default:
452 /* what do we have here ? An unsupported Product-ID ? */
Joe Perches898eb712007-10-18 03:06:30 -0700453 dev_err(&dev->interface->dev, "%s - not supported for product=0x%x\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800454 __func__, dev->product_id);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800455 retval = -EFAULT;
456 goto exit;
457 break;
458 }
459error:
Daniel Mack997ea582010-04-12 13:17:25 +0200460 usb_free_coherent(dev->udev, dev->report_size, buf,
461 int_out_urb->transfer_dma);
Oliver Neukumf81ee4d2007-03-19 11:39:13 +0100462error_no_buffer:
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800463 usb_free_urb(int_out_urb);
Oliver Neukumf81ee4d2007-03-19 11:39:13 +0100464error_no_urb:
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800465 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 */
Alan Cox824f16f2008-05-22 22:06:02 +0100475static long iowarrior_ioctl(struct file *file, unsigned int cmd,
476 unsigned long arg)
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800477{
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
Joe Perches5bd6e8b2010-07-12 13:50:12 -0700484 dev = file->private_data;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800485 if (dev == NULL) {
486 return -ENODEV;
487 }
488
489 buffer = kzalloc(dev->report_size, GFP_KERNEL);
490 if (!buffer)
491 return -ENOMEM;
492
493 /* lock this object */
Arnd Bergmann925ce682010-07-11 23:18:56 +0200494 mutex_lock(&iowarrior_mutex);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800495 mutex_lock(&dev->mutex);
496
497 /* verify that the device wasn't unplugged */
498 if (!dev->present) {
Oliver Neukumfc0f8fc2007-06-12 15:36:07 +0200499 retval = -ENODEV;
500 goto error_out;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800501 }
502
Joe Perches549e8352014-05-20 13:09:33 -0700503 dev_dbg(&dev->interface->dev, "minor %d, cmd 0x%.4x, arg %ld\n",
504 dev->minor, cmd, arg);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800505
506 retval = 0;
507 io_res = 0;
508 switch (cmd) {
509 case IOW_WRITE:
510 if (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW24 ||
511 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOWPV1 ||
512 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOWPV2 ||
513 dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW40) {
514 user_buffer = (__u8 __user *)arg;
515 io_res = copy_from_user(buffer, user_buffer,
516 dev->report_size);
517 if (io_res) {
518 retval = -EFAULT;
519 } else {
520 io_res = usb_set_report(dev->interface, 2, 0,
521 buffer,
522 dev->report_size);
523 if (io_res < 0)
524 retval = io_res;
525 }
526 } else {
527 retval = -EINVAL;
528 dev_err(&dev->interface->dev,
Joe Perches898eb712007-10-18 03:06:30 -0700529 "ioctl 'IOW_WRITE' is not supported for product=0x%x.\n",
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800530 dev->product_id);
531 }
532 break;
533 case IOW_READ:
534 user_buffer = (__u8 __user *)arg;
535 io_res = usb_get_report(dev->udev,
536 dev->interface->cur_altsetting, 1, 0,
537 buffer, dev->report_size);
538 if (io_res < 0)
539 retval = io_res;
540 else {
541 io_res = copy_to_user(user_buffer, buffer, dev->report_size);
Kulikov Vasiliy6d4d4552010-07-31 21:39:46 +0400542 if (io_res)
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800543 retval = -EFAULT;
544 }
545 break;
546 case IOW_GETINFO:
547 {
548 /* Report available information for the device */
549 struct iowarrior_info info;
550 /* needed for power consumption */
551 struct usb_config_descriptor *cfg_descriptor = &dev->udev->actconfig->desc;
552
Vasiliy Kulikoveca67aa2010-11-06 17:41:31 +0300553 memset(&info, 0, sizeof(info));
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800554 /* directly from the descriptor */
555 info.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
556 info.product = dev->product_id;
557 info.revision = le16_to_cpu(dev->udev->descriptor.bcdDevice);
558
559 /* 0==UNKNOWN, 1==LOW(usb1.1) ,2=FULL(usb1.1), 3=HIGH(usb2.0) */
560 info.speed = le16_to_cpu(dev->udev->speed);
561 info.if_num = dev->interface->cur_altsetting->desc.bInterfaceNumber;
562 info.report_size = dev->report_size;
563
564 /* serial number string has been read earlier 8 chars or empty string */
565 memcpy(info.serial, dev->chip_serial,
566 sizeof(dev->chip_serial));
567 if (cfg_descriptor == NULL) {
568 info.power = -1; /* no information available */
569 } else {
570 /* the MaxPower is stored in units of 2mA to make it fit into a byte-value */
571 info.power = cfg_descriptor->bMaxPower * 2;
572 }
573 io_res = copy_to_user((struct iowarrior_info __user *)arg, &info,
574 sizeof(struct iowarrior_info));
Kulikov Vasiliy6d4d4552010-07-31 21:39:46 +0400575 if (io_res)
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800576 retval = -EFAULT;
577 break;
578 }
579 default:
580 /* return that we did not understand this ioctl call */
581 retval = -ENOTTY;
582 break;
583 }
Oliver Neukumfc0f8fc2007-06-12 15:36:07 +0200584error_out:
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800585 /* unlock the device */
586 mutex_unlock(&dev->mutex);
Arnd Bergmann925ce682010-07-11 23:18:56 +0200587 mutex_unlock(&iowarrior_mutex);
Oliver Neukumfc0f8fc2007-06-12 15:36:07 +0200588 kfree(buffer);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800589 return retval;
590}
591
592/**
593 * iowarrior_open
594 */
595static int iowarrior_open(struct inode *inode, struct file *file)
596{
597 struct iowarrior *dev = NULL;
598 struct usb_interface *interface;
599 int subminor;
600 int retval = 0;
601
Arnd Bergmann925ce682010-07-11 23:18:56 +0200602 mutex_lock(&iowarrior_mutex);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800603 subminor = iminor(inode);
604
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800605 interface = usb_find_interface(&iowarrior_driver, subminor);
606 if (!interface) {
Arnd Bergmann925ce682010-07-11 23:18:56 +0200607 mutex_unlock(&iowarrior_mutex);
Greg Kroah-Hartman1c2eef02012-04-20 16:53:45 -0700608 printk(KERN_ERR "%s - error, can't find device for minor %d\n",
609 __func__, subminor);
Alan Sternd4ead162007-05-22 11:46:41 -0400610 return -ENODEV;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800611 }
612
Oliver Neukum03f36e82007-10-25 15:46:30 +0200613 mutex_lock(&iowarrior_open_disc_lock);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800614 dev = usb_get_intfdata(interface);
Oliver Neukum03f36e82007-10-25 15:46:30 +0200615 if (!dev) {
616 mutex_unlock(&iowarrior_open_disc_lock);
Arnd Bergmann925ce682010-07-11 23:18:56 +0200617 mutex_unlock(&iowarrior_mutex);
Alan Sternd4ead162007-05-22 11:46:41 -0400618 return -ENODEV;
Oliver Neukum03f36e82007-10-25 15:46:30 +0200619 }
Alan Sternd4ead162007-05-22 11:46:41 -0400620
621 mutex_lock(&dev->mutex);
Oliver Neukum03f36e82007-10-25 15:46:30 +0200622 mutex_unlock(&iowarrior_open_disc_lock);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800623
624 /* Only one process can open each device, no sharing. */
625 if (dev->opened) {
626 retval = -EBUSY;
627 goto out;
628 }
629
630 /* setup interrupt handler for receiving values */
631 if ((retval = usb_submit_urb(dev->int_in_urb, GFP_KERNEL)) < 0) {
632 dev_err(&interface->dev, "Error %d while submitting URB\n", retval);
633 retval = -EFAULT;
634 goto out;
635 }
636 /* increment our usage count for the driver */
637 ++dev->opened;
638 /* save our object in the file's private structure */
639 file->private_data = dev;
640 retval = 0;
641
642out:
Alan Sternd4ead162007-05-22 11:46:41 -0400643 mutex_unlock(&dev->mutex);
Arnd Bergmann925ce682010-07-11 23:18:56 +0200644 mutex_unlock(&iowarrior_mutex);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800645 return retval;
646}
647
648/**
649 * iowarrior_release
650 */
651static int iowarrior_release(struct inode *inode, struct file *file)
652{
653 struct iowarrior *dev;
654 int retval = 0;
655
Joe Perches5bd6e8b2010-07-12 13:50:12 -0700656 dev = file->private_data;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800657 if (dev == NULL) {
658 return -ENODEV;
659 }
660
Joe Perches549e8352014-05-20 13:09:33 -0700661 dev_dbg(&dev->interface->dev, "minor %d\n", dev->minor);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800662
663 /* lock our device */
664 mutex_lock(&dev->mutex);
665
666 if (dev->opened <= 0) {
667 retval = -ENODEV; /* close called more than once */
668 mutex_unlock(&dev->mutex);
669 } else {
Masanari Iidaa895d572013-04-09 02:06:50 +0900670 dev->opened = 0; /* we're closing now */
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800671 retval = 0;
672 if (dev->present) {
673 /*
674 The device is still connected so we only shutdown
675 pending read-/write-ops.
676 */
677 usb_kill_urb(dev->int_in_urb);
678 wake_up_interruptible(&dev->read_wait);
679 wake_up_interruptible(&dev->write_wait);
680 mutex_unlock(&dev->mutex);
681 } else {
682 /* The device was unplugged, cleanup resources */
683 mutex_unlock(&dev->mutex);
684 iowarrior_delete(dev);
685 }
686 }
687 return retval;
688}
689
690static unsigned iowarrior_poll(struct file *file, poll_table * wait)
691{
692 struct iowarrior *dev = file->private_data;
693 unsigned int mask = 0;
694
695 if (!dev->present)
696 return POLLERR | POLLHUP;
697
698 poll_wait(file, &dev->read_wait, wait);
699 poll_wait(file, &dev->write_wait, wait);
700
701 if (!dev->present)
702 return POLLERR | POLLHUP;
703
704 if (read_index(dev) != -1)
705 mask |= POLLIN | POLLRDNORM;
706
707 if (atomic_read(&dev->write_busy) < MAX_WRITES_IN_FLIGHT)
708 mask |= POLLOUT | POLLWRNORM;
709 return mask;
710}
711
712/*
713 * File operations needed when we register this driver.
714 * This assumes that this driver NEEDS file operations,
715 * of course, which means that the driver is expected
716 * to have a node in the /dev directory. If the USB
717 * device were for a network interface then the driver
718 * would use "struct net_driver" instead, and a serial
719 * device would use "struct tty_driver".
720 */
Jan Engelhardt0b3f5fe2008-01-22 20:51:11 +0100721static const struct file_operations iowarrior_fops = {
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800722 .owner = THIS_MODULE,
723 .write = iowarrior_write,
724 .read = iowarrior_read,
Alan Cox824f16f2008-05-22 22:06:02 +0100725 .unlocked_ioctl = iowarrior_ioctl,
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800726 .open = iowarrior_open,
727 .release = iowarrior_release,
728 .poll = iowarrior_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200729 .llseek = noop_llseek,
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800730};
731
Al Viro2c9ede52011-07-23 20:24:48 -0400732static char *iowarrior_devnode(struct device *dev, umode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +0200733{
734 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
735}
736
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800737/*
738 * usb class driver info in order to get a minor number from the usb core,
739 * and to have the device registered with devfs and the driver core
740 */
741static struct usb_class_driver iowarrior_class = {
742 .name = "iowarrior%d",
Kay Sieverse454cea2009-09-18 23:01:12 +0200743 .devnode = iowarrior_devnode,
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800744 .fops = &iowarrior_fops,
745 .minor_base = IOWARRIOR_MINOR_BASE,
746};
747
748/*---------------------------------*/
749/* probe and disconnect functions */
750/*---------------------------------*/
751/**
752 * iowarrior_probe
753 *
754 * Called by the usb core when a new device is connected that it thinks
755 * this driver might be interested in.
756 */
757static int iowarrior_probe(struct usb_interface *interface,
758 const struct usb_device_id *id)
759{
760 struct usb_device *udev = interface_to_usbdev(interface);
761 struct iowarrior *dev = NULL;
762 struct usb_host_interface *iface_desc;
763 struct usb_endpoint_descriptor *endpoint;
764 int i;
765 int retval = -ENOMEM;
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800766
Uwe Kleine-Königb5950762010-11-01 15:38:34 -0400767 /* allocate memory for our device state and initialize it */
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800768 dev = kzalloc(sizeof(struct iowarrior), GFP_KERNEL);
769 if (dev == NULL) {
Joe Perches898eb712007-10-18 03:06:30 -0700770 dev_err(&interface->dev, "Out of memory\n");
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800771 return retval;
772 }
773
774 mutex_init(&dev->mutex);
775
776 atomic_set(&dev->intr_idx, 0);
777 atomic_set(&dev->read_idx, 0);
778 spin_lock_init(&dev->intr_idx_lock);
779 atomic_set(&dev->overflow_flag, 0);
780 init_waitqueue_head(&dev->read_wait);
781 atomic_set(&dev->write_busy, 0);
782 init_waitqueue_head(&dev->write_wait);
783
784 dev->udev = udev;
785 dev->interface = interface;
786
787 iface_desc = interface->cur_altsetting;
788 dev->product_id = le16_to_cpu(udev->descriptor.idProduct);
789
790 /* set up the endpoint information */
791 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
792 endpoint = &iface_desc->endpoint[i].desc;
793
794 if (usb_endpoint_is_int_in(endpoint))
795 dev->int_in_endpoint = endpoint;
796 if (usb_endpoint_is_int_out(endpoint))
797 /* this one will match for the IOWarrior56 only */
798 dev->int_out_endpoint = endpoint;
799 }
Masanari Iidaa895d572013-04-09 02:06:50 +0900800 /* we have to check the report_size often, so remember it in the endianness suitable for our machine */
Kuninori Morimoto29cc8892011-08-23 03:12:03 -0700801 dev->report_size = usb_endpoint_maxp(dev->int_in_endpoint);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800802 if ((dev->interface->cur_altsetting->desc.bInterfaceNumber == 0) &&
803 (dev->product_id == USB_DEVICE_ID_CODEMERCS_IOW56))
804 /* IOWarrior56 has wMaxPacketSize different from report size */
805 dev->report_size = 7;
806
807 /* create the urb and buffer for reading */
808 dev->int_in_urb = usb_alloc_urb(0, GFP_KERNEL);
809 if (!dev->int_in_urb) {
810 dev_err(&interface->dev, "Couldn't allocate interrupt_in_urb\n");
811 goto error;
812 }
813 dev->int_in_buffer = kmalloc(dev->report_size, GFP_KERNEL);
814 if (!dev->int_in_buffer) {
815 dev_err(&interface->dev, "Couldn't allocate int_in_buffer\n");
816 goto error;
817 }
818 usb_fill_int_urb(dev->int_in_urb, dev->udev,
819 usb_rcvintpipe(dev->udev,
820 dev->int_in_endpoint->bEndpointAddress),
821 dev->int_in_buffer, dev->report_size,
822 iowarrior_callback, dev,
823 dev->int_in_endpoint->bInterval);
824 /* create an internal buffer for interrupt data from the device */
825 dev->read_queue =
826 kmalloc(((dev->report_size + 1) * MAX_INTERRUPT_BUFFER),
827 GFP_KERNEL);
828 if (!dev->read_queue) {
829 dev_err(&interface->dev, "Couldn't allocate read_queue\n");
830 goto error;
831 }
832 /* Get the serial-number of the chip */
833 memset(dev->chip_serial, 0x00, sizeof(dev->chip_serial));
834 usb_string(udev, udev->descriptor.iSerialNumber, dev->chip_serial,
835 sizeof(dev->chip_serial));
836 if (strlen(dev->chip_serial) != 8)
837 memset(dev->chip_serial, 0x00, sizeof(dev->chip_serial));
838
839 /* Set the idle timeout to 0, if this is interface 0 */
840 if (dev->interface->cur_altsetting->desc.bInterfaceNumber == 0) {
Eberhard Fahle147c5a12007-04-05 11:13:21 +0200841 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
842 0x0A,
843 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0,
844 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800845 }
846 /* allow device read and ioctl */
847 dev->present = 1;
848
849 /* we can register the device now, as it is ready */
850 usb_set_intfdata(interface, dev);
851
852 retval = usb_register_dev(interface, &iowarrior_class);
853 if (retval) {
854 /* something prevented us from registering this driver */
855 dev_err(&interface->dev, "Not able to get a minor for this device.\n");
856 usb_set_intfdata(interface, NULL);
857 goto error;
858 }
859
860 dev->minor = interface->minor;
861
862 /* let the user know what node this device is now attached to */
863 dev_info(&interface->dev, "IOWarrior product=0x%x, serial=%s interface=%d "
864 "now attached to iowarrior%d\n", dev->product_id, dev->chip_serial,
865 iface_desc->desc.bInterfaceNumber, dev->minor - IOWARRIOR_MINOR_BASE);
866 return retval;
867
868error:
869 iowarrior_delete(dev);
870 return retval;
871}
872
873/**
874 * iowarrior_disconnect
875 *
876 * Called by the usb core when the device is removed from the system.
877 */
878static void iowarrior_disconnect(struct usb_interface *interface)
879{
880 struct iowarrior *dev;
881 int minor;
882
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800883 dev = usb_get_intfdata(interface);
Oliver Neukum03f36e82007-10-25 15:46:30 +0200884 mutex_lock(&iowarrior_open_disc_lock);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800885 usb_set_intfdata(interface, NULL);
886
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800887 minor = dev->minor;
888
889 /* give back our minor */
890 usb_deregister_dev(interface, &iowarrior_class);
891
Alan Sternd4ead162007-05-22 11:46:41 -0400892 mutex_lock(&dev->mutex);
893
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800894 /* prevent device read, write and ioctl */
895 dev->present = 0;
896
897 mutex_unlock(&dev->mutex);
Oliver Neukum03f36e82007-10-25 15:46:30 +0200898 mutex_unlock(&iowarrior_open_disc_lock);
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800899
900 if (dev->opened) {
901 /* There is a process that holds a filedescriptor to the device ,
902 so we only shutdown read-/write-ops going on.
903 Deleting the device is postponed until close() was called.
904 */
905 usb_kill_urb(dev->int_in_urb);
906 wake_up_interruptible(&dev->read_wait);
907 wake_up_interruptible(&dev->write_wait);
908 } else {
909 /* no process is using the device, cleanup now */
910 iowarrior_delete(dev);
911 }
Greg Kroah-Hartman946b9602007-02-14 13:40:14 -0800912
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
Greg Kroah-Hartman65db4302011-11-18 09:34:02 -0800925module_usb_driver(iowarrior_driver);