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/>.
23 #include "sigrok-internal.h"
30 extern libusb_context *usb_context;
31 extern GSList *dev_insts;
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(int dev_index)
109 libusb_device **devlist;
110 struct libusb_device_descriptor des;
111 struct sr_dev_inst *sdi;
115 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
119 if (sdi->status == SR_ST_ACTIVE)
124 libusb_get_device_list(usb_context, &devlist);
125 for (i = 0; devlist[i]; i++) {
126 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
127 sr_err("hantek-dso: failed to get device descriptor: %d", err);
131 if (des.idVendor != ctx->profile->fw_vid
132 || des.idProduct != ctx->profile->fw_pid)
135 if (sdi->status == SR_ST_INITIALIZING) {
136 if (skip != dev_index) {
137 /* Skip devices of this type that aren't the one we want. */
141 } else if (sdi->status == SR_ST_INACTIVE) {
143 * This device is fully enumerated, so we need to find
144 * this device by vendor, product, bus and address.
146 if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus
147 || libusb_get_device_address(devlist[i]) != ctx->usb->address)
148 /* this is not the one */
152 if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) {
153 if (ctx->usb->address == 0xff)
155 * first time we touch this device after firmware upload,
156 * so we don't know the address yet.
158 ctx->usb->address = libusb_get_device_address(devlist[i]);
160 if(!(ctx->epin_maxpacketsize = dso_getmps(devlist[i])))
161 sr_err("hantek-dso: wrong endpoint profile");
163 sdi->status = SR_ST_ACTIVE;
164 sr_info("hantek-dso: opened device %d on %d.%d interface %d",
165 sdi->index, ctx->usb->bus,
166 ctx->usb->address, USB_INTERFACE);
169 sr_err("hantek-dso: failed to open device: %d", err);
172 /* if we made it here, we handled the device one way or another */
175 libusb_free_device_list(devlist, 1);
177 if (sdi->status != SR_ST_ACTIVE)
183 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
189 if (ctx->usb->devhdl == NULL)
192 sr_info("hantek-dso: closing device %d on %d.%d interface %d", sdi->index,
193 ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
194 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
195 libusb_close(ctx->usb->devhdl);
196 ctx->usb->devhdl = NULL;
197 sdi->status = SR_ST_INACTIVE;
201 static int get_channel_offsets(struct context *ctx)
206 sr_dbg("hantek-dso: getting channel offsets");
208 ret = libusb_control_transfer(ctx->usb->devhdl,
209 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
210 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
211 (unsigned char *)&ctx->channel_levels,
212 sizeof(ctx->channel_levels), 200);
213 if (ret != sizeof(ctx->channel_levels)) {
214 sr_err("failed to get channel offsets: %d", ret);
218 /* Comes in as 16-bit numbers with the second byte always 0 on
219 * the DSO-2090. Guessing this is supposed to be big-endian,
220 * since that's how voltage offsets are submitted back to the DSO.
221 * Convert to host order now, so we can use them natively.
223 for (chan = 0; chan < 2; chan++) {
224 for (v = 0; v < 9; v++) {
225 ctx->channel_levels[chan][v][0] = g_ntohs(ctx->channel_levels[chan][v][0]);
226 ctx->channel_levels[chan][v][1] = g_ntohs(ctx->channel_levels[chan][v][1]);
230 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
231 gs = g_string_sized_new(128);
232 for (chan = 0; chan < 2; chan++) {
233 g_string_printf(gs, "hantek-dso: CH%d:", chan + 1);
234 for (v = 0; v < 9; v++) {
235 g_string_append_printf(gs, " %.4x-%.4x",
236 ctx->channel_levels[chan][v][0],
237 ctx->channel_levels[chan][v][1]);
241 g_string_free(gs, TRUE);
247 SR_PRIV int dso_set_trigger_samplerate(struct context *ctx)
250 uint8_t cmdstring[12];
251 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
252 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
253 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
254 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
256 sr_dbg("hantek-dso: preparing CMD_SET_TRIGGER_SAMPLERATE");
258 memset(cmdstring, 0, sizeof(cmdstring));
260 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
263 sr_dbg("hantek-dso: trigger source %s", ctx->triggersource);
264 if (!strcmp("CH2", ctx->triggersource))
266 else if (!strcmp("CH1", ctx->triggersource))
268 else if (!strcmp("EXT", ctx->triggersource))
271 sr_err("hantek-dso: invalid trigger source %s", ctx->triggersource);
277 sr_dbg("hantek-dso: frame size %d", ctx->framesize);
278 cmdstring[2] |= (ctx->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
281 sr_dbg("hantek-dso: time base index %d", ctx->timebase);
282 switch (ctx->framesize) {
283 case FRAMESIZE_SMALL:
284 if (ctx->timebase < TIME_20us)
286 else if (ctx->timebase == TIME_20us)
288 else if (ctx->timebase == TIME_40us)
290 else if (ctx->timebase == TIME_100us)
292 else if (ctx->timebase >= TIME_200us)
295 case FRAMESIZE_LARGE:
296 if (ctx->timebase < TIME_40us) {
297 sr_err("hantek-dso: timebase < 40us only supported with 10K buffer");
300 else if (ctx->timebase == TIME_40us)
302 else if (ctx->timebase == TIME_100us)
304 else if (ctx->timebase == TIME_200us)
306 else if (ctx->timebase >= TIME_400us)
310 cmdstring[2] |= (tmp & 0x07) << 5;
312 /* Enabled channels: 00=CH1 01=CH2 10=both */
313 sr_dbg("hantek-dso: channels CH1=%d CH2=%d", ctx->ch1_enabled, ctx->ch2_enabled);
314 tmp = (((ctx->ch2_enabled ? 1 : 0) << 1) + (ctx->ch1_enabled ? 1 : 0)) - 1;
317 /* Fast rates channel */
318 /* TODO: is this right? */
319 tmp = ctx->timebase < TIME_10us ? 1 : 0;
320 cmdstring[3] |= tmp << 2;
322 /* Trigger slope: 0=positive 1=negative */
323 /* TODO: does this work? */
324 sr_dbg("hantek-dso: trigger slope %d", ctx->triggerslope);
325 cmdstring[3] |= (ctx->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
328 if (ctx->timebase < TIME_100us)
330 else if (ctx->timebase > TIME_400ms)
333 if (ctx->framesize == FRAMESIZE_SMALL)
334 tmp = timebase_small[ctx->timebase - 3];
336 tmp = timebase_large[ctx->timebase - 3];
338 cmdstring[4] = tmp & 0xff;
339 cmdstring[5] = (tmp >> 8) & 0xff;
341 /* Horizontal trigger position */
342 sr_dbg("hantek-dso: trigger position %3.2f", ctx->triggerposition);
343 tmp = 0x77fff + 0x8000 * ctx->triggerposition;
344 cmdstring[6] = tmp & 0xff;
345 cmdstring[7] = (tmp >> 8) & 0xff;
346 cmdstring[10] = (tmp >> 16) & 0xff;
348 if (send_begin(ctx) != SR_OK)
351 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
352 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
353 cmdstring, sizeof(cmdstring),
355 sr_err("Failed to set trigger/samplerate: %d", ret);
358 sr_dbg("hantek-dso: sent CMD_SET_TRIGGER_SAMPLERATE");
363 SR_PRIV int dso_set_filters(struct context *ctx)
366 uint8_t cmdstring[8];
368 sr_dbg("hantek-dso: preparing CMD_SET_FILTERS");
370 memset(cmdstring, 0, sizeof(cmdstring));
371 cmdstring[0] = CMD_SET_FILTERS;
373 if (ctx->filter_ch1) {
374 sr_dbg("hantek-dso: turning on CH1 filter");
375 cmdstring[2] |= 0x80;
377 if (ctx->filter_ch2) {
378 sr_dbg("hantek-dso: turning on CH2 filter");
379 cmdstring[2] |= 0x40;
381 if (ctx->filter_trigger) {
382 /* TODO: supported on the DSO-2090? */
383 sr_dbg("hantek-dso: turning on trigger filter");
384 cmdstring[2] |= 0x20;
387 if (send_begin(ctx) != SR_OK)
390 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
391 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
392 cmdstring, sizeof(cmdstring),
394 sr_err("Failed to set filters: %d", ret);
397 sr_dbg("hantek-dso: sent CMD_SET_FILTERS");
402 SR_PRIV int dso_set_voltage(struct context *ctx)
405 uint8_t cmdstring[8];
407 sr_dbg("hantek-dso: preparing CMD_SET_VOLTAGE");
409 memset(cmdstring, 0, sizeof(cmdstring));
410 cmdstring[0] = CMD_SET_VOLTAGE;
414 /* CH1 volts/div is encoded in bits 0-1 */
415 sr_dbg("hantek-dso: CH1 vdiv index %d", ctx->voltage_ch1);
416 switch (ctx->voltage_ch1) {
420 cmdstring[2] |= 0x00;
425 cmdstring[2] |= 0x01;
430 cmdstring[2] |= 0x02;
434 /* CH2 volts/div is encoded in bits 2-3 */
435 sr_dbg("hantek-dso: CH2 vdiv index %d", ctx->voltage_ch2);
436 switch (ctx->voltage_ch2) {
440 cmdstring[2] |= 0x00;
445 cmdstring[2] |= 0x04;
450 cmdstring[2] |= 0x08;
454 if (send_begin(ctx) != SR_OK)
457 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
458 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
459 cmdstring, sizeof(cmdstring),
461 sr_err("Failed to set voltage: %d", ret);
464 sr_dbg("hantek-dso: sent CMD_SET_VOLTAGE");
469 SR_PRIV int dso_set_relays(struct context *ctx)
473 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
474 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
476 sr_dbg("hantek-dso: preparing CTRL_SETRELAYS");
478 if (ctx->voltage_ch1 < VDIV_1V)
479 relays[1] = ~relays[1];
481 if (ctx->voltage_ch1 < VDIV_100MV)
482 relays[2] = ~relays[2];
484 sr_dbg("hantek-dso: CH1 coupling %d", ctx->coupling_ch1);
485 if (ctx->coupling_ch1 != COUPLING_AC)
486 relays[3] = ~relays[3];
488 if (ctx->voltage_ch2 < VDIV_1V)
489 relays[4] = ~relays[4];
491 if (ctx->voltage_ch2 < VDIV_100MV)
492 relays[5] = ~relays[5];
494 sr_dbg("hantek-dso: CH2 coupling %d", ctx->coupling_ch1);
495 if (ctx->coupling_ch2 != COUPLING_AC)
496 relays[6] = ~relays[6];
498 if (!strcmp(ctx->triggersource, "EXT"))
499 relays[7] = ~relays[7];
501 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
502 gs = g_string_sized_new(128);
503 g_string_printf(gs, "hantek-dso: relays:");
504 for (i = 0; i < 17; i++)
505 g_string_append_printf(gs, " %.2x", relays[i]);
507 g_string_free(gs, TRUE);
510 if ((ret = libusb_control_transfer(ctx->usb->devhdl,
511 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
512 0, 0, relays, 17, 100)) != sizeof(relays)) {
513 sr_err("failed to set relays: %d", ret);
516 sr_dbg("hantek-dso: sent CTRL_SETRELAYS");
521 SR_PRIV int dso_set_voffsets(struct context *ctx)
527 sr_dbg("hantek-dso: preparing CTRL_SETOFFSET");
529 memset(offsets, 0, sizeof(offsets));
531 ch_levels = ctx->channel_levels[0][ctx->voltage_ch1];
532 offset = (ch_levels[1] - ch_levels[0]) * ctx->voffset_ch1 + ch_levels[0];
533 offsets[0] = (offset >> 8) | 0x20;
534 offsets[1] = offset & 0xff;
535 sr_dbg("hantek-dso: CH1 offset %3.2f (%.2x%.2x)", ctx->voffset_ch1,
536 offsets[0], offsets[1]);
539 ch_levels = ctx->channel_levels[1][ctx->voltage_ch2];
540 offset = (ch_levels[1] - ch_levels[0]) * ctx->voffset_ch2 + ch_levels[0];
541 offsets[2] = (offset >> 8) | 0x20;
542 offsets[3] = offset & 0xff;
543 sr_dbg("hantek-dso: CH2 offset %3.2f (%.2x%.2x)", ctx->voffset_ch2,
544 offsets[2], offsets[3]);
547 offset = MAX_VERT_TRIGGER * ctx->voffset_trigger;
548 offsets[4] = (offset >> 8) | 0x20;
549 offsets[5] = offset & 0xff;
550 sr_dbg("hantek-dso: trigger offset %3.2f (%.2x%.2x)", ctx->voffset_trigger,
551 offsets[4], offsets[5]);
553 if ((ret = libusb_control_transfer(ctx->usb->devhdl,
554 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
555 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
556 sr_err("failed to set offsets: %d", ret);
559 sr_dbg("hantek-dso: sent CTRL_SETOFFSET");
564 SR_PRIV int dso_enable_trigger(struct context *ctx)
567 uint8_t cmdstring[2];
569 sr_dbg("hantek-dso: sending CMD_ENABLE_TRIGGER");
571 memset(cmdstring, 0, sizeof(cmdstring));
572 cmdstring[0] = CMD_ENABLE_TRIGGER;
575 if (send_begin(ctx) != SR_OK)
578 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
579 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
580 cmdstring, sizeof(cmdstring),
582 sr_err("Failed to enable trigger: %d", ret);
589 SR_PRIV int dso_force_trigger(struct context *ctx)
592 uint8_t cmdstring[2];
594 sr_dbg("hantek-dso: sending CMD_FORCE_TRIGGER");
596 memset(cmdstring, 0, sizeof(cmdstring));
597 cmdstring[0] = CMD_FORCE_TRIGGER;
600 if (send_begin(ctx) != SR_OK)
603 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
604 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
605 cmdstring, sizeof(cmdstring),
607 sr_err("Failed to force trigger: %d", ret);
614 SR_PRIV int dso_init(struct context *ctx)
617 sr_dbg("hantek-dso: initializing dso");
619 if (get_channel_offsets(ctx) != SR_OK)
622 if (dso_set_trigger_samplerate(ctx) != SR_OK)
625 if (dso_set_filters(ctx) != SR_OK)
628 if (dso_set_voltage(ctx) != SR_OK)
631 if (dso_set_relays(ctx) != SR_OK)
634 if (dso_set_voffsets(ctx) != SR_OK)
637 if (dso_enable_trigger(ctx) != SR_OK)
643 SR_PRIV int dso_get_capturestate(struct context *ctx, uint8_t *capturestate,
644 uint32_t *trigger_offset)
647 unsigned int bitvalue, toff;
648 uint8_t cmdstring[2], inbuf[512];
650 sr_dbg("hantek-dso: sending CMD_GET_CAPTURESTATE");
652 cmdstring[0] = CMD_GET_CAPTURESTATE;
655 if ((ret = send_bulkcmd(ctx, cmdstring, sizeof(cmdstring))) != SR_OK) {
656 sr_dbg("Failed to send get_capturestate command: %d", ret);
660 if ((ret = libusb_bulk_transfer(ctx->usb->devhdl,
661 DSO_EP_IN | LIBUSB_ENDPOINT_IN,
662 inbuf, 512, &tmp, 100)) != 0) {
663 sr_dbg("Failed to get capturestate: %d", ret);
666 *capturestate = inbuf[0];
667 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
669 /* This conversion comes from the openhantek project.
670 * Each set bit in the 24-bit value inverts all bits with a lower
671 * value. No idea why the device reports the trigger point this way.
674 for (i = 0; i < 24; i++) {
675 /* Each set bit inverts all bits with a lower value. */
677 toff ^= bitvalue - 1;
680 *trigger_offset = toff;
685 SR_PRIV int dso_capture_start(struct context *ctx)
688 uint8_t cmdstring[2];
690 sr_dbg("hantek-dso: sending CMD_CAPTURE_START");
692 cmdstring[0] = CMD_CAPTURE_START;
695 if ((ret = send_bulkcmd(ctx, cmdstring, sizeof(cmdstring))) != SR_OK) {
696 sr_err("Failed to send capture_start command: %d", ret);
703 SR_PRIV int dso_get_channeldata(struct context *ctx, libusb_transfer_cb_fn cb)
705 struct libusb_transfer *transfer;
706 int num_transfers, ret, i;
707 uint8_t cmdstring[2];
710 sr_dbg("hantek-dso: sending CMD_GET_CHANNELDATA");
712 cmdstring[0] = CMD_GET_CHANNELDATA;
715 if ((ret = send_bulkcmd(ctx, cmdstring, sizeof(cmdstring))) != SR_OK) {
716 sr_err("Failed to get channel data: %d", ret);
720 /* TODO: dso-2xxx only */
721 num_transfers = ctx->framesize * sizeof(unsigned short) / ctx->epin_maxpacketsize;
722 sr_dbg("hantek-dso: queueing up %d transfers", num_transfers);
723 for (i = 0; i < num_transfers; i++) {
724 if (!(buf = g_try_malloc(ctx->epin_maxpacketsize))) {
725 sr_err("hantek-dso: %s: buf malloc failed", __func__);
726 return SR_ERR_MALLOC;
728 transfer = libusb_alloc_transfer(0);
729 libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
730 DSO_EP_IN | LIBUSB_ENDPOINT_IN, buf,
731 ctx->epin_maxpacketsize, cb, ctx, 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);