Commit | Line | Data |
---|---|---|
5fd54ace | 1 | // SPDX-License-Identifier: GPL-2.0+ |
7e8455b1 | 2 | /* |
2824bd25 MH |
3 | * Generic USB driver for report based interrupt in/out devices |
4 | * like LD Didactic's USB devices. LD Didactic's USB devices are | |
5 | * HID devices which do not use HID report definitons (they use | |
6 | * raw interrupt in and our reports only for communication). | |
7 | * | |
8 | * This driver uses a ring buffer for time critical reading of | |
9 | * interrupt in reports and provides read and write methods for | |
10 | * raw interrupt reports (similar to the Windows HID driver). | |
11 | * Devices based on the book USB COMPLETE by Jan Axelson may need | |
12 | * such a compatibility to the Windows HID driver. | |
13 | * | |
14 | * Copyright (C) 2005 Michael Hund <mhund@ld-didactic.de> | |
15 | * | |
2824bd25 MH |
16 | * Derived from Lego USB Tower driver |
17 | * Copyright (C) 2003 David Glance <advidgsf@sourceforge.net> | |
18 | * 2001-2004 Juergen Stuber <starblue@users.sourceforge.net> | |
2824bd25 MH |
19 | */ |
20 | ||
2824bd25 MH |
21 | #include <linux/kernel.h> |
22 | #include <linux/errno.h> | |
2824bd25 MH |
23 | #include <linux/slab.h> |
24 | #include <linux/module.h> | |
4186ecf8 | 25 | #include <linux/mutex.h> |
2824bd25 | 26 | |
7c0f6ba6 | 27 | #include <linux/uaccess.h> |
2824bd25 MH |
28 | #include <linux/input.h> |
29 | #include <linux/usb.h> | |
30 | #include <linux/poll.h> | |
31 | ||
32 | /* Define these values to match your devices */ | |
33 | #define USB_VENDOR_ID_LD 0x0f11 /* USB Vendor ID of LD Didactic GmbH */ | |
ce97cac8 MH |
34 | #define USB_DEVICE_ID_LD_CASSY 0x1000 /* USB Product ID of CASSY-S modules with 8 bytes endpoint size */ |
35 | #define USB_DEVICE_ID_LD_CASSY2 0x1001 /* USB Product ID of CASSY-S modules with 64 bytes endpoint size */ | |
ba3e66e9 | 36 | #define USB_DEVICE_ID_LD_POCKETCASSY 0x1010 /* USB Product ID of Pocket-CASSY */ |
ce97cac8 | 37 | #define USB_DEVICE_ID_LD_POCKETCASSY2 0x1011 /* USB Product ID of Pocket-CASSY 2 (reserved) */ |
ba3e66e9 | 38 | #define USB_DEVICE_ID_LD_MOBILECASSY 0x1020 /* USB Product ID of Mobile-CASSY */ |
ce97cac8 MH |
39 | #define USB_DEVICE_ID_LD_MOBILECASSY2 0x1021 /* USB Product ID of Mobile-CASSY 2 (reserved) */ |
40 | #define USB_DEVICE_ID_LD_MICROCASSYVOLTAGE 0x1031 /* USB Product ID of Micro-CASSY Voltage */ | |
41 | #define USB_DEVICE_ID_LD_MICROCASSYCURRENT 0x1032 /* USB Product ID of Micro-CASSY Current */ | |
42 | #define USB_DEVICE_ID_LD_MICROCASSYTIME 0x1033 /* USB Product ID of Micro-CASSY Time (reserved) */ | |
43 | #define USB_DEVICE_ID_LD_MICROCASSYTEMPERATURE 0x1035 /* USB Product ID of Micro-CASSY Temperature */ | |
44 | #define USB_DEVICE_ID_LD_MICROCASSYPH 0x1038 /* USB Product ID of Micro-CASSY pH */ | |
52ad2bd8 KK |
45 | #define USB_DEVICE_ID_LD_POWERANALYSERCASSY 0x1040 /* USB Product ID of Power Analyser CASSY */ |
46 | #define USB_DEVICE_ID_LD_CONVERTERCONTROLLERCASSY 0x1042 /* USB Product ID of Converter Controller CASSY */ | |
47 | #define USB_DEVICE_ID_LD_MACHINETESTCASSY 0x1043 /* USB Product ID of Machine Test CASSY */ | |
ba3e66e9 MH |
48 | #define USB_DEVICE_ID_LD_JWM 0x1080 /* USB Product ID of Joule and Wattmeter */ |
49 | #define USB_DEVICE_ID_LD_DMMP 0x1081 /* USB Product ID of Digital Multimeter P (reserved) */ | |
50 | #define USB_DEVICE_ID_LD_UMIP 0x1090 /* USB Product ID of UMI P */ | |
ce97cac8 MH |
51 | #define USB_DEVICE_ID_LD_UMIC 0x10A0 /* USB Product ID of UMI C */ |
52 | #define USB_DEVICE_ID_LD_UMIB 0x10B0 /* USB Product ID of UMI B */ | |
53 | #define USB_DEVICE_ID_LD_XRAY 0x1100 /* USB Product ID of X-Ray Apparatus 55481 */ | |
54 | #define USB_DEVICE_ID_LD_XRAY2 0x1101 /* USB Product ID of X-Ray Apparatus 554800 */ | |
55 | #define USB_DEVICE_ID_LD_XRAYCT 0x1110 /* USB Product ID of X-Ray Apparatus CT 554821*/ | |
ba3e66e9 | 56 | #define USB_DEVICE_ID_LD_VIDEOCOM 0x1200 /* USB Product ID of VideoCom */ |
ce97cac8 | 57 | #define USB_DEVICE_ID_LD_MOTOR 0x1210 /* USB Product ID of Motor (reserved) */ |
ba3e66e9 MH |
58 | #define USB_DEVICE_ID_LD_COM3LAB 0x2000 /* USB Product ID of COM3LAB */ |
59 | #define USB_DEVICE_ID_LD_TELEPORT 0x2010 /* USB Product ID of Terminal Adapter */ | |
60 | #define USB_DEVICE_ID_LD_NETWORKANALYSER 0x2020 /* USB Product ID of Network Analyser */ | |
61 | #define USB_DEVICE_ID_LD_POWERCONTROL 0x2030 /* USB Product ID of Converter Control Unit */ | |
62 | #define USB_DEVICE_ID_LD_MACHINETEST 0x2040 /* USB Product ID of Machine Test System */ | |
ce97cac8 MH |
63 | #define USB_DEVICE_ID_LD_MOSTANALYSER 0x2050 /* USB Product ID of MOST Protocol Analyser */ |
64 | #define USB_DEVICE_ID_LD_MOSTANALYSER2 0x2051 /* USB Product ID of MOST Protocol Analyser 2 */ | |
65 | #define USB_DEVICE_ID_LD_ABSESP 0x2060 /* USB Product ID of ABS ESP */ | |
66 | #define USB_DEVICE_ID_LD_AUTODATABUS 0x2070 /* USB Product ID of Automotive Data Buses */ | |
67 | #define USB_DEVICE_ID_LD_MCT 0x2080 /* USB Product ID of Microcontroller technique */ | |
68 | #define USB_DEVICE_ID_LD_HYBRID 0x2090 /* USB Product ID of Automotive Hybrid */ | |
69 | #define USB_DEVICE_ID_LD_HEATCONTROL 0x20A0 /* USB Product ID of Heat control */ | |
2824bd25 | 70 | |
2824bd25 MH |
71 | #ifdef CONFIG_USB_DYNAMIC_MINORS |
72 | #define USB_LD_MINOR_BASE 0 | |
73 | #else | |
74 | #define USB_LD_MINOR_BASE 176 | |
75 | #endif | |
76 | ||
77 | /* table of devices that work with this driver */ | |
33b9e162 | 78 | static const struct usb_device_id ld_usb_table[] = { |
ba3e66e9 | 79 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY) }, |
ce97cac8 | 80 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CASSY2) }, |
ba3e66e9 | 81 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY) }, |
ce97cac8 | 82 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POCKETCASSY2) }, |
ba3e66e9 | 83 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY) }, |
ce97cac8 MH |
84 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOBILECASSY2) }, |
85 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYVOLTAGE) }, | |
86 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYCURRENT) }, | |
87 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYTIME) }, | |
88 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYTEMPERATURE) }, | |
89 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MICROCASSYPH) }, | |
52ad2bd8 KK |
90 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERANALYSERCASSY) }, |
91 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_CONVERTERCONTROLLERCASSY) }, | |
92 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETESTCASSY) }, | |
ba3e66e9 MH |
93 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_JWM) }, |
94 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_DMMP) }, | |
95 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIP) }, | |
ce97cac8 MH |
96 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIC) }, |
97 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_UMIB) }, | |
98 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY) }, | |
ba3e66e9 MH |
99 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_XRAY2) }, |
100 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_VIDEOCOM) }, | |
ce97cac8 | 101 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOTOR) }, |
ba3e66e9 MH |
102 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_COM3LAB) }, |
103 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_TELEPORT) }, | |
104 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_NETWORKANALYSER) }, | |
105 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_POWERCONTROL) }, | |
106 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MACHINETEST) }, | |
ce97cac8 MH |
107 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOSTANALYSER) }, |
108 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MOSTANALYSER2) }, | |
109 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_ABSESP) }, | |
110 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_AUTODATABUS) }, | |
111 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_MCT) }, | |
112 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_HYBRID) }, | |
113 | { USB_DEVICE(USB_VENDOR_ID_LD, USB_DEVICE_ID_LD_HEATCONTROL) }, | |
2824bd25 MH |
114 | { } /* Terminating entry */ |
115 | }; | |
116 | MODULE_DEVICE_TABLE(usb, ld_usb_table); | |
2824bd25 MH |
117 | MODULE_AUTHOR("Michael Hund <mhund@ld-didactic.de>"); |
118 | MODULE_DESCRIPTION("LD USB Driver"); | |
119 | MODULE_LICENSE("GPL"); | |
2824bd25 | 120 | |
2824bd25 MH |
121 | /* All interrupt in transfers are collected in a ring buffer to |
122 | * avoid racing conditions and get better performance of the driver. | |
123 | */ | |
124 | static int ring_buffer_size = 128; | |
3d1a4673 | 125 | module_param(ring_buffer_size, int, 0000); |
2824bd25 MH |
126 | MODULE_PARM_DESC(ring_buffer_size, "Read ring buffer size in reports"); |
127 | ||
128 | /* The write_buffer can contain more than one interrupt out transfer. | |
129 | */ | |
130 | static int write_buffer_size = 10; | |
3d1a4673 | 131 | module_param(write_buffer_size, int, 0000); |
2824bd25 MH |
132 | MODULE_PARM_DESC(write_buffer_size, "Write buffer size in reports"); |
133 | ||
134 | /* As of kernel version 2.6.4 ehci-hcd uses an | |
135 | * "only one interrupt transfer per frame" shortcut | |
136 | * to simplify the scheduling of periodic transfers. | |
137 | * This conflicts with our standard 1ms intervals for in and out URBs. | |
138 | * We use default intervals of 2ms for in and 2ms for out transfers, | |
139 | * which should be fast enough. | |
140 | * Increase the interval to allow more devices that do interrupt transfers, | |
141 | * or set to 1 to use the standard interval from the endpoint descriptors. | |
142 | */ | |
143 | static int min_interrupt_in_interval = 2; | |
3d1a4673 | 144 | module_param(min_interrupt_in_interval, int, 0000); |
2824bd25 MH |
145 | MODULE_PARM_DESC(min_interrupt_in_interval, "Minimum interrupt in interval in ms"); |
146 | ||
147 | static int min_interrupt_out_interval = 2; | |
3d1a4673 | 148 | module_param(min_interrupt_out_interval, int, 0000); |
2824bd25 MH |
149 | MODULE_PARM_DESC(min_interrupt_out_interval, "Minimum interrupt out interval in ms"); |
150 | ||
151 | /* Structure to hold all of our device specific stuff */ | |
152 | struct ld_usb { | |
ce0d7d3f | 153 | struct mutex mutex; /* locks this structure */ |
4d72e35d | 154 | struct usb_interface *intf; /* save off the usb interface pointer */ |
58ecf131 | 155 | unsigned long disconnected:1; |
2824bd25 MH |
156 | |
157 | int open_count; /* number of times this port has been opened */ | |
158 | ||
4d72e35d | 159 | char *ring_buffer; |
2824bd25 MH |
160 | unsigned int ring_head; |
161 | unsigned int ring_tail; | |
162 | ||
163 | wait_queue_head_t read_wait; | |
164 | wait_queue_head_t write_wait; | |
165 | ||
4d72e35d MR |
166 | char *interrupt_in_buffer; |
167 | struct usb_endpoint_descriptor *interrupt_in_endpoint; | |
168 | struct urb *interrupt_in_urb; | |
2824bd25 MH |
169 | int interrupt_in_interval; |
170 | size_t interrupt_in_endpoint_size; | |
171 | int interrupt_in_running; | |
172 | int interrupt_in_done; | |
9d33efd9 ON |
173 | int buffer_overflow; |
174 | spinlock_t rbsl; | |
2824bd25 | 175 | |
4d72e35d MR |
176 | char *interrupt_out_buffer; |
177 | struct usb_endpoint_descriptor *interrupt_out_endpoint; | |
178 | struct urb *interrupt_out_urb; | |
2824bd25 MH |
179 | int interrupt_out_interval; |
180 | size_t interrupt_out_endpoint_size; | |
181 | int interrupt_out_busy; | |
182 | }; | |
183 | ||
2824bd25 MH |
184 | static struct usb_driver ld_usb_driver; |
185 | ||
7e8455b1 | 186 | /* |
2824bd25 MH |
187 | * ld_usb_abort_transfers |
188 | * aborts transfers and frees associated data structures | |
189 | */ | |
190 | static void ld_usb_abort_transfers(struct ld_usb *dev) | |
191 | { | |
192 | /* shutdown transfer */ | |
193 | if (dev->interrupt_in_running) { | |
194 | dev->interrupt_in_running = 0; | |
58ecf131 | 195 | usb_kill_urb(dev->interrupt_in_urb); |
2824bd25 MH |
196 | } |
197 | if (dev->interrupt_out_busy) | |
58ecf131 | 198 | usb_kill_urb(dev->interrupt_out_urb); |
2824bd25 MH |
199 | } |
200 | ||
7e8455b1 | 201 | /* |
2824bd25 MH |
202 | * ld_usb_delete |
203 | */ | |
204 | static void ld_usb_delete(struct ld_usb *dev) | |
205 | { | |
2824bd25 MH |
206 | /* free data structures */ |
207 | usb_free_urb(dev->interrupt_in_urb); | |
208 | usb_free_urb(dev->interrupt_out_urb); | |
209 | kfree(dev->ring_buffer); | |
210 | kfree(dev->interrupt_in_buffer); | |
211 | kfree(dev->interrupt_out_buffer); | |
212 | kfree(dev); | |
213 | } | |
214 | ||
7e8455b1 | 215 | /* |
2824bd25 MH |
216 | * ld_usb_interrupt_in_callback |
217 | */ | |
7d12e780 | 218 | static void ld_usb_interrupt_in_callback(struct urb *urb) |
2824bd25 MH |
219 | { |
220 | struct ld_usb *dev = urb->context; | |
221 | size_t *actual_buffer; | |
222 | unsigned int next_ring_head; | |
491c021e | 223 | int status = urb->status; |
d7cdbdd0 | 224 | unsigned long flags; |
2824bd25 MH |
225 | int retval; |
226 | ||
491c021e GKH |
227 | if (status) { |
228 | if (status == -ENOENT || | |
229 | status == -ECONNRESET || | |
230 | status == -ESHUTDOWN) { | |
2824bd25 MH |
231 | goto exit; |
232 | } else { | |
457163c4 GKH |
233 | dev_dbg(&dev->intf->dev, |
234 | "%s: nonzero status received: %d\n", __func__, | |
235 | status); | |
d7cdbdd0 | 236 | spin_lock_irqsave(&dev->rbsl, flags); |
2824bd25 MH |
237 | goto resubmit; /* maybe we can recover */ |
238 | } | |
239 | } | |
240 | ||
d7cdbdd0 | 241 | spin_lock_irqsave(&dev->rbsl, flags); |
2824bd25 MH |
242 | if (urb->actual_length > 0) { |
243 | next_ring_head = (dev->ring_head+1) % ring_buffer_size; | |
244 | if (next_ring_head != dev->ring_tail) { | |
4d72e35d | 245 | actual_buffer = (size_t *)(dev->ring_buffer + dev->ring_head * (sizeof(size_t)+dev->interrupt_in_endpoint_size)); |
2824bd25 MH |
246 | /* actual_buffer gets urb->actual_length + interrupt_in_buffer */ |
247 | *actual_buffer = urb->actual_length; | |
248 | memcpy(actual_buffer+1, dev->interrupt_in_buffer, urb->actual_length); | |
249 | dev->ring_head = next_ring_head; | |
457163c4 GKH |
250 | dev_dbg(&dev->intf->dev, "%s: received %d bytes\n", |
251 | __func__, urb->actual_length); | |
9d33efd9 | 252 | } else { |
2824bd25 MH |
253 | dev_warn(&dev->intf->dev, |
254 | "Ring buffer overflow, %d bytes dropped\n", | |
255 | urb->actual_length); | |
9d33efd9 ON |
256 | dev->buffer_overflow = 1; |
257 | } | |
2824bd25 MH |
258 | } |
259 | ||
260 | resubmit: | |
261 | /* resubmit if we're still running */ | |
58ecf131 | 262 | if (dev->interrupt_in_running && !dev->buffer_overflow) { |
2824bd25 | 263 | retval = usb_submit_urb(dev->interrupt_in_urb, GFP_ATOMIC); |
9d33efd9 | 264 | if (retval) { |
2824bd25 MH |
265 | dev_err(&dev->intf->dev, |
266 | "usb_submit_urb failed (%d)\n", retval); | |
9d33efd9 ON |
267 | dev->buffer_overflow = 1; |
268 | } | |
2824bd25 | 269 | } |
d7cdbdd0 | 270 | spin_unlock_irqrestore(&dev->rbsl, flags); |
2824bd25 MH |
271 | exit: |
272 | dev->interrupt_in_done = 1; | |
273 | wake_up_interruptible(&dev->read_wait); | |
274 | } | |
275 | ||
7e8455b1 | 276 | /* |
2824bd25 MH |
277 | * ld_usb_interrupt_out_callback |
278 | */ | |
7d12e780 | 279 | static void ld_usb_interrupt_out_callback(struct urb *urb) |
2824bd25 MH |
280 | { |
281 | struct ld_usb *dev = urb->context; | |
491c021e | 282 | int status = urb->status; |
2824bd25 MH |
283 | |
284 | /* sync/async unlink faults aren't errors */ | |
491c021e GKH |
285 | if (status && !(status == -ENOENT || |
286 | status == -ECONNRESET || | |
287 | status == -ESHUTDOWN)) | |
457163c4 GKH |
288 | dev_dbg(&dev->intf->dev, |
289 | "%s - nonzero write interrupt status received: %d\n", | |
290 | __func__, status); | |
2824bd25 MH |
291 | |
292 | dev->interrupt_out_busy = 0; | |
293 | wake_up_interruptible(&dev->write_wait); | |
294 | } | |
295 | ||
7e8455b1 | 296 | /* |
2824bd25 MH |
297 | * ld_usb_open |
298 | */ | |
299 | static int ld_usb_open(struct inode *inode, struct file *file) | |
300 | { | |
301 | struct ld_usb *dev; | |
302 | int subminor; | |
d4ead16f | 303 | int retval; |
2824bd25 MH |
304 | struct usb_interface *interface; |
305 | ||
c5bf68fe | 306 | stream_open(inode, file); |
2824bd25 MH |
307 | subminor = iminor(inode); |
308 | ||
2824bd25 MH |
309 | interface = usb_find_interface(&ld_usb_driver, subminor); |
310 | ||
311 | if (!interface) { | |
b22862e5 GKH |
312 | printk(KERN_ERR "%s - error, can't find device for minor %d\n", |
313 | __func__, subminor); | |
d4ead16f | 314 | return -ENODEV; |
2824bd25 MH |
315 | } |
316 | ||
317 | dev = usb_get_intfdata(interface); | |
318 | ||
6248c52f | 319 | if (!dev) |
d4ead16f | 320 | return -ENODEV; |
2824bd25 MH |
321 | |
322 | /* lock this device */ | |
6248c52f | 323 | if (mutex_lock_interruptible(&dev->mutex)) |
d4ead16f | 324 | return -ERESTARTSYS; |
2824bd25 MH |
325 | |
326 | /* allow opening only once */ | |
327 | if (dev->open_count) { | |
328 | retval = -EBUSY; | |
329 | goto unlock_exit; | |
330 | } | |
331 | dev->open_count = 1; | |
332 | ||
333 | /* initialize in direction */ | |
334 | dev->ring_head = 0; | |
335 | dev->ring_tail = 0; | |
9d33efd9 | 336 | dev->buffer_overflow = 0; |
2824bd25 MH |
337 | usb_fill_int_urb(dev->interrupt_in_urb, |
338 | interface_to_usbdev(interface), | |
339 | usb_rcvintpipe(interface_to_usbdev(interface), | |
340 | dev->interrupt_in_endpoint->bEndpointAddress), | |
341 | dev->interrupt_in_buffer, | |
342 | dev->interrupt_in_endpoint_size, | |
343 | ld_usb_interrupt_in_callback, | |
344 | dev, | |
345 | dev->interrupt_in_interval); | |
346 | ||
347 | dev->interrupt_in_running = 1; | |
348 | dev->interrupt_in_done = 0; | |
349 | ||
350 | retval = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL); | |
351 | if (retval) { | |
352 | dev_err(&interface->dev, "Couldn't submit interrupt_in_urb %d\n", retval); | |
353 | dev->interrupt_in_running = 0; | |
354 | dev->open_count = 0; | |
355 | goto unlock_exit; | |
356 | } | |
357 | ||
358 | /* save device in the file's private structure */ | |
359 | file->private_data = dev; | |
360 | ||
361 | unlock_exit: | |
ce0d7d3f | 362 | mutex_unlock(&dev->mutex); |
2824bd25 | 363 | |
2824bd25 MH |
364 | return retval; |
365 | } | |
366 | ||
7e8455b1 | 367 | /* |
2824bd25 MH |
368 | * ld_usb_release |
369 | */ | |
370 | static int ld_usb_release(struct inode *inode, struct file *file) | |
371 | { | |
372 | struct ld_usb *dev; | |
373 | int retval = 0; | |
374 | ||
375 | dev = file->private_data; | |
376 | ||
377 | if (dev == NULL) { | |
378 | retval = -ENODEV; | |
379 | goto exit; | |
380 | } | |
381 | ||
b14a3904 | 382 | mutex_lock(&dev->mutex); |
2824bd25 MH |
383 | |
384 | if (dev->open_count != 1) { | |
385 | retval = -ENODEV; | |
386 | goto unlock_exit; | |
387 | } | |
58ecf131 | 388 | if (dev->disconnected) { |
2824bd25 | 389 | /* the device was unplugged before the file was released */ |
ce0d7d3f | 390 | mutex_unlock(&dev->mutex); |
2824bd25 MH |
391 | /* unlock here as ld_usb_delete frees dev */ |
392 | ld_usb_delete(dev); | |
393 | goto exit; | |
394 | } | |
395 | ||
396 | /* wait until write transfer is finished */ | |
397 | if (dev->interrupt_out_busy) | |
398 | wait_event_interruptible_timeout(dev->write_wait, !dev->interrupt_out_busy, 2 * HZ); | |
399 | ld_usb_abort_transfers(dev); | |
400 | dev->open_count = 0; | |
401 | ||
402 | unlock_exit: | |
ce0d7d3f | 403 | mutex_unlock(&dev->mutex); |
2824bd25 MH |
404 | |
405 | exit: | |
406 | return retval; | |
407 | } | |
408 | ||
7e8455b1 | 409 | /* |
2824bd25 MH |
410 | * ld_usb_poll |
411 | */ | |
afc9a42b | 412 | static __poll_t ld_usb_poll(struct file *file, poll_table *wait) |
2824bd25 MH |
413 | { |
414 | struct ld_usb *dev; | |
afc9a42b | 415 | __poll_t mask = 0; |
2824bd25 MH |
416 | |
417 | dev = file->private_data; | |
418 | ||
58ecf131 | 419 | if (dev->disconnected) |
a9a08845 | 420 | return EPOLLERR | EPOLLHUP; |
d12b85e7 | 421 | |
2824bd25 MH |
422 | poll_wait(file, &dev->read_wait, wait); |
423 | poll_wait(file, &dev->write_wait, wait); | |
424 | ||
425 | if (dev->ring_head != dev->ring_tail) | |
a9a08845 | 426 | mask |= EPOLLIN | EPOLLRDNORM; |
2824bd25 | 427 | if (!dev->interrupt_out_busy) |
a9a08845 | 428 | mask |= EPOLLOUT | EPOLLWRNORM; |
2824bd25 MH |
429 | |
430 | return mask; | |
431 | } | |
432 | ||
7e8455b1 | 433 | /* |
2824bd25 MH |
434 | * ld_usb_read |
435 | */ | |
436 | static ssize_t ld_usb_read(struct file *file, char __user *buffer, size_t count, | |
437 | loff_t *ppos) | |
438 | { | |
439 | struct ld_usb *dev; | |
440 | size_t *actual_buffer; | |
441 | size_t bytes_to_read; | |
442 | int retval = 0; | |
9d33efd9 | 443 | int rv; |
2824bd25 MH |
444 | |
445 | dev = file->private_data; | |
446 | ||
447 | /* verify that we actually have some data to read */ | |
448 | if (count == 0) | |
449 | goto exit; | |
450 | ||
451 | /* lock this object */ | |
ce0d7d3f | 452 | if (mutex_lock_interruptible(&dev->mutex)) { |
2824bd25 MH |
453 | retval = -ERESTARTSYS; |
454 | goto exit; | |
455 | } | |
456 | ||
457 | /* verify that the device wasn't unplugged */ | |
58ecf131 | 458 | if (dev->disconnected) { |
2824bd25 | 459 | retval = -ENODEV; |
b22862e5 | 460 | printk(KERN_ERR "ldusb: No device or device unplugged %d\n", retval); |
2824bd25 MH |
461 | goto unlock_exit; |
462 | } | |
463 | ||
464 | /* wait for data */ | |
9d33efd9 | 465 | spin_lock_irq(&dev->rbsl); |
7a6f22d7 | 466 | while (dev->ring_head == dev->ring_tail) { |
9d33efd9 ON |
467 | dev->interrupt_in_done = 0; |
468 | spin_unlock_irq(&dev->rbsl); | |
2824bd25 MH |
469 | if (file->f_flags & O_NONBLOCK) { |
470 | retval = -EAGAIN; | |
471 | goto unlock_exit; | |
472 | } | |
473 | retval = wait_event_interruptible(dev->read_wait, dev->interrupt_in_done); | |
474 | if (retval < 0) | |
475 | goto unlock_exit; | |
7a6f22d7 JH |
476 | |
477 | spin_lock_irq(&dev->rbsl); | |
2824bd25 | 478 | } |
7a6f22d7 | 479 | spin_unlock_irq(&dev->rbsl); |
2824bd25 MH |
480 | |
481 | /* actual_buffer contains actual_length + interrupt_in_buffer */ | |
4d72e35d | 482 | actual_buffer = (size_t *)(dev->ring_buffer + dev->ring_tail * (sizeof(size_t)+dev->interrupt_in_endpoint_size)); |
7a6f22d7 JH |
483 | if (*actual_buffer > dev->interrupt_in_endpoint_size) { |
484 | retval = -EIO; | |
485 | goto unlock_exit; | |
486 | } | |
2824bd25 MH |
487 | bytes_to_read = min(count, *actual_buffer); |
488 | if (bytes_to_read < *actual_buffer) | |
88f6bf38 | 489 | dev_warn(&dev->intf->dev, "Read buffer overflow, %zu bytes dropped\n", |
2824bd25 MH |
490 | *actual_buffer-bytes_to_read); |
491 | ||
492 | /* copy one interrupt_in_buffer from ring_buffer into userspace */ | |
493 | if (copy_to_user(buffer, actual_buffer+1, bytes_to_read)) { | |
494 | retval = -EFAULT; | |
495 | goto unlock_exit; | |
496 | } | |
2824bd25 MH |
497 | retval = bytes_to_read; |
498 | ||
9d33efd9 | 499 | spin_lock_irq(&dev->rbsl); |
d98ee2a1 JH |
500 | dev->ring_tail = (dev->ring_tail + 1) % ring_buffer_size; |
501 | ||
9d33efd9 ON |
502 | if (dev->buffer_overflow) { |
503 | dev->buffer_overflow = 0; | |
504 | spin_unlock_irq(&dev->rbsl); | |
505 | rv = usb_submit_urb(dev->interrupt_in_urb, GFP_KERNEL); | |
506 | if (rv < 0) | |
507 | dev->buffer_overflow = 1; | |
508 | } else { | |
509 | spin_unlock_irq(&dev->rbsl); | |
510 | } | |
511 | ||
2824bd25 MH |
512 | unlock_exit: |
513 | /* unlock the device */ | |
ce0d7d3f | 514 | mutex_unlock(&dev->mutex); |
2824bd25 MH |
515 | |
516 | exit: | |
517 | return retval; | |
518 | } | |
519 | ||
7e8455b1 | 520 | /* |
2824bd25 MH |
521 | * ld_usb_write |
522 | */ | |
523 | static ssize_t ld_usb_write(struct file *file, const char __user *buffer, | |
524 | size_t count, loff_t *ppos) | |
525 | { | |
526 | struct ld_usb *dev; | |
527 | size_t bytes_to_write; | |
528 | int retval = 0; | |
529 | ||
530 | dev = file->private_data; | |
531 | ||
532 | /* verify that we actually have some data to write */ | |
533 | if (count == 0) | |
534 | goto exit; | |
535 | ||
536 | /* lock this object */ | |
ce0d7d3f | 537 | if (mutex_lock_interruptible(&dev->mutex)) { |
2824bd25 MH |
538 | retval = -ERESTARTSYS; |
539 | goto exit; | |
540 | } | |
541 | ||
542 | /* verify that the device wasn't unplugged */ | |
58ecf131 | 543 | if (dev->disconnected) { |
2824bd25 | 544 | retval = -ENODEV; |
b22862e5 | 545 | printk(KERN_ERR "ldusb: No device or device unplugged %d\n", retval); |
2824bd25 MH |
546 | goto unlock_exit; |
547 | } | |
548 | ||
549 | /* wait until previous transfer is finished */ | |
550 | if (dev->interrupt_out_busy) { | |
551 | if (file->f_flags & O_NONBLOCK) { | |
552 | retval = -EAGAIN; | |
553 | goto unlock_exit; | |
554 | } | |
555 | retval = wait_event_interruptible(dev->write_wait, !dev->interrupt_out_busy); | |
556 | if (retval < 0) { | |
557 | goto unlock_exit; | |
558 | } | |
559 | } | |
560 | ||
561 | /* write the data into interrupt_out_buffer from userspace */ | |
562 | bytes_to_write = min(count, write_buffer_size*dev->interrupt_out_endpoint_size); | |
563 | if (bytes_to_write < count) | |
88f6bf38 JH |
564 | dev_warn(&dev->intf->dev, "Write buffer overflow, %zu bytes dropped\n", |
565 | count - bytes_to_write); | |
566 | dev_dbg(&dev->intf->dev, "%s: count = %zu, bytes_to_write = %zu\n", | |
457163c4 | 567 | __func__, count, bytes_to_write); |
2824bd25 MH |
568 | |
569 | if (copy_from_user(dev->interrupt_out_buffer, buffer, bytes_to_write)) { | |
570 | retval = -EFAULT; | |
571 | goto unlock_exit; | |
572 | } | |
573 | ||
574 | if (dev->interrupt_out_endpoint == NULL) { | |
575 | /* try HID_REQ_SET_REPORT=9 on control_endpoint instead of interrupt_out_endpoint */ | |
576 | retval = usb_control_msg(interface_to_usbdev(dev->intf), | |
577 | usb_sndctrlpipe(interface_to_usbdev(dev->intf), 0), | |
578 | 9, | |
579 | USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT, | |
580 | 1 << 8, 0, | |
581 | dev->interrupt_out_buffer, | |
582 | bytes_to_write, | |
52403cfb | 583 | USB_CTRL_SET_TIMEOUT); |
2824bd25 | 584 | if (retval < 0) |
b22862e5 GKH |
585 | dev_err(&dev->intf->dev, |
586 | "Couldn't submit HID_REQ_SET_REPORT %d\n", | |
587 | retval); | |
2824bd25 MH |
588 | goto unlock_exit; |
589 | } | |
590 | ||
591 | /* send off the urb */ | |
592 | usb_fill_int_urb(dev->interrupt_out_urb, | |
593 | interface_to_usbdev(dev->intf), | |
594 | usb_sndintpipe(interface_to_usbdev(dev->intf), | |
595 | dev->interrupt_out_endpoint->bEndpointAddress), | |
596 | dev->interrupt_out_buffer, | |
597 | bytes_to_write, | |
598 | ld_usb_interrupt_out_callback, | |
599 | dev, | |
600 | dev->interrupt_out_interval); | |
601 | ||
602 | dev->interrupt_out_busy = 1; | |
603 | wmb(); | |
604 | ||
605 | retval = usb_submit_urb(dev->interrupt_out_urb, GFP_KERNEL); | |
606 | if (retval) { | |
607 | dev->interrupt_out_busy = 0; | |
b22862e5 GKH |
608 | dev_err(&dev->intf->dev, |
609 | "Couldn't submit interrupt_out_urb %d\n", retval); | |
2824bd25 MH |
610 | goto unlock_exit; |
611 | } | |
612 | retval = bytes_to_write; | |
613 | ||
614 | unlock_exit: | |
615 | /* unlock the device */ | |
ce0d7d3f | 616 | mutex_unlock(&dev->mutex); |
2824bd25 MH |
617 | |
618 | exit: | |
619 | return retval; | |
620 | } | |
621 | ||
622 | /* file operations needed when we register this driver */ | |
066202dd | 623 | static const struct file_operations ld_usb_fops = { |
2824bd25 MH |
624 | .owner = THIS_MODULE, |
625 | .read = ld_usb_read, | |
626 | .write = ld_usb_write, | |
627 | .open = ld_usb_open, | |
628 | .release = ld_usb_release, | |
629 | .poll = ld_usb_poll, | |
6038f373 | 630 | .llseek = no_llseek, |
2824bd25 MH |
631 | }; |
632 | ||
633 | /* | |
634 | * usb class driver info in order to get a minor number from the usb core, | |
595b14cb | 635 | * and to have the device registered with the driver core |
2824bd25 MH |
636 | */ |
637 | static struct usb_class_driver ld_usb_class = { | |
638 | .name = "ldusb%d", | |
639 | .fops = &ld_usb_fops, | |
640 | .minor_base = USB_LD_MINOR_BASE, | |
641 | }; | |
642 | ||
7e8455b1 | 643 | /* |
2824bd25 MH |
644 | * ld_usb_probe |
645 | * | |
646 | * Called by the usb core when a new device is connected that it thinks | |
647 | * this driver might be interested in. | |
648 | */ | |
649 | static int ld_usb_probe(struct usb_interface *intf, const struct usb_device_id *id) | |
650 | { | |
651 | struct usb_device *udev = interface_to_usbdev(intf); | |
652 | struct ld_usb *dev = NULL; | |
653 | struct usb_host_interface *iface_desc; | |
2824bd25 | 654 | char *buffer; |
2824bd25 | 655 | int retval = -ENOMEM; |
2707ca16 | 656 | int res; |
2824bd25 | 657 | |
b595076a | 658 | /* allocate memory for our device state and initialize it */ |
2824bd25 | 659 | |
1144cf7a | 660 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); |
6714ffae | 661 | if (!dev) |
2824bd25 | 662 | goto exit; |
ce0d7d3f | 663 | mutex_init(&dev->mutex); |
9d33efd9 | 664 | spin_lock_init(&dev->rbsl); |
2824bd25 MH |
665 | dev->intf = intf; |
666 | init_waitqueue_head(&dev->read_wait); | |
667 | init_waitqueue_head(&dev->write_wait); | |
668 | ||
669 | /* workaround for early firmware versions on fast computers */ | |
670 | if ((le16_to_cpu(udev->descriptor.idVendor) == USB_VENDOR_ID_LD) && | |
ba3e66e9 MH |
671 | ((le16_to_cpu(udev->descriptor.idProduct) == USB_DEVICE_ID_LD_CASSY) || |
672 | (le16_to_cpu(udev->descriptor.idProduct) == USB_DEVICE_ID_LD_COM3LAB)) && | |
2824bd25 MH |
673 | (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x103)) { |
674 | buffer = kmalloc(256, GFP_KERNEL); | |
6714ffae | 675 | if (!buffer) |
a6db592e | 676 | goto error; |
2824bd25 MH |
677 | /* usb_string makes SETUP+STALL to leave always ControlReadLoop */ |
678 | usb_string(udev, 255, buffer, 256); | |
679 | kfree(buffer); | |
680 | } | |
681 | ||
682 | iface_desc = intf->cur_altsetting; | |
683 | ||
2707ca16 JH |
684 | res = usb_find_last_int_in_endpoint(iface_desc, |
685 | &dev->interrupt_in_endpoint); | |
686 | if (res) { | |
2824bd25 | 687 | dev_err(&intf->dev, "Interrupt in endpoint not found\n"); |
2707ca16 | 688 | retval = res; |
2824bd25 MH |
689 | goto error; |
690 | } | |
2707ca16 JH |
691 | |
692 | res = usb_find_last_int_out_endpoint(iface_desc, | |
693 | &dev->interrupt_out_endpoint); | |
694 | if (res) | |
2824bd25 MH |
695 | dev_warn(&intf->dev, "Interrupt out endpoint not found (using control endpoint instead)\n"); |
696 | ||
29cc8897 | 697 | dev->interrupt_in_endpoint_size = usb_endpoint_maxp(dev->interrupt_in_endpoint); |
7a6f22d7 JH |
698 | dev->ring_buffer = kcalloc(ring_buffer_size, |
699 | sizeof(size_t) + dev->interrupt_in_endpoint_size, | |
700 | GFP_KERNEL); | |
6714ffae | 701 | if (!dev->ring_buffer) |
2824bd25 | 702 | goto error; |
2824bd25 | 703 | dev->interrupt_in_buffer = kmalloc(dev->interrupt_in_endpoint_size, GFP_KERNEL); |
6714ffae | 704 | if (!dev->interrupt_in_buffer) |
2824bd25 | 705 | goto error; |
2824bd25 | 706 | dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL); |
2d403903 | 707 | if (!dev->interrupt_in_urb) |
2824bd25 | 708 | goto error; |
29cc8897 | 709 | dev->interrupt_out_endpoint_size = dev->interrupt_out_endpoint ? usb_endpoint_maxp(dev->interrupt_out_endpoint) : |
2824bd25 | 710 | udev->descriptor.bMaxPacketSize0; |
6da2ec56 KC |
711 | dev->interrupt_out_buffer = |
712 | kmalloc_array(write_buffer_size, | |
713 | dev->interrupt_out_endpoint_size, GFP_KERNEL); | |
6714ffae | 714 | if (!dev->interrupt_out_buffer) |
2824bd25 | 715 | goto error; |
2824bd25 | 716 | dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL); |
2d403903 | 717 | if (!dev->interrupt_out_urb) |
2824bd25 | 718 | goto error; |
efa2bebf JY |
719 | dev->interrupt_in_interval = max_t(int, min_interrupt_in_interval, |
720 | dev->interrupt_in_endpoint->bInterval); | |
2824bd25 | 721 | if (dev->interrupt_out_endpoint) |
efa2bebf JY |
722 | dev->interrupt_out_interval = max_t(int, min_interrupt_out_interval, |
723 | dev->interrupt_out_endpoint->bInterval); | |
2824bd25 MH |
724 | |
725 | /* we can register the device now, as it is ready */ | |
726 | usb_set_intfdata(intf, dev); | |
727 | ||
728 | retval = usb_register_dev(intf, &ld_usb_class); | |
729 | if (retval) { | |
730 | /* something prevented us from registering this driver */ | |
731 | dev_err(&intf->dev, "Not able to get a minor for this device.\n"); | |
732 | usb_set_intfdata(intf, NULL); | |
733 | goto error; | |
734 | } | |
735 | ||
736 | /* let the user know what node this device is now attached to */ | |
737 | dev_info(&intf->dev, "LD USB Device #%d now attached to major %d minor %d\n", | |
738 | (intf->minor - USB_LD_MINOR_BASE), USB_MAJOR, intf->minor); | |
739 | ||
740 | exit: | |
741 | return retval; | |
742 | ||
743 | error: | |
744 | ld_usb_delete(dev); | |
745 | ||
746 | return retval; | |
747 | } | |
748 | ||
7e8455b1 | 749 | /* |
2824bd25 MH |
750 | * ld_usb_disconnect |
751 | * | |
752 | * Called by the usb core when the device is removed from the system. | |
753 | */ | |
754 | static void ld_usb_disconnect(struct usb_interface *intf) | |
755 | { | |
756 | struct ld_usb *dev; | |
757 | int minor; | |
758 | ||
2824bd25 MH |
759 | dev = usb_get_intfdata(intf); |
760 | usb_set_intfdata(intf, NULL); | |
761 | ||
2824bd25 MH |
762 | minor = intf->minor; |
763 | ||
764 | /* give back our minor */ | |
765 | usb_deregister_dev(intf, &ld_usb_class); | |
766 | ||
58ecf131 JH |
767 | usb_poison_urb(dev->interrupt_in_urb); |
768 | usb_poison_urb(dev->interrupt_out_urb); | |
769 | ||
ce0d7d3f | 770 | mutex_lock(&dev->mutex); |
d4ead16f | 771 | |
2824bd25 MH |
772 | /* if the device is not opened, then we clean up right now */ |
773 | if (!dev->open_count) { | |
ce0d7d3f | 774 | mutex_unlock(&dev->mutex); |
2824bd25 MH |
775 | ld_usb_delete(dev); |
776 | } else { | |
58ecf131 | 777 | dev->disconnected = 1; |
d12b85e7 ON |
778 | /* wake up pollers */ |
779 | wake_up_interruptible_all(&dev->read_wait); | |
780 | wake_up_interruptible_all(&dev->write_wait); | |
ce0d7d3f | 781 | mutex_unlock(&dev->mutex); |
2824bd25 MH |
782 | } |
783 | ||
2824bd25 MH |
784 | dev_info(&intf->dev, "LD USB Device #%d now disconnected\n", |
785 | (minor - USB_LD_MINOR_BASE)); | |
786 | } | |
787 | ||
788 | /* usb specific object needed to register this driver with the usb subsystem */ | |
789 | static struct usb_driver ld_usb_driver = { | |
2824bd25 MH |
790 | .name = "ldusb", |
791 | .probe = ld_usb_probe, | |
792 | .disconnect = ld_usb_disconnect, | |
793 | .id_table = ld_usb_table, | |
794 | }; | |
795 | ||
65db4305 | 796 | module_usb_driver(ld_usb_driver); |
2824bd25 | 797 |