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/mutex.h>
31 #include <linux/usb.h>
32 #include <linux/usb/tmc.h>
36 #define USBTMC_HEADER_SIZE 12
37 #define USBTMC_MINOR_BASE 176
40 * Size of driver internal IO buffer. Must be multiple of 4 and at least as
41 * large as wMaxPacketSize (which is usually 512 bytes).
43 #define USBTMC_SIZE_IOBUFFER 2048
45 /* Default USB timeout (in milliseconds) */
46 #define USBTMC_TIMEOUT 5000
49 * Maximum number of read cycles to empty bulk in endpoint during CLEAR and
50 * ABORT_BULK_IN requests. Ends the loop if (for whatever reason) a short
51 * packet is never read.
53 #define USBTMC_MAX_READS_TO_CLEAR_BULK_IN 100
55 static const struct usb_device_id usbtmc_devices[] = {
56 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 0), },
57 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 1), },
58 { 0, } /* terminating entry */
60 MODULE_DEVICE_TABLE(usb, usbtmc_devices);
63 * This structure is the capabilities for the device
64 * See section 4.2.1.8 of the USBTMC specification,
65 * and section 4.2.2 of the USBTMC usb488 subclass
66 * specification for details.
68 struct usbtmc_dev_capabilities {
69 __u8 interface_capabilities;
70 __u8 device_capabilities;
71 __u8 usb488_interface_capabilities;
72 __u8 usb488_device_capabilities;
75 /* This structure holds private data for each USBTMC device. One copy is
76 * allocated for each USBTMC device in the driver's probe function.
78 struct usbtmc_device_data {
79 const struct usb_device_id *id;
80 struct usb_device *usb_dev;
81 struct usb_interface *intf;
84 unsigned int bulk_out;
87 u8 bTag_last_write; /* needed for abort */
88 u8 bTag_last_read; /* needed for abort */
92 /* attributes from the USB TMC spec for this device */
97 bool zombie; /* fd of disconnected device */
99 struct usbtmc_dev_capabilities capabilities;
101 struct mutex io_mutex; /* only one i/o function running at a time */
103 #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
105 struct usbtmc_ID_rigol_quirk {
110 static const struct usbtmc_ID_rigol_quirk usbtmc_id_quirk[] = {
116 /* Forward declarations */
117 static struct usb_driver usbtmc_driver;
119 static void usbtmc_delete(struct kref *kref)
121 struct usbtmc_device_data *data = to_usbtmc_data(kref);
123 usb_put_dev(data->usb_dev);
127 static int usbtmc_open(struct inode *inode, struct file *filp)
129 struct usb_interface *intf;
130 struct usbtmc_device_data *data;
133 intf = usb_find_interface(&usbtmc_driver, iminor(inode));
135 pr_err("can not find device for minor %d", iminor(inode));
139 data = usb_get_intfdata(intf);
140 kref_get(&data->kref);
142 /* Store pointer in file structure's private data field */
143 filp->private_data = data;
148 static int usbtmc_release(struct inode *inode, struct file *file)
150 struct usbtmc_device_data *data = file->private_data;
152 kref_put(&data->kref, usbtmc_delete);
156 static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data *data)
163 struct usb_host_interface *current_setting;
166 dev = &data->intf->dev;
167 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
171 rv = usb_control_msg(data->usb_dev,
172 usb_rcvctrlpipe(data->usb_dev, 0),
173 USBTMC_REQUEST_INITIATE_ABORT_BULK_IN,
174 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
175 data->bTag_last_read, data->bulk_in,
176 buffer, 2, USBTMC_TIMEOUT);
179 dev_err(dev, "usb_control_msg returned %d\n", rv);
183 dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
185 if (buffer[0] == USBTMC_STATUS_FAILED) {
190 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
191 dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n",
198 current_setting = data->intf->cur_altsetting;
199 for (n = 0; n < current_setting->desc.bNumEndpoints; n++)
200 if (current_setting->endpoint[n].desc.bEndpointAddress ==
202 max_size = usb_endpoint_maxp(¤t_setting->endpoint[n].desc);
205 dev_err(dev, "Couldn't get wMaxPacketSize\n");
210 dev_dbg(&data->intf->dev, "wMaxPacketSize is %d\n", max_size);
215 dev_dbg(dev, "Reading from bulk in EP\n");
217 rv = usb_bulk_msg(data->usb_dev,
218 usb_rcvbulkpipe(data->usb_dev,
220 buffer, USBTMC_SIZE_IOBUFFER,
221 &actual, USBTMC_TIMEOUT);
226 dev_err(dev, "usb_bulk_msg returned %d\n", rv);
229 } while ((actual == max_size) &&
230 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
232 if (actual == max_size) {
233 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
234 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
241 usbtmc_abort_bulk_in_status:
242 rv = usb_control_msg(data->usb_dev,
243 usb_rcvctrlpipe(data->usb_dev, 0),
244 USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS,
245 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
246 0, data->bulk_in, buffer, 0x08,
250 dev_err(dev, "usb_control_msg returned %d\n", rv);
254 dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
256 if (buffer[0] == USBTMC_STATUS_SUCCESS) {
261 if (buffer[0] != USBTMC_STATUS_PENDING) {
262 dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
269 dev_dbg(dev, "Reading from bulk in EP\n");
271 rv = usb_bulk_msg(data->usb_dev,
272 usb_rcvbulkpipe(data->usb_dev,
274 buffer, USBTMC_SIZE_IOBUFFER,
275 &actual, USBTMC_TIMEOUT);
280 dev_err(dev, "usb_bulk_msg returned %d\n", rv);
283 } while ((actual == max_size) &&
284 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
286 if (actual == max_size) {
287 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
288 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
293 goto usbtmc_abort_bulk_in_status;
301 static int usbtmc_ioctl_abort_bulk_out(struct usbtmc_device_data *data)
308 dev = &data->intf->dev;
310 buffer = kmalloc(8, GFP_KERNEL);
314 rv = usb_control_msg(data->usb_dev,
315 usb_rcvctrlpipe(data->usb_dev, 0),
316 USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT,
317 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
318 data->bTag_last_write, data->bulk_out,
319 buffer, 2, USBTMC_TIMEOUT);
322 dev_err(dev, "usb_control_msg returned %d\n", rv);
326 dev_dbg(dev, "INITIATE_ABORT_BULK_OUT returned %x\n", buffer[0]);
328 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
329 dev_err(dev, "INITIATE_ABORT_BULK_OUT returned %x\n",
337 usbtmc_abort_bulk_out_check_status:
338 rv = usb_control_msg(data->usb_dev,
339 usb_rcvctrlpipe(data->usb_dev, 0),
340 USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS,
341 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
342 0, data->bulk_out, buffer, 0x08,
346 dev_err(dev, "usb_control_msg returned %d\n", rv);
350 dev_dbg(dev, "CHECK_ABORT_BULK_OUT returned %x\n", buffer[0]);
352 if (buffer[0] == USBTMC_STATUS_SUCCESS)
353 goto usbtmc_abort_bulk_out_clear_halt;
355 if ((buffer[0] == USBTMC_STATUS_PENDING) &&
356 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN))
357 goto usbtmc_abort_bulk_out_check_status;
362 usbtmc_abort_bulk_out_clear_halt:
363 rv = usb_clear_halt(data->usb_dev,
364 usb_sndbulkpipe(data->usb_dev, data->bulk_out));
367 dev_err(dev, "usb_control_msg returned %d\n", rv);
378 * Sends a REQUEST_DEV_DEP_MSG_IN message on the Bulk-IN endpoint.
379 * @transfer_size: number of bytes to request from the device.
381 * See the USBTMC specification, Table 4.
383 * Also updates bTag_last_write.
385 static int send_request_dev_dep_msg_in(struct usbtmc_device_data *data, size_t transfer_size)
391 buffer = kmalloc(USBTMC_HEADER_SIZE, GFP_KERNEL);
394 /* Setup IO buffer for REQUEST_DEV_DEP_MSG_IN message
395 * Refer to class specs for details
398 buffer[1] = data->bTag;
399 buffer[2] = ~data->bTag;
400 buffer[3] = 0; /* Reserved */
401 buffer[4] = transfer_size >> 0;
402 buffer[5] = transfer_size >> 8;
403 buffer[6] = transfer_size >> 16;
404 buffer[7] = transfer_size >> 24;
405 buffer[8] = data->TermCharEnabled * 2;
406 /* Use term character? */
407 buffer[9] = data->TermChar;
408 buffer[10] = 0; /* Reserved */
409 buffer[11] = 0; /* Reserved */
412 retval = usb_bulk_msg(data->usb_dev,
413 usb_sndbulkpipe(data->usb_dev,
415 buffer, USBTMC_HEADER_SIZE, &actual, USBTMC_TIMEOUT);
417 /* Store bTag (in case we need to abort) */
418 data->bTag_last_write = data->bTag;
420 /* Increment bTag -- and increment again if zero */
427 dev_err(&data->intf->dev, "usb_bulk_msg in send_request_dev_dep_msg_in() returned %d\n", retval);
434 static ssize_t usbtmc_read(struct file *filp, char __user *buf,
435 size_t count, loff_t *f_pos)
437 struct usbtmc_device_data *data;
447 /* Get pointer to private data structure */
448 data = filp->private_data;
449 dev = &data->intf->dev;
451 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
455 mutex_lock(&data->io_mutex);
461 if (data->rigol_quirk) {
462 dev_dbg(dev, "usb_bulk_msg_in: count(%zu)\n", count);
464 retval = send_request_dev_dep_msg_in(data, count);
467 if (data->auto_abort)
468 usbtmc_ioctl_abort_bulk_out(data);
473 /* Loop until we have fetched everything we requested */
475 this_part = remaining;
478 while (remaining > 0) {
479 if (!data->rigol_quirk) {
480 dev_dbg(dev, "usb_bulk_msg_in: remaining(%zu), count(%zu)\n", remaining, count);
482 if (remaining > USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE - 3)
483 this_part = USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE - 3;
485 this_part = remaining;
487 retval = send_request_dev_dep_msg_in(data, this_part);
489 dev_err(dev, "usb_bulk_msg returned %d\n", retval);
490 if (data->auto_abort)
491 usbtmc_ioctl_abort_bulk_out(data);
497 retval = usb_bulk_msg(data->usb_dev,
498 usb_rcvbulkpipe(data->usb_dev,
500 buffer, USBTMC_SIZE_IOBUFFER, &actual,
503 dev_dbg(dev, "usb_bulk_msg: retval(%u), done(%zu), remaining(%zu), actual(%d)\n", retval, done, remaining, actual);
505 /* Store bTag (in case we need to abort) */
506 data->bTag_last_read = data->bTag;
509 dev_dbg(dev, "Unable to read data, error %d\n", retval);
510 if (data->auto_abort)
511 usbtmc_ioctl_abort_bulk_in(data);
515 /* Parse header in first packet */
516 if ((done == 0) || !data->rigol_quirk) {
517 /* Sanity checks for the header */
518 if (actual < USBTMC_HEADER_SIZE) {
519 dev_err(dev, "Device sent too small first packet: %u < %u\n", actual, USBTMC_HEADER_SIZE);
520 if (data->auto_abort)
521 usbtmc_ioctl_abort_bulk_in(data);
525 if (buffer[0] != 2) {
526 dev_err(dev, "Device sent reply with wrong MsgID: %u != 2\n", buffer[0]);
527 if (data->auto_abort)
528 usbtmc_ioctl_abort_bulk_in(data);
532 if (buffer[1] != data->bTag_last_write) {
533 dev_err(dev, "Device sent reply with wrong bTag: %u != %u\n", buffer[1], data->bTag_last_write);
534 if (data->auto_abort)
535 usbtmc_ioctl_abort_bulk_in(data);
539 /* How many characters did the instrument send? */
540 n_characters = buffer[4] +
545 if (n_characters > this_part) {
546 dev_err(dev, "Device wants to return more data than requested: %u > %zu\n", n_characters, count);
547 if (data->auto_abort)
548 usbtmc_ioctl_abort_bulk_in(data);
552 /* Remove the USBTMC header */
553 actual -= USBTMC_HEADER_SIZE;
555 /* Check if the message is smaller than requested */
556 if (data->rigol_quirk) {
557 if (remaining > n_characters)
558 remaining = n_characters;
559 /* Remove padding if it exists */
560 if (actual > remaining)
564 if (this_part > n_characters)
565 this_part = n_characters;
566 /* Remove padding if it exists */
567 if (actual > this_part)
571 dev_dbg(dev, "Bulk-IN header: N_characters(%u), bTransAttr(%u)\n", n_characters, buffer[8]);
575 /* Terminate if end-of-message bit received from device */
576 if ((buffer[8] & 0x01) && (actual >= n_characters))
579 dev_dbg(dev, "Bulk-IN header: remaining(%zu), buf(%p), buffer(%p) done(%zu)\n", remaining,buf,buffer,done);
582 /* Copy buffer to user space */
583 if (copy_to_user(buf + done, &buffer[USBTMC_HEADER_SIZE], actual)) {
584 /* There must have been an addressing problem */
591 if (actual > remaining)
596 dev_dbg(dev, "Bulk-IN header cont: actual(%u), done(%zu), remaining(%zu), buf(%p), buffer(%p)\n", actual, done, remaining,buf,buffer);
598 /* Copy buffer to user space */
599 if (copy_to_user(buf + done, buffer, actual)) {
600 /* There must have been an addressing problem */
608 /* Update file position value */
609 *f_pos = *f_pos + done;
613 mutex_unlock(&data->io_mutex);
618 static ssize_t usbtmc_write(struct file *filp, const char __user *buf,
619 size_t count, loff_t *f_pos)
621 struct usbtmc_device_data *data;
625 unsigned long int n_bytes;
630 data = filp->private_data;
632 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
636 mutex_lock(&data->io_mutex);
645 while (remaining > 0) {
646 if (remaining > USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE) {
647 this_part = USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE;
650 this_part = remaining;
654 /* Setup IO buffer for DEV_DEP_MSG_OUT message */
656 buffer[1] = data->bTag;
657 buffer[2] = ~data->bTag;
658 buffer[3] = 0; /* Reserved */
659 buffer[4] = this_part >> 0;
660 buffer[5] = this_part >> 8;
661 buffer[6] = this_part >> 16;
662 buffer[7] = this_part >> 24;
663 /* buffer[8] is set above... */
664 buffer[9] = 0; /* Reserved */
665 buffer[10] = 0; /* Reserved */
666 buffer[11] = 0; /* Reserved */
668 if (copy_from_user(&buffer[USBTMC_HEADER_SIZE], buf + done, this_part)) {
673 n_bytes = roundup(USBTMC_HEADER_SIZE + this_part, 4);
674 memset(buffer + USBTMC_HEADER_SIZE + this_part, 0, n_bytes - (USBTMC_HEADER_SIZE + this_part));
677 retval = usb_bulk_msg(data->usb_dev,
678 usb_sndbulkpipe(data->usb_dev,
681 &actual, USBTMC_TIMEOUT);
687 data->bTag_last_write = data->bTag;
694 dev_err(&data->intf->dev,
695 "Unable to send data, error %d\n", retval);
696 if (data->auto_abort)
697 usbtmc_ioctl_abort_bulk_out(data);
701 remaining -= this_part;
707 mutex_unlock(&data->io_mutex);
712 static int usbtmc_ioctl_clear(struct usbtmc_device_data *data)
714 struct usb_host_interface *current_setting;
715 struct usb_endpoint_descriptor *desc;
723 dev = &data->intf->dev;
725 dev_dbg(dev, "Sending INITIATE_CLEAR request\n");
727 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
731 rv = usb_control_msg(data->usb_dev,
732 usb_rcvctrlpipe(data->usb_dev, 0),
733 USBTMC_REQUEST_INITIATE_CLEAR,
734 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
735 0, 0, buffer, 1, USBTMC_TIMEOUT);
737 dev_err(dev, "usb_control_msg returned %d\n", rv);
741 dev_dbg(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
743 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
744 dev_err(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
750 current_setting = data->intf->cur_altsetting;
751 for (n = 0; n < current_setting->desc.bNumEndpoints; n++) {
752 desc = ¤t_setting->endpoint[n].desc;
753 if (desc->bEndpointAddress == data->bulk_in)
754 max_size = usb_endpoint_maxp(desc);
758 dev_err(dev, "Couldn't get wMaxPacketSize\n");
763 dev_dbg(dev, "wMaxPacketSize is %d\n", max_size);
767 usbtmc_clear_check_status:
769 dev_dbg(dev, "Sending CHECK_CLEAR_STATUS request\n");
771 rv = usb_control_msg(data->usb_dev,
772 usb_rcvctrlpipe(data->usb_dev, 0),
773 USBTMC_REQUEST_CHECK_CLEAR_STATUS,
774 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
775 0, 0, buffer, 2, USBTMC_TIMEOUT);
777 dev_err(dev, "usb_control_msg returned %d\n", rv);
781 dev_dbg(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
783 if (buffer[0] == USBTMC_STATUS_SUCCESS)
784 goto usbtmc_clear_bulk_out_halt;
786 if (buffer[0] != USBTMC_STATUS_PENDING) {
787 dev_err(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
794 dev_dbg(dev, "Reading from bulk in EP\n");
796 rv = usb_bulk_msg(data->usb_dev,
797 usb_rcvbulkpipe(data->usb_dev,
799 buffer, USBTMC_SIZE_IOBUFFER,
800 &actual, USBTMC_TIMEOUT);
804 dev_err(dev, "usb_control_msg returned %d\n",
808 } while ((actual == max_size) &&
809 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
811 if (actual == max_size) {
812 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
813 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
818 goto usbtmc_clear_check_status;
820 usbtmc_clear_bulk_out_halt:
822 rv = usb_clear_halt(data->usb_dev,
823 usb_sndbulkpipe(data->usb_dev, data->bulk_out));
825 dev_err(dev, "usb_control_msg returned %d\n", rv);
835 static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data *data)
839 rv = usb_clear_halt(data->usb_dev,
840 usb_sndbulkpipe(data->usb_dev, data->bulk_out));
843 dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
850 static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data *data)
854 rv = usb_clear_halt(data->usb_dev,
855 usb_rcvbulkpipe(data->usb_dev, data->bulk_in));
858 dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
865 static int get_capabilities(struct usbtmc_device_data *data)
867 struct device *dev = &data->usb_dev->dev;
871 buffer = kmalloc(0x18, GFP_KERNEL);
875 rv = usb_control_msg(data->usb_dev, usb_rcvctrlpipe(data->usb_dev, 0),
876 USBTMC_REQUEST_GET_CAPABILITIES,
877 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
878 0, 0, buffer, 0x18, USBTMC_TIMEOUT);
880 dev_err(dev, "usb_control_msg returned %d\n", rv);
884 dev_dbg(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
885 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
886 dev_err(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
890 dev_dbg(dev, "Interface capabilities are %x\n", buffer[4]);
891 dev_dbg(dev, "Device capabilities are %x\n", buffer[5]);
892 dev_dbg(dev, "USB488 interface capabilities are %x\n", buffer[14]);
893 dev_dbg(dev, "USB488 device capabilities are %x\n", buffer[15]);
895 data->capabilities.interface_capabilities = buffer[4];
896 data->capabilities.device_capabilities = buffer[5];
897 data->capabilities.usb488_interface_capabilities = buffer[14];
898 data->capabilities.usb488_device_capabilities = buffer[15];
906 #define capability_attribute(name) \
907 static ssize_t name##_show(struct device *dev, \
908 struct device_attribute *attr, char *buf) \
910 struct usb_interface *intf = to_usb_interface(dev); \
911 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
913 return sprintf(buf, "%d\n", data->capabilities.name); \
915 static DEVICE_ATTR_RO(name)
917 capability_attribute(interface_capabilities);
918 capability_attribute(device_capabilities);
919 capability_attribute(usb488_interface_capabilities);
920 capability_attribute(usb488_device_capabilities);
922 static struct attribute *capability_attrs[] = {
923 &dev_attr_interface_capabilities.attr,
924 &dev_attr_device_capabilities.attr,
925 &dev_attr_usb488_interface_capabilities.attr,
926 &dev_attr_usb488_device_capabilities.attr,
930 static struct attribute_group capability_attr_grp = {
931 .attrs = capability_attrs,
934 static ssize_t TermChar_show(struct device *dev,
935 struct device_attribute *attr, char *buf)
937 struct usb_interface *intf = to_usb_interface(dev);
938 struct usbtmc_device_data *data = usb_get_intfdata(intf);
940 return sprintf(buf, "%c\n", data->TermChar);
943 static ssize_t TermChar_store(struct device *dev,
944 struct device_attribute *attr,
945 const char *buf, size_t count)
947 struct usb_interface *intf = to_usb_interface(dev);
948 struct usbtmc_device_data *data = usb_get_intfdata(intf);
952 data->TermChar = buf[0];
955 static DEVICE_ATTR_RW(TermChar);
957 #define data_attribute(name) \
958 static ssize_t name##_show(struct device *dev, \
959 struct device_attribute *attr, char *buf) \
961 struct usb_interface *intf = to_usb_interface(dev); \
962 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
964 return sprintf(buf, "%d\n", data->name); \
966 static ssize_t name##_store(struct device *dev, \
967 struct device_attribute *attr, \
968 const char *buf, size_t count) \
970 struct usb_interface *intf = to_usb_interface(dev); \
971 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
975 result = sscanf(buf, "%u\n", &val); \
984 static DEVICE_ATTR_RW(name)
986 data_attribute(TermCharEnabled);
987 data_attribute(auto_abort);
989 static struct attribute *data_attrs[] = {
990 &dev_attr_TermChar.attr,
991 &dev_attr_TermCharEnabled.attr,
992 &dev_attr_auto_abort.attr,
996 static struct attribute_group data_attr_grp = {
1000 static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data *data)
1006 dev = &data->intf->dev;
1008 buffer = kmalloc(2, GFP_KERNEL);
1012 rv = usb_control_msg(data->usb_dev,
1013 usb_rcvctrlpipe(data->usb_dev, 0),
1014 USBTMC_REQUEST_INDICATOR_PULSE,
1015 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1016 0, 0, buffer, 0x01, USBTMC_TIMEOUT);
1019 dev_err(dev, "usb_control_msg returned %d\n", rv);
1023 dev_dbg(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
1025 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
1026 dev_err(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
1037 static long usbtmc_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1039 struct usbtmc_device_data *data;
1040 int retval = -EBADRQC;
1042 data = file->private_data;
1043 mutex_lock(&data->io_mutex);
1046 goto skip_io_on_zombie;
1050 case USBTMC_IOCTL_CLEAR_OUT_HALT:
1051 retval = usbtmc_ioctl_clear_out_halt(data);
1054 case USBTMC_IOCTL_CLEAR_IN_HALT:
1055 retval = usbtmc_ioctl_clear_in_halt(data);
1058 case USBTMC_IOCTL_INDICATOR_PULSE:
1059 retval = usbtmc_ioctl_indicator_pulse(data);
1062 case USBTMC_IOCTL_CLEAR:
1063 retval = usbtmc_ioctl_clear(data);
1066 case USBTMC_IOCTL_ABORT_BULK_OUT:
1067 retval = usbtmc_ioctl_abort_bulk_out(data);
1070 case USBTMC_IOCTL_ABORT_BULK_IN:
1071 retval = usbtmc_ioctl_abort_bulk_in(data);
1076 mutex_unlock(&data->io_mutex);
1080 static const struct file_operations fops = {
1081 .owner = THIS_MODULE,
1082 .read = usbtmc_read,
1083 .write = usbtmc_write,
1084 .open = usbtmc_open,
1085 .release = usbtmc_release,
1086 .unlocked_ioctl = usbtmc_ioctl,
1087 .llseek = default_llseek,
1090 static struct usb_class_driver usbtmc_class = {
1093 .minor_base = USBTMC_MINOR_BASE,
1097 static int usbtmc_probe(struct usb_interface *intf,
1098 const struct usb_device_id *id)
1100 struct usbtmc_device_data *data;
1101 struct usb_host_interface *iface_desc;
1102 struct usb_endpoint_descriptor *endpoint;
1106 dev_dbg(&intf->dev, "%s called\n", __func__);
1108 data = kzalloc(sizeof(*data), GFP_KERNEL);
1114 data->usb_dev = usb_get_dev(interface_to_usbdev(intf));
1115 usb_set_intfdata(intf, data);
1116 kref_init(&data->kref);
1117 mutex_init(&data->io_mutex);
1120 /* Determine if it is a Rigol or not */
1121 data->rigol_quirk = 0;
1122 dev_dbg(&intf->dev, "Trying to find if device Vendor 0x%04X Product 0x%04X has the RIGOL quirk\n",
1123 le16_to_cpu(data->usb_dev->descriptor.idVendor),
1124 le16_to_cpu(data->usb_dev->descriptor.idProduct));
1125 for(n = 0; usbtmc_id_quirk[n].idVendor > 0; n++) {
1126 if ((usbtmc_id_quirk[n].idVendor == le16_to_cpu(data->usb_dev->descriptor.idVendor)) &&
1127 (usbtmc_id_quirk[n].idProduct == le16_to_cpu(data->usb_dev->descriptor.idProduct))) {
1128 dev_dbg(&intf->dev, "Setting this device as having the RIGOL quirk\n");
1129 data->rigol_quirk = 1;
1134 /* Initialize USBTMC bTag and other fields */
1136 data->TermCharEnabled = 0;
1137 data->TermChar = '\n';
1139 /* USBTMC devices have only one setting, so use that */
1140 iface_desc = data->intf->cur_altsetting;
1142 /* Find bulk in endpoint */
1143 for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
1144 endpoint = &iface_desc->endpoint[n].desc;
1146 if (usb_endpoint_is_bulk_in(endpoint)) {
1147 data->bulk_in = endpoint->bEndpointAddress;
1148 dev_dbg(&intf->dev, "Found bulk in endpoint at %u\n",
1154 /* Find bulk out endpoint */
1155 for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
1156 endpoint = &iface_desc->endpoint[n].desc;
1158 if (usb_endpoint_is_bulk_out(endpoint)) {
1159 data->bulk_out = endpoint->bEndpointAddress;
1160 dev_dbg(&intf->dev, "Found Bulk out endpoint at %u\n",
1166 if (!data->bulk_out || !data->bulk_in) {
1167 dev_err(&intf->dev, "bulk endpoints not found\n");
1172 retcode = get_capabilities(data);
1174 dev_err(&intf->dev, "can't read capabilities\n");
1176 retcode = sysfs_create_group(&intf->dev.kobj,
1177 &capability_attr_grp);
1179 retcode = sysfs_create_group(&intf->dev.kobj, &data_attr_grp);
1181 retcode = usb_register_dev(intf, &usbtmc_class);
1183 dev_err(&intf->dev, "Not able to get a minor"
1184 " (base %u, slice default): %d\n", USBTMC_MINOR_BASE,
1186 goto error_register;
1188 dev_dbg(&intf->dev, "Using minor number %d\n", intf->minor);
1193 sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
1194 sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
1196 kref_put(&data->kref, usbtmc_delete);
1200 static void usbtmc_disconnect(struct usb_interface *intf)
1202 struct usbtmc_device_data *data;
1204 dev_dbg(&intf->dev, "usbtmc_disconnect called\n");
1206 data = usb_get_intfdata(intf);
1207 usb_deregister_dev(intf, &usbtmc_class);
1208 sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
1209 sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
1210 mutex_lock(&data->io_mutex);
1212 mutex_unlock(&data->io_mutex);
1213 kref_put(&data->kref, usbtmc_delete);
1216 static int usbtmc_suspend(struct usb_interface *intf, pm_message_t message)
1218 /* this driver does not have pending URBs */
1222 static int usbtmc_resume(struct usb_interface *intf)
1227 static struct usb_driver usbtmc_driver = {
1229 .id_table = usbtmc_devices,
1230 .probe = usbtmc_probe,
1231 .disconnect = usbtmc_disconnect,
1232 .suspend = usbtmc_suspend,
1233 .resume = usbtmc_resume,
1236 module_usb_driver(usbtmc_driver);
1238 MODULE_LICENSE("GPL");