2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include <libsigrok/libsigrok.h>
23 #include "libsigrok-internal.h"
26 #define LOG_PREFIX "scpi_usbtmc"
28 #define MAX_TRANSFER_LENGTH 2048
29 #define TRANSFER_TIMEOUT 1000
31 struct scpi_usbtmc_libusb {
32 struct sr_context *ctx;
33 struct sr_usb_dev_inst *usb;
34 int detached_kernel_driver;
39 uint8_t usbtmc_int_cap;
40 uint8_t usbtmc_dev_cap;
41 uint8_t usb488_dev_cap;
43 uint8_t bulkin_attributes;
44 uint8_t buffer[MAX_TRANSFER_LENGTH];
46 int response_bytes_read;
50 /* Some USBTMC-specific enums, as defined in the USBTMC standard. */
51 #define SUBCLASS_USBTMC 0x03
52 #define USBTMC_USB488 0x01
55 /* USBTMC control requests */
56 INITIATE_ABORT_BULK_OUT = 1,
57 CHECK_ABORT_BULK_OUT_STATUS = 2,
58 INITIATE_ABORT_BULK_IN = 3,
59 CHECK_ABORT_BULK_IN_STATUS = 4,
61 CHECK_CLEAR_STATUS = 6,
65 /* USB488 control requests */
66 READ_STATUS_BYTE = 128,
72 /* USBTMC status codes */
73 #define USBTMC_STATUS_SUCCESS 0x01
75 /* USBTMC capabilities */
76 #define USBTMC_INT_CAP_LISTEN_ONLY 0x01
77 #define USBTMC_INT_CAP_TALK_ONLY 0x02
78 #define USBTMC_INT_CAP_INDICATOR 0x04
80 #define USBTMC_DEV_CAP_TERMCHAR 0x01
82 #define USB488_DEV_CAP_DT1 0x01
83 #define USB488_DEV_CAP_RL1 0x02
84 #define USB488_DEV_CAP_SR1 0x04
85 #define USB488_DEV_CAP_SCPI 0x08
87 /* Bulk messages constants */
88 #define USBTMC_BULK_HEADER_SIZE 12
90 /* Bulk MsgID values */
91 #define DEV_DEP_MSG_OUT 1
92 #define REQUEST_DEV_DEP_MSG_IN 2
93 #define DEV_DEP_MSG_IN 2
95 /* bmTransferAttributes */
97 #define TERM_CHAR_ENABLED 0x02
99 struct usbtmc_blacklist {
104 /* Devices that publish RL1 support, but don't support it. */
105 static struct usbtmc_blacklist blacklist_remote[] = {
106 { 0x1ab1, 0x0588 }, /* Rigol DS1000 series */
107 { 0x1ab1, 0x04b0 }, /* Rigol DS2000 series */
108 { 0x0957, 0x0588 }, /* Agilent DSO1000 series (rebadged Rigol DS1000) */
109 { 0x0b21, 0xffff }, /* All Yokogawa devices */
110 { 0xf4ec, 0xffff }, /* All Siglent SDS devices */
114 /* Devices that shall get reset during open(). */
115 static struct usbtmc_blacklist whitelist_usb_reset[] = {
116 { 0xf4ec, 0xffff }, /* All Siglent SDS devices */
120 static GSList *scpi_usbtmc_libusb_scan(struct drv_context *drvc)
122 struct libusb_device **devlist;
123 struct libusb_device_descriptor des;
124 struct libusb_config_descriptor *confdes;
125 const struct libusb_interface_descriptor *intfdes;
126 GSList *resources = NULL;
127 int confidx, intfidx, ret, i;
130 ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
132 sr_err("Failed to get device list: %s.",
133 libusb_error_name(ret));
136 for (i = 0; devlist[i]; i++) {
137 libusb_get_device_descriptor(devlist[i], &des);
139 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
140 if ((ret = libusb_get_config_descriptor(devlist[i], confidx, &confdes)) < 0) {
141 if (ret != LIBUSB_ERROR_NOT_FOUND)
142 sr_dbg("Failed to get configuration descriptor: %s, "
143 "ignoring device.", libusb_error_name(ret));
146 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
147 intfdes = confdes->interface[intfidx].altsetting;
148 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
149 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
150 intfdes->bInterfaceProtocol != USBTMC_USB488)
152 sr_dbg("Found USBTMC device (VID:PID = %04x:%04x, "
153 "bus.address = %d.%d).", des.idVendor, des.idProduct,
154 libusb_get_bus_number(devlist[i]),
155 libusb_get_device_address(devlist[i]));
156 res = g_strdup_printf("usbtmc/%d.%d",
157 libusb_get_bus_number(devlist[i]),
158 libusb_get_device_address(devlist[i]));
159 resources = g_slist_append(resources, res);
161 libusb_free_config_descriptor(confdes);
164 libusb_free_device_list(devlist, 1);
166 /* No log message for #devices found (caller will log that). */
171 static int scpi_usbtmc_libusb_dev_inst_new(void *priv, struct drv_context *drvc,
172 const char *resource, char **params, const char *serialcomm)
174 struct scpi_usbtmc_libusb *uscpi = priv;
180 if (!params || !params[1]) {
181 sr_err("Invalid parameters.");
185 uscpi->ctx = drvc->sr_ctx;
186 devices = sr_usb_find(uscpi->ctx->libusb_ctx, params[1]);
187 if (g_slist_length(devices) != 1) {
188 sr_err("Failed to find USB device '%s'.", params[1]);
189 g_slist_free_full(devices, (GDestroyNotify)sr_usb_dev_inst_free);
192 uscpi->usb = devices->data;
193 g_slist_free(devices);
198 static int check_usbtmc_blacklist(struct usbtmc_blacklist *blacklist,
199 uint16_t vid, uint16_t pid)
203 for (i = 0; blacklist[i].vid; i++) {
204 if ((blacklist[i].vid == vid && blacklist[i].pid == 0xFFFF) ||
205 (blacklist[i].vid == vid && blacklist[i].pid == pid))
212 static int scpi_usbtmc_remote(struct scpi_usbtmc_libusb *uscpi)
214 struct sr_usb_dev_inst *usb = uscpi->usb;
215 struct libusb_device *dev;
216 struct libusb_device_descriptor des;
220 if (!(uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1))
223 dev = libusb_get_device(usb->devhdl);
224 libusb_get_device_descriptor(dev, &des);
225 if (check_usbtmc_blacklist(blacklist_remote, des.idVendor, des.idProduct))
228 sr_dbg("Locking out local control.");
229 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
230 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
231 REN_CONTROL, 1, uscpi->interface, &status, 1, TRANSFER_TIMEOUT);
232 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
234 sr_dbg("Failed to enter REN state: %s.", libusb_error_name(ret));
236 sr_dbg("Failed to enter REN state: USBTMC status %d.", status);
240 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
241 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
242 LOCAL_LOCKOUT, 0, uscpi->interface, &status, 1,
244 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
246 sr_dbg("Failed to enter local lockout state: %s.",
247 libusb_error_name(ret));
249 sr_dbg("Failed to enter local lockout state: USBTMC "
250 "status %d.", status);
257 static void scpi_usbtmc_local(struct scpi_usbtmc_libusb *uscpi)
259 struct sr_usb_dev_inst *usb = uscpi->usb;
260 struct libusb_device *dev;
261 struct libusb_device_descriptor des;
265 if (!(uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1))
268 dev = libusb_get_device(usb->devhdl);
269 libusb_get_device_descriptor(dev, &des);
270 if (check_usbtmc_blacklist(blacklist_remote, des.idVendor, des.idProduct))
273 sr_dbg("Returning local control.");
274 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
275 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
276 GO_TO_LOCAL, 0, uscpi->interface, &status, 1, TRANSFER_TIMEOUT);
277 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
279 sr_dbg("Failed to clear local lockout state: %s.",
280 libusb_error_name(ret));
282 sr_dbg("Failed to clear local lockout state: USBTMC "
283 "status %d.", status);
289 static int scpi_usbtmc_libusb_open(struct sr_scpi_dev_inst *scpi)
291 struct scpi_usbtmc_libusb *uscpi = scpi->priv;
292 struct sr_usb_dev_inst *usb = uscpi->usb;
293 struct libusb_device *dev;
294 struct libusb_device_descriptor des;
295 struct libusb_config_descriptor *confdes;
296 const struct libusb_interface_descriptor *intfdes;
297 const struct libusb_endpoint_descriptor *ep;
298 int confidx, intfidx, epidx, config = 0, current_config;
299 uint8_t capabilities[24];
306 if (sr_usb_open(uscpi->ctx->libusb_ctx, usb) != SR_OK)
309 dev = libusb_get_device(usb->devhdl);
310 libusb_get_device_descriptor(dev, &des);
312 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
313 if ((ret = libusb_get_config_descriptor(dev, confidx, &confdes)) < 0) {
314 if (ret != LIBUSB_ERROR_NOT_FOUND)
315 sr_dbg("Failed to get configuration descriptor: %s, "
316 "ignoring device.", libusb_error_name(ret));
319 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
320 intfdes = confdes->interface[intfidx].altsetting;
321 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
322 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
323 intfdes->bInterfaceProtocol != USBTMC_USB488)
325 uscpi->interface = intfdes->bInterfaceNumber;
326 config = confdes->bConfigurationValue;
327 sr_dbg("Interface %d configuration %d.", uscpi->interface, config);
328 for (epidx = 0; epidx < intfdes->bNumEndpoints; epidx++) {
329 ep = &intfdes->endpoint[epidx];
330 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
331 !(ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK))) {
332 uscpi->bulk_out_ep = ep->bEndpointAddress;
333 sr_dbg("Bulk OUT EP %d", uscpi->bulk_out_ep);
335 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
336 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
337 uscpi->bulk_in_ep = ep->bEndpointAddress;
338 sr_dbg("Bulk IN EP %d", uscpi->bulk_in_ep & 0x7f);
340 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_INTERRUPT &&
341 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
342 uscpi->interrupt_ep = ep->bEndpointAddress;
343 sr_dbg("Interrupt EP %d", uscpi->interrupt_ep & 0x7f);
348 libusb_free_config_descriptor(confdes);
354 sr_err("Failed to find USBTMC interface.");
358 if (libusb_kernel_driver_active(usb->devhdl, uscpi->interface) == 1) {
359 if ((ret = libusb_detach_kernel_driver(usb->devhdl,
360 uscpi->interface)) < 0) {
361 sr_err("Failed to detach kernel driver: %s.",
362 libusb_error_name(ret));
365 uscpi->detached_kernel_driver = 1;
368 if (libusb_get_configuration(usb->devhdl, ¤t_config) == 0
369 && current_config != config) {
370 if ((ret = libusb_set_configuration(usb->devhdl, config)) < 0) {
371 sr_err("Failed to set configuration: %s.",
372 libusb_error_name(ret));
377 if ((ret = libusb_claim_interface(usb->devhdl, uscpi->interface)) < 0) {
378 sr_err("Failed to claim interface: %s.",
379 libusb_error_name(ret));
383 /* Optionally reset the USB device. */
384 do_reset = check_usbtmc_blacklist(whitelist_usb_reset,
385 des.idVendor, des.idProduct);
387 libusb_reset_device(usb->devhdl);
389 /* Get capabilities. */
390 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
391 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
392 GET_CAPABILITIES, 0, uscpi->interface, capabilities,
393 sizeof(capabilities), TRANSFER_TIMEOUT);
394 if (ret == sizeof(capabilities)) {
395 uscpi->usbtmc_int_cap = capabilities[ 4];
396 uscpi->usbtmc_dev_cap = capabilities[ 5];
397 uscpi->usb488_dev_cap = capabilities[15];
399 sr_dbg("Device capabilities: %s%s%s%s%s, %s, %s",
400 uscpi->usb488_dev_cap & USB488_DEV_CAP_SCPI ? "SCPI, " : "",
401 uscpi->usbtmc_dev_cap & USBTMC_DEV_CAP_TERMCHAR ? "TermChar, ": "",
402 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY ? "L3, " :
403 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "" : "L4, ",
404 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "T5, " :
405 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY ? "" : "T6, ",
406 uscpi->usb488_dev_cap & USB488_DEV_CAP_SR1 ? "SR1" : "SR0",
407 uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1 ? "RL1" : "RL0",
408 uscpi->usb488_dev_cap & USB488_DEV_CAP_DT1 ? "DT1" : "DT0");
410 scpi_usbtmc_remote(uscpi);
415 static int scpi_usbtmc_libusb_source_add(struct sr_session *session,
416 void *priv, int events, int timeout, sr_receive_data_callback cb,
419 struct scpi_usbtmc_libusb *uscpi = priv;
421 return usb_source_add(session, uscpi->ctx, timeout, cb, cb_data);
424 static int scpi_usbtmc_libusb_source_remove(struct sr_session *session,
427 struct scpi_usbtmc_libusb *uscpi = priv;
428 return usb_source_remove(session, uscpi->ctx);
431 static void usbtmc_bulk_out_header_write(void *header, uint8_t MsgID,
433 uint32_t TransferSize,
434 uint8_t bmTransferAttributes,
437 W8(header + 0, MsgID);
438 W8(header + 1, bTag);
439 W8(header + 2, ~bTag);
441 WL32(header + 4, TransferSize);
442 W8(header + 8, bmTransferAttributes);
443 W8(header + 9, TermChar);
444 WL16(header + 10, 0);
447 static int usbtmc_bulk_in_header_read(void *header, uint8_t MsgID,
449 int32_t *TransferSize,
450 uint8_t *bmTransferAttributes)
452 if (R8(header + 0) != MsgID ||
453 R8(header + 1) != bTag ||
454 R8(header + 2) != (unsigned char)~bTag)
457 *TransferSize = RL32(header + 4);
458 if (bmTransferAttributes)
459 *bmTransferAttributes = R8(header + 8);
464 static int scpi_usbtmc_bulkout(struct scpi_usbtmc_libusb *uscpi,
465 uint8_t msg_id, const void *data, int32_t size,
466 uint8_t transfer_attributes)
468 struct sr_usb_dev_inst *usb = uscpi->usb;
469 int padded_size, ret, transferred;
471 if (data && (size + USBTMC_BULK_HEADER_SIZE + 3) > (int)sizeof(uscpi->buffer)) {
472 sr_err("USBTMC bulk out transfer is too big.");
477 uscpi->bTag += !uscpi->bTag; /* bTag == 0 is invalid so avoid it. */
479 usbtmc_bulk_out_header_write(uscpi->buffer, msg_id, uscpi->bTag,
480 size, transfer_attributes, 0);
482 memcpy(uscpi->buffer + USBTMC_BULK_HEADER_SIZE, data, size);
485 size += USBTMC_BULK_HEADER_SIZE;
486 padded_size = (size + 3) & ~0x3;
487 memset(uscpi->buffer + size, 0, padded_size - size);
489 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_out_ep,
490 uscpi->buffer, padded_size, &transferred,
493 sr_err("USBTMC bulk out transfer error: %s.",
494 libusb_error_name(ret));
498 if (transferred < padded_size) {
499 sr_dbg("USBTMC bulk out partial transfer (%d/%d bytes).",
500 transferred, padded_size);
504 return transferred - USBTMC_BULK_HEADER_SIZE;
507 static int scpi_usbtmc_bulkin_start(struct scpi_usbtmc_libusb *uscpi,
508 uint8_t msg_id, void *data, int32_t size,
509 uint8_t *transfer_attributes)
511 struct sr_usb_dev_inst *usb = uscpi->usb;
512 int ret, transferred, message_size;
514 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
515 &transferred, TRANSFER_TIMEOUT);
517 sr_err("USBTMC bulk in transfer error: %s.",
518 libusb_error_name(ret));
522 if (usbtmc_bulk_in_header_read(data, msg_id, uscpi->bTag, &message_size,
523 transfer_attributes) != SR_OK) {
524 sr_err("USBTMC invalid bulk in header.");
528 message_size += USBTMC_BULK_HEADER_SIZE;
529 uscpi->response_length = MIN(transferred, message_size);
530 uscpi->response_bytes_read = USBTMC_BULK_HEADER_SIZE;
531 uscpi->remaining_length = message_size - uscpi->response_length;
533 return transferred - USBTMC_BULK_HEADER_SIZE;
536 static int scpi_usbtmc_bulkin_continue(struct scpi_usbtmc_libusb *uscpi,
537 void *data, int size)
539 struct sr_usb_dev_inst *usb = uscpi->usb;
540 int ret, transferred;
542 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
543 &transferred, TRANSFER_TIMEOUT);
545 sr_err("USBTMC bulk in transfer error: %s.",
546 libusb_error_name(ret));
550 uscpi->response_length = MIN(transferred, uscpi->remaining_length);
551 uscpi->response_bytes_read = 0;
552 uscpi->remaining_length -= uscpi->response_length;
557 static int scpi_usbtmc_libusb_send(void *priv, const char *command)
559 struct scpi_usbtmc_libusb *uscpi = priv;
561 if (scpi_usbtmc_bulkout(uscpi, DEV_DEP_MSG_OUT,
562 command, strlen(command), EOM) <= 0)
565 sr_spew("Successfully sent SCPI command: '%s'.", command);
570 static int scpi_usbtmc_libusb_read_begin(void *priv)
572 struct scpi_usbtmc_libusb *uscpi = priv;
574 uscpi->remaining_length = 0;
576 if (scpi_usbtmc_bulkout(uscpi, REQUEST_DEV_DEP_MSG_IN,
577 NULL, INT32_MAX, 0) < 0)
579 if (scpi_usbtmc_bulkin_start(uscpi, DEV_DEP_MSG_IN,
580 uscpi->buffer, sizeof(uscpi->buffer),
581 &uscpi->bulkin_attributes) < 0)
587 static int scpi_usbtmc_libusb_read_data(void *priv, char *buf, int maxlen)
589 struct scpi_usbtmc_libusb *uscpi = priv;
592 if (uscpi->response_bytes_read >= uscpi->response_length) {
593 if (uscpi->remaining_length > 0) {
594 if (scpi_usbtmc_bulkin_continue(uscpi, uscpi->buffer,
595 sizeof(uscpi->buffer)) <= 0)
598 if (uscpi->bulkin_attributes & EOM)
600 if (scpi_usbtmc_libusb_read_begin(uscpi) < 0)
605 read_length = MIN(uscpi->response_length - uscpi->response_bytes_read, maxlen);
607 memcpy(buf, uscpi->buffer + uscpi->response_bytes_read, read_length);
609 uscpi->response_bytes_read += read_length;
614 static int scpi_usbtmc_libusb_read_complete(void *priv)
616 struct scpi_usbtmc_libusb *uscpi = priv;
617 return uscpi->response_bytes_read >= uscpi->response_length &&
618 uscpi->remaining_length <= 0 &&
619 uscpi->bulkin_attributes & EOM;
622 static int scpi_usbtmc_libusb_close(struct sr_scpi_dev_inst *scpi)
624 struct scpi_usbtmc_libusb *uscpi = scpi->priv;
625 struct sr_usb_dev_inst *usb = uscpi->usb;
631 scpi_usbtmc_local(uscpi);
633 if ((ret = libusb_release_interface(usb->devhdl, uscpi->interface)) < 0)
634 sr_err("Failed to release interface: %s.",
635 libusb_error_name(ret));
637 if (uscpi->detached_kernel_driver) {
638 if ((ret = libusb_attach_kernel_driver(usb->devhdl,
639 uscpi->interface)) < 0)
640 sr_err("Failed to re-attach kernel driver: %s.",
641 libusb_error_name(ret));
643 uscpi->detached_kernel_driver = 0;
650 static void scpi_usbtmc_libusb_free(void *priv)
652 struct scpi_usbtmc_libusb *uscpi = priv;
653 sr_usb_dev_inst_free(uscpi->usb);
656 SR_PRIV const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev = {
659 .priv_size = sizeof(struct scpi_usbtmc_libusb),
660 .scan = scpi_usbtmc_libusb_scan,
661 .dev_inst_new = scpi_usbtmc_libusb_dev_inst_new,
662 .open = scpi_usbtmc_libusb_open,
663 .source_add = scpi_usbtmc_libusb_source_add,
664 .source_remove = scpi_usbtmc_libusb_source_remove,
665 .send = scpi_usbtmc_libusb_send,
666 .read_begin = scpi_usbtmc_libusb_read_begin,
667 .read_data = scpi_usbtmc_libusb_read_data,
668 .read_complete = scpi_usbtmc_libusb_read_complete,
669 .close = scpi_usbtmc_libusb_close,
670 .free = scpi_usbtmc_libusb_free,