2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5 * With protocol information from the hantekdso project,
6 * Copyright (C) 2008 Oleg Khudyakov <prcoder@gmail.com>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libsigrok.h"
23 #include "libsigrok-internal.h"
29 extern struct sr_dev_driver hantek_dso_driver_info;
31 static int send_begin(struct dev_context *devc)
34 unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
37 sr_dbg("Sending CTRL_BEGINCOMMAND.");
39 if ((ret = libusb_control_transfer(devc->usb->devhdl,
40 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_BEGINCOMMAND,
41 0, 0, buffer, sizeof(buffer), 200)) != sizeof(buffer)) {
42 sr_err("Failed to send begincommand: %d.", ret);
49 static int send_bulkcmd(struct dev_context *devc, uint8_t *cmdstring, int cmdlen)
53 if (send_begin(devc) != SR_OK)
56 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
57 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
58 cmdstring, cmdlen, &tmp, 200)) != 0)
64 SR_PRIV int dso_getmps(libusb_device *dev)
66 struct libusb_device_descriptor des;
67 struct libusb_config_descriptor *conf_dsc;
68 const struct libusb_interface_descriptor *intf_dsc;
71 if (libusb_get_device_descriptor(dev, &des) != 0)
74 if (des.bNumConfigurations != 1)
77 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
81 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
82 if (intf_dsc->bNumEndpoints != 2)
85 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
86 (2 | LIBUSB_ENDPOINT_OUT))
87 /* The first endpoint should be 2 (outbound). */
90 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
91 (6 | LIBUSB_ENDPOINT_IN))
92 /* The second endpoint should be 6 (inbound). */
95 mps = intf_dsc->endpoint[1].wMaxPacketSize;
99 libusb_free_config_descriptor(conf_dsc);
104 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
106 libusb_device **devlist;
107 struct libusb_device_descriptor des;
108 struct dev_context *devc;
109 struct drv_context *drvc = hantek_dso_driver_info.priv;
114 if (sdi->status == SR_ST_ACTIVE)
119 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
120 for (i = 0; devlist[i]; i++) {
121 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
122 sr_err("Failed to get device descriptor: %d.", err);
126 if (des.idVendor != devc->profile->fw_vid
127 || des.idProduct != devc->profile->fw_pid)
130 if (sdi->status == SR_ST_INITIALIZING) {
131 if (skip != sdi->index) {
132 /* Skip devices of this type that aren't the one we want. */
136 } else if (sdi->status == SR_ST_INACTIVE) {
138 * This device is fully enumerated, so we need to find
139 * this device by vendor, product, bus and address.
141 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
142 || libusb_get_device_address(devlist[i]) != devc->usb->address)
143 /* this is not the one */
147 if (!(err = libusb_open(devlist[i], &devc->usb->devhdl))) {
148 if (devc->usb->address == 0xff)
150 * first time we touch this device after firmware upload,
151 * so we don't know the address yet.
153 devc->usb->address = libusb_get_device_address(devlist[i]);
155 if (!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
156 sr_err("Wrong endpoint profile.");
158 sdi->status = SR_ST_ACTIVE;
159 sr_info("Opened device %d on %d.%d interface %d.",
160 sdi->index, devc->usb->bus,
161 devc->usb->address, USB_INTERFACE);
164 sr_err("Failed to open device: %d.", err);
167 /* If we made it here, we handled the device (somehow). */
170 libusb_free_device_list(devlist, 1);
172 if (sdi->status != SR_ST_ACTIVE)
178 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
180 struct dev_context *devc;
184 if (devc->usb->devhdl == NULL)
187 sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
188 devc->usb->bus, devc->usb->address, USB_INTERFACE);
189 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
190 libusb_close(devc->usb->devhdl);
191 devc->usb->devhdl = NULL;
192 sdi->status = SR_ST_INACTIVE;
196 static int get_channel_offsets(struct dev_context *devc)
201 sr_dbg("Getting channel offsets.");
203 ret = libusb_control_transfer(devc->usb->devhdl,
204 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
205 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
206 (unsigned char *)&devc->channel_levels,
207 sizeof(devc->channel_levels), 200);
208 if (ret != sizeof(devc->channel_levels)) {
209 sr_err("Failed to get channel offsets: %d.", ret);
213 /* Comes in as 16-bit numbers with the second byte always 0 on
214 * the DSO-2090. Guessing this is supposed to be big-endian,
215 * since that's how voltage offsets are submitted back to the DSO.
216 * Convert to host order now, so we can use them natively.
218 for (chan = 0; chan < 2; chan++) {
219 for (v = 0; v < 9; v++) {
220 devc->channel_levels[chan][v][0] =
221 g_ntohs(devc->channel_levels[chan][v][0]);
222 devc->channel_levels[chan][v][1] =
223 g_ntohs(devc->channel_levels[chan][v][1]);
227 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
228 gs = g_string_sized_new(128);
229 for (chan = 0; chan < 2; chan++) {
230 g_string_printf(gs, "CH%d:", chan + 1);
231 for (v = 0; v < 9; v++) {
232 g_string_append_printf(gs, " %.4x-%.4x",
233 devc->channel_levels[chan][v][0],
234 devc->channel_levels[chan][v][1]);
238 g_string_free(gs, TRUE);
244 SR_PRIV int dso_set_trigger_samplerate(struct dev_context *devc)
247 uint8_t cmdstring[12];
248 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
249 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
250 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
251 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
253 sr_dbg("Preparing CMD_SET_TRIGGER_SAMPLERATE.");
255 memset(cmdstring, 0, sizeof(cmdstring));
257 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
260 sr_dbg("Trigger source %s.", devc->triggersource);
261 if (!strcmp("CH2", devc->triggersource))
263 else if (!strcmp("CH1", devc->triggersource))
265 else if (!strcmp("EXT", devc->triggersource))
268 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
274 sr_dbg("Frame size: %d.", devc->framesize);
275 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
278 sr_dbg("Time base index: %d.", devc->timebase);
279 switch (devc->framesize) {
280 case FRAMESIZE_SMALL:
281 if (devc->timebase < TIME_20us)
283 else if (devc->timebase == TIME_20us)
285 else if (devc->timebase == TIME_40us)
287 else if (devc->timebase == TIME_100us)
289 else if (devc->timebase >= TIME_200us)
292 case FRAMESIZE_LARGE:
293 if (devc->timebase < TIME_40us) {
294 sr_err("Timebase < 40us only supported with 10K buffer.");
297 else if (devc->timebase == TIME_40us)
299 else if (devc->timebase == TIME_100us)
301 else if (devc->timebase == TIME_200us)
303 else if (devc->timebase >= TIME_400us)
307 cmdstring[2] |= (tmp & 0x07) << 5;
309 /* Enabled channels: 00=CH1 01=CH2 10=both */
310 sr_dbg("Channels CH1=%d CH2=%d", devc->ch1_enabled, devc->ch2_enabled);
311 tmp = (((devc->ch2_enabled ? 1 : 0) << 1) + (devc->ch1_enabled ? 1 : 0)) - 1;
314 /* Fast rates channel */
315 /* TODO: Is this right? */
316 tmp = devc->timebase < TIME_10us ? 1 : 0;
317 cmdstring[3] |= tmp << 2;
319 /* Trigger slope: 0=positive 1=negative */
320 /* TODO: Does this work? */
321 sr_dbg("Trigger slope: %d.", devc->triggerslope);
322 cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
325 if (devc->timebase < TIME_100us)
327 else if (devc->timebase > TIME_400ms)
330 if (devc->framesize == FRAMESIZE_SMALL)
331 tmp = timebase_small[devc->timebase - 3];
333 tmp = timebase_large[devc->timebase - 3];
335 cmdstring[4] = tmp & 0xff;
336 cmdstring[5] = (tmp >> 8) & 0xff;
338 /* Horizontal trigger position */
339 sr_dbg("Trigger position: %3.2f.", devc->triggerposition);
340 tmp = 0x77fff + 0x8000 * devc->triggerposition;
341 cmdstring[6] = tmp & 0xff;
342 cmdstring[7] = (tmp >> 8) & 0xff;
343 cmdstring[10] = (tmp >> 16) & 0xff;
345 if (send_begin(devc) != SR_OK)
348 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
349 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
350 cmdstring, sizeof(cmdstring),
352 sr_err("Failed to set trigger/samplerate: %d.", ret);
355 sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
360 SR_PRIV int dso_set_filters(struct dev_context *devc)
363 uint8_t cmdstring[8];
365 sr_dbg("Preparing CMD_SET_FILTERS.");
367 memset(cmdstring, 0, sizeof(cmdstring));
368 cmdstring[0] = CMD_SET_FILTERS;
370 if (devc->filter_ch1) {
371 sr_dbg("Turning on CH1 filter.");
372 cmdstring[2] |= 0x80;
374 if (devc->filter_ch2) {
375 sr_dbg("Turning on CH2 filter.");
376 cmdstring[2] |= 0x40;
378 if (devc->filter_trigger) {
379 /* TODO: supported on the DSO-2090? */
380 sr_dbg("Turning on trigger filter.");
381 cmdstring[2] |= 0x20;
384 if (send_begin(devc) != SR_OK)
387 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
388 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
389 cmdstring, sizeof(cmdstring),
391 sr_err("Failed to set filters: %d", ret);
394 sr_dbg("Sent CMD_SET_FILTERS.");
399 SR_PRIV int dso_set_voltage(struct dev_context *devc)
402 uint8_t cmdstring[8];
404 sr_dbg("Preparing CMD_SET_VOLTAGE.");
406 memset(cmdstring, 0, sizeof(cmdstring));
407 cmdstring[0] = CMD_SET_VOLTAGE;
411 /* CH1 volts/div is encoded in bits 0-1 */
412 sr_dbg("CH1 vdiv index: %d.", devc->voltage_ch1);
413 switch (devc->voltage_ch1) {
417 cmdstring[2] |= 0x00;
422 cmdstring[2] |= 0x01;
427 cmdstring[2] |= 0x02;
431 /* CH2 volts/div is encoded in bits 2-3 */
432 sr_dbg("CH2 vdiv index: %d.", devc->voltage_ch2);
433 switch (devc->voltage_ch2) {
437 cmdstring[2] |= 0x00;
442 cmdstring[2] |= 0x04;
447 cmdstring[2] |= 0x08;
451 if (send_begin(devc) != SR_OK)
454 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
455 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
456 cmdstring, sizeof(cmdstring),
458 sr_err("Failed to set voltage: %d.", ret);
461 sr_dbg("Sent CMD_SET_VOLTAGE.");
466 SR_PRIV int dso_set_relays(struct dev_context *devc)
470 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
471 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
473 sr_dbg("Preparing CTRL_SETRELAYS.");
475 if (devc->voltage_ch1 < VDIV_1V)
476 relays[1] = ~relays[1];
478 if (devc->voltage_ch1 < VDIV_100MV)
479 relays[2] = ~relays[2];
481 sr_dbg("CH1 coupling: %d.", devc->coupling_ch1);
482 if (devc->coupling_ch1 != COUPLING_AC)
483 relays[3] = ~relays[3];
485 if (devc->voltage_ch2 < VDIV_1V)
486 relays[4] = ~relays[4];
488 if (devc->voltage_ch2 < VDIV_100MV)
489 relays[5] = ~relays[5];
491 sr_dbg("CH2 coupling: %d.", devc->coupling_ch1);
492 if (devc->coupling_ch2 != COUPLING_AC)
493 relays[6] = ~relays[6];
495 if (!strcmp(devc->triggersource, "EXT"))
496 relays[7] = ~relays[7];
498 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
499 gs = g_string_sized_new(128);
500 g_string_printf(gs, "Relays:");
501 for (i = 0; i < 17; i++)
502 g_string_append_printf(gs, " %.2x", relays[i]);
504 g_string_free(gs, TRUE);
507 if ((ret = libusb_control_transfer(devc->usb->devhdl,
508 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
509 0, 0, relays, 17, 100)) != sizeof(relays)) {
510 sr_err("Failed to set relays: %d.", ret);
513 sr_dbg("Sent CTRL_SETRELAYS.");
518 SR_PRIV int dso_set_voffsets(struct dev_context *devc)
524 sr_dbg("Preparing CTRL_SETOFFSET.");
526 memset(offsets, 0, sizeof(offsets));
528 ch_levels = devc->channel_levels[0][devc->voltage_ch1];
529 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
530 offsets[0] = (offset >> 8) | 0x20;
531 offsets[1] = offset & 0xff;
532 sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
533 offsets[0], offsets[1]);
536 ch_levels = devc->channel_levels[1][devc->voltage_ch2];
537 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
538 offsets[2] = (offset >> 8) | 0x20;
539 offsets[3] = offset & 0xff;
540 sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
541 offsets[2], offsets[3]);
544 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
545 offsets[4] = (offset >> 8) | 0x20;
546 offsets[5] = offset & 0xff;
547 sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
548 offsets[4], offsets[5]);
550 if ((ret = libusb_control_transfer(devc->usb->devhdl,
551 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
552 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
553 sr_err("Failed to set offsets: %d.", ret);
556 sr_dbg("Sent CTRL_SETOFFSET.");
561 SR_PRIV int dso_enable_trigger(struct dev_context *devc)
564 uint8_t cmdstring[2];
566 sr_dbg("Sending CMD_ENABLE_TRIGGER.");
568 memset(cmdstring, 0, sizeof(cmdstring));
569 cmdstring[0] = CMD_ENABLE_TRIGGER;
572 if (send_begin(devc) != SR_OK)
575 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
576 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
577 cmdstring, sizeof(cmdstring),
579 sr_err("Failed to enable trigger: %d.", ret);
586 SR_PRIV int dso_force_trigger(struct dev_context *devc)
589 uint8_t cmdstring[2];
591 sr_dbg("Sending CMD_FORCE_TRIGGER.");
593 memset(cmdstring, 0, sizeof(cmdstring));
594 cmdstring[0] = CMD_FORCE_TRIGGER;
597 if (send_begin(devc) != SR_OK)
600 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
601 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
602 cmdstring, sizeof(cmdstring),
604 sr_err("Failed to force trigger: %d.", ret);
611 SR_PRIV int dso_init(struct dev_context *devc)
614 sr_dbg("Initializing DSO.");
616 if (get_channel_offsets(devc) != SR_OK)
619 if (dso_set_trigger_samplerate(devc) != SR_OK)
622 if (dso_set_filters(devc) != SR_OK)
625 if (dso_set_voltage(devc) != SR_OK)
628 if (dso_set_relays(devc) != SR_OK)
631 if (dso_set_voffsets(devc) != SR_OK)
634 if (dso_enable_trigger(devc) != SR_OK)
640 SR_PRIV int dso_get_capturestate(struct dev_context *devc,
641 uint8_t *capturestate,
642 uint32_t *trigger_offset)
645 unsigned int bitvalue, toff;
646 uint8_t cmdstring[2], inbuf[512];
648 sr_dbg("Sending CMD_GET_CAPTURESTATE.");
650 cmdstring[0] = CMD_GET_CAPTURESTATE;
653 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
654 sr_dbg("Failed to send get_capturestate command: %d.", ret);
658 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
659 DSO_EP_IN | LIBUSB_ENDPOINT_IN,
660 inbuf, 512, &tmp, 100)) != 0) {
661 sr_dbg("Failed to get capturestate: %d.", ret);
664 *capturestate = inbuf[0];
665 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
668 * This conversion comes from the openhantek project.
669 * Each set bit in the 24-bit value inverts all bits with a lower
670 * value. No idea why the device reports the trigger point this way.
673 for (i = 0; i < 24; i++) {
674 /* Each set bit inverts all bits with a lower value. */
676 toff ^= bitvalue - 1;
679 *trigger_offset = toff;
684 SR_PRIV int dso_capture_start(struct dev_context *devc)
687 uint8_t cmdstring[2];
689 sr_dbg("Sending CMD_CAPTURE_START.");
691 cmdstring[0] = CMD_CAPTURE_START;
694 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
695 sr_err("Failed to send capture_start command: %d.", ret);
702 SR_PRIV int dso_get_channeldata(struct dev_context *devc, libusb_transfer_cb_fn cb)
704 struct libusb_transfer *transfer;
705 int num_transfers, ret, i;
706 uint8_t cmdstring[2];
709 sr_dbg("Sending CMD_GET_CHANNELDATA.");
711 cmdstring[0] = CMD_GET_CHANNELDATA;
714 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
715 sr_err("Failed to get channel data: %d.", ret);
719 /* TODO: DSO-2xxx only. */
720 num_transfers = devc->framesize *
721 sizeof(unsigned short) / devc->epin_maxpacketsize;
722 sr_dbg("Queueing up %d transfers.", num_transfers);
723 for (i = 0; i < num_transfers; i++) {
724 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
725 sr_err("Failed to malloc USB endpoint buffer.");
726 return SR_ERR_MALLOC;
728 transfer = libusb_alloc_transfer(0);
729 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
730 DSO_EP_IN | LIBUSB_ENDPOINT_IN, buf,
731 devc->epin_maxpacketsize, cb, devc, 40);
732 if ((ret = libusb_submit_transfer(transfer)) != 0) {
733 sr_err("Failed to submit transfer: %d.", ret);
734 /* TODO: Free them all. */
735 libusb_free_transfer(transfer);