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"
30 extern libusb_context *usb_context;
31 extern struct sr_dev_driver hantek_dso_driver_info;
34 static int send_begin(struct context *ctx)
37 unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
40 sr_dbg("hantek-dso: sending CTRL_BEGINCOMMAND");
42 if ((ret = libusb_control_transfer(ctx->usb->devhdl,
43 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_BEGINCOMMAND,
44 0, 0, buffer, sizeof(buffer), 200)) != sizeof(buffer)) {
45 sr_err("failed to send begincommand: %d", ret);
52 static int send_bulkcmd(struct context *ctx, uint8_t *cmdstring, int cmdlen)
56 if (send_begin(ctx) != SR_OK)
59 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
60 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
61 cmdstring, cmdlen, &tmp, 200)) != 0)
67 SR_PRIV int dso_getmps(libusb_device *dev)
69 struct libusb_device_descriptor des;
70 struct libusb_config_descriptor *conf_dsc;
71 const struct libusb_interface_descriptor *intf_dsc;
74 if (libusb_get_device_descriptor(dev, &des) != 0)
77 if (des.bNumConfigurations != 1)
80 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
84 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
85 if (intf_dsc->bNumEndpoints != 2)
88 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
89 (2 | LIBUSB_ENDPOINT_OUT))
90 /* The first endpoint should be 2 (outbound). */
93 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
94 (6 | LIBUSB_ENDPOINT_IN))
95 /* The second endpoint should be 6 (inbound). */
98 mps = intf_dsc->endpoint[1].wMaxPacketSize;
102 libusb_free_config_descriptor(conf_dsc);
107 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
109 libusb_device **devlist;
110 struct libusb_device_descriptor des;
116 if (sdi->status == SR_ST_ACTIVE)
121 libusb_get_device_list(usb_context, &devlist);
122 for (i = 0; devlist[i]; i++) {
123 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
124 sr_err("hantek-dso: failed to get device descriptor: %d", err);
128 if (des.idVendor != ctx->profile->fw_vid
129 || des.idProduct != ctx->profile->fw_pid)
132 if (sdi->status == SR_ST_INITIALIZING) {
133 if (skip != sdi->index) {
134 /* Skip devices of this type that aren't the one we want. */
138 } else if (sdi->status == SR_ST_INACTIVE) {
140 * This device is fully enumerated, so we need to find
141 * this device by vendor, product, bus and address.
143 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
144 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
145 /* this is not the one */
149 if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) {
150 if (ctx->usb->address == 0xff)
152 * first time we touch this device after firmware upload,
153 * so we don't know the address yet.
155 ctx->usb->address = libusb_get_device_address(devlist[i]);
157 if(!(ctx->epin_maxpacketsize = dso_getmps(devlist[i])))
158 sr_err("hantek-dso: wrong endpoint profile");
160 sdi->status = SR_ST_ACTIVE;
161 sr_info("hantek-dso: opened device %d on %d.%d interface %d",
162 sdi->index, ctx->usb->bus,
163 ctx->usb->address, USB_INTERFACE);
166 sr_err("hantek-dso: failed to open device: %d", err);
169 /* if we made it here, we handled the device one way or another */
172 libusb_free_device_list(devlist, 1);
174 if (sdi->status != SR_ST_ACTIVE)
180 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
186 if (ctx->usb->devhdl == NULL)
189 sr_info("hantek-dso: closing device %d on %d.%d interface %d", sdi->index,
190 ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
191 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
192 libusb_close(ctx->usb->devhdl);
193 ctx->usb->devhdl = NULL;
194 sdi->status = SR_ST_INACTIVE;
198 static int get_channel_offsets(struct context *ctx)
203 sr_dbg("hantek-dso: getting channel offsets");
205 ret = libusb_control_transfer(ctx->usb->devhdl,
206 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
207 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
208 (unsigned char *)&ctx->channel_levels,
209 sizeof(ctx->channel_levels), 200);
210 if (ret != sizeof(ctx->channel_levels)) {
211 sr_err("failed to get channel offsets: %d", ret);
215 /* Comes in as 16-bit numbers with the second byte always 0 on
216 * the DSO-2090. Guessing this is supposed to be big-endian,
217 * since that's how voltage offsets are submitted back to the DSO.
218 * Convert to host order now, so we can use them natively.
220 for (chan = 0; chan < 2; chan++) {
221 for (v = 0; v < 9; v++) {
222 ctx->channel_levels[chan][v][0] = g_ntohs(ctx->channel_levels[chan][v][0]);
223 ctx->channel_levels[chan][v][1] = g_ntohs(ctx->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, "hantek-dso: CH%d:", chan + 1);
231 for (v = 0; v < 9; v++) {
232 g_string_append_printf(gs, " %.4x-%.4x",
233 ctx->channel_levels[chan][v][0],
234 ctx->channel_levels[chan][v][1]);
238 g_string_free(gs, TRUE);
244 SR_PRIV int dso_set_trigger_samplerate(struct context *ctx)
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("hantek-dso: preparing CMD_SET_TRIGGER_SAMPLERATE");
255 memset(cmdstring, 0, sizeof(cmdstring));
257 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
260 sr_dbg("hantek-dso: trigger source %s", ctx->triggersource);
261 if (!strcmp("CH2", ctx->triggersource))
263 else if (!strcmp("CH1", ctx->triggersource))
265 else if (!strcmp("EXT", ctx->triggersource))
268 sr_err("hantek-dso: invalid trigger source %s", ctx->triggersource);
274 sr_dbg("hantek-dso: frame size %d", ctx->framesize);
275 cmdstring[2] |= (ctx->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
278 sr_dbg("hantek-dso: time base index %d", ctx->timebase);
279 switch (ctx->framesize) {
280 case FRAMESIZE_SMALL:
281 if (ctx->timebase < TIME_20us)
283 else if (ctx->timebase == TIME_20us)
285 else if (ctx->timebase == TIME_40us)
287 else if (ctx->timebase == TIME_100us)
289 else if (ctx->timebase >= TIME_200us)
292 case FRAMESIZE_LARGE:
293 if (ctx->timebase < TIME_40us) {
294 sr_err("hantek-dso: timebase < 40us only supported with 10K buffer");
297 else if (ctx->timebase == TIME_40us)
299 else if (ctx->timebase == TIME_100us)
301 else if (ctx->timebase == TIME_200us)
303 else if (ctx->timebase >= TIME_400us)
307 cmdstring[2] |= (tmp & 0x07) << 5;
309 /* Enabled channels: 00=CH1 01=CH2 10=both */
310 sr_dbg("hantek-dso: channels CH1=%d CH2=%d", ctx->ch1_enabled, ctx->ch2_enabled);
311 tmp = (((ctx->ch2_enabled ? 1 : 0) << 1) + (ctx->ch1_enabled ? 1 : 0)) - 1;
314 /* Fast rates channel */
315 /* TODO: is this right? */
316 tmp = ctx->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("hantek-dso: trigger slope %d", ctx->triggerslope);
322 cmdstring[3] |= (ctx->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
325 if (ctx->timebase < TIME_100us)
327 else if (ctx->timebase > TIME_400ms)
330 if (ctx->framesize == FRAMESIZE_SMALL)
331 tmp = timebase_small[ctx->timebase - 3];
333 tmp = timebase_large[ctx->timebase - 3];
335 cmdstring[4] = tmp & 0xff;
336 cmdstring[5] = (tmp >> 8) & 0xff;
338 /* Horizontal trigger position */
339 sr_dbg("hantek-dso: trigger position %3.2f", ctx->triggerposition);
340 tmp = 0x77fff + 0x8000 * ctx->triggerposition;
341 cmdstring[6] = tmp & 0xff;
342 cmdstring[7] = (tmp >> 8) & 0xff;
343 cmdstring[10] = (tmp >> 16) & 0xff;
345 if (send_begin(ctx) != SR_OK)
348 if ((ret = libusb_bulk_transfer(ctx->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("hantek-dso: sent CMD_SET_TRIGGER_SAMPLERATE");
360 SR_PRIV int dso_set_filters(struct context *ctx)
363 uint8_t cmdstring[8];
365 sr_dbg("hantek-dso: preparing CMD_SET_FILTERS");
367 memset(cmdstring, 0, sizeof(cmdstring));
368 cmdstring[0] = CMD_SET_FILTERS;
370 if (ctx->filter_ch1) {
371 sr_dbg("hantek-dso: turning on CH1 filter");
372 cmdstring[2] |= 0x80;
374 if (ctx->filter_ch2) {
375 sr_dbg("hantek-dso: turning on CH2 filter");
376 cmdstring[2] |= 0x40;
378 if (ctx->filter_trigger) {
379 /* TODO: supported on the DSO-2090? */
380 sr_dbg("hantek-dso: turning on trigger filter");
381 cmdstring[2] |= 0x20;
384 if (send_begin(ctx) != SR_OK)
387 if ((ret = libusb_bulk_transfer(ctx->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("hantek-dso: sent CMD_SET_FILTERS");
399 SR_PRIV int dso_set_voltage(struct context *ctx)
402 uint8_t cmdstring[8];
404 sr_dbg("hantek-dso: 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("hantek-dso: CH1 vdiv index %d", ctx->voltage_ch1);
413 switch (ctx->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("hantek-dso: CH2 vdiv index %d", ctx->voltage_ch2);
433 switch (ctx->voltage_ch2) {
437 cmdstring[2] |= 0x00;
442 cmdstring[2] |= 0x04;
447 cmdstring[2] |= 0x08;
451 if (send_begin(ctx) != SR_OK)
454 if ((ret = libusb_bulk_transfer(ctx->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("hantek-dso: sent CMD_SET_VOLTAGE");
466 SR_PRIV int dso_set_relays(struct context *ctx)
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("hantek-dso: preparing CTRL_SETRELAYS");
475 if (ctx->voltage_ch1 < VDIV_1V)
476 relays[1] = ~relays[1];
478 if (ctx->voltage_ch1 < VDIV_100MV)
479 relays[2] = ~relays[2];
481 sr_dbg("hantek-dso: CH1 coupling %d", ctx->coupling_ch1);
482 if (ctx->coupling_ch1 != COUPLING_AC)
483 relays[3] = ~relays[3];
485 if (ctx->voltage_ch2 < VDIV_1V)
486 relays[4] = ~relays[4];
488 if (ctx->voltage_ch2 < VDIV_100MV)
489 relays[5] = ~relays[5];
491 sr_dbg("hantek-dso: CH2 coupling %d", ctx->coupling_ch1);
492 if (ctx->coupling_ch2 != COUPLING_AC)
493 relays[6] = ~relays[6];
495 if (!strcmp(ctx->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, "hantek-dso: 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(ctx->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("hantek-dso: sent CTRL_SETRELAYS");
518 SR_PRIV int dso_set_voffsets(struct context *ctx)
524 sr_dbg("hantek-dso: preparing CTRL_SETOFFSET");
526 memset(offsets, 0, sizeof(offsets));
528 ch_levels = ctx->channel_levels[0][ctx->voltage_ch1];
529 offset = (ch_levels[1] - ch_levels[0]) * ctx->voffset_ch1 + ch_levels[0];
530 offsets[0] = (offset >> 8) | 0x20;
531 offsets[1] = offset & 0xff;
532 sr_dbg("hantek-dso: CH1 offset %3.2f (%.2x%.2x)", ctx->voffset_ch1,
533 offsets[0], offsets[1]);
536 ch_levels = ctx->channel_levels[1][ctx->voltage_ch2];
537 offset = (ch_levels[1] - ch_levels[0]) * ctx->voffset_ch2 + ch_levels[0];
538 offsets[2] = (offset >> 8) | 0x20;
539 offsets[3] = offset & 0xff;
540 sr_dbg("hantek-dso: CH2 offset %3.2f (%.2x%.2x)", ctx->voffset_ch2,
541 offsets[2], offsets[3]);
544 offset = MAX_VERT_TRIGGER * ctx->voffset_trigger;
545 offsets[4] = (offset >> 8) | 0x20;
546 offsets[5] = offset & 0xff;
547 sr_dbg("hantek-dso: trigger offset %3.2f (%.2x%.2x)", ctx->voffset_trigger,
548 offsets[4], offsets[5]);
550 if ((ret = libusb_control_transfer(ctx->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("hantek-dso: sent CTRL_SETOFFSET");
561 SR_PRIV int dso_enable_trigger(struct context *ctx)
564 uint8_t cmdstring[2];
566 sr_dbg("hantek-dso: sending CMD_ENABLE_TRIGGER");
568 memset(cmdstring, 0, sizeof(cmdstring));
569 cmdstring[0] = CMD_ENABLE_TRIGGER;
572 if (send_begin(ctx) != SR_OK)
575 if ((ret = libusb_bulk_transfer(ctx->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 context *ctx)
589 uint8_t cmdstring[2];
591 sr_dbg("hantek-dso: sending CMD_FORCE_TRIGGER");
593 memset(cmdstring, 0, sizeof(cmdstring));
594 cmdstring[0] = CMD_FORCE_TRIGGER;
597 if (send_begin(ctx) != SR_OK)
600 if ((ret = libusb_bulk_transfer(ctx->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 context *ctx)
614 sr_dbg("hantek-dso: initializing dso");
616 if (get_channel_offsets(ctx) != SR_OK)
619 if (dso_set_trigger_samplerate(ctx) != SR_OK)
622 if (dso_set_filters(ctx) != SR_OK)
625 if (dso_set_voltage(ctx) != SR_OK)
628 if (dso_set_relays(ctx) != SR_OK)
631 if (dso_set_voffsets(ctx) != SR_OK)
634 if (dso_enable_trigger(ctx) != SR_OK)
640 SR_PRIV int dso_get_capturestate(struct context *ctx, uint8_t *capturestate,
641 uint32_t *trigger_offset)
644 unsigned int bitvalue, toff;
645 uint8_t cmdstring[2], inbuf[512];
647 sr_dbg("hantek-dso: sending CMD_GET_CAPTURESTATE");
649 cmdstring[0] = CMD_GET_CAPTURESTATE;
652 if ((ret = send_bulkcmd(ctx, cmdstring, sizeof(cmdstring))) != SR_OK) {
653 sr_dbg("Failed to send get_capturestate command: %d", ret);
657 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
658 DSO_EP_IN | LIBUSB_ENDPOINT_IN,
659 inbuf, 512, &tmp, 100)) != 0) {
660 sr_dbg("Failed to get capturestate: %d", ret);
663 *capturestate = inbuf[0];
664 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
666 /* This conversion comes from the openhantek project.
667 * Each set bit in the 24-bit value inverts all bits with a lower
668 * value. No idea why the device reports the trigger point this way.
671 for (i = 0; i < 24; i++) {
672 /* Each set bit inverts all bits with a lower value. */
674 toff ^= bitvalue - 1;
677 *trigger_offset = toff;
682 SR_PRIV int dso_capture_start(struct context *ctx)
685 uint8_t cmdstring[2];
687 sr_dbg("hantek-dso: sending CMD_CAPTURE_START");
689 cmdstring[0] = CMD_CAPTURE_START;
692 if ((ret = send_bulkcmd(ctx, cmdstring, sizeof(cmdstring))) != SR_OK) {
693 sr_err("Failed to send capture_start command: %d", ret);
700 SR_PRIV int dso_get_channeldata(struct context *ctx, libusb_transfer_cb_fn cb)
702 struct libusb_transfer *transfer;
703 int num_transfers, ret, i;
704 uint8_t cmdstring[2];
707 sr_dbg("hantek-dso: sending CMD_GET_CHANNELDATA");
709 cmdstring[0] = CMD_GET_CHANNELDATA;
712 if ((ret = send_bulkcmd(ctx, cmdstring, sizeof(cmdstring))) != SR_OK) {
713 sr_err("Failed to get channel data: %d", ret);
717 /* TODO: dso-2xxx only */
718 num_transfers = ctx->framesize * sizeof(unsigned short) / ctx->epin_maxpacketsize;
719 sr_dbg("hantek-dso: queueing up %d transfers", num_transfers);
720 for (i = 0; i < num_transfers; i++) {
721 if (!(buf = g_try_malloc(ctx->epin_maxpacketsize))) {
722 sr_err("hantek-dso: %s: buf malloc failed", __func__);
723 return SR_ERR_MALLOC;
725 transfer = libusb_alloc_transfer(0);
726 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
727 DSO_EP_IN | LIBUSB_ENDPOINT_IN, buf,
728 ctx->epin_maxpacketsize, cb, ctx, 40);
729 if ((ret = libusb_submit_transfer(transfer)) != 0) {
730 sr_err("failed to submit transfer: %d", ret);
731 /* TODO: Free them all. */
732 libusb_free_transfer(transfer);