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 #include <linux/init.h>
23 #include <linux/module.h>
24 #include <linux/kernel.h>
26 #include <linux/uaccess.h>
27 #include <linux/kref.h>
28 #include <linux/slab.h>
29 #include <linux/mutex.h>
30 #include <linux/usb.h>
31 #include <linux/usb/tmc.h>
34 #define USBTMC_MINOR_BASE 176
37 * Size of driver internal IO buffer. Must be multiple of 4 and at least as
38 * large as wMaxPacketSize (which is usually 512 bytes).
40 #define USBTMC_SIZE_IOBUFFER 2048
42 /* Default USB timeout (in milliseconds) */
43 #define USBTMC_TIMEOUT 5000
46 * Maximum number of read cycles to empty bulk in endpoint during CLEAR and
47 * ABORT_BULK_IN requests. Ends the loop if (for whatever reason) a short
48 * packet is never read.
50 #define USBTMC_MAX_READS_TO_CLEAR_BULK_IN 100
52 static const struct usb_device_id usbtmc_devices[] = {
53 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 0), },
54 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 1), },
55 { 0, } /* terminating entry */
57 MODULE_DEVICE_TABLE(usb, usbtmc_devices);
60 * This structure is the capabilities for the device
61 * See section 4.2.1.8 of the USBTMC specification,
62 * and section 4.2.2 of the USBTMC usb488 subclass
63 * specification for details.
65 struct usbtmc_dev_capabilities {
66 __u8 interface_capabilities;
67 __u8 device_capabilities;
68 __u8 usb488_interface_capabilities;
69 __u8 usb488_device_capabilities;
72 /* This structure holds private data for each USBTMC device. One copy is
73 * allocated for each USBTMC device in the driver's probe function.
75 struct usbtmc_device_data {
76 const struct usb_device_id *id;
77 struct usb_device *usb_dev;
78 struct usb_interface *intf;
81 unsigned int bulk_out;
84 u8 bTag_last_write; /* needed for abort */
85 u8 bTag_last_read; /* needed for abort */
87 /* attributes from the USB TMC spec for this device */
92 bool zombie; /* fd of disconnected device */
94 struct usbtmc_dev_capabilities capabilities;
96 struct mutex io_mutex; /* only one i/o function running at a time */
98 #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
100 /* Forward declarations */
101 static struct usb_driver usbtmc_driver;
103 static void usbtmc_delete(struct kref *kref)
105 struct usbtmc_device_data *data = to_usbtmc_data(kref);
107 usb_put_dev(data->usb_dev);
111 static int usbtmc_open(struct inode *inode, struct file *filp)
113 struct usb_interface *intf;
114 struct usbtmc_device_data *data;
117 intf = usb_find_interface(&usbtmc_driver, iminor(inode));
119 printk(KERN_ERR KBUILD_MODNAME
120 ": can not find device for minor %d", iminor(inode));
125 data = usb_get_intfdata(intf);
126 kref_get(&data->kref);
128 /* Store pointer in file structure's private data field */
129 filp->private_data = data;
135 static int usbtmc_release(struct inode *inode, struct file *file)
137 struct usbtmc_device_data *data = file->private_data;
139 kref_put(&data->kref, usbtmc_delete);
143 static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data *data)
150 struct usb_host_interface *current_setting;
153 dev = &data->intf->dev;
154 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
158 rv = usb_control_msg(data->usb_dev,
159 usb_rcvctrlpipe(data->usb_dev, 0),
160 USBTMC_REQUEST_INITIATE_ABORT_BULK_IN,
161 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
162 data->bTag_last_read, data->bulk_in,
163 buffer, 2, USBTMC_TIMEOUT);
166 dev_err(dev, "usb_control_msg returned %d\n", rv);
170 dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
172 if (buffer[0] == USBTMC_STATUS_FAILED) {
177 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
178 dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n",
185 current_setting = data->intf->cur_altsetting;
186 for (n = 0; n < current_setting->desc.bNumEndpoints; n++)
187 if (current_setting->endpoint[n].desc.bEndpointAddress ==
189 max_size = usb_endpoint_maxp(¤t_setting->endpoint[n].desc);
192 dev_err(dev, "Couldn't get wMaxPacketSize\n");
197 dev_dbg(&data->intf->dev, "wMaxPacketSize is %d\n", max_size);
202 dev_dbg(dev, "Reading from bulk in EP\n");
204 rv = usb_bulk_msg(data->usb_dev,
205 usb_rcvbulkpipe(data->usb_dev,
207 buffer, USBTMC_SIZE_IOBUFFER,
208 &actual, USBTMC_TIMEOUT);
213 dev_err(dev, "usb_bulk_msg returned %d\n", rv);
216 } while ((actual == max_size) &&
217 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
219 if (actual == max_size) {
220 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
221 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
228 usbtmc_abort_bulk_in_status:
229 rv = usb_control_msg(data->usb_dev,
230 usb_rcvctrlpipe(data->usb_dev, 0),
231 USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS,
232 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
233 0, data->bulk_in, buffer, 0x08,
237 dev_err(dev, "usb_control_msg returned %d\n", rv);
241 dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
243 if (buffer[0] == USBTMC_STATUS_SUCCESS) {
248 if (buffer[0] != USBTMC_STATUS_PENDING) {
249 dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
256 dev_dbg(dev, "Reading from bulk in EP\n");
258 rv = usb_bulk_msg(data->usb_dev,
259 usb_rcvbulkpipe(data->usb_dev,
261 buffer, USBTMC_SIZE_IOBUFFER,
262 &actual, USBTMC_TIMEOUT);
267 dev_err(dev, "usb_bulk_msg returned %d\n", rv);
270 } while ((actual == max_size) &&
271 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
273 if (actual == max_size) {
274 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
275 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
280 goto usbtmc_abort_bulk_in_status;
288 static int usbtmc_ioctl_abort_bulk_out(struct usbtmc_device_data *data)
295 dev = &data->intf->dev;
297 buffer = kmalloc(8, GFP_KERNEL);
301 rv = usb_control_msg(data->usb_dev,
302 usb_rcvctrlpipe(data->usb_dev, 0),
303 USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT,
304 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
305 data->bTag_last_write, data->bulk_out,
306 buffer, 2, USBTMC_TIMEOUT);
309 dev_err(dev, "usb_control_msg returned %d\n", rv);
313 dev_dbg(dev, "INITIATE_ABORT_BULK_OUT returned %x\n", buffer[0]);
315 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
316 dev_err(dev, "INITIATE_ABORT_BULK_OUT returned %x\n",
324 usbtmc_abort_bulk_out_check_status:
325 rv = usb_control_msg(data->usb_dev,
326 usb_rcvctrlpipe(data->usb_dev, 0),
327 USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS,
328 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
329 0, data->bulk_out, buffer, 0x08,
333 dev_err(dev, "usb_control_msg returned %d\n", rv);
337 dev_dbg(dev, "CHECK_ABORT_BULK_OUT returned %x\n", buffer[0]);
339 if (buffer[0] == USBTMC_STATUS_SUCCESS)
340 goto usbtmc_abort_bulk_out_clear_halt;
342 if ((buffer[0] == USBTMC_STATUS_PENDING) &&
343 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN))
344 goto usbtmc_abort_bulk_out_check_status;
349 usbtmc_abort_bulk_out_clear_halt:
350 rv = usb_clear_halt(data->usb_dev,
351 usb_sndbulkpipe(data->usb_dev, data->bulk_out));
354 dev_err(dev, "usb_control_msg returned %d\n", rv);
364 static ssize_t usbtmc_read(struct file *filp, char __user *buf,
365 size_t count, loff_t *f_pos)
367 struct usbtmc_device_data *data;
377 /* Get pointer to private data structure */
378 data = filp->private_data;
379 dev = &data->intf->dev;
381 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
385 mutex_lock(&data->io_mutex);
394 while (remaining > 0) {
395 if (remaining > USBTMC_SIZE_IOBUFFER - 12 - 3)
396 this_part = USBTMC_SIZE_IOBUFFER - 12 - 3;
398 this_part = remaining;
400 /* Setup IO buffer for DEV_DEP_MSG_IN message
401 * Refer to class specs for details
404 buffer[1] = data->bTag;
405 buffer[2] = ~(data->bTag);
406 buffer[3] = 0; /* Reserved */
407 buffer[4] = (this_part) & 255;
408 buffer[5] = ((this_part) >> 8) & 255;
409 buffer[6] = ((this_part) >> 16) & 255;
410 buffer[7] = ((this_part) >> 24) & 255;
411 buffer[8] = data->TermCharEnabled * 2;
412 /* Use term character? */
413 buffer[9] = data->TermChar;
414 buffer[10] = 0; /* Reserved */
415 buffer[11] = 0; /* Reserved */
418 retval = usb_bulk_msg(data->usb_dev,
419 usb_sndbulkpipe(data->usb_dev,
421 buffer, 12, &actual, USBTMC_TIMEOUT);
423 /* Store bTag (in case we need to abort) */
424 data->bTag_last_write = data->bTag;
426 /* Increment bTag -- and increment again if zero */
432 dev_err(dev, "usb_bulk_msg returned %d\n", retval);
433 if (data->auto_abort)
434 usbtmc_ioctl_abort_bulk_out(data);
439 retval = usb_bulk_msg(data->usb_dev,
440 usb_rcvbulkpipe(data->usb_dev,
442 buffer, USBTMC_SIZE_IOBUFFER, &actual,
445 /* Store bTag (in case we need to abort) */
446 data->bTag_last_read = data->bTag;
449 dev_err(dev, "Unable to read data, error %d\n", retval);
450 if (data->auto_abort)
451 usbtmc_ioctl_abort_bulk_in(data);
455 /* How many characters did the instrument send? */
456 n_characters = buffer[4] +
461 /* Ensure the instrument doesn't lie about it */
462 if(n_characters > actual - 12) {
463 dev_err(dev, "Device lies about message size: %u > %d\n", n_characters, actual - 12);
464 n_characters = actual - 12;
467 /* Ensure the instrument doesn't send more back than requested */
468 if(n_characters > this_part) {
469 dev_err(dev, "Device returns more than requested: %zu > %zu\n", done + n_characters, done + this_part);
470 n_characters = this_part;
473 /* Bound amount of data received by amount of data requested */
474 if (n_characters > this_part)
475 n_characters = this_part;
477 /* Copy buffer to user space */
478 if (copy_to_user(buf + done, &buffer[12], n_characters)) {
479 /* There must have been an addressing problem */
484 done += n_characters;
485 /* Terminate if end-of-message bit received from device */
486 if ((buffer[8] & 0x01) && (actual >= n_characters + 12))
489 remaining -= n_characters;
492 /* Update file position value */
493 *f_pos = *f_pos + done;
497 mutex_unlock(&data->io_mutex);
502 static ssize_t usbtmc_write(struct file *filp, const char __user *buf,
503 size_t count, loff_t *f_pos)
505 struct usbtmc_device_data *data;
509 unsigned long int n_bytes;
514 data = filp->private_data;
516 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
520 mutex_lock(&data->io_mutex);
529 while (remaining > 0) {
530 if (remaining > USBTMC_SIZE_IOBUFFER - 12) {
531 this_part = USBTMC_SIZE_IOBUFFER - 12;
534 this_part = remaining;
538 /* Setup IO buffer for DEV_DEP_MSG_OUT message */
540 buffer[1] = data->bTag;
541 buffer[2] = ~(data->bTag);
542 buffer[3] = 0; /* Reserved */
543 buffer[4] = this_part & 255;
544 buffer[5] = (this_part >> 8) & 255;
545 buffer[6] = (this_part >> 16) & 255;
546 buffer[7] = (this_part >> 24) & 255;
547 /* buffer[8] is set above... */
548 buffer[9] = 0; /* Reserved */
549 buffer[10] = 0; /* Reserved */
550 buffer[11] = 0; /* Reserved */
552 if (copy_from_user(&buffer[12], buf + done, this_part)) {
557 n_bytes = roundup(12 + this_part, 4);
558 memset(buffer + 12 + this_part, 0, n_bytes - (12 + this_part));
561 retval = usb_bulk_msg(data->usb_dev,
562 usb_sndbulkpipe(data->usb_dev,
565 &actual, USBTMC_TIMEOUT);
571 data->bTag_last_write = data->bTag;
578 dev_err(&data->intf->dev,
579 "Unable to send data, error %d\n", retval);
580 if (data->auto_abort)
581 usbtmc_ioctl_abort_bulk_out(data);
585 remaining -= this_part;
591 mutex_unlock(&data->io_mutex);
596 static int usbtmc_ioctl_clear(struct usbtmc_device_data *data)
598 struct usb_host_interface *current_setting;
599 struct usb_endpoint_descriptor *desc;
607 dev = &data->intf->dev;
609 dev_dbg(dev, "Sending INITIATE_CLEAR request\n");
611 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
615 rv = usb_control_msg(data->usb_dev,
616 usb_rcvctrlpipe(data->usb_dev, 0),
617 USBTMC_REQUEST_INITIATE_CLEAR,
618 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
619 0, 0, buffer, 1, USBTMC_TIMEOUT);
621 dev_err(dev, "usb_control_msg returned %d\n", rv);
625 dev_dbg(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
627 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
628 dev_err(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
634 current_setting = data->intf->cur_altsetting;
635 for (n = 0; n < current_setting->desc.bNumEndpoints; n++) {
636 desc = ¤t_setting->endpoint[n].desc;
637 if (desc->bEndpointAddress == data->bulk_in)
638 max_size = usb_endpoint_maxp(desc);
642 dev_err(dev, "Couldn't get wMaxPacketSize\n");
647 dev_dbg(dev, "wMaxPacketSize is %d\n", max_size);
651 usbtmc_clear_check_status:
653 dev_dbg(dev, "Sending CHECK_CLEAR_STATUS request\n");
655 rv = usb_control_msg(data->usb_dev,
656 usb_rcvctrlpipe(data->usb_dev, 0),
657 USBTMC_REQUEST_CHECK_CLEAR_STATUS,
658 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
659 0, 0, buffer, 2, USBTMC_TIMEOUT);
661 dev_err(dev, "usb_control_msg returned %d\n", rv);
665 dev_dbg(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
667 if (buffer[0] == USBTMC_STATUS_SUCCESS)
668 goto usbtmc_clear_bulk_out_halt;
670 if (buffer[0] != USBTMC_STATUS_PENDING) {
671 dev_err(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
678 dev_dbg(dev, "Reading from bulk in EP\n");
680 rv = usb_bulk_msg(data->usb_dev,
681 usb_rcvbulkpipe(data->usb_dev,
683 buffer, USBTMC_SIZE_IOBUFFER,
684 &actual, USBTMC_TIMEOUT);
688 dev_err(dev, "usb_control_msg returned %d\n",
692 } while ((actual == max_size) &&
693 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
695 if (actual == max_size) {
696 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
697 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
702 goto usbtmc_clear_check_status;
704 usbtmc_clear_bulk_out_halt:
706 rv = usb_clear_halt(data->usb_dev,
707 usb_sndbulkpipe(data->usb_dev, data->bulk_out));
709 dev_err(dev, "usb_control_msg returned %d\n", rv);
719 static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data *data)
723 rv = usb_clear_halt(data->usb_dev,
724 usb_sndbulkpipe(data->usb_dev, data->bulk_out));
727 dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
734 static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data *data)
738 rv = usb_clear_halt(data->usb_dev,
739 usb_rcvbulkpipe(data->usb_dev, data->bulk_in));
742 dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
749 static int get_capabilities(struct usbtmc_device_data *data)
751 struct device *dev = &data->usb_dev->dev;
755 buffer = kmalloc(0x18, GFP_KERNEL);
759 rv = usb_control_msg(data->usb_dev, usb_rcvctrlpipe(data->usb_dev, 0),
760 USBTMC_REQUEST_GET_CAPABILITIES,
761 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
762 0, 0, buffer, 0x18, USBTMC_TIMEOUT);
764 dev_err(dev, "usb_control_msg returned %d\n", rv);
768 dev_dbg(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
769 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
770 dev_err(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
774 dev_dbg(dev, "Interface capabilities are %x\n", buffer[4]);
775 dev_dbg(dev, "Device capabilities are %x\n", buffer[5]);
776 dev_dbg(dev, "USB488 interface capabilities are %x\n", buffer[14]);
777 dev_dbg(dev, "USB488 device capabilities are %x\n", buffer[15]);
779 data->capabilities.interface_capabilities = buffer[4];
780 data->capabilities.device_capabilities = buffer[5];
781 data->capabilities.usb488_interface_capabilities = buffer[14];
782 data->capabilities.usb488_device_capabilities = buffer[15];
790 #define capability_attribute(name) \
791 static ssize_t show_##name(struct device *dev, \
792 struct device_attribute *attr, char *buf) \
794 struct usb_interface *intf = to_usb_interface(dev); \
795 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
797 return sprintf(buf, "%d\n", data->capabilities.name); \
799 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
801 capability_attribute(interface_capabilities);
802 capability_attribute(device_capabilities);
803 capability_attribute(usb488_interface_capabilities);
804 capability_attribute(usb488_device_capabilities);
806 static struct attribute *capability_attrs[] = {
807 &dev_attr_interface_capabilities.attr,
808 &dev_attr_device_capabilities.attr,
809 &dev_attr_usb488_interface_capabilities.attr,
810 &dev_attr_usb488_device_capabilities.attr,
814 static struct attribute_group capability_attr_grp = {
815 .attrs = capability_attrs,
818 static ssize_t show_TermChar(struct device *dev,
819 struct device_attribute *attr, char *buf)
821 struct usb_interface *intf = to_usb_interface(dev);
822 struct usbtmc_device_data *data = usb_get_intfdata(intf);
824 return sprintf(buf, "%c\n", data->TermChar);
827 static ssize_t store_TermChar(struct device *dev,
828 struct device_attribute *attr,
829 const char *buf, size_t count)
831 struct usb_interface *intf = to_usb_interface(dev);
832 struct usbtmc_device_data *data = usb_get_intfdata(intf);
836 data->TermChar = buf[0];
839 static DEVICE_ATTR(TermChar, S_IRUGO, show_TermChar, store_TermChar);
841 #define data_attribute(name) \
842 static ssize_t show_##name(struct device *dev, \
843 struct device_attribute *attr, char *buf) \
845 struct usb_interface *intf = to_usb_interface(dev); \
846 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
848 return sprintf(buf, "%d\n", data->name); \
850 static ssize_t store_##name(struct device *dev, \
851 struct device_attribute *attr, \
852 const char *buf, size_t count) \
854 struct usb_interface *intf = to_usb_interface(dev); \
855 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
859 result = sscanf(buf, "%u\n", &val); \
868 static DEVICE_ATTR(name, S_IRUGO, show_##name, store_##name)
870 data_attribute(TermCharEnabled);
871 data_attribute(auto_abort);
873 static struct attribute *data_attrs[] = {
874 &dev_attr_TermChar.attr,
875 &dev_attr_TermCharEnabled.attr,
876 &dev_attr_auto_abort.attr,
880 static struct attribute_group data_attr_grp = {
884 static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data *data)
890 dev = &data->intf->dev;
892 buffer = kmalloc(2, GFP_KERNEL);
896 rv = usb_control_msg(data->usb_dev,
897 usb_rcvctrlpipe(data->usb_dev, 0),
898 USBTMC_REQUEST_INDICATOR_PULSE,
899 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
900 0, 0, buffer, 0x01, USBTMC_TIMEOUT);
903 dev_err(dev, "usb_control_msg returned %d\n", rv);
907 dev_dbg(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
909 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
910 dev_err(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
921 static long usbtmc_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
923 struct usbtmc_device_data *data;
924 int retval = -EBADRQC;
926 data = file->private_data;
927 mutex_lock(&data->io_mutex);
930 goto skip_io_on_zombie;
934 case USBTMC_IOCTL_CLEAR_OUT_HALT:
935 retval = usbtmc_ioctl_clear_out_halt(data);
938 case USBTMC_IOCTL_CLEAR_IN_HALT:
939 retval = usbtmc_ioctl_clear_in_halt(data);
942 case USBTMC_IOCTL_INDICATOR_PULSE:
943 retval = usbtmc_ioctl_indicator_pulse(data);
946 case USBTMC_IOCTL_CLEAR:
947 retval = usbtmc_ioctl_clear(data);
950 case USBTMC_IOCTL_ABORT_BULK_OUT:
951 retval = usbtmc_ioctl_abort_bulk_out(data);
954 case USBTMC_IOCTL_ABORT_BULK_IN:
955 retval = usbtmc_ioctl_abort_bulk_in(data);
960 mutex_unlock(&data->io_mutex);
964 static const struct file_operations fops = {
965 .owner = THIS_MODULE,
967 .write = usbtmc_write,
969 .release = usbtmc_release,
970 .unlocked_ioctl = usbtmc_ioctl,
971 .llseek = default_llseek,
974 static struct usb_class_driver usbtmc_class = {
977 .minor_base = USBTMC_MINOR_BASE,
981 static int usbtmc_probe(struct usb_interface *intf,
982 const struct usb_device_id *id)
984 struct usbtmc_device_data *data;
985 struct usb_host_interface *iface_desc;
986 struct usb_endpoint_descriptor *endpoint;
990 dev_dbg(&intf->dev, "%s called\n", __func__);
992 data = kmalloc(sizeof(struct usbtmc_device_data), GFP_KERNEL);
994 dev_err(&intf->dev, "Unable to allocate kernel memory\n");
1000 data->usb_dev = usb_get_dev(interface_to_usbdev(intf));
1001 usb_set_intfdata(intf, data);
1002 kref_init(&data->kref);
1003 mutex_init(&data->io_mutex);
1006 /* Initialize USBTMC bTag and other fields */
1008 data->TermCharEnabled = 0;
1009 data->TermChar = '\n';
1011 /* USBTMC devices have only one setting, so use that */
1012 iface_desc = data->intf->cur_altsetting;
1014 /* Find bulk in endpoint */
1015 for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
1016 endpoint = &iface_desc->endpoint[n].desc;
1018 if (usb_endpoint_is_bulk_in(endpoint)) {
1019 data->bulk_in = endpoint->bEndpointAddress;
1020 dev_dbg(&intf->dev, "Found bulk in endpoint at %u\n",
1026 /* Find bulk out endpoint */
1027 for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
1028 endpoint = &iface_desc->endpoint[n].desc;
1030 if (usb_endpoint_is_bulk_out(endpoint)) {
1031 data->bulk_out = endpoint->bEndpointAddress;
1032 dev_dbg(&intf->dev, "Found Bulk out endpoint at %u\n",
1038 retcode = get_capabilities(data);
1040 dev_err(&intf->dev, "can't read capabilities\n");
1042 retcode = sysfs_create_group(&intf->dev.kobj,
1043 &capability_attr_grp);
1045 retcode = sysfs_create_group(&intf->dev.kobj, &data_attr_grp);
1047 retcode = usb_register_dev(intf, &usbtmc_class);
1049 dev_err(&intf->dev, "Not able to get a minor"
1050 " (base %u, slice default): %d\n", USBTMC_MINOR_BASE,
1052 goto error_register;
1054 dev_dbg(&intf->dev, "Using minor number %d\n", intf->minor);
1059 sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
1060 sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
1061 kref_put(&data->kref, usbtmc_delete);
1065 static void usbtmc_disconnect(struct usb_interface *intf)
1067 struct usbtmc_device_data *data;
1069 dev_dbg(&intf->dev, "usbtmc_disconnect called\n");
1071 data = usb_get_intfdata(intf);
1072 usb_deregister_dev(intf, &usbtmc_class);
1073 sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
1074 sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
1075 mutex_lock(&data->io_mutex);
1077 mutex_unlock(&data->io_mutex);
1078 kref_put(&data->kref, usbtmc_delete);
1081 static int usbtmc_suspend(struct usb_interface *intf, pm_message_t message)
1083 /* this driver does not have pending URBs */
1087 static int usbtmc_resume(struct usb_interface *intf)
1092 static struct usb_driver usbtmc_driver = {
1094 .id_table = usbtmc_devices,
1095 .probe = usbtmc_probe,
1096 .disconnect = usbtmc_disconnect,
1097 .suspend = usbtmc_suspend,
1098 .resume = usbtmc_resume,
1101 module_usb_driver(usbtmc_driver);
1103 MODULE_LICENSE("GPL");