2 * This file is part of the libsigrok 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/>.
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
30 #define NUM_CHANNELS 2
32 extern struct sr_dev_driver hantek_dso_driver_info;
34 static int send_begin(const struct sr_dev_inst *sdi)
36 struct sr_usb_dev_inst *usb;
38 unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
41 sr_dbg("Sending CTRL_BEGINCOMMAND.");
44 if ((ret = libusb_control_transfer(usb->devhdl,
45 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_BEGINCOMMAND,
46 0, 0, buffer, sizeof(buffer), 200)) != sizeof(buffer)) {
47 sr_err("Failed to send begincommand: %s.",
48 libusb_error_name(ret));
55 static int send_bulkcmd(const struct sr_dev_inst *sdi, uint8_t *cmdstring, int cmdlen)
57 struct sr_usb_dev_inst *usb;
62 if (send_begin(sdi) != SR_OK)
65 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT, cmdstring,
66 cmdlen, &tmp, 200)) != 0)
72 static int dso_getmps(libusb_device *dev)
74 struct libusb_device_descriptor des;
75 struct libusb_config_descriptor *conf_dsc;
76 const struct libusb_interface_descriptor *intf_dsc;
79 libusb_get_device_descriptor(dev, &des);
81 if (des.bNumConfigurations != 1)
84 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
88 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
89 if (intf_dsc->bNumEndpoints != 2)
92 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
93 (2 | LIBUSB_ENDPOINT_OUT))
94 /* The first endpoint should be 2 (outbound). */
97 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
98 (6 | LIBUSB_ENDPOINT_IN))
99 /* The second endpoint should be 6 (inbound). */
102 mps = intf_dsc->endpoint[1].wMaxPacketSize;
106 libusb_free_config_descriptor(conf_dsc);
111 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
113 struct dev_context *devc;
114 struct drv_context *drvc = hantek_dso_driver_info.context;
115 struct sr_usb_dev_inst *usb;
116 struct libusb_device_descriptor des;
117 libusb_device **devlist;
119 char connection_id[64];
124 if (sdi->status == SR_ST_ACTIVE)
128 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
129 for (i = 0; devlist[i]; i++) {
130 libusb_get_device_descriptor(devlist[i], &des);
132 if (des.idVendor != devc->profile->fw_vid
133 || des.idProduct != devc->profile->fw_pid)
136 if ((sdi->status == SR_ST_INITIALIZING) ||
137 (sdi->status == SR_ST_INACTIVE)) {
139 * Check device by its physical USB bus/port address.
141 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
142 if (strcmp(sdi->connection_id, connection_id))
143 /* This is not the one. */
147 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
148 if (usb->address == 0xff)
150 * first time we touch this device after firmware upload,
151 * so we don't know the address yet.
153 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 on %d.%d (logical) / "
160 "%s (physical) interface %d.",
161 usb->bus, usb->address,
162 sdi->connection_id, USB_INTERFACE);
165 sr_err("Failed to open device: %s.",
166 libusb_error_name(err));
169 /* If we made it here, we handled the device (somehow). */
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)
182 struct sr_usb_dev_inst *usb;
189 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
190 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
191 libusb_release_interface(usb->devhdl, USB_INTERFACE);
192 libusb_close(usb->devhdl);
194 sdi->status = SR_ST_INACTIVE;
198 static int get_channel_offsets(const struct sr_dev_inst *sdi)
200 struct dev_context *devc;
201 struct sr_usb_dev_inst *usb;
205 sr_dbg("Getting channel offsets.");
210 ret = libusb_control_transfer(usb->devhdl,
211 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
212 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
213 (unsigned char *)&devc->channel_levels,
214 sizeof(devc->channel_levels), 200);
215 if (ret != sizeof(devc->channel_levels)) {
216 sr_err("Failed to get channel offsets: %s.",
217 libusb_error_name(ret));
221 /* Comes in as 16-bit numbers with the second byte always 0 on
222 * the DSO-2090. Guessing this is supposed to be big-endian,
223 * since that's how voltage offsets are submitted back to the DSO.
224 * Convert to host order now, so we can use them natively.
226 for (chan = 0; chan < NUM_CHANNELS; chan++) {
227 for (v = 0; v < 9; v++) {
228 devc->channel_levels[chan][v][0] =
229 g_ntohs(devc->channel_levels[chan][v][0]);
230 devc->channel_levels[chan][v][1] =
231 g_ntohs(devc->channel_levels[chan][v][1]);
235 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
236 gs = g_string_sized_new(128);
237 for (chan = 0; chan < NUM_CHANNELS; chan++) {
238 g_string_printf(gs, "CH%d:", chan + 1);
239 for (v = 0; v < 9; v++) {
240 g_string_append_printf(gs, " %.4x-%.4x",
241 devc->channel_levels[chan][v][0],
242 devc->channel_levels[chan][v][1]);
244 sr_dbg("%s", gs->str);
246 g_string_free(gs, TRUE);
252 static int dso_set_trigger_samplerate(const struct sr_dev_inst *sdi)
254 struct dev_context *devc;
255 struct sr_usb_dev_inst *usb;
257 uint8_t cmdstring[12];
258 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
259 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
260 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
261 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
263 sr_dbg("Preparing CMD_SET_TRIGGER_SAMPLERATE.");
268 memset(cmdstring, 0, sizeof(cmdstring));
270 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
273 sr_dbg("Trigger source %s.", devc->triggersource);
274 if (!strcmp("CH2", devc->triggersource))
276 else if (!strcmp("CH1", devc->triggersource))
278 else if (!strcmp("EXT", devc->triggersource))
281 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
287 sr_dbg("Frame size: %d.", devc->framesize);
288 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
291 sr_dbg("Time base index: %d.", devc->timebase);
292 if (devc->framesize == FRAMESIZE_SMALL) {
293 if (devc->timebase < TIME_20us)
295 else if (devc->timebase == TIME_20us)
297 else if (devc->timebase == TIME_40us)
299 else if (devc->timebase == TIME_100us)
301 else if (devc->timebase >= TIME_200us)
304 if (devc->timebase < TIME_40us) {
305 sr_err("Timebase < 40us only supported with 10K buffer.");
308 else if (devc->timebase == TIME_40us)
310 else if (devc->timebase == TIME_100us)
312 else if (devc->timebase == TIME_200us)
314 else if (devc->timebase >= TIME_400us)
317 cmdstring[2] |= (tmp & 0x07) << 5;
319 /* Enabled channels: 00=CH1 01=CH2 10=both */
320 sr_dbg("Channels CH1=%d CH2=%d", devc->ch1_enabled, devc->ch2_enabled);
321 tmp = (((devc->ch2_enabled ? 1 : 0) << 1) + (devc->ch1_enabled ? 1 : 0)) - 1;
324 /* Fast rates channel */
325 /* TODO: Is this right? */
326 tmp = devc->timebase < TIME_10us ? 1 : 0;
327 cmdstring[3] |= tmp << 2;
329 /* Trigger slope: 0=positive 1=negative */
330 /* TODO: Does this work? */
331 sr_dbg("Trigger slope: %d.", devc->triggerslope);
332 cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
335 if (devc->timebase < TIME_100us)
337 else if (devc->timebase > TIME_400ms)
340 if (devc->framesize == FRAMESIZE_SMALL)
341 tmp = timebase_small[devc->timebase - 3];
343 tmp = timebase_large[devc->timebase - 3];
345 cmdstring[4] = tmp & 0xff;
346 cmdstring[5] = (tmp >> 8) & 0xff;
348 /* Horizontal trigger position */
349 sr_dbg("Trigger position: %3.2f.", devc->triggerposition);
350 tmp = 0x77fff + 0x8000 * devc->triggerposition;
351 cmdstring[6] = tmp & 0xff;
352 cmdstring[7] = (tmp >> 8) & 0xff;
353 cmdstring[10] = (tmp >> 16) & 0xff;
355 if (send_begin(sdi) != SR_OK)
358 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
359 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
360 sr_err("Failed to set trigger/samplerate: %s.",
361 libusb_error_name(ret));
364 sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
369 static int dso_set_filters(const struct sr_dev_inst *sdi)
371 struct dev_context *devc;
372 struct sr_usb_dev_inst *usb;
374 uint8_t cmdstring[8];
376 sr_dbg("Preparing CMD_SET_FILTERS.");
381 memset(cmdstring, 0, sizeof(cmdstring));
382 cmdstring[0] = CMD_SET_FILTERS;
384 if (devc->filter[0]) {
385 sr_dbg("Turning on CH1 filter.");
386 cmdstring[2] |= 0x80;
388 if (devc->filter[1]) {
389 sr_dbg("Turning on CH2 filter.");
390 cmdstring[2] |= 0x40;
393 * Not supported: filtering on the trigger
394 * cmdstring[2] |= 0x20;
397 if (send_begin(sdi) != SR_OK)
400 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
401 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
402 sr_err("Failed to set filters: %s.", libusb_error_name(ret));
405 sr_dbg("Sent CMD_SET_FILTERS.");
410 static int dso_set_voltage(const struct sr_dev_inst *sdi)
412 struct dev_context *devc;
413 struct sr_usb_dev_inst *usb;
415 uint8_t cmdstring[8];
417 sr_dbg("Preparing CMD_SET_VOLTAGE.");
422 memset(cmdstring, 0, sizeof(cmdstring));
423 cmdstring[0] = CMD_SET_VOLTAGE;
427 /* CH1 volts/div is encoded in bits 0-1 */
428 sr_dbg("CH1 vdiv index: %d.", devc->voltage[0]);
429 switch (devc->voltage[0]) {
433 cmdstring[2] |= 0x00;
438 cmdstring[2] |= 0x01;
443 cmdstring[2] |= 0x02;
447 /* CH2 volts/div is encoded in bits 2-3 */
448 sr_dbg("CH2 vdiv index: %d.", devc->voltage[1]);
449 switch (devc->voltage[1]) {
453 cmdstring[2] |= 0x00;
458 cmdstring[2] |= 0x04;
463 cmdstring[2] |= 0x08;
467 if (send_begin(sdi) != SR_OK)
470 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
471 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
472 sr_err("Failed to set voltage: %s.", libusb_error_name(ret));
475 sr_dbg("Sent CMD_SET_VOLTAGE.");
480 static int dso_set_relays(const struct sr_dev_inst *sdi)
482 struct dev_context *devc;
483 struct sr_usb_dev_inst *usb;
486 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
487 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
489 sr_dbg("Preparing CTRL_SETRELAYS.");
494 if (devc->voltage[0] < VDIV_1V)
495 relays[1] = ~relays[1];
497 if (devc->voltage[0] < VDIV_100MV)
498 relays[2] = ~relays[2];
500 sr_dbg("CH1 coupling: %d.", devc->coupling[0]);
501 if (devc->coupling[0] != COUPLING_AC)
502 relays[3] = ~relays[3];
504 if (devc->voltage[1] < VDIV_1V)
505 relays[4] = ~relays[4];
507 if (devc->voltage[1] < VDIV_100MV)
508 relays[5] = ~relays[5];
510 sr_dbg("CH2 coupling: %d.", devc->coupling[1]);
511 if (devc->coupling[1] != COUPLING_AC)
512 relays[6] = ~relays[6];
514 if (!strcmp(devc->triggersource, "EXT"))
515 relays[7] = ~relays[7];
517 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
518 gs = g_string_sized_new(128);
519 g_string_printf(gs, "Relays:");
520 for (i = 0; i < 17; i++)
521 g_string_append_printf(gs, " %.2x", relays[i]);
522 sr_dbg("%s", gs->str);
523 g_string_free(gs, TRUE);
526 if ((ret = libusb_control_transfer(usb->devhdl,
527 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
528 0, 0, relays, 17, 100)) != sizeof(relays)) {
529 sr_err("Failed to set relays: %s.", libusb_error_name(ret));
532 sr_dbg("Sent CTRL_SETRELAYS.");
537 static int dso_set_voffsets(const struct sr_dev_inst *sdi)
539 struct dev_context *devc;
540 struct sr_usb_dev_inst *usb;
545 sr_dbg("Preparing CTRL_SETOFFSET.");
550 memset(offsets, 0, sizeof(offsets));
552 ch_levels = devc->channel_levels[0][devc->voltage[0]];
553 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
554 offsets[0] = (offset >> 8) | 0x20;
555 offsets[1] = offset & 0xff;
556 sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
557 offsets[0], offsets[1]);
560 ch_levels = devc->channel_levels[1][devc->voltage[1]];
561 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
562 offsets[2] = (offset >> 8) | 0x20;
563 offsets[3] = offset & 0xff;
564 sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
565 offsets[2], offsets[3]);
568 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
569 offsets[4] = (offset >> 8) | 0x20;
570 offsets[5] = offset & 0xff;
571 sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
572 offsets[4], offsets[5]);
574 if ((ret = libusb_control_transfer(usb->devhdl,
575 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
576 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
577 sr_err("Failed to set offsets: %s.", libusb_error_name(ret));
580 sr_dbg("Sent CTRL_SETOFFSET.");
585 SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi)
587 struct sr_usb_dev_inst *usb;
589 uint8_t cmdstring[2];
591 sr_dbg("Sending CMD_ENABLE_TRIGGER.");
595 memset(cmdstring, 0, sizeof(cmdstring));
596 cmdstring[0] = CMD_ENABLE_TRIGGER;
599 if (send_begin(sdi) != SR_OK)
602 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
603 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
604 sr_err("Failed to enable trigger: %s.", libusb_error_name(ret));
611 SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi)
613 struct sr_usb_dev_inst *usb;
615 uint8_t cmdstring[2];
617 sr_dbg("Sending CMD_FORCE_TRIGGER.");
621 memset(cmdstring, 0, sizeof(cmdstring));
622 cmdstring[0] = CMD_FORCE_TRIGGER;
625 if (send_begin(sdi) != SR_OK)
628 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
629 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
630 sr_err("Failed to force trigger: %s.", libusb_error_name(ret));
637 SR_PRIV int dso_init(const struct sr_dev_inst *sdi)
640 sr_dbg("Initializing DSO.");
642 if (get_channel_offsets(sdi) != SR_OK)
645 if (dso_set_trigger_samplerate(sdi) != SR_OK)
648 if (dso_set_filters(sdi) != SR_OK)
651 if (dso_set_voltage(sdi) != SR_OK)
654 if (dso_set_relays(sdi) != SR_OK)
657 if (dso_set_voffsets(sdi) != SR_OK)
660 if (dso_enable_trigger(sdi) != SR_OK)
666 SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
667 uint8_t *capturestate, uint32_t *trigger_offset)
669 struct sr_usb_dev_inst *usb;
671 unsigned int bitvalue, toff;
672 uint8_t cmdstring[2], inbuf[512];
674 sr_dbg("Sending CMD_GET_CAPTURESTATE.");
678 cmdstring[0] = CMD_GET_CAPTURESTATE;
681 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
682 sr_dbg("Failed to send get_capturestate command: %s.",
683 libusb_error_name(ret));
687 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_IN,
688 inbuf, 512, &tmp, 100)) != 0) {
689 sr_dbg("Failed to get capturestate: %s.",
690 libusb_error_name(ret));
693 *capturestate = inbuf[0];
694 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
697 * This conversion comes from the openhantek project.
698 * Each set bit in the 24-bit value inverts all bits with a lower
699 * value. No idea why the device reports the trigger point this way.
702 for (i = 0; i < 24; i++) {
703 /* Each set bit inverts all bits with a lower value. */
705 toff ^= bitvalue - 1;
708 *trigger_offset = toff;
713 SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi)
716 uint8_t cmdstring[2];
718 sr_dbg("Sending CMD_CAPTURE_START.");
720 cmdstring[0] = CMD_CAPTURE_START;
723 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
724 sr_err("Failed to send capture_start command: %s.",
725 libusb_error_name(ret));
732 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
733 libusb_transfer_cb_fn cb)
735 struct dev_context *devc;
736 struct sr_usb_dev_inst *usb;
737 struct libusb_transfer *transfer;
738 int num_transfers, ret, i;
739 uint8_t cmdstring[2];
742 sr_dbg("Sending CMD_GET_CHANNELDATA.");
747 cmdstring[0] = CMD_GET_CHANNELDATA;
750 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
751 sr_err("Failed to get channel data: %s.",
752 libusb_error_name(ret));
756 /* TODO: DSO-2xxx only. */
757 num_transfers = devc->framesize *
758 sizeof(unsigned short) / devc->epin_maxpacketsize;
759 sr_dbg("Queueing up %d transfers.", num_transfers);
760 for (i = 0; i < num_transfers; i++) {
761 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
762 sr_err("Failed to malloc USB endpoint buffer.");
763 return SR_ERR_MALLOC;
765 transfer = libusb_alloc_transfer(0);
766 libusb_fill_bulk_transfer(transfer, usb->devhdl, DSO_EP_IN, buf,
767 devc->epin_maxpacketsize, cb, (void *)sdi, 40);
768 if ((ret = libusb_submit_transfer(transfer)) != 0) {
769 sr_err("Failed to submit transfer: %s.",
770 libusb_error_name(ret));
771 /* TODO: Free them all. */
772 libusb_free_transfer(transfer);