]> sigrok.org Git - libsigrok.git/blame - src/scpi/scpi_usbtmc_libusb.c
rdtech-dps: User ternary operator.
[libsigrok.git] / src / scpi / scpi_usbtmc_libusb.c
CommitLineData
20ed3cee
AJ
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
6ec6c43b 20#include <config.h>
20ed3cee 21#include <string.h>
c1aae900 22#include <libsigrok/libsigrok.h>
20ed3cee 23#include "libsigrok-internal.h"
5a1afc09 24#include "scpi.h"
20ed3cee
AJ
25
26#define LOG_PREFIX "scpi_usbtmc"
27
28#define MAX_TRANSFER_LENGTH 2048
29#define TRANSFER_TIMEOUT 1000
30
31struct scpi_usbtmc_libusb {
32 struct sr_context *ctx;
33 struct sr_usb_dev_inst *usb;
34 int detached_kernel_driver;
35 uint8_t interface;
36 uint8_t bulk_in_ep;
37 uint8_t bulk_out_ep;
38 uint8_t interrupt_ep;
39 uint8_t usbtmc_int_cap;
40 uint8_t usbtmc_dev_cap;
41 uint8_t usb488_dev_cap;
42 uint8_t bTag;
43 uint8_t bulkin_attributes;
44 uint8_t buffer[MAX_TRANSFER_LENGTH];
45 int response_length;
46 int response_bytes_read;
47 int remaining_length;
48};
49
50/* Some USBTMC-specific enums, as defined in the USBTMC standard. */
d9251a2c
UH
51#define SUBCLASS_USBTMC 0x03
52#define USBTMC_USB488 0x01
20ed3cee
AJ
53
54enum {
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,
60 INITIATE_CLEAR = 5,
61 CHECK_CLEAR_STATUS = 6,
62 GET_CAPABILITIES = 7,
63 INDICATOR_PULSE = 64,
64
65 /* USB488 control requests */
66 READ_STATUS_BYTE = 128,
67 REN_CONTROL = 160,
68 GO_TO_LOCAL = 161,
69 LOCAL_LOCKOUT = 162,
70};
71
baed0211
BV
72/* USBTMC status codes */
73#define USBTMC_STATUS_SUCCESS 0x01
74
20ed3cee
AJ
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
79
80#define USBTMC_DEV_CAP_TERMCHAR 0x01
81
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
86
87/* Bulk messages constants */
d9251a2c 88#define USBTMC_BULK_HEADER_SIZE 12
20ed3cee
AJ
89
90/* Bulk MsgID values */
d9251a2c
UH
91#define DEV_DEP_MSG_OUT 1
92#define REQUEST_DEV_DEP_MSG_IN 2
93#define DEV_DEP_MSG_IN 2
20ed3cee
AJ
94
95/* bmTransferAttributes */
d9251a2c
UH
96#define EOM 0x01
97#define TERM_CHAR_ENABLED 0x02
20ed3cee 98
11582652
BV
99struct usbtmc_blacklist {
100 uint16_t vid;
101 uint16_t pid;
102};
103
e40e9ca2 104/* Devices that publish RL1 support, but don't support it. */
11582652 105static struct usbtmc_blacklist blacklist_remote[] = {
d9251a2c
UH
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 */
9a4cc7dd 110 { 0xf4ec, 0xffff }, /* All Siglent SDS devices */
11582652
BV
111 ALL_ZERO
112};
113
7a970e31
GS
114/* Devices that shall get reset during open(). */
115static struct usbtmc_blacklist whitelist_usb_reset[] = {
116 { 0xf4ec, 0xffff }, /* All Siglent SDS devices */
117 ALL_ZERO
118};
119
20ed3cee
AJ
120static GSList *scpi_usbtmc_libusb_scan(struct drv_context *drvc)
121{
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;
128 char *res;
129
52f6951c
UH
130 ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
131 if (ret < 0) {
132 sr_err("Failed to get device list: %s.",
133 libusb_error_name(ret));
134 return NULL;
135 }
20ed3cee 136 for (i = 0; devlist[i]; i++) {
2a8f2d41 137 libusb_get_device_descriptor(devlist[i], &des);
20ed3cee
AJ
138
139 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
9ad05e6c
UH
140 if ((ret = libusb_get_config_descriptor(devlist[i], confidx, &confdes)) < 0) {
141 sr_dbg("Failed to get configuration descriptor: %s, "
142 "ignoring device.", libusb_error_name(ret));
20ed3cee
AJ
143 break;
144 }
145 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
146 intfdes = confdes->interface[intfidx].altsetting;
147 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
148 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
149 intfdes->bInterfaceProtocol != USBTMC_USB488)
150 continue;
151 sr_dbg("Found USBTMC device (VID:PID = %04x:%04x, "
152 "bus.address = %d.%d).", des.idVendor, des.idProduct,
153 libusb_get_bus_number(devlist[i]),
154 libusb_get_device_address(devlist[i]));
155 res = g_strdup_printf("usbtmc/%d.%d",
156 libusb_get_bus_number(devlist[i]),
157 libusb_get_device_address(devlist[i]));
158 resources = g_slist_append(resources, res);
159 }
160 libusb_free_config_descriptor(confdes);
161 }
162 }
163 libusb_free_device_list(devlist, 1);
164
91057d2f 165 /* No log message for #devices found (caller will log that). */
20ed3cee
AJ
166
167 return resources;
168}
169
170static int scpi_usbtmc_libusb_dev_inst_new(void *priv, struct drv_context *drvc,
171 const char *resource, char **params, const char *serialcomm)
172{
173 struct scpi_usbtmc_libusb *uscpi = priv;
174 GSList *devices;
175
176 (void)resource;
177 (void)serialcomm;
178
179 if (!params || !params[1]) {
180 sr_err("Invalid parameters.");
181 return SR_ERR;
182 }
183
184 uscpi->ctx = drvc->sr_ctx;
185 devices = sr_usb_find(uscpi->ctx->libusb_ctx, params[1]);
186 if (g_slist_length(devices) != 1) {
187 sr_err("Failed to find USB device '%s'.", params[1]);
188 g_slist_free_full(devices, (GDestroyNotify)sr_usb_dev_inst_free);
189 return SR_ERR;
190 }
191 uscpi->usb = devices->data;
192 g_slist_free(devices);
193
194 return SR_OK;
195}
196
11582652
BV
197static int check_usbtmc_blacklist(struct usbtmc_blacklist *blacklist,
198 uint16_t vid, uint16_t pid)
199{
200 int i;
201
202 for (i = 0; blacklist[i].vid; i++) {
a084a8f2
SA
203 if ((blacklist[i].vid == vid && blacklist[i].pid == 0xFFFF) ||
204 (blacklist[i].vid == vid && blacklist[i].pid == pid))
11582652
BV
205 return TRUE;
206 }
207
208 return FALSE;
209}
210
211static int scpi_usbtmc_remote(struct scpi_usbtmc_libusb *uscpi)
212{
213 struct sr_usb_dev_inst *usb = uscpi->usb;
214 struct libusb_device *dev;
215 struct libusb_device_descriptor des;
216 int ret;
217 uint8_t status;
218
219 if (!(uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1))
220 return SR_OK;
221
222 dev = libusb_get_device(usb->devhdl);
223 libusb_get_device_descriptor(dev, &des);
224 if (check_usbtmc_blacklist(blacklist_remote, des.idVendor, des.idProduct))
225 return SR_OK;
226
227 sr_dbg("Locking out local control.");
d9251a2c
UH
228 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
229 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
230 REN_CONTROL, 1, uscpi->interface, &status, 1, TRANSFER_TIMEOUT);
11582652
BV
231 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
232 if (ret < 0)
233 sr_dbg("Failed to enter REN state: %s.", libusb_error_name(ret));
234 else
235 sr_dbg("Failed to enter REN state: USBTMC status %d.", status);
236 return SR_ERR;
237 }
238
d9251a2c
UH
239 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
240 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
241 LOCAL_LOCKOUT, 0, uscpi->interface, &status, 1,
242 TRANSFER_TIMEOUT);
11582652
BV
243 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
244 if (ret < 0)
245 sr_dbg("Failed to enter local lockout state: %s.",
246 libusb_error_name(ret));
247 else
248 sr_dbg("Failed to enter local lockout state: USBTMC "
249 "status %d.", status);
250 return SR_ERR;
251 }
252
253 return SR_OK;
254}
255
256static void scpi_usbtmc_local(struct scpi_usbtmc_libusb *uscpi)
257{
258 struct sr_usb_dev_inst *usb = uscpi->usb;
259 struct libusb_device *dev;
260 struct libusb_device_descriptor des;
261 int ret;
262 uint8_t status;
263
264 if (!(uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1))
265 return;
266
267 dev = libusb_get_device(usb->devhdl);
268 libusb_get_device_descriptor(dev, &des);
269 if (check_usbtmc_blacklist(blacklist_remote, des.idVendor, des.idProduct))
270 return;
271
272 sr_dbg("Returning local control.");
d9251a2c
UH
273 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
274 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
275 GO_TO_LOCAL, 0, uscpi->interface, &status, 1, TRANSFER_TIMEOUT);
11582652
BV
276 if (ret < 0 || status != USBTMC_STATUS_SUCCESS) {
277 if (ret < 0)
278 sr_dbg("Failed to clear local lockout state: %s.",
279 libusb_error_name(ret));
280 else
281 sr_dbg("Failed to clear local lockout state: USBTMC "
282 "status %d.", status);
283 }
284
285 return;
286}
287
04229f7b 288static int scpi_usbtmc_libusb_open(struct sr_scpi_dev_inst *scpi)
20ed3cee 289{
04229f7b 290 struct scpi_usbtmc_libusb *uscpi = scpi->priv;
20ed3cee
AJ
291 struct sr_usb_dev_inst *usb = uscpi->usb;
292 struct libusb_device *dev;
293 struct libusb_device_descriptor des;
294 struct libusb_config_descriptor *confdes;
295 const struct libusb_interface_descriptor *intfdes;
296 const struct libusb_endpoint_descriptor *ep;
938bdc25 297 int confidx, intfidx, epidx, config = 0, current_config;
11582652 298 uint8_t capabilities[24];
20ed3cee 299 int ret, found = 0;
7a970e31 300 int do_reset;
20ed3cee
AJ
301
302 if (usb->devhdl)
303 return SR_OK;
304
305 if (sr_usb_open(uscpi->ctx->libusb_ctx, usb) != SR_OK)
306 return SR_ERR;
307
308 dev = libusb_get_device(usb->devhdl);
2a8f2d41 309 libusb_get_device_descriptor(dev, &des);
20ed3cee
AJ
310
311 for (confidx = 0; confidx < des.bNumConfigurations; confidx++) {
9ad05e6c
UH
312 if ((ret = libusb_get_config_descriptor(dev, confidx, &confdes)) < 0) {
313 sr_dbg("Failed to get configuration descriptor: %s, "
314 "ignoring device.", libusb_error_name(ret));
20ed3cee
AJ
315 continue;
316 }
317 for (intfidx = 0; intfidx < confdes->bNumInterfaces; intfidx++) {
318 intfdes = confdes->interface[intfidx].altsetting;
319 if (intfdes->bInterfaceClass != LIBUSB_CLASS_APPLICATION ||
d9251a2c 320 intfdes->bInterfaceSubClass != SUBCLASS_USBTMC ||
20ed3cee
AJ
321 intfdes->bInterfaceProtocol != USBTMC_USB488)
322 continue;
323 uscpi->interface = intfdes->bInterfaceNumber;
20ed3cee 324 config = confdes->bConfigurationValue;
e82d34a9 325 sr_dbg("Interface %d configuration %d.", uscpi->interface, config);
20ed3cee
AJ
326 for (epidx = 0; epidx < intfdes->bNumEndpoints; epidx++) {
327 ep = &intfdes->endpoint[epidx];
328 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
329 !(ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK))) {
330 uscpi->bulk_out_ep = ep->bEndpointAddress;
331 sr_dbg("Bulk OUT EP %d", uscpi->bulk_out_ep);
332 }
333 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_BULK &&
334 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
335 uscpi->bulk_in_ep = ep->bEndpointAddress;
e82d34a9 336 sr_dbg("Bulk IN EP %d", uscpi->bulk_in_ep & 0x7f);
20ed3cee
AJ
337 }
338 if (ep->bmAttributes == LIBUSB_TRANSFER_TYPE_INTERRUPT &&
339 ep->bEndpointAddress & (LIBUSB_ENDPOINT_DIR_MASK)) {
340 uscpi->interrupt_ep = ep->bEndpointAddress;
e82d34a9 341 sr_dbg("Interrupt EP %d", uscpi->interrupt_ep & 0x7f);
20ed3cee
AJ
342 }
343 }
344 found = 1;
345 }
346 libusb_free_config_descriptor(confdes);
347 if (found)
348 break;
349 }
350
351 if (!found) {
52f6951c 352 sr_err("Failed to find USBTMC interface.");
20ed3cee
AJ
353 return SR_ERR;
354 }
355
356 if (libusb_kernel_driver_active(usb->devhdl, uscpi->interface) == 1) {
357 if ((ret = libusb_detach_kernel_driver(usb->devhdl,
358 uscpi->interface)) < 0) {
52f6951c
UH
359 sr_err("Failed to detach kernel driver: %s.",
360 libusb_error_name(ret));
20ed3cee
AJ
361 return SR_ERR;
362 }
363 uscpi->detached_kernel_driver = 1;
364 }
365
938bdc25
AJ
366 if (libusb_get_configuration(usb->devhdl, &current_config) == 0
367 && current_config != config) {
368 if ((ret = libusb_set_configuration(usb->devhdl, config)) < 0) {
369 sr_err("Failed to set configuration: %s.",
370 libusb_error_name(ret));
371 return SR_ERR;
372 }
20ed3cee
AJ
373 }
374
d8cbd659 375 if ((ret = libusb_claim_interface(usb->devhdl, uscpi->interface)) < 0) {
52f6951c
UH
376 sr_err("Failed to claim interface: %s.",
377 libusb_error_name(ret));
20ed3cee
AJ
378 return SR_ERR;
379 }
380
7a970e31
GS
381 /* Optionally reset the USB device. */
382 do_reset = check_usbtmc_blacklist(whitelist_usb_reset,
383 des.idVendor, des.idProduct);
384 if (do_reset)
385 libusb_reset_device(usb->devhdl);
9a4cc7dd 386
52f6951c 387 /* Get capabilities. */
d9251a2c
UH
388 ret = libusb_control_transfer(usb->devhdl, LIBUSB_ENDPOINT_IN |
389 LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
390 GET_CAPABILITIES, 0, uscpi->interface, capabilities,
391 sizeof(capabilities), TRANSFER_TIMEOUT);
20ed3cee
AJ
392 if (ret == sizeof(capabilities)) {
393 uscpi->usbtmc_int_cap = capabilities[ 4];
394 uscpi->usbtmc_dev_cap = capabilities[ 5];
395 uscpi->usb488_dev_cap = capabilities[15];
396 }
52f6951c 397 sr_dbg("Device capabilities: %s%s%s%s%s, %s, %s",
d9251a2c
UH
398 uscpi->usb488_dev_cap & USB488_DEV_CAP_SCPI ? "SCPI, " : "",
399 uscpi->usbtmc_dev_cap & USBTMC_DEV_CAP_TERMCHAR ? "TermChar, ": "",
400 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY ? "L3, " :
401 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "" : "L4, ",
402 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_TALK_ONLY ? "T5, " :
403 uscpi->usbtmc_int_cap & USBTMC_INT_CAP_LISTEN_ONLY ? "" : "T6, ",
404 uscpi->usb488_dev_cap & USB488_DEV_CAP_SR1 ? "SR1" : "SR0",
405 uscpi->usb488_dev_cap & USB488_DEV_CAP_RL1 ? "RL1" : "RL0",
406 uscpi->usb488_dev_cap & USB488_DEV_CAP_DT1 ? "DT1" : "DT0");
20ed3cee 407
11582652 408 scpi_usbtmc_remote(uscpi);
baed0211 409
20ed3cee
AJ
410 return SR_OK;
411}
412
102f1239
BV
413static int scpi_usbtmc_libusb_source_add(struct sr_session *session,
414 void *priv, int events, int timeout, sr_receive_data_callback cb,
415 void *cb_data)
20ed3cee
AJ
416{
417 struct scpi_usbtmc_libusb *uscpi = priv;
418 (void)events;
102f1239 419 return usb_source_add(session, uscpi->ctx, timeout, cb, cb_data);
20ed3cee
AJ
420}
421
102f1239
BV
422static int scpi_usbtmc_libusb_source_remove(struct sr_session *session,
423 void *priv)
20ed3cee
AJ
424{
425 struct scpi_usbtmc_libusb *uscpi = priv;
102f1239 426 return usb_source_remove(session, uscpi->ctx);
20ed3cee
AJ
427}
428
429static void usbtmc_bulk_out_header_write(void *header, uint8_t MsgID,
430 uint8_t bTag,
431 uint32_t TransferSize,
432 uint8_t bmTransferAttributes,
433 char TermChar)
434{
d9251a2c
UH
435 W8(header + 0, MsgID);
436 W8(header + 1, bTag);
437 W8(header + 2, ~bTag);
438 W8(header + 3, 0);
439 WL32(header + 4, TransferSize);
440 W8(header + 8, bmTransferAttributes);
441 W8(header + 9, TermChar);
442 WL16(header + 10, 0);
20ed3cee
AJ
443}
444
445static int usbtmc_bulk_in_header_read(void *header, uint8_t MsgID,
446 unsigned char bTag,
447 int32_t *TransferSize,
448 uint8_t *bmTransferAttributes)
449{
d9251a2c
UH
450 if (R8(header + 0) != MsgID ||
451 R8(header + 1) != bTag ||
452 R8(header + 2) != (unsigned char)~bTag)
20ed3cee
AJ
453 return SR_ERR;
454 if (TransferSize)
d9251a2c 455 *TransferSize = RL32(header + 4);
20ed3cee 456 if (bmTransferAttributes)
d9251a2c
UH
457 *bmTransferAttributes = R8(header + 8);
458
20ed3cee
AJ
459 return SR_OK;
460}
461
462static int scpi_usbtmc_bulkout(struct scpi_usbtmc_libusb *uscpi,
463 uint8_t msg_id, const void *data, int32_t size,
464 uint8_t transfer_attributes)
465{
466 struct sr_usb_dev_inst *usb = uscpi->usb;
467 int padded_size, ret, transferred;
468
d9251a2c 469 if (data && (size + USBTMC_BULK_HEADER_SIZE + 3) > (int)sizeof(uscpi->buffer)) {
52f6951c 470 sr_err("USBTMC bulk out transfer is too big.");
20ed3cee
AJ
471 return SR_ERR;
472 }
473
474 uscpi->bTag++;
d9251a2c 475 uscpi->bTag += !uscpi->bTag; /* bTag == 0 is invalid so avoid it. */
20ed3cee
AJ
476
477 usbtmc_bulk_out_header_write(uscpi->buffer, msg_id, uscpi->bTag,
478 size, transfer_attributes, 0);
479 if (data)
d9251a2c 480 memcpy(uscpi->buffer + USBTMC_BULK_HEADER_SIZE, data, size);
20ed3cee
AJ
481 else
482 size = 0;
483 size += USBTMC_BULK_HEADER_SIZE;
484 padded_size = (size + 3) & ~0x3;
d9251a2c 485 memset(uscpi->buffer + size, 0, padded_size - size);
20ed3cee
AJ
486
487 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_out_ep,
488 uscpi->buffer, padded_size, &transferred,
489 TRANSFER_TIMEOUT);
d8cbd659 490 if (ret < 0) {
52f6951c
UH
491 sr_err("USBTMC bulk out transfer error: %s.",
492 libusb_error_name(ret));
20ed3cee
AJ
493 return SR_ERR;
494 }
495
496 if (transferred < padded_size) {
52f6951c 497 sr_dbg("USBTMC bulk out partial transfer (%d/%d bytes).",
20ed3cee
AJ
498 transferred, padded_size);
499 return SR_ERR;
500 }
501
502 return transferred - USBTMC_BULK_HEADER_SIZE;
503}
504
505static int scpi_usbtmc_bulkin_start(struct scpi_usbtmc_libusb *uscpi,
506 uint8_t msg_id, void *data, int32_t size,
507 uint8_t *transfer_attributes)
508{
509 struct sr_usb_dev_inst *usb = uscpi->usb;
510 int ret, transferred, message_size;
511
512 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
513 &transferred, TRANSFER_TIMEOUT);
d8cbd659 514 if (ret < 0) {
52f6951c
UH
515 sr_err("USBTMC bulk in transfer error: %s.",
516 libusb_error_name(ret));
20ed3cee
AJ
517 return SR_ERR;
518 }
519
520 if (usbtmc_bulk_in_header_read(data, msg_id, uscpi->bTag, &message_size,
521 transfer_attributes) != SR_OK) {
52f6951c 522 sr_err("USBTMC invalid bulk in header.");
20ed3cee
AJ
523 return SR_ERR;
524 }
525
526 message_size += USBTMC_BULK_HEADER_SIZE;
527 uscpi->response_length = MIN(transferred, message_size);
528 uscpi->response_bytes_read = USBTMC_BULK_HEADER_SIZE;
529 uscpi->remaining_length = message_size - uscpi->response_length;
530
531 return transferred - USBTMC_BULK_HEADER_SIZE;
532}
533
534static int scpi_usbtmc_bulkin_continue(struct scpi_usbtmc_libusb *uscpi,
535 void *data, int size)
536{
537 struct sr_usb_dev_inst *usb = uscpi->usb;
538 int ret, transferred;
539
540 ret = libusb_bulk_transfer(usb->devhdl, uscpi->bulk_in_ep, data, size,
541 &transferred, TRANSFER_TIMEOUT);
d8cbd659 542 if (ret < 0) {
52f6951c
UH
543 sr_err("USBTMC bulk in transfer error: %s.",
544 libusb_error_name(ret));
20ed3cee
AJ
545 return SR_ERR;
546 }
547
548 uscpi->response_length = MIN(transferred, uscpi->remaining_length);
549 uscpi->response_bytes_read = 0;
550 uscpi->remaining_length -= uscpi->response_length;
551
552 return transferred;
553}
554
555static int scpi_usbtmc_libusb_send(void *priv, const char *command)
556{
557 struct scpi_usbtmc_libusb *uscpi = priv;
558
559 if (scpi_usbtmc_bulkout(uscpi, DEV_DEP_MSG_OUT,
560 command, strlen(command), EOM) <= 0)
561 return SR_ERR;
562
563 sr_spew("Successfully sent SCPI command: '%s'.", command);
564
565 return SR_OK;
566}
567
568static int scpi_usbtmc_libusb_read_begin(void *priv)
569{
570 struct scpi_usbtmc_libusb *uscpi = priv;
571
572 uscpi->remaining_length = 0;
573
574 if (scpi_usbtmc_bulkout(uscpi, REQUEST_DEV_DEP_MSG_IN,
575 NULL, INT32_MAX, 0) < 0)
576 return SR_ERR;
577 if (scpi_usbtmc_bulkin_start(uscpi, DEV_DEP_MSG_IN,
578 uscpi->buffer, sizeof(uscpi->buffer),
579 &uscpi->bulkin_attributes) < 0)
580 return SR_ERR;
581
582 return SR_OK;
583}
584
585static int scpi_usbtmc_libusb_read_data(void *priv, char *buf, int maxlen)
586{
587 struct scpi_usbtmc_libusb *uscpi = priv;
588 int read_length;
589
590 if (uscpi->response_bytes_read >= uscpi->response_length) {
591 if (uscpi->remaining_length > 0) {
592 if (scpi_usbtmc_bulkin_continue(uscpi, uscpi->buffer,
593 sizeof(uscpi->buffer)) <= 0)
594 return SR_ERR;
595 } else {
596 if (uscpi->bulkin_attributes & EOM)
597 return SR_ERR;
598 if (scpi_usbtmc_libusb_read_begin(uscpi) < 0)
599 return SR_ERR;
600 }
601 }
602
603 read_length = MIN(uscpi->response_length - uscpi->response_bytes_read, maxlen);
604
605 memcpy(buf, uscpi->buffer + uscpi->response_bytes_read, read_length);
606
607 uscpi->response_bytes_read += read_length;
608
609 return read_length;
610}
611
612static int scpi_usbtmc_libusb_read_complete(void *priv)
613{
614 struct scpi_usbtmc_libusb *uscpi = priv;
615 return uscpi->response_bytes_read >= uscpi->response_length &&
616 uscpi->remaining_length <= 0 &&
617 uscpi->bulkin_attributes & EOM;
618}
619
04229f7b 620static int scpi_usbtmc_libusb_close(struct sr_scpi_dev_inst *scpi)
20ed3cee 621{
04229f7b 622 struct scpi_usbtmc_libusb *uscpi = scpi->priv;
20ed3cee 623 struct sr_usb_dev_inst *usb = uscpi->usb;
04229f7b 624 int ret;
20ed3cee
AJ
625
626 if (!usb->devhdl)
627 return SR_ERR;
628
11582652 629 scpi_usbtmc_local(uscpi);
baed0211 630
52f6951c
UH
631 if ((ret = libusb_release_interface(usb->devhdl, uscpi->interface)) < 0)
632 sr_err("Failed to release interface: %s.",
633 libusb_error_name(ret));
176d785d 634
20ed3cee 635 if (uscpi->detached_kernel_driver) {
52f6951c
UH
636 if ((ret = libusb_attach_kernel_driver(usb->devhdl,
637 uscpi->interface)) < 0)
638 sr_err("Failed to re-attach kernel driver: %s.",
639 libusb_error_name(ret));
640
20ed3cee
AJ
641 uscpi->detached_kernel_driver = 0;
642 }
0b2b92f6 643 sr_usb_close(usb);
20ed3cee
AJ
644
645 return SR_OK;
646}
647
648static void scpi_usbtmc_libusb_free(void *priv)
649{
650 struct scpi_usbtmc_libusb *uscpi = priv;
651 sr_usb_dev_inst_free(uscpi->usb);
652}
653
20ed3cee
AJ
654SR_PRIV const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev = {
655 .name = "USBTMC",
656 .prefix = "usbtmc",
657 .priv_size = sizeof(struct scpi_usbtmc_libusb),
658 .scan = scpi_usbtmc_libusb_scan,
659 .dev_inst_new = scpi_usbtmc_libusb_dev_inst_new,
660 .open = scpi_usbtmc_libusb_open,
661 .source_add = scpi_usbtmc_libusb_source_add,
662 .source_remove = scpi_usbtmc_libusb_source_remove,
663 .send = scpi_usbtmc_libusb_send,
664 .read_begin = scpi_usbtmc_libusb_read_begin,
665 .read_data = scpi_usbtmc_libusb_read_data,
666 .read_complete = scpi_usbtmc_libusb_read_complete,
667 .close = scpi_usbtmc_libusb_close,
668 .free = scpi_usbtmc_libusb_free,
669};