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 10
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 { 0, } /* terminating entry */
55 MODULE_DEVICE_TABLE(usb
, usbtmc_devices
);
58 * This structure is the capabilities for the device
59 * See section 4.2.1.8 of the USBTMC specification for details.
61 struct usbtmc_dev_capabilities
{
62 __u8 interface_capabilities
;
63 __u8 device_capabilities
;
64 __u8 usb488_interface_capabilities
;
65 __u8 usb488_device_capabilities
;
68 /* This structure holds private data for each USBTMC device. One copy is
69 * allocated for each USBTMC device in the driver's probe function.
71 struct usbtmc_device_data
{
72 const struct usb_device_id
*id
;
73 struct usb_device
*usb_dev
;
74 struct usb_interface
*intf
;
77 unsigned int bulk_out
;
80 u8 bTag_last_write
; /* needed for abort */
81 u8 bTag_last_read
; /* needed for abort */
83 /* attributes from the USB TMC spec for this device */
88 struct usbtmc_dev_capabilities capabilities
;
90 struct mutex io_mutex
; /* only one i/o function running at a time */
92 #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
94 /* Forward declarations */
95 static struct usb_driver usbtmc_driver
;
97 static void usbtmc_delete(struct kref
*kref
)
99 struct usbtmc_device_data
*data
= to_usbtmc_data(kref
);
101 usb_put_dev(data
->usb_dev
);
105 static int usbtmc_open(struct inode
*inode
, struct file
*filp
)
107 struct usb_interface
*intf
;
108 struct usbtmc_device_data
*data
;
109 int retval
= -ENODEV
;
111 intf
= usb_find_interface(&usbtmc_driver
, iminor(inode
));
113 printk(KERN_ERR KBUILD_MODNAME
114 ": can not find device for minor %d", iminor(inode
));
118 data
= usb_get_intfdata(intf
);
119 kref_get(&data
->kref
);
121 /* Store pointer in file structure's private data field */
122 filp
->private_data
= data
;
128 static int usbtmc_release(struct inode
*inode
, struct file
*file
)
130 struct usbtmc_device_data
*data
= file
->private_data
;
132 kref_put(&data
->kref
, usbtmc_delete
);
136 static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data
*data
)
143 struct usb_host_interface
*current_setting
;
146 dev
= &data
->intf
->dev
;
147 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
151 rv
= usb_control_msg(data
->usb_dev
,
152 usb_rcvctrlpipe(data
->usb_dev
, 0),
153 USBTMC_REQUEST_INITIATE_ABORT_BULK_IN
,
154 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
155 data
->bTag_last_read
, data
->bulk_in
,
156 buffer
, 2, USBTMC_TIMEOUT
);
159 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
163 dev_dbg(dev
, "INITIATE_ABORT_BULK_IN returned %x\n", buffer
[0]);
165 if (buffer
[0] == USBTMC_STATUS_FAILED
) {
170 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
171 dev_err(dev
, "INITIATE_ABORT_BULK_IN returned %x\n",
178 current_setting
= data
->intf
->cur_altsetting
;
179 for (n
= 0; n
< current_setting
->desc
.bNumEndpoints
; n
++)
180 if (current_setting
->endpoint
[n
].desc
.bEndpointAddress
==
182 max_size
= le16_to_cpu(current_setting
->endpoint
[n
].
183 desc
.wMaxPacketSize
);
186 dev_err(dev
, "Couldn't get wMaxPacketSize\n");
191 dev_dbg(&data
->intf
->dev
, "wMaxPacketSize is %d\n", max_size
);
196 dev_dbg(dev
, "Reading from bulk in EP\n");
198 rv
= usb_bulk_msg(data
->usb_dev
,
199 usb_rcvbulkpipe(data
->usb_dev
,
201 buffer
, USBTMC_SIZE_IOBUFFER
,
202 &actual
, USBTMC_TIMEOUT
);
207 dev_err(dev
, "usb_bulk_msg returned %d\n", rv
);
210 } while ((actual
== max_size
) &&
211 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
));
213 if (actual
== max_size
) {
214 dev_err(dev
, "Couldn't clear device buffer within %d cycles\n",
215 USBTMC_MAX_READS_TO_CLEAR_BULK_IN
);
222 usbtmc_abort_bulk_in_status
:
223 rv
= usb_control_msg(data
->usb_dev
,
224 usb_rcvctrlpipe(data
->usb_dev
, 0),
225 USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS
,
226 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
227 0, data
->bulk_in
, buffer
, 0x08,
231 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
235 dev_dbg(dev
, "INITIATE_ABORT_BULK_IN returned %x\n", buffer
[0]);
237 if (buffer
[0] == USBTMC_STATUS_SUCCESS
) {
242 if (buffer
[0] != USBTMC_STATUS_PENDING
) {
243 dev_err(dev
, "INITIATE_ABORT_BULK_IN returned %x\n", buffer
[0]);
250 dev_dbg(dev
, "Reading from bulk in EP\n");
252 rv
= usb_bulk_msg(data
->usb_dev
,
253 usb_rcvbulkpipe(data
->usb_dev
,
255 buffer
, USBTMC_SIZE_IOBUFFER
,
256 &actual
, USBTMC_TIMEOUT
);
261 dev_err(dev
, "usb_bulk_msg returned %d\n", rv
);
264 } while ((actual
= max_size
) &&
265 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
));
267 if (actual
== max_size
) {
268 dev_err(dev
, "Couldn't clear device buffer within %d cycles\n",
269 USBTMC_MAX_READS_TO_CLEAR_BULK_IN
);
274 goto usbtmc_abort_bulk_in_status
;
282 static int usbtmc_ioctl_abort_bulk_out(struct usbtmc_device_data
*data
)
289 dev
= &data
->intf
->dev
;
291 buffer
= kmalloc(8, GFP_KERNEL
);
295 rv
= usb_control_msg(data
->usb_dev
,
296 usb_rcvctrlpipe(data
->usb_dev
, 0),
297 USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT
,
298 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
299 data
->bTag_last_write
, data
->bulk_out
,
300 buffer
, 2, USBTMC_TIMEOUT
);
303 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
307 dev_dbg(dev
, "INITIATE_ABORT_BULK_OUT returned %x\n", buffer
[0]);
309 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
310 dev_err(dev
, "INITIATE_ABORT_BULK_OUT returned %x\n",
318 usbtmc_abort_bulk_out_check_status
:
319 rv
= usb_control_msg(data
->usb_dev
,
320 usb_rcvctrlpipe(data
->usb_dev
, 0),
321 USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS
,
322 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
323 0, data
->bulk_out
, buffer
, 0x08,
327 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
331 dev_dbg(dev
, "CHECK_ABORT_BULK_OUT returned %x\n", buffer
[0]);
333 if (buffer
[0] == USBTMC_STATUS_SUCCESS
)
334 goto usbtmc_abort_bulk_out_clear_halt
;
336 if ((buffer
[0] == USBTMC_STATUS_PENDING
) &&
337 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
))
338 goto usbtmc_abort_bulk_out_check_status
;
343 usbtmc_abort_bulk_out_clear_halt
:
344 rv
= usb_control_msg(data
->usb_dev
,
345 usb_sndctrlpipe(data
->usb_dev
, 0),
346 USB_REQ_CLEAR_FEATURE
,
347 USB_DIR_OUT
| USB_TYPE_STANDARD
|
349 USB_ENDPOINT_HALT
, data
->bulk_out
, buffer
,
353 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
363 static ssize_t
usbtmc_read(struct file
*filp
, char __user
*buf
,
364 size_t count
, loff_t
*f_pos
)
366 struct usbtmc_device_data
*data
;
368 unsigned long int n_characters
;
376 /* Get pointer to private data structure */
377 data
= filp
->private_data
;
378 dev
= &data
->intf
->dev
;
380 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
384 mutex_lock(&data
->io_mutex
);
389 while (remaining
> 0) {
390 if (remaining
> USBTMC_SIZE_IOBUFFER
- 12 - 3)
391 this_part
= USBTMC_SIZE_IOBUFFER
- 12 - 3;
393 this_part
= remaining
;
395 /* Setup IO buffer for DEV_DEP_MSG_IN message
396 * Refer to class specs for details
399 buffer
[1] = data
->bTag
;
400 buffer
[2] = ~(data
->bTag
);
401 buffer
[3] = 0; /* Reserved */
402 buffer
[4] = (this_part
- 12 - 3) & 255;
403 buffer
[5] = ((this_part
- 12 - 3) >> 8) & 255;
404 buffer
[6] = ((this_part
- 12 - 3) >> 16) & 255;
405 buffer
[7] = ((this_part
- 12 - 3) >> 24) & 255;
406 buffer
[8] = data
->TermCharEnabled
* 2;
407 /* Use term character? */
408 buffer
[9] = data
->TermChar
;
409 buffer
[10] = 0; /* Reserved */
410 buffer
[11] = 0; /* Reserved */
413 retval
= usb_bulk_msg(data
->usb_dev
,
414 usb_sndbulkpipe(data
->usb_dev
,
416 buffer
, 12, &actual
, USBTMC_TIMEOUT
);
418 /* Store bTag (in case we need to abort) */
419 data
->bTag_last_write
= data
->bTag
;
421 /* Increment bTag -- and increment again if zero */
427 dev_err(dev
, "usb_bulk_msg returned %d\n", retval
);
428 if (data
->auto_abort
)
429 usbtmc_ioctl_abort_bulk_out(data
);
434 retval
= usb_bulk_msg(data
->usb_dev
,
435 usb_rcvbulkpipe(data
->usb_dev
,
437 buffer
, USBTMC_SIZE_IOBUFFER
, &actual
,
440 /* Store bTag (in case we need to abort) */
441 data
->bTag_last_read
= data
->bTag
;
444 dev_err(dev
, "Unable to read data, error %d\n", retval
);
445 if (data
->auto_abort
)
446 usbtmc_ioctl_abort_bulk_in(data
);
450 /* How many characters did the instrument send? */
451 n_characters
= buffer
[4] +
456 /* Copy buffer to user space */
457 if (copy_to_user(buf
+ done
, &buffer
[12], n_characters
)) {
458 /* There must have been an addressing problem */
463 done
+= n_characters
;
464 if (n_characters
< USBTMC_SIZE_IOBUFFER
)
468 /* Update file position value */
469 *f_pos
= *f_pos
+ done
;
473 mutex_unlock(&data
->io_mutex
);
478 static ssize_t
usbtmc_write(struct file
*filp
, const char __user
*buf
,
479 size_t count
, loff_t
*f_pos
)
481 struct usbtmc_device_data
*data
;
485 unsigned long int n_bytes
;
490 data
= filp
->private_data
;
492 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
496 mutex_lock(&data
->io_mutex
);
501 while (remaining
> 0) {
502 if (remaining
> USBTMC_SIZE_IOBUFFER
- 12) {
503 this_part
= USBTMC_SIZE_IOBUFFER
- 12;
506 this_part
= remaining
;
510 /* Setup IO buffer for DEV_DEP_MSG_OUT message */
512 buffer
[1] = data
->bTag
;
513 buffer
[2] = ~(data
->bTag
);
514 buffer
[3] = 0; /* Reserved */
515 buffer
[4] = this_part
& 255;
516 buffer
[5] = (this_part
>> 8) & 255;
517 buffer
[6] = (this_part
>> 16) & 255;
518 buffer
[7] = (this_part
>> 24) & 255;
519 /* buffer[8] is set above... */
520 buffer
[9] = 0; /* Reserved */
521 buffer
[10] = 0; /* Reserved */
522 buffer
[11] = 0; /* Reserved */
524 if (copy_from_user(&buffer
[12], buf
+ done
, this_part
)) {
529 n_bytes
= roundup(12 + this_part
, 4);
530 memset(buffer
+ 12 + this_part
, 0, n_bytes
- (12 + this_part
));
532 retval
= usb_bulk_msg(data
->usb_dev
,
533 usb_sndbulkpipe(data
->usb_dev
,
535 buffer
, n_bytes
, &actual
, USBTMC_TIMEOUT
);
537 data
->bTag_last_write
= data
->bTag
;
544 dev_err(&data
->intf
->dev
,
545 "Unable to send data, error %d\n", retval
);
546 if (data
->auto_abort
)
547 usbtmc_ioctl_abort_bulk_out(data
);
551 remaining
-= this_part
;
557 mutex_unlock(&data
->io_mutex
);
562 static int usbtmc_ioctl_clear(struct usbtmc_device_data
*data
)
564 struct usb_host_interface
*current_setting
;
565 struct usb_endpoint_descriptor
*desc
;
573 dev
= &data
->intf
->dev
;
575 dev_dbg(dev
, "Sending INITIATE_CLEAR request\n");
577 buffer
= kmalloc(USBTMC_SIZE_IOBUFFER
, GFP_KERNEL
);
581 rv
= usb_control_msg(data
->usb_dev
,
582 usb_rcvctrlpipe(data
->usb_dev
, 0),
583 USBTMC_REQUEST_INITIATE_CLEAR
,
584 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
585 0, 0, buffer
, 1, USBTMC_TIMEOUT
);
587 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
591 dev_dbg(dev
, "INITIATE_CLEAR returned %x\n", buffer
[0]);
593 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
594 dev_err(dev
, "INITIATE_CLEAR returned %x\n", buffer
[0]);
600 current_setting
= data
->intf
->cur_altsetting
;
601 for (n
= 0; n
< current_setting
->desc
.bNumEndpoints
; n
++) {
602 desc
= ¤t_setting
->endpoint
[n
].desc
;
603 if (desc
->bEndpointAddress
== data
->bulk_in
)
604 max_size
= le16_to_cpu(desc
->wMaxPacketSize
);
608 dev_err(dev
, "Couldn't get wMaxPacketSize\n");
613 dev_dbg(dev
, "wMaxPacketSize is %d\n", max_size
);
617 usbtmc_clear_check_status
:
619 dev_dbg(dev
, "Sending CHECK_CLEAR_STATUS request\n");
621 rv
= usb_control_msg(data
->usb_dev
,
622 usb_rcvctrlpipe(data
->usb_dev
, 0),
623 USBTMC_REQUEST_CHECK_CLEAR_STATUS
,
624 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
625 0, 0, buffer
, 2, USBTMC_TIMEOUT
);
627 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
631 dev_dbg(dev
, "CHECK_CLEAR_STATUS returned %x\n", buffer
[0]);
633 if (buffer
[0] == USBTMC_STATUS_SUCCESS
)
634 goto usbtmc_clear_bulk_out_halt
;
636 if (buffer
[0] != USBTMC_STATUS_PENDING
) {
637 dev_err(dev
, "CHECK_CLEAR_STATUS returned %x\n", buffer
[0]);
644 dev_dbg(dev
, "Reading from bulk in EP\n");
646 rv
= usb_bulk_msg(data
->usb_dev
,
647 usb_rcvbulkpipe(data
->usb_dev
,
649 buffer
, USBTMC_SIZE_IOBUFFER
,
650 &actual
, USBTMC_TIMEOUT
);
654 dev_err(dev
, "usb_control_msg returned %d\n",
658 } while ((actual
== max_size
) &&
659 (n
< USBTMC_MAX_READS_TO_CLEAR_BULK_IN
));
661 if (actual
== max_size
) {
662 dev_err(dev
, "Couldn't clear device buffer within %d cycles\n",
663 USBTMC_MAX_READS_TO_CLEAR_BULK_IN
);
668 goto usbtmc_clear_check_status
;
670 usbtmc_clear_bulk_out_halt
:
672 rv
= usb_control_msg(data
->usb_dev
,
673 usb_sndctrlpipe(data
->usb_dev
, 0),
674 USB_REQ_CLEAR_FEATURE
,
675 USB_DIR_OUT
| USB_TYPE_STANDARD
|
678 data
->bulk_out
, buffer
, 0,
681 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
691 static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data
*data
)
696 buffer
= kmalloc(2, GFP_KERNEL
);
700 rv
= usb_control_msg(data
->usb_dev
,
701 usb_sndctrlpipe(data
->usb_dev
, 0),
702 USB_REQ_CLEAR_FEATURE
,
703 USB_DIR_OUT
| USB_TYPE_STANDARD
|
705 USB_ENDPOINT_HALT
, data
->bulk_out
,
706 buffer
, 0, USBTMC_TIMEOUT
);
709 dev_err(&data
->usb_dev
->dev
, "usb_control_msg returned %d\n",
720 static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data
*data
)
725 buffer
= kmalloc(2, GFP_KERNEL
);
729 rv
= usb_control_msg(data
->usb_dev
, usb_sndctrlpipe(data
->usb_dev
, 0),
730 USB_REQ_CLEAR_FEATURE
,
731 USB_DIR_OUT
| USB_TYPE_STANDARD
|
733 USB_ENDPOINT_HALT
, data
->bulk_in
, buffer
, 0,
737 dev_err(&data
->usb_dev
->dev
, "usb_control_msg returned %d\n",
748 static int get_capabilities(struct usbtmc_device_data
*data
)
750 struct device
*dev
= &data
->usb_dev
->dev
;
754 buffer
= kmalloc(0x18, GFP_KERNEL
);
758 rv
= usb_control_msg(data
->usb_dev
, usb_rcvctrlpipe(data
->usb_dev
, 0),
759 USBTMC_REQUEST_GET_CAPABILITIES
,
760 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
761 0, 0, buffer
, 0x18, USBTMC_TIMEOUT
);
763 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
767 dev_dbg(dev
, "GET_CAPABILITIES returned %x\n", buffer
[0]);
768 dev_dbg(dev
, "Interface capabilities are %x\n", buffer
[4]);
769 dev_dbg(dev
, "Device capabilities are %x\n", buffer
[5]);
770 dev_dbg(dev
, "USB488 interface capabilities are %x\n", buffer
[14]);
771 dev_dbg(dev
, "USB488 device capabilities are %x\n", buffer
[15]);
772 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
773 dev_err(dev
, "GET_CAPABILITIES returned %x\n", buffer
[0]);
777 data
->capabilities
.interface_capabilities
= buffer
[4];
778 data
->capabilities
.device_capabilities
= buffer
[5];
779 data
->capabilities
.usb488_interface_capabilities
= buffer
[14];
780 data
->capabilities
.usb488_device_capabilities
= buffer
[15];
786 #define capability_attribute(name) \
787 static ssize_t show_##name(struct device *dev, \
788 struct device_attribute *attr, char *buf) \
790 struct usb_interface *intf = to_usb_interface(dev); \
791 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
793 return sprintf(buf, "%d\n", data->capabilities.name); \
795 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
797 capability_attribute(interface_capabilities
);
798 capability_attribute(device_capabilities
);
799 capability_attribute(usb488_interface_capabilities
);
800 capability_attribute(usb488_device_capabilities
);
802 static struct attribute
*capability_attrs
[] = {
803 &dev_attr_interface_capabilities
.attr
,
804 &dev_attr_device_capabilities
.attr
,
805 &dev_attr_usb488_interface_capabilities
.attr
,
806 &dev_attr_usb488_device_capabilities
.attr
,
810 static struct attribute_group capability_attr_grp
= {
811 .attrs
= capability_attrs
,
814 static ssize_t
show_TermChar(struct device
*dev
,
815 struct device_attribute
*attr
, char *buf
)
817 struct usb_interface
*intf
= to_usb_interface(dev
);
818 struct usbtmc_device_data
*data
= usb_get_intfdata(intf
);
820 return sprintf(buf
, "%c\n", data
->TermChar
);
823 static ssize_t
store_TermChar(struct device
*dev
,
824 struct device_attribute
*attr
,
825 const char *buf
, size_t count
)
827 struct usb_interface
*intf
= to_usb_interface(dev
);
828 struct usbtmc_device_data
*data
= usb_get_intfdata(intf
);
832 data
->TermChar
= buf
[0];
835 static DEVICE_ATTR(TermChar
, S_IRUGO
, show_TermChar
, store_TermChar
);
837 #define data_attribute(name) \
838 static ssize_t show_##name(struct device *dev, \
839 struct device_attribute *attr, char *buf) \
841 struct usb_interface *intf = to_usb_interface(dev); \
842 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
844 return sprintf(buf, "%d\n", data->name); \
846 static ssize_t store_##name(struct device *dev, \
847 struct device_attribute *attr, \
848 const char *buf, size_t count) \
850 struct usb_interface *intf = to_usb_interface(dev); \
851 struct usbtmc_device_data *data = usb_get_intfdata(intf); \
855 result = sscanf(buf, "%u\n", &val); \
864 static DEVICE_ATTR(name, S_IRUGO, show_##name, store_##name)
866 data_attribute(TermCharEnabled
);
867 data_attribute(auto_abort
);
869 static struct attribute
*data_attrs
[] = {
870 &dev_attr_TermChar
.attr
,
871 &dev_attr_TermCharEnabled
.attr
,
872 &dev_attr_auto_abort
.attr
,
876 static struct attribute_group data_attr_grp
= {
880 static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data
*data
)
886 dev
= &data
->intf
->dev
;
888 buffer
= kmalloc(2, GFP_KERNEL
);
892 rv
= usb_control_msg(data
->usb_dev
,
893 usb_rcvctrlpipe(data
->usb_dev
, 0),
894 USBTMC_REQUEST_INDICATOR_PULSE
,
895 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
896 0, 0, buffer
, 0x01, USBTMC_TIMEOUT
);
899 dev_err(dev
, "usb_control_msg returned %d\n", rv
);
903 dev_dbg(dev
, "INDICATOR_PULSE returned %x\n", buffer
[0]);
905 if (buffer
[0] != USBTMC_STATUS_SUCCESS
) {
906 dev_err(dev
, "INDICATOR_PULSE returned %x\n", buffer
[0]);
917 static long usbtmc_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
919 struct usbtmc_device_data
*data
;
920 int retval
= -EBADRQC
;
922 data
= file
->private_data
;
923 mutex_lock(&data
->io_mutex
);
926 case USBTMC_IOCTL_CLEAR_OUT_HALT
:
927 retval
= usbtmc_ioctl_clear_out_halt(data
);
929 case USBTMC_IOCTL_CLEAR_IN_HALT
:
930 retval
= usbtmc_ioctl_clear_in_halt(data
);
932 case USBTMC_IOCTL_INDICATOR_PULSE
:
933 retval
= usbtmc_ioctl_indicator_pulse(data
);
935 case USBTMC_IOCTL_CLEAR
:
936 retval
= usbtmc_ioctl_clear(data
);
938 case USBTMC_IOCTL_ABORT_BULK_OUT
:
939 retval
= usbtmc_ioctl_abort_bulk_out(data
);
941 case USBTMC_IOCTL_ABORT_BULK_IN
:
942 retval
= usbtmc_ioctl_abort_bulk_in(data
);
945 mutex_unlock(&data
->io_mutex
);
949 static struct file_operations fops
= {
950 .owner
= THIS_MODULE
,
952 .write
= usbtmc_write
,
954 .release
= usbtmc_release
,
955 .unlocked_ioctl
= usbtmc_ioctl
,
958 static struct usb_class_driver usbtmc_class
= {
961 .minor_base
= USBTMC_MINOR_BASE
,
965 static int usbtmc_probe(struct usb_interface
*intf
,
966 const struct usb_device_id
*id
)
968 struct usbtmc_device_data
*data
;
969 struct usb_host_interface
*iface_desc
;
970 struct usb_endpoint_descriptor
*endpoint
;
974 dev_dbg(&intf
->dev
, "%s called\n", __func__
);
976 data
= kmalloc(sizeof(struct usbtmc_device_data
), GFP_KERNEL
);
978 dev_err(&intf
->dev
, "Unable to allocate kernel memory\n");
984 data
->usb_dev
= usb_get_dev(interface_to_usbdev(intf
));
985 usb_set_intfdata(intf
, data
);
986 kref_init(&data
->kref
);
987 mutex_init(&data
->io_mutex
);
989 /* Initialize USBTMC bTag and other fields */
991 data
->TermCharEnabled
= 0;
992 data
->TermChar
= '\n';
994 /* USBTMC devices have only one setting, so use that */
995 iface_desc
= data
->intf
->cur_altsetting
;
997 /* Find bulk in endpoint */
998 for (n
= 0; n
< iface_desc
->desc
.bNumEndpoints
; n
++) {
999 endpoint
= &iface_desc
->endpoint
[n
].desc
;
1001 if (usb_endpoint_is_bulk_in(endpoint
)) {
1002 data
->bulk_in
= endpoint
->bEndpointAddress
;
1003 dev_dbg(&intf
->dev
, "Found bulk in endpoint at %u\n",
1009 /* Find bulk out endpoint */
1010 for (n
= 0; n
< iface_desc
->desc
.bNumEndpoints
; n
++) {
1011 endpoint
= &iface_desc
->endpoint
[n
].desc
;
1013 if (usb_endpoint_is_bulk_out(endpoint
)) {
1014 data
->bulk_out
= endpoint
->bEndpointAddress
;
1015 dev_dbg(&intf
->dev
, "Found Bulk out endpoint at %u\n",
1021 retcode
= get_capabilities(data
);
1023 dev_err(&intf
->dev
, "can't read capabilities\n");
1025 retcode
= sysfs_create_group(&intf
->dev
.kobj
,
1026 &capability_attr_grp
);
1028 retcode
= sysfs_create_group(&intf
->dev
.kobj
, &data_attr_grp
);
1030 retcode
= usb_register_dev(intf
, &usbtmc_class
);
1032 dev_err(&intf
->dev
, "Not able to get a minor"
1033 " (base %u, slice default): %d\n", USBTMC_MINOR_BASE
,
1035 goto error_register
;
1037 dev_dbg(&intf
->dev
, "Using minor number %d\n", intf
->minor
);
1042 sysfs_remove_group(&intf
->dev
.kobj
, &capability_attr_grp
);
1043 sysfs_remove_group(&intf
->dev
.kobj
, &data_attr_grp
);
1044 kref_put(&data
->kref
, usbtmc_delete
);
1048 static void usbtmc_disconnect(struct usb_interface
*intf
)
1050 struct usbtmc_device_data
*data
;
1052 dev_dbg(&intf
->dev
, "usbtmc_disconnect called\n");
1054 data
= usb_get_intfdata(intf
);
1055 usb_deregister_dev(intf
, &usbtmc_class
);
1056 sysfs_remove_group(&intf
->dev
.kobj
, &capability_attr_grp
);
1057 sysfs_remove_group(&intf
->dev
.kobj
, &data_attr_grp
);
1058 kref_put(&data
->kref
, usbtmc_delete
);
1061 static struct usb_driver usbtmc_driver
= {
1063 .id_table
= usbtmc_devices
,
1064 .probe
= usbtmc_probe
,
1065 .disconnect
= usbtmc_disconnect
1068 static int __init
usbtmc_init(void)
1072 retcode
= usb_register(&usbtmc_driver
);
1074 printk(KERN_ERR KBUILD_MODNAME
": Unable to register driver\n");
1077 module_init(usbtmc_init
);
1079 static void __exit
usbtmc_exit(void)
1081 usb_deregister(&usbtmc_driver
);
1083 module_exit(usbtmc_exit
);
1085 MODULE_LICENSE("GPL");