2 * drivers/usb/class/usbtmc.c - USB Test & Measurement class driver
4 * Copyright (C) 2007 Stefan Kopp, Gechingen, Germany
5 * Copyright (C) 2008 Novell, Inc.
6 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * The GNU General Public License is available at
19 * http://www.gnu.org/copyleft/gpl.html.
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 #include <linux/module.h>
25 #include <linux/kernel.h>
27 #include <linux/uaccess.h>
28 #include <linux/kref.h>
29 #include <linux/slab.h>
30 #include <linux/poll.h>
31 #include <linux/mutex.h>
32 #include <linux/usb.h>
33 #include <linux/usb/tmc.h>
37 #define USBTMC_HEADER_SIZE 12
38 #define USBTMC_MINOR_BASE 176
41 * Size of driver internal IO buffer. Must be multiple of 4 and at least as
42 * large as wMaxPacketSize (which is usually 512 bytes).
44 #define USBTMC_SIZE_IOBUFFER 2048
46 /* Default USB timeout (in milliseconds) */
47 #define USBTMC_TIMEOUT 5000
50 * Maximum number of read cycles to empty bulk in endpoint during CLEAR and
51 * ABORT_BULK_IN requests. Ends the loop if (for whatever reason) a short
52 * packet is never read.
54 #define USBTMC_MAX_READS_TO_CLEAR_BULK_IN 100
56 static const struct usb_device_id usbtmc_devices
[] = {
57 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC
, 3, 0), },
58 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC
, 3, 1), },
59 { 0, } /* terminating entry */
61 MODULE_DEVICE_TABLE(usb
, usbtmc_devices
);
64 * This structure is the capabilities for the device
65 * See section 4.2.1.8 of the USBTMC specification,
66 * and section 4.2.2 of the USBTMC usb488 subclass
67 * specification for details.
69 struct usbtmc_dev_capabilities
{
70 __u8 interface_capabilities
;
71 __u8 device_capabilities
;
72 __u8 usb488_interface_capabilities
;
73 __u8 usb488_device_capabilities
;
76 /* This structure holds private data for each USBTMC device. One copy is
77 * allocated for each USBTMC device in the driver's probe function.
79 struct usbtmc_device_data
{
80 const struct usb_device_id
*id
;
81 struct usb_device
*usb_dev
;
82 struct usb_interface
*intf
;
85 unsigned int bulk_out
;
88 u8 bTag_last_write
; /* needed for abort */
89 u8 bTag_last_read
; /* needed for abort */
91 /* data for interrupt in endpoint handling */
97 atomic_t iin_data_valid
;
102 u16 iin_wMaxPacketSize
;
103 atomic_t srq_asserted
;
107 /* attributes from the USB TMC spec for this device */
109 bool TermCharEnabled
;
112 bool zombie
; /* fd of disconnected device */
114 struct usbtmc_dev_capabilities capabilities
;
116 struct mutex io_mutex
; /* only one i/o function running at a time */
117 wait_queue_head_t waitq
;
118 struct fasync_struct
*fasync
;
120 #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
122 struct usbtmc_ID_rigol_quirk
{
127 static const struct usbtmc_ID_rigol_quirk usbtmc_id_quirk
[] = {
133 /* Forward declarations */
134 static struct usb_driver usbtmc_driver
;
136 static void usbtmc_delete(struct kref
*kref
)
138 struct usbtmc_device_data
*data
= to_usbtmc_data(kref
);
140 usb_put_dev(data
->usb_dev
);
143 static int usbtmc_open(struct inode
*inode
, struct file
*filp
)
145 struct usb_interface
*intf
;
146 struct usbtmc_device_data
*data
;
149 intf
= usb_find_interface(&usbtmc_driver
, iminor(inode
));
151 pr_err("can not find device for minor %d", iminor(inode
));
155 data
= usb_get_intfdata(intf
);
156 kref_get(&data
->kref
);
158 /* Store pointer in file structure's private data field */
159 filp
->private_data
= data
;
164 static int usbtmc_release(struct inode
*inode
, struct file
*file
)
166 struct usbtmc_device_data
*data
= file
->private_data
;
168 kref_put(&data
->kref
, usbtmc_delete
);
172 static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data
*data
)
179 struct usb_host_interface
*current_setting
;
182 dev
= &data
->intf
->dev
;
183 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
187 rv
= usb_control_msg(data
->usb_dev
,
188 usb_rcvctrlpipe(data
->usb_dev
, 0),
189 USBTMC_REQUEST_INITIATE_ABORT_BULK_IN
,
190 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
191 data
->bTag_last_read
, data
->bulk_in
,
192 buffer
, 2, USBTMC_TIMEOUT
);
195 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
199 dev_dbg(dev
, "INITIATE_ABORT_BULK_IN returned %x\n", buffer
[0]);
201 if (buffer
[0] == USBTMC_STATUS_FAILED
) {
206 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
207 dev_err(dev
, "INITIATE_ABORT_BULK_IN returned %x\n",
214 current_setting
= data
->intf
->cur_altsetting
;
215 for (n
= 0; n
< current_setting
->desc
.bNumEndpoints
; n
++)
216 if (current_setting
->endpoint
[n
].desc
.bEndpointAddress
==
218 max_size
= usb_endpoint_maxp(¤t_setting
->endpoint
[n
].desc
);
221 dev_err(dev
, "Couldn't get wMaxPacketSize\n");
226 dev_dbg(&data
->intf
->dev
, "wMaxPacketSize is %d\n", max_size
);
231 dev_dbg(dev
, "Reading from bulk in EP\n");
233 rv
= usb_bulk_msg(data
->usb_dev
,
234 usb_rcvbulkpipe(data
->usb_dev
,
236 buffer
, USBTMC_SIZE_IOBUFFER
,
237 &actual
, USBTMC_TIMEOUT
);
242 dev_err(dev
, "usb_bulk_msg returned %d\n", rv
);
245 } while ((actual
== max_size
) &&
246 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
));
248 if (actual
== max_size
) {
249 dev_err(dev
, "Couldn't clear device buffer within %d cycles\n",
250 USBTMC_MAX_READS_TO_CLEAR_BULK_IN
);
257 usbtmc_abort_bulk_in_status
:
258 rv
= usb_control_msg(data
->usb_dev
,
259 usb_rcvctrlpipe(data
->usb_dev
, 0),
260 USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS
,
261 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
262 0, data
->bulk_in
, buffer
, 0x08,
266 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
270 dev_dbg(dev
, "INITIATE_ABORT_BULK_IN returned %x\n", buffer
[0]);
272 if (buffer
[0] == USBTMC_STATUS_SUCCESS
) {
277 if (buffer
[0] != USBTMC_STATUS_PENDING
) {
278 dev_err(dev
, "INITIATE_ABORT_BULK_IN returned %x\n", buffer
[0]);
285 dev_dbg(dev
, "Reading from bulk in EP\n");
287 rv
= usb_bulk_msg(data
->usb_dev
,
288 usb_rcvbulkpipe(data
->usb_dev
,
290 buffer
, USBTMC_SIZE_IOBUFFER
,
291 &actual
, USBTMC_TIMEOUT
);
296 dev_err(dev
, "usb_bulk_msg returned %d\n", rv
);
299 } while ((actual
== max_size
) &&
300 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
));
302 if (actual
== max_size
) {
303 dev_err(dev
, "Couldn't clear device buffer within %d cycles\n",
304 USBTMC_MAX_READS_TO_CLEAR_BULK_IN
);
309 goto usbtmc_abort_bulk_in_status
;
317 static int usbtmc_ioctl_abort_bulk_out(struct usbtmc_device_data
*data
)
324 dev
= &data
->intf
->dev
;
326 buffer
= kmalloc(8, GFP_KERNEL
);
330 rv
= usb_control_msg(data
->usb_dev
,
331 usb_rcvctrlpipe(data
->usb_dev
, 0),
332 USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT
,
333 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
334 data
->bTag_last_write
, data
->bulk_out
,
335 buffer
, 2, USBTMC_TIMEOUT
);
338 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
342 dev_dbg(dev
, "INITIATE_ABORT_BULK_OUT returned %x\n", buffer
[0]);
344 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
345 dev_err(dev
, "INITIATE_ABORT_BULK_OUT returned %x\n",
353 usbtmc_abort_bulk_out_check_status
:
354 rv
= usb_control_msg(data
->usb_dev
,
355 usb_rcvctrlpipe(data
->usb_dev
, 0),
356 USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS
,
357 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
358 0, data
->bulk_out
, buffer
, 0x08,
362 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
366 dev_dbg(dev
, "CHECK_ABORT_BULK_OUT returned %x\n", buffer
[0]);
368 if (buffer
[0] == USBTMC_STATUS_SUCCESS
)
369 goto usbtmc_abort_bulk_out_clear_halt
;
371 if ((buffer
[0] == USBTMC_STATUS_PENDING
) &&
372 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
))
373 goto usbtmc_abort_bulk_out_check_status
;
378 usbtmc_abort_bulk_out_clear_halt
:
379 rv
= usb_clear_halt(data
->usb_dev
,
380 usb_sndbulkpipe(data
->usb_dev
, data
->bulk_out
));
383 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
393 static int usbtmc488_ioctl_read_stb(struct usbtmc_device_data
*data
,
396 struct device
*dev
= &data
->intf
->dev
;
402 dev_dbg(dev
, "Enter ioctl_read_stb iin_ep_present: %d\n",
403 data
->iin_ep_present
);
405 buffer
= kmalloc(8, GFP_KERNEL
);
409 atomic_set(&data
->iin_data_valid
, 0);
411 /* must issue read_stb before using poll or select */
412 atomic_set(&data
->srq_asserted
, 0);
414 rv
= usb_control_msg(data
->usb_dev
,
415 usb_rcvctrlpipe(data
->usb_dev
, 0),
416 USBTMC488_REQUEST_READ_STATUS_BYTE
,
417 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
420 buffer
, 0x03, USBTMC_TIMEOUT
);
422 dev_err(dev
, "stb usb_control_msg returned %d\n", rv
);
426 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
427 dev_err(dev
, "control status returned %x\n", buffer
[0]);
432 if (data
->iin_ep_present
) {
433 rv
= wait_event_interruptible_timeout(
435 atomic_read(&data
->iin_data_valid
) != 0,
438 dev_dbg(dev
, "wait interrupted %d\n", rv
);
443 dev_dbg(dev
, "wait timed out\n");
448 tag
= data
->bNotify1
& 0x7f;
449 if (tag
!= data
->iin_bTag
) {
450 dev_err(dev
, "expected bTag %x got %x\n",
451 data
->iin_bTag
, tag
);
454 stb
= data
->bNotify2
;
459 rv
= copy_to_user(arg
, &stb
, sizeof(stb
));
464 /* bump interrupt bTag */
466 if (data
->iin_bTag
> 127)
467 /* 1 is for SRQ see USBTMC-USB488 subclass spec section 4.3.1 */
475 * Sends a REQUEST_DEV_DEP_MSG_IN message on the Bulk-IN endpoint.
476 * @transfer_size: number of bytes to request from the device.
478 * See the USBTMC specification, Table 4.
480 * Also updates bTag_last_write.
482 static int send_request_dev_dep_msg_in(struct usbtmc_device_data
*data
, size_t transfer_size
)
488 buffer
= kmalloc(USBTMC_HEADER_SIZE
, GFP_KERNEL
);
491 /* Setup IO buffer for REQUEST_DEV_DEP_MSG_IN message
492 * Refer to class specs for details
495 buffer
[1] = data
->bTag
;
496 buffer
[2] = ~data
->bTag
;
497 buffer
[3] = 0; /* Reserved */
498 buffer
[4] = transfer_size
>> 0;
499 buffer
[5] = transfer_size
>> 8;
500 buffer
[6] = transfer_size
>> 16;
501 buffer
[7] = transfer_size
>> 24;
502 buffer
[8] = data
->TermCharEnabled
* 2;
503 /* Use term character? */
504 buffer
[9] = data
->TermChar
;
505 buffer
[10] = 0; /* Reserved */
506 buffer
[11] = 0; /* Reserved */
509 retval
= usb_bulk_msg(data
->usb_dev
,
510 usb_sndbulkpipe(data
->usb_dev
,
512 buffer
, USBTMC_HEADER_SIZE
, &actual
, USBTMC_TIMEOUT
);
514 /* Store bTag (in case we need to abort) */
515 data
->bTag_last_write
= data
->bTag
;
517 /* Increment bTag -- and increment again if zero */
524 dev_err(&data
->intf
->dev
, "usb_bulk_msg in send_request_dev_dep_msg_in() returned %d\n", retval
);
531 static ssize_t
usbtmc_read(struct file
*filp
, char __user
*buf
,
532 size_t count
, loff_t
*f_pos
)
534 struct usbtmc_device_data
*data
;
544 /* Get pointer to private data structure */
545 data
= filp
->private_data
;
546 dev
= &data
->intf
->dev
;
548 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
552 mutex_lock(&data
->io_mutex
);
558 if (data
->rigol_quirk
) {
559 dev_dbg(dev
, "usb_bulk_msg_in: count(%zu)\n", count
);
561 retval
= send_request_dev_dep_msg_in(data
, count
);
564 if (data
->auto_abort
)
565 usbtmc_ioctl_abort_bulk_out(data
);
570 /* Loop until we have fetched everything we requested */
572 this_part
= remaining
;
575 while (remaining
> 0) {
576 if (!data
->rigol_quirk
) {
577 dev_dbg(dev
, "usb_bulk_msg_in: remaining(%zu), count(%zu)\n", remaining
, count
);
579 if (remaining
> USBTMC_SIZE_IOBUFFER
- USBTMC_HEADER_SIZE
- 3)
580 this_part
= USBTMC_SIZE_IOBUFFER
- USBTMC_HEADER_SIZE
- 3;
582 this_part
= remaining
;
584 retval
= send_request_dev_dep_msg_in(data
, this_part
);
586 dev_err(dev
, "usb_bulk_msg returned %d\n", retval
);
587 if (data
->auto_abort
)
588 usbtmc_ioctl_abort_bulk_out(data
);
594 retval
= usb_bulk_msg(data
->usb_dev
,
595 usb_rcvbulkpipe(data
->usb_dev
,
597 buffer
, USBTMC_SIZE_IOBUFFER
, &actual
,
600 dev_dbg(dev
, "usb_bulk_msg: retval(%u), done(%zu), remaining(%zu), actual(%d)\n", retval
, done
, remaining
, actual
);
602 /* Store bTag (in case we need to abort) */
603 data
->bTag_last_read
= data
->bTag
;
606 dev_dbg(dev
, "Unable to read data, error %d\n", retval
);
607 if (data
->auto_abort
)
608 usbtmc_ioctl_abort_bulk_in(data
);
612 /* Parse header in first packet */
613 if ((done
== 0) || !data
->rigol_quirk
) {
614 /* Sanity checks for the header */
615 if (actual
< USBTMC_HEADER_SIZE
) {
616 dev_err(dev
, "Device sent too small first packet: %u < %u\n", actual
, USBTMC_HEADER_SIZE
);
617 if (data
->auto_abort
)
618 usbtmc_ioctl_abort_bulk_in(data
);
622 if (buffer
[0] != 2) {
623 dev_err(dev
, "Device sent reply with wrong MsgID: %u != 2\n", buffer
[0]);
624 if (data
->auto_abort
)
625 usbtmc_ioctl_abort_bulk_in(data
);
629 if (buffer
[1] != data
->bTag_last_write
) {
630 dev_err(dev
, "Device sent reply with wrong bTag: %u != %u\n", buffer
[1], data
->bTag_last_write
);
631 if (data
->auto_abort
)
632 usbtmc_ioctl_abort_bulk_in(data
);
636 /* How many characters did the instrument send? */
637 n_characters
= buffer
[4] +
642 if (n_characters
> this_part
) {
643 dev_err(dev
, "Device wants to return more data than requested: %u > %zu\n", n_characters
, count
);
644 if (data
->auto_abort
)
645 usbtmc_ioctl_abort_bulk_in(data
);
649 /* Remove the USBTMC header */
650 actual
-= USBTMC_HEADER_SIZE
;
652 /* Check if the message is smaller than requested */
653 if (data
->rigol_quirk
) {
654 if (remaining
> n_characters
)
655 remaining
= n_characters
;
656 /* Remove padding if it exists */
657 if (actual
> remaining
)
661 if (this_part
> n_characters
)
662 this_part
= n_characters
;
663 /* Remove padding if it exists */
664 if (actual
> this_part
)
668 dev_dbg(dev
, "Bulk-IN header: N_characters(%u), bTransAttr(%u)\n", n_characters
, buffer
[8]);
672 /* Terminate if end-of-message bit received from device */
673 if ((buffer
[8] & 0x01) && (actual
>= n_characters
))
676 dev_dbg(dev
, "Bulk-IN header: remaining(%zu), buf(%p), buffer(%p) done(%zu)\n", remaining
,buf
,buffer
,done
);
679 /* Copy buffer to user space */
680 if (copy_to_user(buf
+ done
, &buffer
[USBTMC_HEADER_SIZE
], actual
)) {
681 /* There must have been an addressing problem */
688 if (actual
> remaining
)
693 dev_dbg(dev
, "Bulk-IN header cont: actual(%u), done(%zu), remaining(%zu), buf(%p), buffer(%p)\n", actual
, done
, remaining
,buf
,buffer
);
695 /* Copy buffer to user space */
696 if (copy_to_user(buf
+ done
, buffer
, actual
)) {
697 /* There must have been an addressing problem */
705 /* Update file position value */
706 *f_pos
= *f_pos
+ done
;
710 mutex_unlock(&data
->io_mutex
);
715 static ssize_t
usbtmc_write(struct file
*filp
, const char __user
*buf
,
716 size_t count
, loff_t
*f_pos
)
718 struct usbtmc_device_data
*data
;
722 unsigned long int n_bytes
;
727 data
= filp
->private_data
;
729 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
733 mutex_lock(&data
->io_mutex
);
742 while (remaining
> 0) {
743 if (remaining
> USBTMC_SIZE_IOBUFFER
- USBTMC_HEADER_SIZE
) {
744 this_part
= USBTMC_SIZE_IOBUFFER
- USBTMC_HEADER_SIZE
;
747 this_part
= remaining
;
751 /* Setup IO buffer for DEV_DEP_MSG_OUT message */
753 buffer
[1] = data
->bTag
;
754 buffer
[2] = ~data
->bTag
;
755 buffer
[3] = 0; /* Reserved */
756 buffer
[4] = this_part
>> 0;
757 buffer
[5] = this_part
>> 8;
758 buffer
[6] = this_part
>> 16;
759 buffer
[7] = this_part
>> 24;
760 /* buffer[8] is set above... */
761 buffer
[9] = 0; /* Reserved */
762 buffer
[10] = 0; /* Reserved */
763 buffer
[11] = 0; /* Reserved */
765 if (copy_from_user(&buffer
[USBTMC_HEADER_SIZE
], buf
+ done
, this_part
)) {
770 n_bytes
= roundup(USBTMC_HEADER_SIZE
+ this_part
, 4);
771 memset(buffer
+ USBTMC_HEADER_SIZE
+ this_part
, 0, n_bytes
- (USBTMC_HEADER_SIZE
+ this_part
));
774 retval
= usb_bulk_msg(data
->usb_dev
,
775 usb_sndbulkpipe(data
->usb_dev
,
778 &actual
, USBTMC_TIMEOUT
);
784 data
->bTag_last_write
= data
->bTag
;
791 dev_err(&data
->intf
->dev
,
792 "Unable to send data, error %d\n", retval
);
793 if (data
->auto_abort
)
794 usbtmc_ioctl_abort_bulk_out(data
);
798 remaining
-= this_part
;
804 mutex_unlock(&data
->io_mutex
);
809 static int usbtmc_ioctl_clear(struct usbtmc_device_data
*data
)
811 struct usb_host_interface
*current_setting
;
812 struct usb_endpoint_descriptor
*desc
;
820 dev
= &data
->intf
->dev
;
822 dev_dbg(dev
, "Sending INITIATE_CLEAR request\n");
824 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
828 rv
= usb_control_msg(data
->usb_dev
,
829 usb_rcvctrlpipe(data
->usb_dev
, 0),
830 USBTMC_REQUEST_INITIATE_CLEAR
,
831 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
832 0, 0, buffer
, 1, USBTMC_TIMEOUT
);
834 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
838 dev_dbg(dev
, "INITIATE_CLEAR returned %x\n", buffer
[0]);
840 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
841 dev_err(dev
, "INITIATE_CLEAR returned %x\n", buffer
[0]);
847 current_setting
= data
->intf
->cur_altsetting
;
848 for (n
= 0; n
< current_setting
->desc
.bNumEndpoints
; n
++) {
849 desc
= ¤t_setting
->endpoint
[n
].desc
;
850 if (desc
->bEndpointAddress
== data
->bulk_in
)
851 max_size
= usb_endpoint_maxp(desc
);
855 dev_err(dev
, "Couldn't get wMaxPacketSize\n");
860 dev_dbg(dev
, "wMaxPacketSize is %d\n", max_size
);
864 usbtmc_clear_check_status
:
866 dev_dbg(dev
, "Sending CHECK_CLEAR_STATUS request\n");
868 rv
= usb_control_msg(data
->usb_dev
,
869 usb_rcvctrlpipe(data
->usb_dev
, 0),
870 USBTMC_REQUEST_CHECK_CLEAR_STATUS
,
871 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
872 0, 0, buffer
, 2, USBTMC_TIMEOUT
);
874 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
878 dev_dbg(dev
, "CHECK_CLEAR_STATUS returned %x\n", buffer
[0]);
880 if (buffer
[0] == USBTMC_STATUS_SUCCESS
)
881 goto usbtmc_clear_bulk_out_halt
;
883 if (buffer
[0] != USBTMC_STATUS_PENDING
) {
884 dev_err(dev
, "CHECK_CLEAR_STATUS returned %x\n", buffer
[0]);
891 dev_dbg(dev
, "Reading from bulk in EP\n");
893 rv
= usb_bulk_msg(data
->usb_dev
,
894 usb_rcvbulkpipe(data
->usb_dev
,
896 buffer
, USBTMC_SIZE_IOBUFFER
,
897 &actual
, USBTMC_TIMEOUT
);
901 dev_err(dev
, "usb_control_msg returned %d\n",
905 } while ((actual
== max_size
) &&
906 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
));
908 if (actual
== max_size
) {
909 dev_err(dev
, "Couldn't clear device buffer within %d cycles\n",
910 USBTMC_MAX_READS_TO_CLEAR_BULK_IN
);
915 goto usbtmc_clear_check_status
;
917 usbtmc_clear_bulk_out_halt
:
919 rv
= usb_clear_halt(data
->usb_dev
,
920 usb_sndbulkpipe(data
->usb_dev
, data
->bulk_out
));
922 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
932 static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data
*data
)
936 rv
= usb_clear_halt(data
->usb_dev
,
937 usb_sndbulkpipe(data
->usb_dev
, data
->bulk_out
));
940 dev_err(&data
->usb_dev
->dev
, "usb_control_msg returned %d\n",
947 static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data
*data
)
951 rv
= usb_clear_halt(data
->usb_dev
,
952 usb_rcvbulkpipe(data
->usb_dev
, data
->bulk_in
));
955 dev_err(&data
->usb_dev
->dev
, "usb_control_msg returned %d\n",
962 static int get_capabilities(struct usbtmc_device_data
*data
)
964 struct device
*dev
= &data
->usb_dev
->dev
;
968 buffer
= kmalloc(0x18, GFP_KERNEL
);
972 rv
= usb_control_msg(data
->usb_dev
, usb_rcvctrlpipe(data
->usb_dev
, 0),
973 USBTMC_REQUEST_GET_CAPABILITIES
,
974 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
975 0, 0, buffer
, 0x18, USBTMC_TIMEOUT
);
977 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
981 dev_dbg(dev
, "GET_CAPABILITIES returned %x\n", buffer
[0]);
982 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
983 dev_err(dev
, "GET_CAPABILITIES returned %x\n", buffer
[0]);
987 dev_dbg(dev
, "Interface capabilities are %x\n", buffer
[4]);
988 dev_dbg(dev
, "Device capabilities are %x\n", buffer
[5]);
989 dev_dbg(dev
, "USB488 interface capabilities are %x\n", buffer
[14]);
990 dev_dbg(dev
, "USB488 device capabilities are %x\n", buffer
[15]);
992 data
->capabilities
.interface_capabilities
= buffer
[4];
993 data
->capabilities
.device_capabilities
= buffer
[5];
994 data
->capabilities
.usb488_interface_capabilities
= buffer
[14];
995 data
->capabilities
.usb488_device_capabilities
= buffer
[15];
1003 #define capability_attribute(name) \
1004 static ssize_t name##_show(struct device *dev, \
1005 struct device_attribute *attr, char *buf) \
1007 struct usb_interface *intf = to_usb_interface(dev); \
1008 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
1010 return sprintf(buf, "%d\n", data->capabilities.name); \
1012 static DEVICE_ATTR_RO(name)
1014 capability_attribute(interface_capabilities
);
1015 capability_attribute(device_capabilities
);
1016 capability_attribute(usb488_interface_capabilities
);
1017 capability_attribute(usb488_device_capabilities
);
1019 static struct attribute
*capability_attrs
[] = {
1020 &dev_attr_interface_capabilities
.attr
,
1021 &dev_attr_device_capabilities
.attr
,
1022 &dev_attr_usb488_interface_capabilities
.attr
,
1023 &dev_attr_usb488_device_capabilities
.attr
,
1027 static struct attribute_group capability_attr_grp
= {
1028 .attrs
= capability_attrs
,
1031 static ssize_t
TermChar_show(struct device
*dev
,
1032 struct device_attribute
*attr
, char *buf
)
1034 struct usb_interface
*intf
= to_usb_interface(dev
);
1035 struct usbtmc_device_data
*data
= usb_get_intfdata(intf
);
1037 return sprintf(buf
, "%c\n", data
->TermChar
);
1040 static ssize_t
TermChar_store(struct device
*dev
,
1041 struct device_attribute
*attr
,
1042 const char *buf
, size_t count
)
1044 struct usb_interface
*intf
= to_usb_interface(dev
);
1045 struct usbtmc_device_data
*data
= usb_get_intfdata(intf
);
1049 data
->TermChar
= buf
[0];
1052 static DEVICE_ATTR_RW(TermChar
);
1054 #define data_attribute(name) \
1055 static ssize_t name##_show(struct device *dev, \
1056 struct device_attribute *attr, char *buf) \
1058 struct usb_interface *intf = to_usb_interface(dev); \
1059 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
1061 return sprintf(buf, "%d\n", data->name); \
1063 static ssize_t name##_store(struct device *dev, \
1064 struct device_attribute *attr, \
1065 const char *buf, size_t count) \
1067 struct usb_interface *intf = to_usb_interface(dev); \
1068 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
1072 result = sscanf(buf, "%u\n", &val); \
1081 static DEVICE_ATTR_RW(name)
1083 data_attribute(TermCharEnabled
);
1084 data_attribute(auto_abort
);
1086 static struct attribute
*data_attrs
[] = {
1087 &dev_attr_TermChar
.attr
,
1088 &dev_attr_TermCharEnabled
.attr
,
1089 &dev_attr_auto_abort
.attr
,
1093 static struct attribute_group data_attr_grp
= {
1094 .attrs
= data_attrs
,
1097 static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data
*data
)
1103 dev
= &data
->intf
->dev
;
1105 buffer
= kmalloc(2, GFP_KERNEL
);
1109 rv
= usb_control_msg(data
->usb_dev
,
1110 usb_rcvctrlpipe(data
->usb_dev
, 0),
1111 USBTMC_REQUEST_INDICATOR_PULSE
,
1112 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
1113 0, 0, buffer
, 0x01, USBTMC_TIMEOUT
);
1116 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
1120 dev_dbg(dev
, "INDICATOR_PULSE returned %x\n", buffer
[0]);
1122 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
1123 dev_err(dev
, "INDICATOR_PULSE returned %x\n", buffer
[0]);
1134 static long usbtmc_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1136 struct usbtmc_device_data
*data
;
1137 int retval
= -EBADRQC
;
1139 data
= file
->private_data
;
1140 mutex_lock(&data
->io_mutex
);
1143 goto skip_io_on_zombie
;
1147 case USBTMC_IOCTL_CLEAR_OUT_HALT
:
1148 retval
= usbtmc_ioctl_clear_out_halt(data
);
1151 case USBTMC_IOCTL_CLEAR_IN_HALT
:
1152 retval
= usbtmc_ioctl_clear_in_halt(data
);
1155 case USBTMC_IOCTL_INDICATOR_PULSE
:
1156 retval
= usbtmc_ioctl_indicator_pulse(data
);
1159 case USBTMC_IOCTL_CLEAR
:
1160 retval
= usbtmc_ioctl_clear(data
);
1163 case USBTMC_IOCTL_ABORT_BULK_OUT
:
1164 retval
= usbtmc_ioctl_abort_bulk_out(data
);
1167 case USBTMC_IOCTL_ABORT_BULK_IN
:
1168 retval
= usbtmc_ioctl_abort_bulk_in(data
);
1171 case USBTMC488_IOCTL_READ_STB
:
1172 retval
= usbtmc488_ioctl_read_stb(data
, (void __user
*)arg
);
1177 mutex_unlock(&data
->io_mutex
);
1181 static int usbtmc_fasync(int fd
, struct file
*file
, int on
)
1183 struct usbtmc_device_data
*data
= file
->private_data
;
1185 return fasync_helper(fd
, file
, on
, &data
->fasync
);
1188 static unsigned int usbtmc_poll(struct file
*file
, poll_table
*wait
)
1190 struct usbtmc_device_data
*data
= file
->private_data
;
1193 mutex_lock(&data
->io_mutex
);
1196 mask
= POLLHUP
| POLLERR
;
1200 poll_wait(file
, &data
->waitq
, wait
);
1202 mask
= (atomic_read(&data
->srq_asserted
)) ? POLLIN
| POLLRDNORM
: 0;
1205 mutex_unlock(&data
->io_mutex
);
1209 static const struct file_operations fops
= {
1210 .owner
= THIS_MODULE
,
1211 .read
= usbtmc_read
,
1212 .write
= usbtmc_write
,
1213 .open
= usbtmc_open
,
1214 .release
= usbtmc_release
,
1215 .unlocked_ioctl
= usbtmc_ioctl
,
1216 .fasync
= usbtmc_fasync
,
1217 .poll
= usbtmc_poll
,
1218 .llseek
= default_llseek
,
1221 static struct usb_class_driver usbtmc_class
= {
1224 .minor_base
= USBTMC_MINOR_BASE
,
1227 static void usbtmc_interrupt(struct urb
*urb
)
1229 struct usbtmc_device_data
*data
= urb
->context
;
1230 struct device
*dev
= &data
->intf
->dev
;
1231 int status
= urb
->status
;
1234 dev_dbg(&data
->intf
->dev
, "int status: %d len %d\n",
1235 status
, urb
->actual_length
);
1238 case 0: /* SUCCESS */
1239 /* check for valid STB notification */
1240 if (data
->iin_buffer
[0] > 0x81) {
1241 data
->bNotify1
= data
->iin_buffer
[0];
1242 data
->bNotify2
= data
->iin_buffer
[1];
1243 atomic_set(&data
->iin_data_valid
, 1);
1244 wake_up_interruptible(&data
->waitq
);
1247 /* check for SRQ notification */
1248 if (data
->iin_buffer
[0] == 0x81) {
1250 kill_fasync(&data
->fasync
,
1253 atomic_set(&data
->srq_asserted
, 1);
1254 wake_up_interruptible(&data
->waitq
);
1257 dev_warn(dev
, "invalid notification: %x\n", data
->iin_buffer
[0]);
1260 dev_err(dev
, "overflow with length %d, actual length is %d\n",
1261 data
->iin_wMaxPacketSize
, urb
->actual_length
);
1267 /* urb terminated, clean up */
1268 dev_dbg(dev
, "urb terminated, status: %d\n", status
);
1271 dev_err(dev
, "unknown status received: %d\n", status
);
1274 rv
= usb_submit_urb(urb
, GFP_ATOMIC
);
1276 dev_err(dev
, "usb_submit_urb failed: %d\n", rv
);
1279 static void usbtmc_free_int(struct usbtmc_device_data
*data
)
1281 if (!data
->iin_ep_present
|| !data
->iin_urb
)
1283 usb_kill_urb(data
->iin_urb
);
1284 kfree(data
->iin_buffer
);
1285 usb_free_urb(data
->iin_urb
);
1286 kref_put(&data
->kref
, usbtmc_delete
);
1289 static int usbtmc_probe(struct usb_interface
*intf
,
1290 const struct usb_device_id
*id
)
1292 struct usbtmc_device_data
*data
;
1293 struct usb_host_interface
*iface_desc
;
1294 struct usb_endpoint_descriptor
*endpoint
;
1298 dev_dbg(&intf
->dev
, "%s called\n", __func__
);
1300 data
= devm_kzalloc(&intf
->dev
, sizeof(*data
), GFP_KERNEL
);
1306 data
->usb_dev
= usb_get_dev(interface_to_usbdev(intf
));
1307 usb_set_intfdata(intf
, data
);
1308 kref_init(&data
->kref
);
1309 mutex_init(&data
->io_mutex
);
1310 init_waitqueue_head(&data
->waitq
);
1311 atomic_set(&data
->iin_data_valid
, 0);
1312 atomic_set(&data
->srq_asserted
, 0);
1315 /* Determine if it is a Rigol or not */
1316 data
->rigol_quirk
= 0;
1317 dev_dbg(&intf
->dev
, "Trying to find if device Vendor 0x%04X Product 0x%04X has the RIGOL quirk\n",
1318 le16_to_cpu(data
->usb_dev
->descriptor
.idVendor
),
1319 le16_to_cpu(data
->usb_dev
->descriptor
.idProduct
));
1320 for(n
= 0; usbtmc_id_quirk
[n
].idVendor
> 0; n
++) {
1321 if ((usbtmc_id_quirk
[n
].idVendor
== le16_to_cpu(data
->usb_dev
->descriptor
.idVendor
)) &&
1322 (usbtmc_id_quirk
[n
].idProduct
== le16_to_cpu(data
->usb_dev
->descriptor
.idProduct
))) {
1323 dev_dbg(&intf
->dev
, "Setting this device as having the RIGOL quirk\n");
1324 data
->rigol_quirk
= 1;
1329 /* Initialize USBTMC bTag and other fields */
1331 data
->TermCharEnabled
= 0;
1332 data
->TermChar
= '\n';
1333 /* 2 <= bTag <= 127 USBTMC-USB488 subclass specification 4.3.1 */
1336 /* USBTMC devices have only one setting, so use that */
1337 iface_desc
= data
->intf
->cur_altsetting
;
1338 data
->ifnum
= iface_desc
->desc
.bInterfaceNumber
;
1340 /* Find bulk in endpoint */
1341 for (n
= 0; n
< iface_desc
->desc
.bNumEndpoints
; n
++) {
1342 endpoint
= &iface_desc
->endpoint
[n
].desc
;
1344 if (usb_endpoint_is_bulk_in(endpoint
)) {
1345 data
->bulk_in
= endpoint
->bEndpointAddress
;
1346 dev_dbg(&intf
->dev
, "Found bulk in endpoint at %u\n",
1352 /* Find bulk out endpoint */
1353 for (n
= 0; n
< iface_desc
->desc
.bNumEndpoints
; n
++) {
1354 endpoint
= &iface_desc
->endpoint
[n
].desc
;
1356 if (usb_endpoint_is_bulk_out(endpoint
)) {
1357 data
->bulk_out
= endpoint
->bEndpointAddress
;
1358 dev_dbg(&intf
->dev
, "Found Bulk out endpoint at %u\n",
1363 /* Find int endpoint */
1364 for (n
= 0; n
< iface_desc
->desc
.bNumEndpoints
; n
++) {
1365 endpoint
= &iface_desc
->endpoint
[n
].desc
;
1367 if (usb_endpoint_is_int_in(endpoint
)) {
1368 data
->iin_ep_present
= 1;
1369 data
->iin_ep
= endpoint
->bEndpointAddress
;
1370 data
->iin_wMaxPacketSize
= usb_endpoint_maxp(endpoint
);
1371 data
->iin_interval
= endpoint
->bInterval
;
1372 dev_dbg(&intf
->dev
, "Found Int in endpoint at %u\n",
1378 retcode
= get_capabilities(data
);
1380 dev_err(&intf
->dev
, "can't read capabilities\n");
1382 retcode
= sysfs_create_group(&intf
->dev
.kobj
,
1383 &capability_attr_grp
);
1385 if (data
->iin_ep_present
) {
1386 /* allocate int urb */
1387 data
->iin_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1388 if (!data
->iin_urb
) {
1389 dev_err(&intf
->dev
, "Failed to allocate int urb\n");
1390 goto error_register
;
1393 /* will reference data in int urb */
1394 kref_get(&data
->kref
);
1396 /* allocate buffer for interrupt in */
1397 data
->iin_buffer
= kmalloc(data
->iin_wMaxPacketSize
,
1399 if (!data
->iin_buffer
) {
1400 dev_err(&intf
->dev
, "Failed to allocate int buf\n");
1401 goto error_register
;
1404 /* fill interrupt urb */
1405 usb_fill_int_urb(data
->iin_urb
, data
->usb_dev
,
1406 usb_rcvintpipe(data
->usb_dev
, data
->iin_ep
),
1407 data
->iin_buffer
, data
->iin_wMaxPacketSize
,
1409 data
, data
->iin_interval
);
1411 retcode
= usb_submit_urb(data
->iin_urb
, GFP_KERNEL
);
1413 dev_err(&intf
->dev
, "Failed to submit iin_urb\n");
1414 goto error_register
;
1418 retcode
= sysfs_create_group(&intf
->dev
.kobj
, &data_attr_grp
);
1420 retcode
= usb_register_dev(intf
, &usbtmc_class
);
1422 dev_err(&intf
->dev
, "Not able to get a minor"
1423 " (base %u, slice default): %d\n", USBTMC_MINOR_BASE
,
1425 goto error_register
;
1427 dev_dbg(&intf
->dev
, "Using minor number %d\n", intf
->minor
);
1432 sysfs_remove_group(&intf
->dev
.kobj
, &capability_attr_grp
);
1433 sysfs_remove_group(&intf
->dev
.kobj
, &data_attr_grp
);
1434 usbtmc_free_int(data
);
1435 kref_put(&data
->kref
, usbtmc_delete
);
1439 static void usbtmc_disconnect(struct usb_interface
*intf
)
1441 struct usbtmc_device_data
*data
;
1443 dev_dbg(&intf
->dev
, "usbtmc_disconnect called\n");
1445 data
= usb_get_intfdata(intf
);
1446 usbtmc_free_int(data
);
1447 usb_deregister_dev(intf
, &usbtmc_class
);
1448 sysfs_remove_group(&intf
->dev
.kobj
, &capability_attr_grp
);
1449 sysfs_remove_group(&intf
->dev
.kobj
, &data_attr_grp
);
1450 mutex_lock(&data
->io_mutex
);
1452 mutex_unlock(&data
->io_mutex
);
1453 kref_put(&data
->kref
, usbtmc_delete
);
1456 static int usbtmc_suspend(struct usb_interface
*intf
, pm_message_t message
)
1458 /* this driver does not have pending URBs */
1462 static int usbtmc_resume(struct usb_interface
*intf
)
1467 static struct usb_driver usbtmc_driver
= {
1469 .id_table
= usbtmc_devices
,
1470 .probe
= usbtmc_probe
,
1471 .disconnect
= usbtmc_disconnect
,
1472 .suspend
= usbtmc_suspend
,
1473 .resume
= usbtmc_resume
,
1476 module_usb_driver(usbtmc_driver
);
1478 MODULE_LICENSE("GPL");