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;
48 /* Some USBTMC-specific enums, as defined in the USBTMC standard. */
49 #define SUBCLASS_USBTMC 0x03
50 #define USBTMC_USB488 0x01
53 /* USBTMC control requests */
54 INITIATE_ABORT_BULK_OUT = 1,
55 CHECK_ABORT_BULK_OUT_STATUS = 2,
56 INITIATE_ABORT_BULK_IN = 3,
57 CHECK_ABORT_BULK_IN_STATUS = 4,
59 CHECK_CLEAR_STATUS = 6,
63 /* USB488 control requests */
64 READ_STATUS_BYTE = 128,
70 /* USBTMC capabilities */
71 #define USBTMC_INT_CAP_LISTEN_ONLY 0x01
72 #define USBTMC_INT_CAP_TALK_ONLY 0x02
73 #define USBTMC_INT_CAP_INDICATOR 0x04
75 #define USBTMC_DEV_CAP_TERMCHAR 0x01
77 #define USB488_DEV_CAP_DT1 0x01
78 #define USB488_DEV_CAP_RL1 0x02
79 #define USB488_DEV_CAP_SR1 0x04
80 #define USB488_DEV_CAP_SCPI 0x08
82 /* Bulk messages constants */
83 #define USBTMC_BULK_HEADER_SIZE 12
85 /* Bulk MsgID values */
86 #define DEV_DEP_MSG_OUT 1
87 #define REQUEST_DEV_DEP_MSG_IN 2
88 #define DEV_DEP_MSG_IN 2
90 /* bmTransferAttributes */
92 #define TERM_CHAR_ENABLED 0x02
95 static GSList *scpi_usbtmc_libusb_scan(struct drv_context *drvc)
97 struct libusb_device **devlist;
98 struct libusb_device_descriptor des;
99 struct libusb_config_descriptor *confdes;
100 const struct libusb_interface_descriptor *intfdes;
101 GSList *resources = NULL;
102 int confidx, intfidx, ret, i;
105 ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
107 sr_err("Failed to get device list: %s.",
108 libusb_error_name(ret));
111 for (i = 0; devlist[i]; i++) {
112 if ((ret = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
113 sr_err("Failed to get device descriptor: %s.",
114 libusb_error_name(ret));
118 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
119 if (libusb_get_config_descriptor(devlist[i], confidx, &confdes) < 0) {
120 sr_err("Failed to get configuration descriptor: %s.",
121 libusb_error_name(ret));
124 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
125 intfdes = confdes->interface[intfidx].altsetting;
126 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
127 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
128 intfdes->bInterfaceProtocol != USBTMC_USB488)
130 sr_dbg("Found USBTMC device (VID:PID = %04x:%04x, "
131 "bus.address = %d.%d).", des.idVendor, des.idProduct,
132 libusb_get_bus_number(devlist[i]),
133 libusb_get_device_address(devlist[i]));
134 res = g_strdup_printf("usbtmc/%d.%d",
135 libusb_get_bus_number(devlist[i]),
136 libusb_get_device_address(devlist[i]));
137 resources = g_slist_append(resources, res);
139 libusb_free_config_descriptor(confdes);
142 libusb_free_device_list(devlist, 1);
144 sr_dbg("Found %d device(s).", g_slist_length(resources));
149 static int scpi_usbtmc_libusb_dev_inst_new(void *priv, struct drv_context *drvc,
150 const char *resource, char **params, const char *serialcomm)
152 struct scpi_usbtmc_libusb *uscpi = priv;
158 if (!params || !params[1]) {
159 sr_err("Invalid parameters.");
163 uscpi->ctx = drvc->sr_ctx;
164 devices = sr_usb_find(uscpi->ctx->libusb_ctx, params[1]);
165 if (g_slist_length(devices) != 1) {
166 sr_err("Failed to find USB device '%s'.", params[1]);
167 g_slist_free_full(devices, (GDestroyNotify)sr_usb_dev_inst_free);
170 uscpi->usb = devices->data;
171 g_slist_free(devices);
176 static int scpi_usbtmc_libusb_open(void *priv)
178 struct scpi_usbtmc_libusb *uscpi = priv;
179 struct sr_usb_dev_inst *usb = uscpi->usb;
180 struct libusb_device *dev;
181 struct libusb_device_descriptor des;
182 struct libusb_config_descriptor *confdes;
183 const struct libusb_interface_descriptor *intfdes;
184 const struct libusb_endpoint_descriptor *ep;
185 int confidx, intfidx, epidx, config = 0;
186 uint8_t capabilities[24];
192 if (sr_usb_open(uscpi->ctx->libusb_ctx, usb) != SR_OK)
195 dev = libusb_get_device(usb->devhdl);
196 if ((ret = libusb_get_device_descriptor(dev, &des)) < 0) {
197 sr_err("Failed to get device descriptor: %s.",
198 libusb_error_name(ret));
202 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
203 if (libusb_get_config_descriptor(dev, confidx, &confdes) < 0) {
204 sr_err("Failed to get configuration descriptor: %s.",
205 libusb_error_name(ret));
208 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
209 intfdes = confdes->interface[intfidx].altsetting;
210 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
211 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
212 intfdes->bInterfaceProtocol != USBTMC_USB488)
214 uscpi->interface = intfdes->bInterfaceNumber;
215 sr_dbg("Interface %d", uscpi->interface);
216 config = confdes->bConfigurationValue;
217 sr_dbg("Configuration %d", config);
218 for (epidx = 0; epidx < intfdes->bNumEndpoints; epidx++) {
219 ep = &intfdes->endpoint[epidx];
220 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
221 !(ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK))) {
222 uscpi->bulk_out_ep = ep->bEndpointAddress;
223 sr_dbg("Bulk OUT EP %d", uscpi->bulk_out_ep);
225 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
226 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
227 uscpi->bulk_in_ep = ep->bEndpointAddress;
228 sr_dbg("Bulk IN EP %d", uscpi->bulk_in_ep);
230 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_INTERRUPT &&
231 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
232 uscpi->interrupt_ep = ep->bEndpointAddress;
233 sr_dbg("Interrupt EP %d", uscpi->interrupt_ep);
238 libusb_free_config_descriptor(confdes);
244 sr_err("Failed to find USBTMC interface.");
248 if (libusb_kernel_driver_active(usb->devhdl, uscpi->interface) == 1) {
249 if ((ret = libusb_detach_kernel_driver(usb->devhdl,
250 uscpi->interface)) < 0) {
251 sr_err("Failed to detach kernel driver: %s.",
252 libusb_error_name(ret));
255 uscpi->detached_kernel_driver = 1;
258 if ((ret = libusb_set_configuration(usb->devhdl, config)) < 0) {
259 sr_err("Failed to set configuration: %s.",
260 libusb_error_name(ret));
264 if ((ret = libusb_claim_interface(usb->devhdl, uscpi->interface)) < 0) {
265 sr_err("Failed to claim interface: %s.",
266 libusb_error_name(ret));
270 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_in_ep)) < 0) {
271 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
272 uscpi->bulk_in_ep, libusb_error_name(ret));
275 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_out_ep)) < 0) {
276 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
277 uscpi->bulk_out_ep, libusb_error_name(ret));
280 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->interrupt_ep)) < 0) {
281 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
282 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");
314 static int scpi_usbtmc_libusb_source_add(void *priv, int events, int timeout,
315 sr_receive_data_callback_t cb, void *cb_data)
317 struct scpi_usbtmc_libusb *uscpi = priv;
319 return usb_source_add(uscpi->ctx, timeout, cb, cb_data);
322 static int scpi_usbtmc_libusb_source_remove(void *priv)
324 struct scpi_usbtmc_libusb *uscpi = priv;
325 return usb_source_remove(uscpi->ctx);
328 static void usbtmc_bulk_out_header_write(void *header, uint8_t MsgID,
330 uint32_t TransferSize,
331 uint8_t bmTransferAttributes,
334 W8(header+ 0, MsgID);
336 W8(header+ 2, ~bTag);
338 WL32(header+ 4, TransferSize);
339 W8(header+ 8, bmTransferAttributes);
340 W8(header+ 9, TermChar);
344 static int usbtmc_bulk_in_header_read(void *header, uint8_t MsgID,
346 int32_t *TransferSize,
347 uint8_t *bmTransferAttributes)
349 if (R8(header+0) != MsgID ||
350 R8(header+1) != bTag ||
351 R8(header+2) != (unsigned char)~bTag)
354 *TransferSize = RL32(header+4);
355 if (bmTransferAttributes)
356 *bmTransferAttributes = R8(header+8);
360 static int scpi_usbtmc_bulkout(struct scpi_usbtmc_libusb *uscpi,
361 uint8_t msg_id, const void *data, int32_t size,
362 uint8_t transfer_attributes)
364 struct sr_usb_dev_inst *usb = uscpi->usb;
365 int padded_size, ret, transferred;
367 if (data && size+USBTMC_BULK_HEADER_SIZE+3 > (int)sizeof(uscpi->buffer)) {
368 sr_err("USBTMC bulk out transfer is too big.");
373 uscpi->bTag += !uscpi->bTag; /* bTag == 0 is invalid so avoid it. */
375 usbtmc_bulk_out_header_write(uscpi->buffer, msg_id, uscpi->bTag,
376 size, transfer_attributes, 0);
378 memcpy(uscpi->buffer+USBTMC_BULK_HEADER_SIZE, data, size);
381 size += USBTMC_BULK_HEADER_SIZE;
382 padded_size = (size + 3) & ~0x3;
383 memset(uscpi->buffer+size, 0, padded_size - size);
385 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_out_ep,
386 uscpi->buffer, padded_size, &transferred,
389 sr_err("USBTMC bulk out transfer error: %s.",
390 libusb_error_name(ret));
394 if (transferred < padded_size) {
395 sr_dbg("USBTMC bulk out partial transfer (%d/%d bytes).",
396 transferred, padded_size);
400 return transferred - USBTMC_BULK_HEADER_SIZE;
403 static int scpi_usbtmc_bulkin_start(struct scpi_usbtmc_libusb *uscpi,
404 uint8_t msg_id, void *data, int32_t size,
405 uint8_t *transfer_attributes)
407 struct sr_usb_dev_inst *usb = uscpi->usb;
408 int ret, transferred, message_size;
410 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
411 &transferred, TRANSFER_TIMEOUT);
413 sr_err("USBTMC bulk in transfer error: %s.",
414 libusb_error_name(ret));
418 if (usbtmc_bulk_in_header_read(data, msg_id, uscpi->bTag, &message_size,
419 transfer_attributes) != SR_OK) {
420 sr_err("USBTMC invalid bulk in header.");
424 message_size += USBTMC_BULK_HEADER_SIZE;
425 uscpi->response_length = MIN(transferred, message_size);
426 uscpi->response_bytes_read = USBTMC_BULK_HEADER_SIZE;
427 uscpi->remaining_length = message_size - uscpi->response_length;
429 return transferred - USBTMC_BULK_HEADER_SIZE;
432 static int scpi_usbtmc_bulkin_continue(struct scpi_usbtmc_libusb *uscpi,
433 void *data, int size)
435 struct sr_usb_dev_inst *usb = uscpi->usb;
436 int ret, transferred;
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 uscpi->response_length = MIN(transferred, uscpi->remaining_length);
447 uscpi->response_bytes_read = 0;
448 uscpi->remaining_length -= uscpi->response_length;
453 static int scpi_usbtmc_libusb_send(void *priv, const char *command)
455 struct scpi_usbtmc_libusb *uscpi = priv;
457 if (scpi_usbtmc_bulkout(uscpi, DEV_DEP_MSG_OUT,
458 command, strlen(command), EOM) <= 0)
461 sr_spew("Successfully sent SCPI command: '%s'.", command);
466 static int scpi_usbtmc_libusb_read_begin(void *priv)
468 struct scpi_usbtmc_libusb *uscpi = priv;
470 uscpi->remaining_length = 0;
472 if (scpi_usbtmc_bulkout(uscpi, REQUEST_DEV_DEP_MSG_IN,
473 NULL, INT32_MAX, 0) < 0)
475 if (scpi_usbtmc_bulkin_start(uscpi, DEV_DEP_MSG_IN,
476 uscpi->buffer, sizeof(uscpi->buffer),
477 &uscpi->bulkin_attributes) < 0)
483 static int scpi_usbtmc_libusb_read_data(void *priv, char *buf, int maxlen)
485 struct scpi_usbtmc_libusb *uscpi = priv;
488 if (uscpi->response_bytes_read >= uscpi->response_length) {
489 if (uscpi->remaining_length > 0) {
490 if (scpi_usbtmc_bulkin_continue(uscpi, uscpi->buffer,
491 sizeof(uscpi->buffer)) <= 0)
494 if (uscpi->bulkin_attributes & EOM)
496 if (scpi_usbtmc_libusb_read_begin(uscpi) < 0)
501 read_length = MIN(uscpi->response_length - uscpi->response_bytes_read, maxlen);
503 memcpy(buf, uscpi->buffer + uscpi->response_bytes_read, read_length);
505 uscpi->response_bytes_read += read_length;
510 static int scpi_usbtmc_libusb_read_complete(void *priv)
512 struct scpi_usbtmc_libusb *uscpi = priv;
513 return uscpi->response_bytes_read >= uscpi->response_length &&
514 uscpi->remaining_length <= 0 &&
515 uscpi->bulkin_attributes & EOM;
518 static int scpi_usbtmc_libusb_close(void *priv)
521 struct scpi_usbtmc_libusb *uscpi = priv;
522 struct sr_usb_dev_inst *usb = uscpi->usb;
527 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_in_ep)) < 0)
528 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
529 uscpi->bulk_in_ep, libusb_error_name(ret));
530 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->bulk_out_ep)) < 0)
531 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
532 uscpi->bulk_out_ep, libusb_error_name(ret));
533 if ((ret = libusb_clear_halt(usb->devhdl, uscpi->interrupt_ep)) < 0)
534 sr_err("Failed to clear halt/stall condition for EP %d: %s.",
535 uscpi->interrupt_ep, libusb_error_name(ret));
537 if ((ret = libusb_release_interface(usb->devhdl, uscpi->interface)) < 0)
538 sr_err("Failed to release interface: %s.",
539 libusb_error_name(ret));
541 if (uscpi->detached_kernel_driver) {
542 if ((ret = libusb_attach_kernel_driver(usb->devhdl,
543 uscpi->interface)) < 0)
544 sr_err("Failed to re-attach kernel driver: %s.",
545 libusb_error_name(ret));
547 uscpi->detached_kernel_driver = 0;
549 libusb_close(usb->devhdl);
555 static void scpi_usbtmc_libusb_free(void *priv)
557 struct scpi_usbtmc_libusb *uscpi = priv;
558 sr_usb_dev_inst_free(uscpi->usb);
561 SR_PRIV const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev = {
564 .priv_size = sizeof(struct scpi_usbtmc_libusb),
565 .scan = scpi_usbtmc_libusb_scan,
566 .dev_inst_new = scpi_usbtmc_libusb_dev_inst_new,
567 .open = scpi_usbtmc_libusb_open,
568 .source_add = scpi_usbtmc_libusb_source_add,
569 .source_remove = scpi_usbtmc_libusb_source_remove,
570 .send = scpi_usbtmc_libusb_send,
571 .read_begin = scpi_usbtmc_libusb_read_begin,
572 .read_data = scpi_usbtmc_libusb_read_data,
573 .read_complete = scpi_usbtmc_libusb_read_complete,
574 .close = scpi_usbtmc_libusb_close,
575 .free = scpi_usbtmc_libusb_free,