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;
51 /* Some USBTMC-specific enums, as defined in the USBTMC standard. */
52 #define SUBCLASS_USBTMC 0x03
53 #define USBTMC_USB488 0x01
56 /* USBTMC control requests */
57 INITIATE_ABORT_BULK_OUT = 1,
58 CHECK_ABORT_BULK_OUT_STATUS = 2,
59 INITIATE_ABORT_BULK_IN = 3,
60 CHECK_ABORT_BULK_IN_STATUS = 4,
62 CHECK_CLEAR_STATUS = 6,
66 /* USB488 control requests */
67 READ_STATUS_BYTE = 128,
73 /* USBTMC status codes */
74 #define USBTMC_STATUS_SUCCESS 0x01
76 /* USBTMC capabilities */
77 #define USBTMC_INT_CAP_LISTEN_ONLY 0x01
78 #define USBTMC_INT_CAP_TALK_ONLY 0x02
79 #define USBTMC_INT_CAP_INDICATOR 0x04
81 #define USBTMC_DEV_CAP_TERMCHAR 0x01
83 #define USB488_DEV_CAP_DT1 0x01
84 #define USB488_DEV_CAP_RL1 0x02
85 #define USB488_DEV_CAP_SR1 0x04
86 #define USB488_DEV_CAP_SCPI 0x08
88 /* Bulk messages constants */
89 #define USBTMC_BULK_HEADER_SIZE 12
91 /* Bulk MsgID values */
92 #define DEV_DEP_MSG_OUT 1
93 #define REQUEST_DEV_DEP_MSG_IN 2
94 #define DEV_DEP_MSG_IN 2
96 /* bmTransferAttributes */
98 #define TERM_CHAR_ENABLED 0x02
100 static GSList *scpi_usbtmc_libusb_scan(struct drv_context *drvc)
102 struct libusb_device **devlist;
103 struct libusb_device_descriptor des;
104 struct libusb_config_descriptor *confdes;
105 const struct libusb_interface_descriptor *intfdes;
106 GSList *resources = NULL;
107 int confidx, intfidx, ret, i;
110 ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
112 sr_err("Failed to get device list: %s.",
113 libusb_error_name(ret));
116 for (i = 0; devlist[i]; i++) {
117 libusb_get_device_descriptor(devlist[i], &des);
119 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
120 if ((ret = libusb_get_config_descriptor(devlist[i], confidx, &confdes)) < 0) {
121 sr_dbg("Failed to get configuration descriptor: %s, "
122 "ignoring device.", libusb_error_name(ret));
125 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
126 intfdes = confdes->interface[intfidx].altsetting;
127 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
128 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
129 intfdes->bInterfaceProtocol != USBTMC_USB488)
131 sr_dbg("Found USBTMC device (VID:PID = %04x:%04x, "
132 "bus.address = %d.%d).", des.idVendor, des.idProduct,
133 libusb_get_bus_number(devlist[i]),
134 libusb_get_device_address(devlist[i]));
135 res = g_strdup_printf("usbtmc/%d.%d",
136 libusb_get_bus_number(devlist[i]),
137 libusb_get_device_address(devlist[i]));
138 resources = g_slist_append(resources, res);
140 libusb_free_config_descriptor(confdes);
143 libusb_free_device_list(devlist, 1);
145 sr_dbg("Found %d device(s).", g_slist_length(resources));
150 static int scpi_usbtmc_libusb_dev_inst_new(void *priv, struct drv_context *drvc,
151 const char *resource, char **params, const char *serialcomm)
153 struct scpi_usbtmc_libusb *uscpi = priv;
159 if (!params || !params[1]) {
160 sr_err("Invalid parameters.");
164 uscpi->ctx = drvc->sr_ctx;
165 devices = sr_usb_find(uscpi->ctx->libusb_ctx, params[1]);
166 if (g_slist_length(devices) != 1) {
167 sr_err("Failed to find USB device '%s'.", params[1]);
168 g_slist_free_full(devices, (GDestroyNotify)sr_usb_dev_inst_free);
171 uscpi->usb = devices->data;
172 g_slist_free(devices);
177 static int scpi_usbtmc_libusb_open(void *priv)
179 struct scpi_usbtmc_libusb *uscpi = priv;
180 struct sr_usb_dev_inst *usb = uscpi->usb;
181 struct libusb_device *dev;
182 struct libusb_device_descriptor des;
183 struct libusb_config_descriptor *confdes;
184 const struct libusb_interface_descriptor *intfdes;
185 const struct libusb_endpoint_descriptor *ep;
186 int confidx, intfidx, epidx, config = 0;
187 uint8_t capabilities[24], status;
193 if (sr_usb_open(uscpi->ctx->libusb_ctx, usb) != SR_OK)
196 dev = libusb_get_device(usb->devhdl);
197 libusb_get_device_descriptor(dev, &des);
199 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
200 if ((ret = libusb_get_config_descriptor(dev, confidx, &confdes)) < 0) {
201 sr_dbg("Failed to get configuration descriptor: %s, "
202 "ignoring device.", libusb_error_name(ret));
205 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
206 intfdes = confdes->interface[intfidx].altsetting;
207 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
208 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
209 intfdes->bInterfaceProtocol != USBTMC_USB488)
211 uscpi->interface = intfdes->bInterfaceNumber;
212 config = confdes->bConfigurationValue;
213 sr_dbg("Interface %d configuration %d.", uscpi->interface, config);
214 for (epidx = 0; epidx < intfdes->bNumEndpoints; epidx++) {
215 ep = &intfdes->endpoint[epidx];
216 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
217 !(ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK))) {
218 uscpi->bulk_out_ep = ep->bEndpointAddress;
219 sr_dbg("Bulk OUT EP %d", uscpi->bulk_out_ep);
221 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
222 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
223 uscpi->bulk_in_ep = ep->bEndpointAddress;
224 sr_dbg("Bulk IN EP %d", uscpi->bulk_in_ep & 0x7f);
226 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_INTERRUPT &&
227 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
228 uscpi->interrupt_ep = ep->bEndpointAddress;
229 sr_dbg("Interrupt EP %d", uscpi->interrupt_ep & 0x7f);
233 uscpi->rigol_ds1000 = des.idVendor == 0x1ab1 &&
234 des.idProduct == 0x0588;
236 libusb_free_config_descriptor(confdes);
242 sr_err("Failed to find USBTMC interface.");
246 if (libusb_kernel_driver_active(usb->devhdl, uscpi->interface) == 1) {
247 if ((ret = libusb_detach_kernel_driver(usb->devhdl,
248 uscpi->interface)) < 0) {
249 sr_err("Failed to detach kernel driver: %s.",
250 libusb_error_name(ret));
253 uscpi->detached_kernel_driver = 1;
256 if ((ret = libusb_set_configuration(usb->devhdl, config)) < 0) {
257 sr_err("Failed to set configuration: %s.",
258 libusb_error_name(ret));
262 if ((ret = libusb_claim_interface(usb->devhdl, uscpi->interface)) < 0) {
263 sr_err("Failed to claim interface: %s.",
264 libusb_error_name(ret));
268 if (!uscpi->rigol_ds1000) {
269 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_in_ep)) < 0) {
270 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
271 uscpi->bulk_in_ep, libusb_error_name(ret));
274 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_out_ep)) < 0) {
275 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
276 uscpi->bulk_out_ep, libusb_error_name(ret));
279 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->interrupt_ep)) < 0) {
280 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
281 uscpi->interrupt_ep, libusb_error_name(ret));
286 /* Get capabilities. */
287 ret = libusb_control_transfer(usb->devhdl,
289 LIBUSB_REQUEST_TYPE_CLASS |
290 LIBUSB_RECIPIENT_INTERFACE,
293 capabilities, sizeof(capabilities),
295 if (ret == sizeof(capabilities)) {
296 uscpi->usbtmc_int_cap = capabilities[ 4];
297 uscpi->usbtmc_dev_cap = capabilities[ 5];
298 uscpi->usb488_dev_cap = capabilities[15];
300 sr_dbg("Device capabilities: %s%s%s%s%s, %s, %s",
301 uscpi->usb488_dev_cap & USB488_DEV_CAP_SCPI ? "SCPI, " : "",
302 uscpi->usbtmc_dev_cap & USBTMC_DEV_CAP_TERMCHAR ? "TermChar, ": "",
303 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY? "L3, " :
304 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "" : "L4, ",
305 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "T5, " :
306 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY? "" : "T6, ",
307 uscpi->usb488_dev_cap & USB488_DEV_CAP_SR1 ? "SR1" : "SR0",
308 uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1 ? "RL1" : "RL0",
309 uscpi->usb488_dev_cap & USB488_DEV_CAP_DT1 ? "DT1" : "DT0");
311 if (uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1) {
312 sr_dbg("Locking out local control.");
313 ret = libusb_control_transfer(usb->devhdl,
315 LIBUSB_REQUEST_TYPE_CLASS |
316 LIBUSB_RECIPIENT_INTERFACE,
321 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
322 sr_dbg("Failed to enter REN state.");
325 ret = libusb_control_transfer(usb->devhdl,
327 LIBUSB_REQUEST_TYPE_CLASS |
328 LIBUSB_RECIPIENT_INTERFACE,
333 if (ret < 0 || status != USBTMC_STATUS_SUCCESS)
334 sr_dbg("Failed to enter local lockout state.");
340 static int scpi_usbtmc_libusb_source_add(struct sr_session *session,
341 void *priv, int events, int timeout, sr_receive_data_callback cb,
344 struct scpi_usbtmc_libusb *uscpi = priv;
346 return usb_source_add(session, uscpi->ctx, timeout, cb, cb_data);
349 static int scpi_usbtmc_libusb_source_remove(struct sr_session *session,
352 struct scpi_usbtmc_libusb *uscpi = priv;
353 return usb_source_remove(session, uscpi->ctx);
356 static void usbtmc_bulk_out_header_write(void *header, uint8_t MsgID,
358 uint32_t TransferSize,
359 uint8_t bmTransferAttributes,
362 W8(header+ 0, MsgID);
364 W8(header+ 2, ~bTag);
366 WL32(header+ 4, TransferSize);
367 W8(header+ 8, bmTransferAttributes);
368 W8(header+ 9, TermChar);
372 static int usbtmc_bulk_in_header_read(void *header, uint8_t MsgID,
374 int32_t *TransferSize,
375 uint8_t *bmTransferAttributes)
377 if (R8(header+0) != MsgID ||
378 R8(header+1) != bTag ||
379 R8(header+2) != (unsigned char)~bTag)
382 *TransferSize = RL32(header+4);
383 if (bmTransferAttributes)
384 *bmTransferAttributes = R8(header+8);
388 static int scpi_usbtmc_bulkout(struct scpi_usbtmc_libusb *uscpi,
389 uint8_t msg_id, const void *data, int32_t size,
390 uint8_t transfer_attributes)
392 struct sr_usb_dev_inst *usb = uscpi->usb;
393 int padded_size, ret, transferred;
395 if (data && size+USBTMC_BULK_HEADER_SIZE+3 > (int)sizeof(uscpi->buffer)) {
396 sr_err("USBTMC bulk out transfer is too big.");
401 uscpi->bTag += !uscpi->bTag; /* bTag == 0 is invalid so avoid it. */
403 usbtmc_bulk_out_header_write(uscpi->buffer, msg_id, uscpi->bTag,
404 size, transfer_attributes, 0);
406 memcpy(uscpi->buffer+USBTMC_BULK_HEADER_SIZE, data, size);
409 size += USBTMC_BULK_HEADER_SIZE;
410 padded_size = (size + 3) & ~0x3;
411 memset(uscpi->buffer+size, 0, padded_size - size);
413 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_out_ep,
414 uscpi->buffer, padded_size, &transferred,
417 sr_err("USBTMC bulk out transfer error: %s.",
418 libusb_error_name(ret));
422 if (transferred < padded_size) {
423 sr_dbg("USBTMC bulk out partial transfer (%d/%d bytes).",
424 transferred, padded_size);
428 return transferred - USBTMC_BULK_HEADER_SIZE;
431 static int scpi_usbtmc_bulkin_start(struct scpi_usbtmc_libusb *uscpi,
432 uint8_t msg_id, void *data, int32_t size,
433 uint8_t *transfer_attributes)
435 struct sr_usb_dev_inst *usb = uscpi->usb;
436 int ret, transferred, message_size;
438 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
439 &transferred, TRANSFER_TIMEOUT);
441 sr_err("USBTMC bulk in transfer error: %s.",
442 libusb_error_name(ret));
446 if (usbtmc_bulk_in_header_read(data, msg_id, uscpi->bTag, &message_size,
447 transfer_attributes) != SR_OK) {
448 sr_err("USBTMC invalid bulk in header.");
452 message_size += USBTMC_BULK_HEADER_SIZE;
453 uscpi->response_length = MIN(transferred, message_size);
454 uscpi->response_bytes_read = USBTMC_BULK_HEADER_SIZE;
455 uscpi->remaining_length = message_size - uscpi->response_length;
457 return transferred - USBTMC_BULK_HEADER_SIZE;
460 static int scpi_usbtmc_bulkin_continue(struct scpi_usbtmc_libusb *uscpi,
461 void *data, int size)
463 struct sr_usb_dev_inst *usb = uscpi->usb;
464 int ret, transferred;
466 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
467 &transferred, TRANSFER_TIMEOUT);
469 sr_err("USBTMC bulk in transfer error: %s.",
470 libusb_error_name(ret));
474 uscpi->response_length = MIN(transferred, uscpi->remaining_length);
475 uscpi->response_bytes_read = 0;
476 uscpi->remaining_length -= uscpi->response_length;
481 static int scpi_usbtmc_libusb_send(void *priv, const char *command)
483 struct scpi_usbtmc_libusb *uscpi = priv;
485 if (scpi_usbtmc_bulkout(uscpi, DEV_DEP_MSG_OUT,
486 command, strlen(command), EOM) <= 0)
489 sr_spew("Successfully sent SCPI command: '%s'.", command);
494 static int scpi_usbtmc_libusb_read_begin(void *priv)
496 struct scpi_usbtmc_libusb *uscpi = priv;
498 uscpi->remaining_length = 0;
500 if (scpi_usbtmc_bulkout(uscpi, REQUEST_DEV_DEP_MSG_IN,
501 NULL, INT32_MAX, 0) < 0)
503 if (scpi_usbtmc_bulkin_start(uscpi, DEV_DEP_MSG_IN,
504 uscpi->buffer, sizeof(uscpi->buffer),
505 &uscpi->bulkin_attributes) < 0)
511 static int scpi_usbtmc_libusb_read_data(void *priv, char *buf, int maxlen)
513 struct scpi_usbtmc_libusb *uscpi = priv;
516 if (uscpi->response_bytes_read >= uscpi->response_length) {
517 if (uscpi->remaining_length > 0) {
518 if (scpi_usbtmc_bulkin_continue(uscpi, uscpi->buffer,
519 sizeof(uscpi->buffer)) <= 0)
522 if (uscpi->bulkin_attributes & EOM)
524 if (scpi_usbtmc_libusb_read_begin(uscpi) < 0)
529 read_length = MIN(uscpi->response_length - uscpi->response_bytes_read, maxlen);
531 memcpy(buf, uscpi->buffer + uscpi->response_bytes_read, read_length);
533 uscpi->response_bytes_read += read_length;
538 static int scpi_usbtmc_libusb_read_complete(void *priv)
540 struct scpi_usbtmc_libusb *uscpi = priv;
541 return uscpi->response_bytes_read >= uscpi->response_length &&
542 uscpi->remaining_length <= 0 &&
543 uscpi->bulkin_attributes & EOM;
546 static int scpi_usbtmc_libusb_close(void *priv)
549 struct scpi_usbtmc_libusb *uscpi = priv;
550 struct sr_usb_dev_inst *usb = uscpi->usb;
556 if (!uscpi->rigol_ds1000) {
557 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_in_ep)) < 0)
558 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
559 uscpi->bulk_in_ep, libusb_error_name(ret));
560 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_out_ep)) < 0)
561 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
562 uscpi->bulk_out_ep, libusb_error_name(ret));
563 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->interrupt_ep)) < 0)
564 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
565 uscpi->interrupt_ep, libusb_error_name(ret));
568 if (uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1) {
569 sr_dbg("Returning local control.");
570 ret = libusb_control_transfer(usb->devhdl,
572 LIBUSB_REQUEST_TYPE_CLASS |
573 LIBUSB_RECIPIENT_INTERFACE,
578 if (ret < 0 || status != USBTMC_STATUS_SUCCESS)
579 sr_dbg("Failed to clear local lockout state.");
582 if ((ret = libusb_release_interface(usb->devhdl, uscpi->interface)) < 0)
583 sr_err("Failed to release interface: %s.",
584 libusb_error_name(ret));
586 if (uscpi->detached_kernel_driver) {
587 if ((ret = libusb_attach_kernel_driver(usb->devhdl,
588 uscpi->interface)) < 0)
589 sr_err("Failed to re-attach kernel driver: %s.",
590 libusb_error_name(ret));
592 uscpi->detached_kernel_driver = 0;
599 static void scpi_usbtmc_libusb_free(void *priv)
601 struct scpi_usbtmc_libusb *uscpi = priv;
602 sr_usb_dev_inst_free(uscpi->usb);
605 SR_PRIV const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev = {
608 .priv_size = sizeof(struct scpi_usbtmc_libusb),
609 .scan = scpi_usbtmc_libusb_scan,
610 .dev_inst_new = scpi_usbtmc_libusb_dev_inst_new,
611 .open = scpi_usbtmc_libusb_open,
612 .source_add = scpi_usbtmc_libusb_source_add,
613 .source_remove = scpi_usbtmc_libusb_source_remove,
614 .send = scpi_usbtmc_libusb_send,
615 .read_begin = scpi_usbtmc_libusb_read_begin,
616 .read_data = scpi_usbtmc_libusb_read_data,
617 .read_complete = scpi_usbtmc_libusb_read_complete,
618 .close = scpi_usbtmc_libusb_close,
619 .free = scpi_usbtmc_libusb_free,