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/>.
22 #include "libsigrok.h"
23 #include "libsigrok-internal.h"
29 extern struct sr_dev_driver hantek_dso_driver_info;
31 static int send_begin(const struct sr_dev_inst *sdi)
33 struct sr_usb_dev_inst *usb;
35 unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
38 sr_dbg("Sending CTRL_BEGINCOMMAND.");
41 if ((ret = libusb_control_transfer(usb->devhdl,
42 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_BEGINCOMMAND,
43 0, 0, buffer, sizeof(buffer), 200)) != sizeof(buffer)) {
44 sr_err("Failed to send begincommand: %s.",
45 libusb_error_name(ret));
52 static int send_bulkcmd(const struct sr_dev_inst *sdi, uint8_t *cmdstring, int cmdlen)
54 struct sr_usb_dev_inst *usb;
59 if (send_begin(sdi) != SR_OK)
62 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT, cmdstring,
63 cmdlen, &tmp, 200)) != 0)
69 SR_PRIV int dso_getmps(libusb_device *dev)
71 struct libusb_device_descriptor des;
72 struct libusb_config_descriptor *conf_dsc;
73 const struct libusb_interface_descriptor *intf_dsc;
76 if (libusb_get_device_descriptor(dev, &des) != 0)
79 if (des.bNumConfigurations != 1)
82 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
86 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
87 if (intf_dsc->bNumEndpoints != 2)
90 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
91 (2 | LIBUSB_ENDPOINT_OUT))
92 /* The first endpoint should be 2 (outbound). */
95 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
96 (6 | LIBUSB_ENDPOINT_IN))
97 /* The second endpoint should be 6 (inbound). */
100 mps = intf_dsc->endpoint[1].wMaxPacketSize;
104 libusb_free_config_descriptor(conf_dsc);
109 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
111 struct dev_context *devc;
112 struct drv_context *drvc = hantek_dso_driver_info.priv;
113 struct sr_usb_dev_inst *usb;
114 struct libusb_device_descriptor des;
115 libusb_device **devlist;
121 if (sdi->status == SR_ST_ACTIVE)
126 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
127 for (i = 0; devlist[i]; i++) {
128 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
129 sr_err("Failed to get device descriptor: %s.",
130 libusb_error_name(err));
134 if (des.idVendor != devc->profile->fw_vid
135 || des.idProduct != devc->profile->fw_pid)
138 if (sdi->status == SR_ST_INITIALIZING) {
139 if (skip != sdi->index) {
140 /* Skip devices of this type that aren't the one we want. */
144 } else if (sdi->status == SR_ST_INACTIVE) {
146 * This device is fully enumerated, so we need to find
147 * this device by vendor, product, bus and address.
149 if (libusb_get_bus_number(devlist[i]) != usb->bus
150 || libusb_get_device_address(devlist[i]) != usb->address)
151 /* this is not the one */
155 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
156 if (usb->address == 0xff)
158 * first time we touch this device after firmware upload,
159 * so we don't know the address yet.
161 usb->address = libusb_get_device_address(devlist[i]);
163 if (!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
164 sr_err("Wrong endpoint profile.");
166 sdi->status = SR_ST_ACTIVE;
167 sr_info("Opened device %d on %d.%d interface %d.",
168 sdi->index, usb->bus,
169 usb->address, USB_INTERFACE);
172 sr_err("Failed to open device: %s.",
173 libusb_error_name(err));
176 /* If we made it here, we handled the device (somehow). */
179 libusb_free_device_list(devlist, 1);
181 if (sdi->status != SR_ST_ACTIVE)
187 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
189 struct sr_usb_dev_inst *usb;
193 if (usb->devhdl == NULL)
196 sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
197 usb->bus, usb->address, USB_INTERFACE);
198 libusb_release_interface(usb->devhdl, USB_INTERFACE);
199 libusb_close(usb->devhdl);
201 sdi->status = SR_ST_INACTIVE;
205 static int get_channel_offsets(const struct sr_dev_inst *sdi)
207 struct dev_context *devc;
208 struct sr_usb_dev_inst *usb;
212 sr_dbg("Getting channel offsets.");
217 ret = libusb_control_transfer(usb->devhdl,
218 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
219 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
220 (unsigned char *)&devc->channel_levels,
221 sizeof(devc->channel_levels), 200);
222 if (ret != sizeof(devc->channel_levels)) {
223 sr_err("Failed to get channel offsets: %s.",
224 libusb_error_name(ret));
228 /* Comes in as 16-bit numbers with the second byte always 0 on
229 * the DSO-2090. Guessing this is supposed to be big-endian,
230 * since that's how voltage offsets are submitted back to the DSO.
231 * Convert to host order now, so we can use them natively.
233 for (chan = 0; chan < 2; chan++) {
234 for (v = 0; v < 9; v++) {
235 devc->channel_levels[chan][v][0] =
236 g_ntohs(devc->channel_levels[chan][v][0]);
237 devc->channel_levels[chan][v][1] =
238 g_ntohs(devc->channel_levels[chan][v][1]);
242 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
243 gs = g_string_sized_new(128);
244 for (chan = 0; chan < 2; chan++) {
245 g_string_printf(gs, "CH%d:", chan + 1);
246 for (v = 0; v < 9; v++) {
247 g_string_append_printf(gs, " %.4x-%.4x",
248 devc->channel_levels[chan][v][0],
249 devc->channel_levels[chan][v][1]);
251 sr_dbg("%s", gs->str);
253 g_string_free(gs, TRUE);
259 SR_PRIV int dso_set_trigger_samplerate(const struct sr_dev_inst *sdi)
261 struct dev_context *devc;
262 struct sr_usb_dev_inst *usb;
264 uint8_t cmdstring[12];
265 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
266 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
267 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
268 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
270 sr_dbg("Preparing CMD_SET_TRIGGER_SAMPLERATE.");
275 memset(cmdstring, 0, sizeof(cmdstring));
277 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
280 sr_dbg("Trigger source %s.", devc->triggersource);
281 if (!strcmp("CH2", devc->triggersource))
283 else if (!strcmp("CH1", devc->triggersource))
285 else if (!strcmp("EXT", devc->triggersource))
288 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
294 sr_dbg("Frame size: %d.", devc->framesize);
295 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
298 sr_dbg("Time base index: %d.", devc->timebase);
299 if (devc->framesize == FRAMESIZE_SMALL) {
300 if (devc->timebase < TIME_20us)
302 else if (devc->timebase == TIME_20us)
304 else if (devc->timebase == TIME_40us)
306 else if (devc->timebase == TIME_100us)
308 else if (devc->timebase >= TIME_200us)
311 if (devc->timebase < TIME_40us) {
312 sr_err("Timebase < 40us only supported with 10K buffer.");
315 else if (devc->timebase == TIME_40us)
317 else if (devc->timebase == TIME_100us)
319 else if (devc->timebase == TIME_200us)
321 else if (devc->timebase >= TIME_400us)
324 cmdstring[2] |= (tmp & 0x07) << 5;
326 /* Enabled channels: 00=CH1 01=CH2 10=both */
327 sr_dbg("Channels CH1=%d CH2=%d", devc->ch1_enabled, devc->ch2_enabled);
328 tmp = (((devc->ch2_enabled ? 1 : 0) << 1) + (devc->ch1_enabled ? 1 : 0)) - 1;
331 /* Fast rates channel */
332 /* TODO: Is this right? */
333 tmp = devc->timebase < TIME_10us ? 1 : 0;
334 cmdstring[3] |= tmp << 2;
336 /* Trigger slope: 0=positive 1=negative */
337 /* TODO: Does this work? */
338 sr_dbg("Trigger slope: %d.", devc->triggerslope);
339 cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
342 if (devc->timebase < TIME_100us)
344 else if (devc->timebase > TIME_400ms)
347 if (devc->framesize == FRAMESIZE_SMALL)
348 tmp = timebase_small[devc->timebase - 3];
350 tmp = timebase_large[devc->timebase - 3];
352 cmdstring[4] = tmp & 0xff;
353 cmdstring[5] = (tmp >> 8) & 0xff;
355 /* Horizontal trigger position */
356 sr_dbg("Trigger position: %3.2f.", devc->triggerposition);
357 tmp = 0x77fff + 0x8000 * devc->triggerposition;
358 cmdstring[6] = tmp & 0xff;
359 cmdstring[7] = (tmp >> 8) & 0xff;
360 cmdstring[10] = (tmp >> 16) & 0xff;
362 if (send_begin(sdi) != SR_OK)
365 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
366 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
367 sr_err("Failed to set trigger/samplerate: %s.",
368 libusb_error_name(ret));
371 sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
376 SR_PRIV int dso_set_filters(const struct sr_dev_inst *sdi)
378 struct dev_context *devc;
379 struct sr_usb_dev_inst *usb;
381 uint8_t cmdstring[8];
383 sr_dbg("Preparing CMD_SET_FILTERS.");
388 memset(cmdstring, 0, sizeof(cmdstring));
389 cmdstring[0] = CMD_SET_FILTERS;
391 if (devc->filter_ch1) {
392 sr_dbg("Turning on CH1 filter.");
393 cmdstring[2] |= 0x80;
395 if (devc->filter_ch2) {
396 sr_dbg("Turning on CH2 filter.");
397 cmdstring[2] |= 0x40;
399 if (devc->filter_trigger) {
400 /* TODO: supported on the DSO-2090? */
401 sr_dbg("Turning on trigger filter.");
402 cmdstring[2] |= 0x20;
405 if (send_begin(sdi) != SR_OK)
408 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
409 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
410 sr_err("Failed to set filters: %s.", libusb_error_name(ret));
413 sr_dbg("Sent CMD_SET_FILTERS.");
418 SR_PRIV int dso_set_voltage(const struct sr_dev_inst *sdi)
420 struct dev_context *devc;
421 struct sr_usb_dev_inst *usb;
423 uint8_t cmdstring[8];
425 sr_dbg("Preparing CMD_SET_VOLTAGE.");
430 memset(cmdstring, 0, sizeof(cmdstring));
431 cmdstring[0] = CMD_SET_VOLTAGE;
435 /* CH1 volts/div is encoded in bits 0-1 */
436 sr_dbg("CH1 vdiv index: %d.", devc->voltage_ch1);
437 switch (devc->voltage_ch1) {
441 cmdstring[2] |= 0x00;
446 cmdstring[2] |= 0x01;
451 cmdstring[2] |= 0x02;
455 /* CH2 volts/div is encoded in bits 2-3 */
456 sr_dbg("CH2 vdiv index: %d.", devc->voltage_ch2);
457 switch (devc->voltage_ch2) {
461 cmdstring[2] |= 0x00;
466 cmdstring[2] |= 0x04;
471 cmdstring[2] |= 0x08;
475 if (send_begin(sdi) != SR_OK)
478 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
479 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
480 sr_err("Failed to set voltage: %s.", libusb_error_name(ret));
483 sr_dbg("Sent CMD_SET_VOLTAGE.");
488 SR_PRIV int dso_set_relays(const struct sr_dev_inst *sdi)
490 struct dev_context *devc;
491 struct sr_usb_dev_inst *usb;
494 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
495 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
497 sr_dbg("Preparing CTRL_SETRELAYS.");
502 if (devc->voltage_ch1 < VDIV_1V)
503 relays[1] = ~relays[1];
505 if (devc->voltage_ch1 < VDIV_100MV)
506 relays[2] = ~relays[2];
508 sr_dbg("CH1 coupling: %d.", devc->coupling_ch1);
509 if (devc->coupling_ch1 != COUPLING_AC)
510 relays[3] = ~relays[3];
512 if (devc->voltage_ch2 < VDIV_1V)
513 relays[4] = ~relays[4];
515 if (devc->voltage_ch2 < VDIV_100MV)
516 relays[5] = ~relays[5];
518 sr_dbg("CH2 coupling: %d.", devc->coupling_ch1);
519 if (devc->coupling_ch2 != COUPLING_AC)
520 relays[6] = ~relays[6];
522 if (!strcmp(devc->triggersource, "EXT"))
523 relays[7] = ~relays[7];
525 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
526 gs = g_string_sized_new(128);
527 g_string_printf(gs, "Relays:");
528 for (i = 0; i < 17; i++)
529 g_string_append_printf(gs, " %.2x", relays[i]);
530 sr_dbg("%s", gs->str);
531 g_string_free(gs, TRUE);
534 if ((ret = libusb_control_transfer(usb->devhdl,
535 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
536 0, 0, relays, 17, 100)) != sizeof(relays)) {
537 sr_err("Failed to set relays: %s.", libusb_error_name(ret));
540 sr_dbg("Sent CTRL_SETRELAYS.");
545 SR_PRIV int dso_set_voffsets(const struct sr_dev_inst *sdi)
547 struct dev_context *devc;
548 struct sr_usb_dev_inst *usb;
553 sr_dbg("Preparing CTRL_SETOFFSET.");
558 memset(offsets, 0, sizeof(offsets));
560 ch_levels = devc->channel_levels[0][devc->voltage_ch1];
561 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
562 offsets[0] = (offset >> 8) | 0x20;
563 offsets[1] = offset & 0xff;
564 sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
565 offsets[0], offsets[1]);
568 ch_levels = devc->channel_levels[1][devc->voltage_ch2];
569 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
570 offsets[2] = (offset >> 8) | 0x20;
571 offsets[3] = offset & 0xff;
572 sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
573 offsets[2], offsets[3]);
576 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
577 offsets[4] = (offset >> 8) | 0x20;
578 offsets[5] = offset & 0xff;
579 sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
580 offsets[4], offsets[5]);
582 if ((ret = libusb_control_transfer(usb->devhdl,
583 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
584 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
585 sr_err("Failed to set offsets: %s.", libusb_error_name(ret));
588 sr_dbg("Sent CTRL_SETOFFSET.");
593 SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi)
595 struct sr_usb_dev_inst *usb;
597 uint8_t cmdstring[2];
599 sr_dbg("Sending CMD_ENABLE_TRIGGER.");
603 memset(cmdstring, 0, sizeof(cmdstring));
604 cmdstring[0] = CMD_ENABLE_TRIGGER;
607 if (send_begin(sdi) != SR_OK)
610 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
611 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
612 sr_err("Failed to enable trigger: %s.", libusb_error_name(ret));
619 SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi)
621 struct sr_usb_dev_inst *usb;
623 uint8_t cmdstring[2];
625 sr_dbg("Sending CMD_FORCE_TRIGGER.");
629 memset(cmdstring, 0, sizeof(cmdstring));
630 cmdstring[0] = CMD_FORCE_TRIGGER;
633 if (send_begin(sdi) != SR_OK)
636 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
637 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
638 sr_err("Failed to force trigger: %s.", libusb_error_name(ret));
645 SR_PRIV int dso_init(const struct sr_dev_inst *sdi)
648 sr_dbg("Initializing DSO.");
650 if (get_channel_offsets(sdi) != SR_OK)
653 if (dso_set_trigger_samplerate(sdi) != SR_OK)
656 if (dso_set_filters(sdi) != SR_OK)
659 if (dso_set_voltage(sdi) != SR_OK)
662 if (dso_set_relays(sdi) != SR_OK)
665 if (dso_set_voffsets(sdi) != SR_OK)
668 if (dso_enable_trigger(sdi) != SR_OK)
674 SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
675 uint8_t *capturestate, uint32_t *trigger_offset)
677 struct sr_usb_dev_inst *usb;
679 unsigned int bitvalue, toff;
680 uint8_t cmdstring[2], inbuf[512];
682 sr_dbg("Sending CMD_GET_CAPTURESTATE.");
686 cmdstring[0] = CMD_GET_CAPTURESTATE;
689 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
690 sr_dbg("Failed to send get_capturestate command: %s.",
691 libusb_error_name(ret));
695 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_IN,
696 inbuf, 512, &tmp, 100)) != 0) {
697 sr_dbg("Failed to get capturestate: %s.",
698 libusb_error_name(ret));
701 *capturestate = inbuf[0];
702 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
705 * This conversion comes from the openhantek project.
706 * Each set bit in the 24-bit value inverts all bits with a lower
707 * value. No idea why the device reports the trigger point this way.
710 for (i = 0; i < 24; i++) {
711 /* Each set bit inverts all bits with a lower value. */
713 toff ^= bitvalue - 1;
716 *trigger_offset = toff;
721 SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi)
724 uint8_t cmdstring[2];
726 sr_dbg("Sending CMD_CAPTURE_START.");
728 cmdstring[0] = CMD_CAPTURE_START;
731 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
732 sr_err("Failed to send capture_start command: %s.",
733 libusb_error_name(ret));
740 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
741 libusb_transfer_cb_fn cb)
743 struct dev_context *devc;
744 struct sr_usb_dev_inst *usb;
745 struct libusb_transfer *transfer;
746 int num_transfers, ret, i;
747 uint8_t cmdstring[2];
750 sr_dbg("Sending CMD_GET_CHANNELDATA.");
755 cmdstring[0] = CMD_GET_CHANNELDATA;
758 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
759 sr_err("Failed to get channel data: %s.",
760 libusb_error_name(ret));
764 /* TODO: DSO-2xxx only. */
765 num_transfers = devc->framesize *
766 sizeof(unsigned short) / devc->epin_maxpacketsize;
767 sr_dbg("Queueing up %d transfers.", num_transfers);
768 for (i = 0; i < num_transfers; i++) {
769 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
770 sr_err("Failed to malloc USB endpoint buffer.");
771 return SR_ERR_MALLOC;
773 transfer = libusb_alloc_transfer(0);
774 libusb_fill_bulk_transfer(transfer, usb->devhdl, DSO_EP_IN, buf,
775 devc->epin_maxpacketsize, cb, (void *)sdi, 40);
776 if ((ret = libusb_submit_transfer(transfer)) != 0) {
777 sr_err("Failed to submit transfer: %s.",
778 libusb_error_name(ret));
779 /* TODO: Free them all. */
780 libusb_free_transfer(transfer);