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/>.
21 #include "libsigrok.h"
22 #include "libsigrok-internal.h"
24 #define LOG_PREFIX "scpi_usbtmc"
26 #define MAX_TRANSFER_LENGTH 2048
27 #define TRANSFER_TIMEOUT 1000
29 struct scpi_usbtmc_libusb {
30 struct sr_context *ctx;
31 struct sr_usb_dev_inst *usb;
32 int detached_kernel_driver;
37 uint8_t usbtmc_int_cap;
38 uint8_t usbtmc_dev_cap;
39 uint8_t usb488_dev_cap;
41 uint8_t bulkin_attributes;
42 uint8_t buffer[MAX_TRANSFER_LENGTH];
44 int response_bytes_read;
49 /* Some USBTMC-specific enums, as defined in the USBTMC standard. */
50 #define SUBCLASS_USBTMC 0x03
51 #define USBTMC_USB488 0x01
54 /* USBTMC control requests */
55 INITIATE_ABORT_BULK_OUT = 1,
56 CHECK_ABORT_BULK_OUT_STATUS = 2,
57 INITIATE_ABORT_BULK_IN = 3,
58 CHECK_ABORT_BULK_IN_STATUS = 4,
60 CHECK_CLEAR_STATUS = 6,
64 /* USB488 control requests */
65 READ_STATUS_BYTE = 128,
71 /* USBTMC capabilities */
72 #define USBTMC_INT_CAP_LISTEN_ONLY 0x01
73 #define USBTMC_INT_CAP_TALK_ONLY 0x02
74 #define USBTMC_INT_CAP_INDICATOR 0x04
76 #define USBTMC_DEV_CAP_TERMCHAR 0x01
78 #define USB488_DEV_CAP_DT1 0x01
79 #define USB488_DEV_CAP_RL1 0x02
80 #define USB488_DEV_CAP_SR1 0x04
81 #define USB488_DEV_CAP_SCPI 0x08
83 /* Bulk messages constants */
84 #define USBTMC_BULK_HEADER_SIZE 12
86 /* Bulk MsgID values */
87 #define DEV_DEP_MSG_OUT 1
88 #define REQUEST_DEV_DEP_MSG_IN 2
89 #define DEV_DEP_MSG_IN 2
91 /* bmTransferAttributes */
93 #define TERM_CHAR_ENABLED 0x02
96 static GSList *scpi_usbtmc_libusb_scan(struct drv_context *drvc)
98 struct libusb_device **devlist;
99 struct libusb_device_descriptor des;
100 struct libusb_config_descriptor *confdes;
101 const struct libusb_interface_descriptor *intfdes;
102 GSList *resources = NULL;
103 int confidx, intfidx, ret, i;
106 ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
108 sr_err("Failed to get device list: %s.",
109 libusb_error_name(ret));
112 for (i = 0; devlist[i]; i++) {
113 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
114 sr_err("Failed to get device descriptor: %s.",
115 libusb_error_name(ret));
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];
193 if (sr_usb_open(uscpi->ctx->libusb_ctx, usb) != SR_OK)
196 dev = libusb_get_device(usb->devhdl);
197 if ((ret = libusb_get_device_descriptor(dev, &des)) < 0) {
198 sr_err("Failed to get device descriptor: %s.",
199 libusb_error_name(ret));
203 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
204 if ((ret = libusb_get_config_descriptor(dev, confidx, &confdes)) < 0) {
205 sr_dbg("Failed to get configuration descriptor: %s, "
206 "ignoring device.", libusb_error_name(ret));
209 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
210 intfdes = confdes->interface[intfidx].altsetting;
211 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
212 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
213 intfdes->bInterfaceProtocol != USBTMC_USB488)
215 uscpi->interface = intfdes->bInterfaceNumber;
216 sr_dbg("Interface %d", uscpi->interface);
217 config = confdes->bConfigurationValue;
218 sr_dbg("Configuration %d", config);
219 for (epidx = 0; epidx < intfdes->bNumEndpoints; epidx++) {
220 ep = &intfdes->endpoint[epidx];
221 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
222 !(ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK))) {
223 uscpi->bulk_out_ep = ep->bEndpointAddress;
224 sr_dbg("Bulk OUT EP %d", uscpi->bulk_out_ep);
226 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
227 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
228 uscpi->bulk_in_ep = ep->bEndpointAddress;
229 sr_dbg("Bulk IN EP %d", uscpi->bulk_in_ep);
231 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_INTERRUPT &&
232 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
233 uscpi->interrupt_ep = ep->bEndpointAddress;
234 sr_dbg("Interrupt EP %d", uscpi->interrupt_ep);
238 uscpi->rigol_ds1000 = des.idVendor == 0x1ab1 &&
239 des.idProduct == 0x0588;
241 libusb_free_config_descriptor(confdes);
247 sr_err("Failed to find USBTMC interface.");
251 if (libusb_kernel_driver_active(usb->devhdl, uscpi->interface) == 1) {
252 if ((ret = libusb_detach_kernel_driver(usb->devhdl,
253 uscpi->interface)) < 0) {
254 sr_err("Failed to detach kernel driver: %s.",
255 libusb_error_name(ret));
258 uscpi->detached_kernel_driver = 1;
261 if ((ret = libusb_set_configuration(usb->devhdl, config)) < 0) {
262 sr_err("Failed to set configuration: %s.",
263 libusb_error_name(ret));
267 if ((ret = libusb_claim_interface(usb->devhdl, uscpi->interface)) < 0) {
268 sr_err("Failed to claim interface: %s.",
269 libusb_error_name(ret));
273 if (!uscpi->rigol_ds1000) {
274 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_in_ep)) < 0) {
275 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
276 uscpi->bulk_in_ep, libusb_error_name(ret));
279 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_out_ep)) < 0) {
280 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
281 uscpi->bulk_out_ep, libusb_error_name(ret));
284 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->interrupt_ep)) < 0) {
285 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
286 uscpi->interrupt_ep, libusb_error_name(ret));
291 /* Get capabilities. */
292 ret = libusb_control_transfer(usb->devhdl,
294 LIBUSB_REQUEST_TYPE_CLASS |
295 LIBUSB_RECIPIENT_INTERFACE,
298 capabilities, sizeof(capabilities),
300 if (ret == sizeof(capabilities)) {
301 uscpi->usbtmc_int_cap = capabilities[ 4];
302 uscpi->usbtmc_dev_cap = capabilities[ 5];
303 uscpi->usb488_dev_cap = capabilities[15];
305 sr_dbg("Device capabilities: %s%s%s%s%s, %s, %s",
306 uscpi->usb488_dev_cap & USB488_DEV_CAP_SCPI ? "SCPI, " : "",
307 uscpi->usbtmc_dev_cap & USBTMC_DEV_CAP_TERMCHAR ? "TermChar, ": "",
308 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY? "L3, " :
309 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "" : "L4, ",
310 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "T5, " :
311 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY? "" : "T6, ",
312 uscpi->usb488_dev_cap & USB488_DEV_CAP_SR1 ? "SR1" : "SR0",
313 uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1 ? "RL1" : "RL0",
314 uscpi->usb488_dev_cap & USB488_DEV_CAP_DT1 ? "DT1" : "DT0");
319 static int scpi_usbtmc_libusb_source_add(void *priv, int events, int timeout,
320 sr_receive_data_callback cb, void *cb_data)
322 struct scpi_usbtmc_libusb *uscpi = priv;
324 return usb_source_add(uscpi->ctx, timeout, cb, cb_data);
327 static int scpi_usbtmc_libusb_source_remove(void *priv)
329 struct scpi_usbtmc_libusb *uscpi = priv;
330 return usb_source_remove(uscpi->ctx);
333 static void usbtmc_bulk_out_header_write(void *header, uint8_t MsgID,
335 uint32_t TransferSize,
336 uint8_t bmTransferAttributes,
339 W8(header+ 0, MsgID);
341 W8(header+ 2, ~bTag);
343 WL32(header+ 4, TransferSize);
344 W8(header+ 8, bmTransferAttributes);
345 W8(header+ 9, TermChar);
349 static int usbtmc_bulk_in_header_read(void *header, uint8_t MsgID,
351 int32_t *TransferSize,
352 uint8_t *bmTransferAttributes)
354 if (R8(header+0) != MsgID ||
355 R8(header+1) != bTag ||
356 R8(header+2) != (unsigned char)~bTag)
359 *TransferSize = RL32(header+4);
360 if (bmTransferAttributes)
361 *bmTransferAttributes = R8(header+8);
365 static int scpi_usbtmc_bulkout(struct scpi_usbtmc_libusb *uscpi,
366 uint8_t msg_id, const void *data, int32_t size,
367 uint8_t transfer_attributes)
369 struct sr_usb_dev_inst *usb = uscpi->usb;
370 int padded_size, ret, transferred;
372 if (data && size+USBTMC_BULK_HEADER_SIZE+3 > (int)sizeof(uscpi->buffer)) {
373 sr_err("USBTMC bulk out transfer is too big.");
378 uscpi->bTag += !uscpi->bTag; /* bTag == 0 is invalid so avoid it. */
380 usbtmc_bulk_out_header_write(uscpi->buffer, msg_id, uscpi->bTag,
381 size, transfer_attributes, 0);
383 memcpy(uscpi->buffer+USBTMC_BULK_HEADER_SIZE, data, size);
386 size += USBTMC_BULK_HEADER_SIZE;
387 padded_size = (size + 3) & ~0x3;
388 memset(uscpi->buffer+size, 0, padded_size - size);
390 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_out_ep,
391 uscpi->buffer, padded_size, &transferred,
394 sr_err("USBTMC bulk out transfer error: %s.",
395 libusb_error_name(ret));
399 if (transferred < padded_size) {
400 sr_dbg("USBTMC bulk out partial transfer (%d/%d bytes).",
401 transferred, padded_size);
405 return transferred - USBTMC_BULK_HEADER_SIZE;
408 static int scpi_usbtmc_bulkin_start(struct scpi_usbtmc_libusb *uscpi,
409 uint8_t msg_id, void *data, int32_t size,
410 uint8_t *transfer_attributes)
412 struct sr_usb_dev_inst *usb = uscpi->usb;
413 int ret, transferred, message_size;
415 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
416 &transferred, TRANSFER_TIMEOUT);
418 sr_err("USBTMC bulk in transfer error: %s.",
419 libusb_error_name(ret));
423 if (usbtmc_bulk_in_header_read(data, msg_id, uscpi->bTag, &message_size,
424 transfer_attributes) != SR_OK) {
425 sr_err("USBTMC invalid bulk in header.");
429 message_size += USBTMC_BULK_HEADER_SIZE;
430 uscpi->response_length = MIN(transferred, message_size);
431 uscpi->response_bytes_read = USBTMC_BULK_HEADER_SIZE;
432 uscpi->remaining_length = message_size - uscpi->response_length;
434 return transferred - USBTMC_BULK_HEADER_SIZE;
437 static int scpi_usbtmc_bulkin_continue(struct scpi_usbtmc_libusb *uscpi,
438 void *data, int size)
440 struct sr_usb_dev_inst *usb = uscpi->usb;
441 int ret, transferred;
443 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
444 &transferred, TRANSFER_TIMEOUT);
446 sr_err("USBTMC bulk in transfer error: %s.",
447 libusb_error_name(ret));
451 uscpi->response_length = MIN(transferred, uscpi->remaining_length);
452 uscpi->response_bytes_read = 0;
453 uscpi->remaining_length -= uscpi->response_length;
458 static int scpi_usbtmc_libusb_send(void *priv, const char *command)
460 struct scpi_usbtmc_libusb *uscpi = priv;
462 if (scpi_usbtmc_bulkout(uscpi, DEV_DEP_MSG_OUT,
463 command, strlen(command), EOM) <= 0)
466 sr_spew("Successfully sent SCPI command: '%s'.", command);
471 static int scpi_usbtmc_libusb_read_begin(void *priv)
473 struct scpi_usbtmc_libusb *uscpi = priv;
475 uscpi->remaining_length = 0;
477 if (scpi_usbtmc_bulkout(uscpi, REQUEST_DEV_DEP_MSG_IN,
478 NULL, INT32_MAX, 0) < 0)
480 if (scpi_usbtmc_bulkin_start(uscpi, DEV_DEP_MSG_IN,
481 uscpi->buffer, sizeof(uscpi->buffer),
482 &uscpi->bulkin_attributes) < 0)
488 static int scpi_usbtmc_libusb_read_data(void *priv, char *buf, int maxlen)
490 struct scpi_usbtmc_libusb *uscpi = priv;
493 if (uscpi->response_bytes_read >= uscpi->response_length) {
494 if (uscpi->remaining_length > 0) {
495 if (scpi_usbtmc_bulkin_continue(uscpi, uscpi->buffer,
496 sizeof(uscpi->buffer)) <= 0)
499 if (uscpi->bulkin_attributes & EOM)
501 if (scpi_usbtmc_libusb_read_begin(uscpi) < 0)
506 read_length = MIN(uscpi->response_length - uscpi->response_bytes_read, maxlen);
508 memcpy(buf, uscpi->buffer + uscpi->response_bytes_read, read_length);
510 uscpi->response_bytes_read += read_length;
515 static int scpi_usbtmc_libusb_read_complete(void *priv)
517 struct scpi_usbtmc_libusb *uscpi = priv;
518 return uscpi->response_bytes_read >= uscpi->response_length &&
519 uscpi->remaining_length <= 0 &&
520 uscpi->bulkin_attributes & EOM;
523 static int scpi_usbtmc_libusb_close(void *priv)
526 struct scpi_usbtmc_libusb *uscpi = priv;
527 struct sr_usb_dev_inst *usb = uscpi->usb;
532 if (!uscpi->rigol_ds1000) {
533 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_in_ep)) < 0)
534 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
535 uscpi->bulk_in_ep, libusb_error_name(ret));
536 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_out_ep)) < 0)
537 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
538 uscpi->bulk_out_ep, libusb_error_name(ret));
539 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->interrupt_ep)) < 0)
540 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
541 uscpi->interrupt_ep, libusb_error_name(ret));
544 if ((ret = libusb_release_interface(usb->devhdl, uscpi->interface)) < 0)
545 sr_err("Failed to release interface: %s.",
546 libusb_error_name(ret));
548 if (uscpi->detached_kernel_driver) {
549 if ((ret = libusb_attach_kernel_driver(usb->devhdl,
550 uscpi->interface)) < 0)
551 sr_err("Failed to re-attach kernel driver: %s.",
552 libusb_error_name(ret));
554 uscpi->detached_kernel_driver = 0;
556 libusb_close(usb->devhdl);
562 static void scpi_usbtmc_libusb_free(void *priv)
564 struct scpi_usbtmc_libusb *uscpi = priv;
565 sr_usb_dev_inst_free(uscpi->usb);
568 SR_PRIV const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev = {
571 .priv_size = sizeof(struct scpi_usbtmc_libusb),
572 .scan = scpi_usbtmc_libusb_scan,
573 .dev_inst_new = scpi_usbtmc_libusb_dev_inst_new,
574 .open = scpi_usbtmc_libusb_open,
575 .source_add = scpi_usbtmc_libusb_source_add,
576 .source_remove = scpi_usbtmc_libusb_source_remove,
577 .send = scpi_usbtmc_libusb_send,
578 .read_begin = scpi_usbtmc_libusb_read_begin,
579 .read_data = scpi_usbtmc_libusb_read_data,
580 .read_complete = scpi_usbtmc_libusb_read_complete,
581 .close = scpi_usbtmc_libusb_close,
582 .free = scpi_usbtmc_libusb_free,