2 * drivers/usb/class/usbtmc.c - USB Test & Measurment 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/mutex.h>
29 #include <linux/usb.h>
30 #include <linux/usb/tmc.h>
33 #define USBTMC_MINOR_BASE 176
36 * Size of driver internal IO buffer. Must be multiple of 4 and at least as
37 * large as wMaxPacketSize (which is usually 512 bytes).
39 #define USBTMC_SIZE_IOBUFFER 2048
41 /* Default USB timeout (in milliseconds) */
42 #define USBTMC_TIMEOUT 5000
45 * Maximum number of read cycles to empty bulk in endpoint during CLEAR and
46 * ABORT_BULK_IN requests. Ends the loop if (for whatever reason) a short
47 * packet is never read.
49 #define USBTMC_MAX_READS_TO_CLEAR_BULK_IN 100
51 static struct usb_device_id usbtmc_devices[] = {
52 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 0), },
53 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 1), },
54 { 0, } /* terminating entry */
56 MODULE_DEVICE_TABLE(usb, usbtmc_devices);
59 * This structure is the capabilities for the device
60 * See section 4.2.1.8 of the USBTMC specification,
61 * and section 4.2.2 of the USBTMC usb488 subclass
62 * specification for details.
64 struct usbtmc_dev_capabilities {
65 __u8 interface_capabilities;
66 __u8 device_capabilities;
67 __u8 usb488_interface_capabilities;
68 __u8 usb488_device_capabilities;
71 /* This structure holds private data for each USBTMC device. One copy is
72 * allocated for each USBTMC device in the driver's probe function.
74 struct usbtmc_device_data {
75 const struct usb_device_id *id;
76 struct usb_device *usb_dev;
77 struct usb_interface *intf;
80 unsigned int bulk_out;
83 u8 bTag_last_write; /* needed for abort */
84 u8 bTag_last_read; /* needed for abort */
86 /* attributes from the USB TMC spec for this device */
91 bool zombie; /* fd of disconnected device */
93 struct usbtmc_dev_capabilities capabilities;
95 struct mutex io_mutex; /* only one i/o function running at a time */
97 #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
99 /* Forward declarations */
100 static struct usb_driver usbtmc_driver;
102 static void usbtmc_delete(struct kref *kref)
104 struct usbtmc_device_data *data = to_usbtmc_data(kref);
106 usb_put_dev(data->usb_dev);
110 static int usbtmc_open(struct inode *inode, struct file *filp)
112 struct usb_interface *intf;
113 struct usbtmc_device_data *data;
116 intf = usb_find_interface(&usbtmc_driver, iminor(inode));
118 printk(KERN_ERR KBUILD_MODNAME
119 ": can not find device for minor %d", iminor(inode));
124 data = usb_get_intfdata(intf);
125 kref_get(&data->kref);
127 /* Store pointer in file structure's private data field */
128 filp->private_data = data;
134 static int usbtmc_release(struct inode *inode, struct file *file)
136 struct usbtmc_device_data *data = file->private_data;
138 kref_put(&data->kref, usbtmc_delete);
142 static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data *data)
149 struct usb_host_interface *current_setting;
152 dev = &data->intf->dev;
153 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
157 rv = usb_control_msg(data->usb_dev,
158 usb_rcvctrlpipe(data->usb_dev, 0),
159 USBTMC_REQUEST_INITIATE_ABORT_BULK_IN,
160 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
161 data->bTag_last_read, data->bulk_in,
162 buffer, 2, USBTMC_TIMEOUT);
165 dev_err(dev, "usb_control_msg returned %d\n", rv);
169 dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
171 if (buffer[0] == USBTMC_STATUS_FAILED) {
176 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
177 dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n",
184 current_setting = data->intf->cur_altsetting;
185 for (n = 0; n < current_setting->desc.bNumEndpoints; n++)
186 if (current_setting->endpoint[n].desc.bEndpointAddress ==
188 max_size = le16_to_cpu(current_setting->endpoint[n].
189 desc.wMaxPacketSize);
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_control_msg(data->usb_dev,
351 usb_sndctrlpipe(data->usb_dev, 0),
352 USB_REQ_CLEAR_FEATURE,
353 USB_DIR_OUT | USB_TYPE_STANDARD |
355 USB_ENDPOINT_HALT, data->bulk_out, buffer,
359 dev_err(dev, "usb_control_msg returned %d\n", rv);
369 static ssize_t usbtmc_read(struct file *filp, char __user *buf,
370 size_t count, loff_t *f_pos)
372 struct usbtmc_device_data *data;
382 /* Get pointer to private data structure */
383 data = filp->private_data;
384 dev = &data->intf->dev;
386 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
390 mutex_lock(&data->io_mutex);
399 while (remaining > 0) {
400 if (remaining > USBTMC_SIZE_IOBUFFER - 12 - 3)
401 this_part = USBTMC_SIZE_IOBUFFER - 12 - 3;
403 this_part = remaining;
405 /* Setup IO buffer for DEV_DEP_MSG_IN message
406 * Refer to class specs for details
409 buffer[1] = data->bTag;
410 buffer[2] = ~(data->bTag);
411 buffer[3] = 0; /* Reserved */
412 buffer[4] = (this_part) & 255;
413 buffer[5] = ((this_part) >> 8) & 255;
414 buffer[6] = ((this_part) >> 16) & 255;
415 buffer[7] = ((this_part) >> 24) & 255;
416 buffer[8] = data->TermCharEnabled * 2;
417 /* Use term character? */
418 buffer[9] = data->TermChar;
419 buffer[10] = 0; /* Reserved */
420 buffer[11] = 0; /* Reserved */
423 retval = usb_bulk_msg(data->usb_dev,
424 usb_sndbulkpipe(data->usb_dev,
426 buffer, 12, &actual, USBTMC_TIMEOUT);
428 /* Store bTag (in case we need to abort) */
429 data->bTag_last_write = data->bTag;
431 /* Increment bTag -- and increment again if zero */
437 dev_err(dev, "usb_bulk_msg returned %d\n", retval);
438 if (data->auto_abort)
439 usbtmc_ioctl_abort_bulk_out(data);
444 retval = usb_bulk_msg(data->usb_dev,
445 usb_rcvbulkpipe(data->usb_dev,
447 buffer, USBTMC_SIZE_IOBUFFER, &actual,
450 /* Store bTag (in case we need to abort) */
451 data->bTag_last_read = data->bTag;
454 dev_err(dev, "Unable to read data, error %d\n", retval);
455 if (data->auto_abort)
456 usbtmc_ioctl_abort_bulk_in(data);
460 /* How many characters did the instrument send? */
461 n_characters = buffer[4] +
466 /* Ensure the instrument doesn't lie about it */
467 if(n_characters > actual - 12) {
468 dev_err(dev, "Device lies about message size: %u > %d\n", n_characters, actual - 12);
469 n_characters = actual - 12;
472 /* Ensure the instrument doesn't send more back than requested */
473 if(n_characters > this_part) {
474 dev_err(dev, "Device returns more than requested: %zu > %zu\n", done + n_characters, done + this_part);
475 n_characters = this_part;
478 /* Bound amount of data received by amount of data requested */
479 if (n_characters > this_part)
480 n_characters = this_part;
482 /* Copy buffer to user space */
483 if (copy_to_user(buf + done, &buffer[12], n_characters)) {
484 /* There must have been an addressing problem */
489 done += n_characters;
490 /* Terminate if end-of-message bit recieved from device */
491 if ((buffer[8] & 0x01) && (actual >= n_characters + 12))
494 remaining -= n_characters;
497 /* Update file position value */
498 *f_pos = *f_pos + done;
502 mutex_unlock(&data->io_mutex);
507 static ssize_t usbtmc_write(struct file *filp, const char __user *buf,
508 size_t count, loff_t *f_pos)
510 struct usbtmc_device_data *data;
514 unsigned long int n_bytes;
519 data = filp->private_data;
521 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
525 mutex_lock(&data->io_mutex);
534 while (remaining > 0) {
535 if (remaining > USBTMC_SIZE_IOBUFFER - 12) {
536 this_part = USBTMC_SIZE_IOBUFFER - 12;
539 this_part = remaining;
543 /* Setup IO buffer for DEV_DEP_MSG_OUT message */
545 buffer[1] = data->bTag;
546 buffer[2] = ~(data->bTag);
547 buffer[3] = 0; /* Reserved */
548 buffer[4] = this_part & 255;
549 buffer[5] = (this_part >> 8) & 255;
550 buffer[6] = (this_part >> 16) & 255;
551 buffer[7] = (this_part >> 24) & 255;
552 /* buffer[8] is set above... */
553 buffer[9] = 0; /* Reserved */
554 buffer[10] = 0; /* Reserved */
555 buffer[11] = 0; /* Reserved */
557 if (copy_from_user(&buffer[12], buf + done, this_part)) {
562 n_bytes = roundup(12 + this_part, 4);
563 memset(buffer + 12 + this_part, 0, n_bytes - (12 + this_part));
566 retval = usb_bulk_msg(data->usb_dev,
567 usb_sndbulkpipe(data->usb_dev,
570 &actual, USBTMC_TIMEOUT);
576 data->bTag_last_write = data->bTag;
583 dev_err(&data->intf->dev,
584 "Unable to send data, error %d\n", retval);
585 if (data->auto_abort)
586 usbtmc_ioctl_abort_bulk_out(data);
590 remaining -= this_part;
596 mutex_unlock(&data->io_mutex);
601 static int usbtmc_ioctl_clear(struct usbtmc_device_data *data)
603 struct usb_host_interface *current_setting;
604 struct usb_endpoint_descriptor *desc;
612 dev = &data->intf->dev;
614 dev_dbg(dev, "Sending INITIATE_CLEAR request\n");
616 buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
620 rv = usb_control_msg(data->usb_dev,
621 usb_rcvctrlpipe(data->usb_dev, 0),
622 USBTMC_REQUEST_INITIATE_CLEAR,
623 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
624 0, 0, buffer, 1, USBTMC_TIMEOUT);
626 dev_err(dev, "usb_control_msg returned %d\n", rv);
630 dev_dbg(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
632 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
633 dev_err(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
639 current_setting = data->intf->cur_altsetting;
640 for (n = 0; n < current_setting->desc.bNumEndpoints; n++) {
641 desc = ¤t_setting->endpoint[n].desc;
642 if (desc->bEndpointAddress == data->bulk_in)
643 max_size = le16_to_cpu(desc->wMaxPacketSize);
647 dev_err(dev, "Couldn't get wMaxPacketSize\n");
652 dev_dbg(dev, "wMaxPacketSize is %d\n", max_size);
656 usbtmc_clear_check_status:
658 dev_dbg(dev, "Sending CHECK_CLEAR_STATUS request\n");
660 rv = usb_control_msg(data->usb_dev,
661 usb_rcvctrlpipe(data->usb_dev, 0),
662 USBTMC_REQUEST_CHECK_CLEAR_STATUS,
663 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
664 0, 0, buffer, 2, USBTMC_TIMEOUT);
666 dev_err(dev, "usb_control_msg returned %d\n", rv);
670 dev_dbg(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
672 if (buffer[0] == USBTMC_STATUS_SUCCESS)
673 goto usbtmc_clear_bulk_out_halt;
675 if (buffer[0] != USBTMC_STATUS_PENDING) {
676 dev_err(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
683 dev_dbg(dev, "Reading from bulk in EP\n");
685 rv = usb_bulk_msg(data->usb_dev,
686 usb_rcvbulkpipe(data->usb_dev,
688 buffer, USBTMC_SIZE_IOBUFFER,
689 &actual, USBTMC_TIMEOUT);
693 dev_err(dev, "usb_control_msg returned %d\n",
697 } while ((actual == max_size) &&
698 (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
700 if (actual == max_size) {
701 dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
702 USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
707 goto usbtmc_clear_check_status;
709 usbtmc_clear_bulk_out_halt:
711 rv = usb_control_msg(data->usb_dev,
712 usb_sndctrlpipe(data->usb_dev, 0),
713 USB_REQ_CLEAR_FEATURE,
714 USB_DIR_OUT | USB_TYPE_STANDARD |
717 data->bulk_out, buffer, 0,
720 dev_err(dev, "usb_control_msg returned %d\n", rv);
730 static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data *data)
735 buffer = kmalloc(2, GFP_KERNEL);
739 rv = usb_control_msg(data->usb_dev,
740 usb_sndctrlpipe(data->usb_dev, 0),
741 USB_REQ_CLEAR_FEATURE,
742 USB_DIR_OUT | USB_TYPE_STANDARD |
744 USB_ENDPOINT_HALT, data->bulk_out,
745 buffer, 0, USBTMC_TIMEOUT);
748 dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
759 static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data *data)
764 buffer = kmalloc(2, GFP_KERNEL);
768 rv = usb_control_msg(data->usb_dev, usb_sndctrlpipe(data->usb_dev, 0),
769 USB_REQ_CLEAR_FEATURE,
770 USB_DIR_OUT | USB_TYPE_STANDARD |
772 USB_ENDPOINT_HALT, data->bulk_in, buffer, 0,
776 dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
787 static int get_capabilities(struct usbtmc_device_data *data)
789 struct device *dev = &data->usb_dev->dev;
793 buffer = kmalloc(0x18, GFP_KERNEL);
797 rv = usb_control_msg(data->usb_dev, usb_rcvctrlpipe(data->usb_dev, 0),
798 USBTMC_REQUEST_GET_CAPABILITIES,
799 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
800 0, 0, buffer, 0x18, USBTMC_TIMEOUT);
802 dev_err(dev, "usb_control_msg returned %d\n", rv);
806 dev_dbg(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
807 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
808 dev_err(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
812 dev_dbg(dev, "Interface capabilities are %x\n", buffer[4]);
813 dev_dbg(dev, "Device capabilities are %x\n", buffer[5]);
814 dev_dbg(dev, "USB488 interface capabilities are %x\n", buffer[14]);
815 dev_dbg(dev, "USB488 device capabilities are %x\n", buffer[15]);
817 data->capabilities.interface_capabilities = buffer[4];
818 data->capabilities.device_capabilities = buffer[5];
819 data->capabilities.usb488_interface_capabilities = buffer[14];
820 data->capabilities.usb488_device_capabilities = buffer[15];
828 #define capability_attribute(name) \
829 static ssize_t show_##name(struct device *dev, \
830 struct device_attribute *attr, char *buf) \
832 struct usb_interface *intf = to_usb_interface(dev); \
833 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
835 return sprintf(buf, "%d\n", data->capabilities.name); \
837 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
839 capability_attribute(interface_capabilities);
840 capability_attribute(device_capabilities);
841 capability_attribute(usb488_interface_capabilities);
842 capability_attribute(usb488_device_capabilities);
844 static struct attribute *capability_attrs[] = {
845 &dev_attr_interface_capabilities.attr,
846 &dev_attr_device_capabilities.attr,
847 &dev_attr_usb488_interface_capabilities.attr,
848 &dev_attr_usb488_device_capabilities.attr,
852 static struct attribute_group capability_attr_grp = {
853 .attrs = capability_attrs,
856 static ssize_t show_TermChar(struct device *dev,
857 struct device_attribute *attr, char *buf)
859 struct usb_interface *intf = to_usb_interface(dev);
860 struct usbtmc_device_data *data = usb_get_intfdata(intf);
862 return sprintf(buf, "%c\n", data->TermChar);
865 static ssize_t store_TermChar(struct device *dev,
866 struct device_attribute *attr,
867 const char *buf, size_t count)
869 struct usb_interface *intf = to_usb_interface(dev);
870 struct usbtmc_device_data *data = usb_get_intfdata(intf);
874 data->TermChar = buf[0];
877 static DEVICE_ATTR(TermChar, S_IRUGO, show_TermChar, store_TermChar);
879 #define data_attribute(name) \
880 static ssize_t show_##name(struct device *dev, \
881 struct device_attribute *attr, char *buf) \
883 struct usb_interface *intf = to_usb_interface(dev); \
884 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
886 return sprintf(buf, "%d\n", data->name); \
888 static ssize_t store_##name(struct device *dev, \
889 struct device_attribute *attr, \
890 const char *buf, size_t count) \
892 struct usb_interface *intf = to_usb_interface(dev); \
893 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
897 result = sscanf(buf, "%u\n", &val); \
906 static DEVICE_ATTR(name, S_IRUGO, show_##name, store_##name)
908 data_attribute(TermCharEnabled);
909 data_attribute(auto_abort);
911 static struct attribute *data_attrs[] = {
912 &dev_attr_TermChar.attr,
913 &dev_attr_TermCharEnabled.attr,
914 &dev_attr_auto_abort.attr,
918 static struct attribute_group data_attr_grp = {
922 static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data *data)
928 dev = &data->intf->dev;
930 buffer = kmalloc(2, GFP_KERNEL);
934 rv = usb_control_msg(data->usb_dev,
935 usb_rcvctrlpipe(data->usb_dev, 0),
936 USBTMC_REQUEST_INDICATOR_PULSE,
937 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
938 0, 0, buffer, 0x01, USBTMC_TIMEOUT);
941 dev_err(dev, "usb_control_msg returned %d\n", rv);
945 dev_dbg(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
947 if (buffer[0] != USBTMC_STATUS_SUCCESS) {
948 dev_err(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
959 static long usbtmc_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
961 struct usbtmc_device_data *data;
962 int retval = -EBADRQC;
964 data = file->private_data;
965 mutex_lock(&data->io_mutex);
968 goto skip_io_on_zombie;
972 case USBTMC_IOCTL_CLEAR_OUT_HALT:
973 retval = usbtmc_ioctl_clear_out_halt(data);
976 case USBTMC_IOCTL_CLEAR_IN_HALT:
977 retval = usbtmc_ioctl_clear_in_halt(data);
980 case USBTMC_IOCTL_INDICATOR_PULSE:
981 retval = usbtmc_ioctl_indicator_pulse(data);
984 case USBTMC_IOCTL_CLEAR:
985 retval = usbtmc_ioctl_clear(data);
988 case USBTMC_IOCTL_ABORT_BULK_OUT:
989 retval = usbtmc_ioctl_abort_bulk_out(data);
992 case USBTMC_IOCTL_ABORT_BULK_IN:
993 retval = usbtmc_ioctl_abort_bulk_in(data);
998 mutex_unlock(&data->io_mutex);
1002 static const struct file_operations fops = {
1003 .owner = THIS_MODULE,
1004 .read = usbtmc_read,
1005 .write = usbtmc_write,
1006 .open = usbtmc_open,
1007 .release = usbtmc_release,
1008 .unlocked_ioctl = usbtmc_ioctl,
1011 static struct usb_class_driver usbtmc_class = {
1014 .minor_base = USBTMC_MINOR_BASE,
1018 static int usbtmc_probe(struct usb_interface *intf,
1019 const struct usb_device_id *id)
1021 struct usbtmc_device_data *data;
1022 struct usb_host_interface *iface_desc;
1023 struct usb_endpoint_descriptor *endpoint;
1027 dev_dbg(&intf->dev, "%s called\n", __func__);
1029 data = kmalloc(sizeof(struct usbtmc_device_data), GFP_KERNEL);
1031 dev_err(&intf->dev, "Unable to allocate kernel memory\n");
1037 data->usb_dev = usb_get_dev(interface_to_usbdev(intf));
1038 usb_set_intfdata(intf, data);
1039 kref_init(&data->kref);
1040 mutex_init(&data->io_mutex);
1043 /* Initialize USBTMC bTag and other fields */
1045 data->TermCharEnabled = 0;
1046 data->TermChar = '\n';
1048 /* USBTMC devices have only one setting, so use that */
1049 iface_desc = data->intf->cur_altsetting;
1051 /* Find bulk in endpoint */
1052 for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
1053 endpoint = &iface_desc->endpoint[n].desc;
1055 if (usb_endpoint_is_bulk_in(endpoint)) {
1056 data->bulk_in = endpoint->bEndpointAddress;
1057 dev_dbg(&intf->dev, "Found bulk in endpoint at %u\n",
1063 /* Find bulk out endpoint */
1064 for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
1065 endpoint = &iface_desc->endpoint[n].desc;
1067 if (usb_endpoint_is_bulk_out(endpoint)) {
1068 data->bulk_out = endpoint->bEndpointAddress;
1069 dev_dbg(&intf->dev, "Found Bulk out endpoint at %u\n",
1075 retcode = get_capabilities(data);
1077 dev_err(&intf->dev, "can't read capabilities\n");
1079 retcode = sysfs_create_group(&intf->dev.kobj,
1080 &capability_attr_grp);
1082 retcode = sysfs_create_group(&intf->dev.kobj, &data_attr_grp);
1084 retcode = usb_register_dev(intf, &usbtmc_class);
1086 dev_err(&intf->dev, "Not able to get a minor"
1087 " (base %u, slice default): %d\n", USBTMC_MINOR_BASE,
1089 goto error_register;
1091 dev_dbg(&intf->dev, "Using minor number %d\n", intf->minor);
1096 sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
1097 sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
1098 kref_put(&data->kref, usbtmc_delete);
1102 static void usbtmc_disconnect(struct usb_interface *intf)
1104 struct usbtmc_device_data *data;
1106 dev_dbg(&intf->dev, "usbtmc_disconnect called\n");
1108 data = usb_get_intfdata(intf);
1109 usb_deregister_dev(intf, &usbtmc_class);
1110 sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
1111 sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
1112 mutex_lock(&data->io_mutex);
1114 mutex_unlock(&data->io_mutex);
1115 kref_put(&data->kref, usbtmc_delete);
1118 static int usbtmc_suspend (struct usb_interface *intf, pm_message_t message)
1120 /* this driver does not have pending URBs */
1124 static int usbtmc_resume (struct usb_interface *intf)
1129 static struct usb_driver usbtmc_driver = {
1131 .id_table = usbtmc_devices,
1132 .probe = usbtmc_probe,
1133 .disconnect = usbtmc_disconnect,
1134 .suspend = usbtmc_suspend,
1135 .resume = usbtmc_resume,
1138 static int __init usbtmc_init(void)
1142 retcode = usb_register(&usbtmc_driver);
1144 printk(KERN_ERR KBUILD_MODNAME": Unable to register driver\n");
1147 module_init(usbtmc_init);
1149 static void __exit usbtmc_exit(void)
1151 usb_deregister(&usbtmc_driver);
1153 module_exit(usbtmc_exit);
1155 MODULE_LICENSE("GPL");