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 struct sr_dev_driver hantek_dso_driver_info;
31 static struct sr_dev_driver *hdi = &hantek_dso_driver_info;
34 static int send_begin(struct dev_context *devc)
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(devc->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 dev_context *devc, uint8_t *cmdstring, int cmdlen)
56 if (send_begin(devc) != SR_OK)
59 if ((ret = libusb_bulk_transfer(devc->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;
111 struct drv_context *drvc;
112 struct dev_context *devc;
118 if (sdi->status == SR_ST_ACTIVE)
123 libusb_get_device_list(drvc->usb_context, &devlist);
124 for (i = 0; devlist[i]; i++) {
125 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
126 sr_err("hantek-dso: failed to get device descriptor: %d", err);
130 if (des.idVendor != devc->profile->fw_vid
131 || des.idProduct != devc->profile->fw_pid)
134 if (sdi->status == SR_ST_INITIALIZING) {
135 if (skip != sdi->index) {
136 /* Skip devices of this type that aren't the one we want. */
140 } else if (sdi->status == SR_ST_INACTIVE) {
142 * This device is fully enumerated, so we need to find
143 * this device by vendor, product, bus and address.
145 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
146 || libusb_get_device_address(devlist[i]) != devc->usb->address)
147 /* this is not the one */
151 if (!(err = libusb_open(devlist[i], &devc->usb->devhdl))) {
152 if (devc->usb->address == 0xff)
154 * first time we touch this device after firmware upload,
155 * so we don't know the address yet.
157 devc->usb->address = libusb_get_device_address(devlist[i]);
159 if(!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
160 sr_err("hantek-dso: wrong endpoint profile");
162 sdi->status = SR_ST_ACTIVE;
163 sr_info("hantek-dso: opened device %d on %d.%d interface %d",
164 sdi->index, devc->usb->bus,
165 devc->usb->address, USB_INTERFACE);
168 sr_err("hantek-dso: failed to open device: %d", err);
171 /* if we made it here, we handled the device one way or another */
174 libusb_free_device_list(devlist, 1);
176 if (sdi->status != SR_ST_ACTIVE)
182 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
184 struct dev_context *devc;
188 if (devc->usb->devhdl == NULL)
191 sr_info("hantek-dso: closing device %d on %d.%d interface %d", sdi->index,
192 devc->usb->bus, devc->usb->address, USB_INTERFACE);
193 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
194 libusb_close(devc->usb->devhdl);
195 devc->usb->devhdl = NULL;
196 sdi->status = SR_ST_INACTIVE;
200 static int get_channel_offsets(struct dev_context *devc)
205 sr_dbg("hantek-dso: getting channel offsets");
207 ret = libusb_control_transfer(devc->usb->devhdl,
208 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
209 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
210 (unsigned char *)&devc->channel_levels,
211 sizeof(devc->channel_levels), 200);
212 if (ret != sizeof(devc->channel_levels)) {
213 sr_err("failed to get channel offsets: %d", ret);
217 /* Comes in as 16-bit numbers with the second byte always 0 on
218 * the DSO-2090. Guessing this is supposed to be big-endian,
219 * since that's how voltage offsets are submitted back to the DSO.
220 * Convert to host order now, so we can use them natively.
222 for (chan = 0; chan < 2; chan++) {
223 for (v = 0; v < 9; v++) {
224 devc->channel_levels[chan][v][0] = g_ntohs(devc->channel_levels[chan][v][0]);
225 devc->channel_levels[chan][v][1] = g_ntohs(devc->channel_levels[chan][v][1]);
229 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
230 gs = g_string_sized_new(128);
231 for (chan = 0; chan < 2; chan++) {
232 g_string_printf(gs, "hantek-dso: CH%d:", chan + 1);
233 for (v = 0; v < 9; v++) {
234 g_string_append_printf(gs, " %.4x-%.4x",
235 devc->channel_levels[chan][v][0],
236 devc->channel_levels[chan][v][1]);
240 g_string_free(gs, TRUE);
246 SR_PRIV int dso_set_trigger_samplerate(struct dev_context *devc)
249 uint8_t cmdstring[12];
250 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
251 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
252 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
253 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
255 sr_dbg("hantek-dso: preparing CMD_SET_TRIGGER_SAMPLERATE");
257 memset(cmdstring, 0, sizeof(cmdstring));
259 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
262 sr_dbg("hantek-dso: trigger source %s", devc->triggersource);
263 if (!strcmp("CH2", devc->triggersource))
265 else if (!strcmp("CH1", devc->triggersource))
267 else if (!strcmp("EXT", devc->triggersource))
270 sr_err("hantek-dso: invalid trigger source %s", devc->triggersource);
276 sr_dbg("hantek-dso: frame size %d", devc->framesize);
277 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
280 sr_dbg("hantek-dso: time base index %d", devc->timebase);
281 switch (devc->framesize) {
282 case FRAMESIZE_SMALL:
283 if (devc->timebase < TIME_20us)
285 else if (devc->timebase == TIME_20us)
287 else if (devc->timebase == TIME_40us)
289 else if (devc->timebase == TIME_100us)
291 else if (devc->timebase >= TIME_200us)
294 case FRAMESIZE_LARGE:
295 if (devc->timebase < TIME_40us) {
296 sr_err("hantek-dso: timebase < 40us only supported with 10K buffer");
299 else if (devc->timebase == TIME_40us)
301 else if (devc->timebase == TIME_100us)
303 else if (devc->timebase == TIME_200us)
305 else if (devc->timebase >= TIME_400us)
309 cmdstring[2] |= (tmp & 0x07) << 5;
311 /* Enabled channels: 00=CH1 01=CH2 10=both */
312 sr_dbg("hantek-dso: channels CH1=%d CH2=%d", devc->ch1_enabled, devc->ch2_enabled);
313 tmp = (((devc->ch2_enabled ? 1 : 0) << 1) + (devc->ch1_enabled ? 1 : 0)) - 1;
316 /* Fast rates channel */
317 /* TODO: is this right? */
318 tmp = devc->timebase < TIME_10us ? 1 : 0;
319 cmdstring[3] |= tmp << 2;
321 /* Trigger slope: 0=positive 1=negative */
322 /* TODO: does this work? */
323 sr_dbg("hantek-dso: trigger slope %d", devc->triggerslope);
324 cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
327 if (devc->timebase < TIME_100us)
329 else if (devc->timebase > TIME_400ms)
332 if (devc->framesize == FRAMESIZE_SMALL)
333 tmp = timebase_small[devc->timebase - 3];
335 tmp = timebase_large[devc->timebase - 3];
337 cmdstring[4] = tmp & 0xff;
338 cmdstring[5] = (tmp >> 8) & 0xff;
340 /* Horizontal trigger position */
341 sr_dbg("hantek-dso: trigger position %3.2f", devc->triggerposition);
342 tmp = 0x77fff + 0x8000 * devc->triggerposition;
343 cmdstring[6] = tmp & 0xff;
344 cmdstring[7] = (tmp >> 8) & 0xff;
345 cmdstring[10] = (tmp >> 16) & 0xff;
347 if (send_begin(devc) != SR_OK)
350 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
351 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
352 cmdstring, sizeof(cmdstring),
354 sr_err("Failed to set trigger/samplerate: %d", ret);
357 sr_dbg("hantek-dso: sent CMD_SET_TRIGGER_SAMPLERATE");
362 SR_PRIV int dso_set_filters(struct dev_context *devc)
365 uint8_t cmdstring[8];
367 sr_dbg("hantek-dso: preparing CMD_SET_FILTERS");
369 memset(cmdstring, 0, sizeof(cmdstring));
370 cmdstring[0] = CMD_SET_FILTERS;
372 if (devc->filter_ch1) {
373 sr_dbg("hantek-dso: turning on CH1 filter");
374 cmdstring[2] |= 0x80;
376 if (devc->filter_ch2) {
377 sr_dbg("hantek-dso: turning on CH2 filter");
378 cmdstring[2] |= 0x40;
380 if (devc->filter_trigger) {
381 /* TODO: supported on the DSO-2090? */
382 sr_dbg("hantek-dso: turning on trigger filter");
383 cmdstring[2] |= 0x20;
386 if (send_begin(devc) != SR_OK)
389 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
390 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
391 cmdstring, sizeof(cmdstring),
393 sr_err("Failed to set filters: %d", ret);
396 sr_dbg("hantek-dso: sent CMD_SET_FILTERS");
401 SR_PRIV int dso_set_voltage(struct dev_context *devc)
404 uint8_t cmdstring[8];
406 sr_dbg("hantek-dso: preparing CMD_SET_VOLTAGE");
408 memset(cmdstring, 0, sizeof(cmdstring));
409 cmdstring[0] = CMD_SET_VOLTAGE;
413 /* CH1 volts/div is encoded in bits 0-1 */
414 sr_dbg("hantek-dso: CH1 vdiv index %d", devc->voltage_ch1);
415 switch (devc->voltage_ch1) {
419 cmdstring[2] |= 0x00;
424 cmdstring[2] |= 0x01;
429 cmdstring[2] |= 0x02;
433 /* CH2 volts/div is encoded in bits 2-3 */
434 sr_dbg("hantek-dso: CH2 vdiv index %d", devc->voltage_ch2);
435 switch (devc->voltage_ch2) {
439 cmdstring[2] |= 0x00;
444 cmdstring[2] |= 0x04;
449 cmdstring[2] |= 0x08;
453 if (send_begin(devc) != SR_OK)
456 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
457 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
458 cmdstring, sizeof(cmdstring),
460 sr_err("Failed to set voltage: %d", ret);
463 sr_dbg("hantek-dso: sent CMD_SET_VOLTAGE");
468 SR_PRIV int dso_set_relays(struct dev_context *devc)
472 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
473 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
475 sr_dbg("hantek-dso: preparing CTRL_SETRELAYS");
477 if (devc->voltage_ch1 < VDIV_1V)
478 relays[1] = ~relays[1];
480 if (devc->voltage_ch1 < VDIV_100MV)
481 relays[2] = ~relays[2];
483 sr_dbg("hantek-dso: CH1 coupling %d", devc->coupling_ch1);
484 if (devc->coupling_ch1 != COUPLING_AC)
485 relays[3] = ~relays[3];
487 if (devc->voltage_ch2 < VDIV_1V)
488 relays[4] = ~relays[4];
490 if (devc->voltage_ch2 < VDIV_100MV)
491 relays[5] = ~relays[5];
493 sr_dbg("hantek-dso: CH2 coupling %d", devc->coupling_ch1);
494 if (devc->coupling_ch2 != COUPLING_AC)
495 relays[6] = ~relays[6];
497 if (!strcmp(devc->triggersource, "EXT"))
498 relays[7] = ~relays[7];
500 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
501 gs = g_string_sized_new(128);
502 g_string_printf(gs, "hantek-dso: relays:");
503 for (i = 0; i < 17; i++)
504 g_string_append_printf(gs, " %.2x", relays[i]);
506 g_string_free(gs, TRUE);
509 if ((ret = libusb_control_transfer(devc->usb->devhdl,
510 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
511 0, 0, relays, 17, 100)) != sizeof(relays)) {
512 sr_err("failed to set relays: %d", ret);
515 sr_dbg("hantek-dso: sent CTRL_SETRELAYS");
520 SR_PRIV int dso_set_voffsets(struct dev_context *devc)
526 sr_dbg("hantek-dso: preparing CTRL_SETOFFSET");
528 memset(offsets, 0, sizeof(offsets));
530 ch_levels = devc->channel_levels[0][devc->voltage_ch1];
531 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
532 offsets[0] = (offset >> 8) | 0x20;
533 offsets[1] = offset & 0xff;
534 sr_dbg("hantek-dso: CH1 offset %3.2f (%.2x%.2x)", devc->voffset_ch1,
535 offsets[0], offsets[1]);
538 ch_levels = devc->channel_levels[1][devc->voltage_ch2];
539 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
540 offsets[2] = (offset >> 8) | 0x20;
541 offsets[3] = offset & 0xff;
542 sr_dbg("hantek-dso: CH2 offset %3.2f (%.2x%.2x)", devc->voffset_ch2,
543 offsets[2], offsets[3]);
546 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
547 offsets[4] = (offset >> 8) | 0x20;
548 offsets[5] = offset & 0xff;
549 sr_dbg("hantek-dso: trigger offset %3.2f (%.2x%.2x)", devc->voffset_trigger,
550 offsets[4], offsets[5]);
552 if ((ret = libusb_control_transfer(devc->usb->devhdl,
553 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
554 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
555 sr_err("failed to set offsets: %d", ret);
558 sr_dbg("hantek-dso: sent CTRL_SETOFFSET");
563 SR_PRIV int dso_enable_trigger(struct dev_context *devc)
566 uint8_t cmdstring[2];
568 sr_dbg("hantek-dso: sending CMD_ENABLE_TRIGGER");
570 memset(cmdstring, 0, sizeof(cmdstring));
571 cmdstring[0] = CMD_ENABLE_TRIGGER;
574 if (send_begin(devc) != SR_OK)
577 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
578 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
579 cmdstring, sizeof(cmdstring),
581 sr_err("Failed to enable trigger: %d", ret);
588 SR_PRIV int dso_force_trigger(struct dev_context *devc)
591 uint8_t cmdstring[2];
593 sr_dbg("hantek-dso: sending CMD_FORCE_TRIGGER");
595 memset(cmdstring, 0, sizeof(cmdstring));
596 cmdstring[0] = CMD_FORCE_TRIGGER;
599 if (send_begin(devc) != SR_OK)
602 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
603 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
604 cmdstring, sizeof(cmdstring),
606 sr_err("Failed to force trigger: %d", ret);
613 SR_PRIV int dso_init(struct dev_context *devc)
616 sr_dbg("hantek-dso: initializing dso");
618 if (get_channel_offsets(devc) != SR_OK)
621 if (dso_set_trigger_samplerate(devc) != SR_OK)
624 if (dso_set_filters(devc) != SR_OK)
627 if (dso_set_voltage(devc) != SR_OK)
630 if (dso_set_relays(devc) != SR_OK)
633 if (dso_set_voffsets(devc) != SR_OK)
636 if (dso_enable_trigger(devc) != SR_OK)
642 SR_PRIV int dso_get_capturestate(struct dev_context *devc, uint8_t *capturestate,
643 uint32_t *trigger_offset)
646 unsigned int bitvalue, toff;
647 uint8_t cmdstring[2], inbuf[512];
649 sr_dbg("hantek-dso: sending CMD_GET_CAPTURESTATE");
651 cmdstring[0] = CMD_GET_CAPTURESTATE;
654 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
655 sr_dbg("Failed to send get_capturestate command: %d", ret);
659 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
660 DSO_EP_IN | LIBUSB_ENDPOINT_IN,
661 inbuf, 512, &tmp, 100)) != 0) {
662 sr_dbg("Failed to get capturestate: %d", ret);
665 *capturestate = inbuf[0];
666 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("hantek-dso: 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("hantek-dso: 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 * sizeof(unsigned short) / devc->epin_maxpacketsize;
721 sr_dbg("hantek-dso: queueing up %d transfers", num_transfers);
722 for (i = 0; i < num_transfers; i++) {
723 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
724 sr_err("hantek-dso: %s: buf malloc failed", __func__);
725 return SR_ERR_MALLOC;
727 transfer = libusb_alloc_transfer(0);
728 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
729 DSO_EP_IN | LIBUSB_ENDPOINT_IN, buf,
730 devc->epin_maxpacketsize, cb, devc, 40);
731 if ((ret = libusb_submit_transfer(transfer)) != 0) {
732 sr_err("failed to submit transfer: %d", ret);
733 /* TODO: Free them all. */
734 libusb_free_transfer(transfer);