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 if (libusb_get_device_descriptor(dev, &des) != 0)
82 if (des.bNumConfigurations != 1)
85 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
89 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
90 if (intf_dsc->bNumEndpoints != 2)
93 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
94 (2 | LIBUSB_ENDPOINT_OUT))
95 /* The first endpoint should be 2 (outbound). */
98 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
99 (6 | LIBUSB_ENDPOINT_IN))
100 /* The second endpoint should be 6 (inbound). */
103 mps = intf_dsc->endpoint[1].wMaxPacketSize;
107 libusb_free_config_descriptor(conf_dsc);
112 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
114 struct dev_context *devc;
115 struct drv_context *drvc = hantek_dso_driver_info.context;
116 struct sr_usb_dev_inst *usb;
117 struct libusb_device_descriptor des;
118 libusb_device **devlist;
120 char connection_id[64];
125 if (sdi->status == SR_ST_ACTIVE)
129 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
130 for (i = 0; devlist[i]; i++) {
131 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
132 sr_err("Failed to get device descriptor: %s.",
133 libusb_error_name(err));
137 if (des.idVendor != devc->profile->fw_vid
138 || des.idProduct != devc->profile->fw_pid)
141 if ((sdi->status == SR_ST_INITIALIZING) ||
142 (sdi->status == SR_ST_INACTIVE)) {
144 * Check device by its physical USB bus/port address.
146 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
147 if (strcmp(sdi->connection_id, connection_id))
148 /* This is not the one. */
152 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
153 if (usb->address == 0xff)
155 * first time we touch this device after firmware upload,
156 * so we don't know the address yet.
158 usb->address = libusb_get_device_address(devlist[i]);
160 if (!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
161 sr_err("Wrong endpoint profile.");
163 sdi->status = SR_ST_ACTIVE;
164 sr_info("Opened device on %d.%d (logical) / "
165 "%s (physical) interface %d.",
166 usb->bus, usb->address,
167 sdi->connection_id, USB_INTERFACE);
170 sr_err("Failed to open device: %s.",
171 libusb_error_name(err));
174 /* If we made it here, we handled the device (somehow). */
177 libusb_free_device_list(devlist, 1);
179 if (sdi->status != SR_ST_ACTIVE)
185 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
187 struct sr_usb_dev_inst *usb;
194 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
195 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
196 libusb_release_interface(usb->devhdl, USB_INTERFACE);
197 libusb_close(usb->devhdl);
199 sdi->status = SR_ST_INACTIVE;
203 static int get_channel_offsets(const struct sr_dev_inst *sdi)
205 struct dev_context *devc;
206 struct sr_usb_dev_inst *usb;
210 sr_dbg("Getting channel offsets.");
215 ret = libusb_control_transfer(usb->devhdl,
216 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
217 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
218 (unsigned char *)&devc->channel_levels,
219 sizeof(devc->channel_levels), 200);
220 if (ret != sizeof(devc->channel_levels)) {
221 sr_err("Failed to get channel offsets: %s.",
222 libusb_error_name(ret));
226 /* Comes in as 16-bit numbers with the second byte always 0 on
227 * the DSO-2090. Guessing this is supposed to be big-endian,
228 * since that's how voltage offsets are submitted back to the DSO.
229 * Convert to host order now, so we can use them natively.
231 for (chan = 0; chan < NUM_CHANNELS; chan++) {
232 for (v = 0; v < 9; v++) {
233 devc->channel_levels[chan][v][0] =
234 g_ntohs(devc->channel_levels[chan][v][0]);
235 devc->channel_levels[chan][v][1] =
236 g_ntohs(devc->channel_levels[chan][v][1]);
240 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
241 gs = g_string_sized_new(128);
242 for (chan = 0; chan < NUM_CHANNELS; chan++) {
243 g_string_printf(gs, "CH%d:", chan + 1);
244 for (v = 0; v < 9; v++) {
245 g_string_append_printf(gs, " %.4x-%.4x",
246 devc->channel_levels[chan][v][0],
247 devc->channel_levels[chan][v][1]);
249 sr_dbg("%s", gs->str);
251 g_string_free(gs, TRUE);
257 static int dso_set_trigger_samplerate(const struct sr_dev_inst *sdi)
259 struct dev_context *devc;
260 struct sr_usb_dev_inst *usb;
262 uint8_t cmdstring[12];
263 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
264 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
265 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
266 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
268 sr_dbg("Preparing CMD_SET_TRIGGER_SAMPLERATE.");
273 memset(cmdstring, 0, sizeof(cmdstring));
275 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
278 sr_dbg("Trigger source %s.", devc->triggersource);
279 if (!strcmp("CH2", devc->triggersource))
281 else if (!strcmp("CH1", devc->triggersource))
283 else if (!strcmp("EXT", devc->triggersource))
286 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
292 sr_dbg("Frame size: %d.", devc->framesize);
293 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
296 sr_dbg("Time base index: %d.", devc->timebase);
297 if (devc->framesize == FRAMESIZE_SMALL) {
298 if (devc->timebase < TIME_20us)
300 else if (devc->timebase == TIME_20us)
302 else if (devc->timebase == TIME_40us)
304 else if (devc->timebase == TIME_100us)
306 else if (devc->timebase >= TIME_200us)
309 if (devc->timebase < TIME_40us) {
310 sr_err("Timebase < 40us only supported with 10K buffer.");
313 else if (devc->timebase == TIME_40us)
315 else if (devc->timebase == TIME_100us)
317 else if (devc->timebase == TIME_200us)
319 else if (devc->timebase >= TIME_400us)
322 cmdstring[2] |= (tmp & 0x07) << 5;
324 /* Enabled channels: 00=CH1 01=CH2 10=both */
325 sr_dbg("Channels CH1=%d CH2=%d", devc->ch1_enabled, devc->ch2_enabled);
326 tmp = (((devc->ch2_enabled ? 1 : 0) << 1) + (devc->ch1_enabled ? 1 : 0)) - 1;
329 /* Fast rates channel */
330 /* TODO: Is this right? */
331 tmp = devc->timebase < TIME_10us ? 1 : 0;
332 cmdstring[3] |= tmp << 2;
334 /* Trigger slope: 0=positive 1=negative */
335 /* TODO: Does this work? */
336 sr_dbg("Trigger slope: %d.", devc->triggerslope);
337 cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
340 if (devc->timebase < TIME_100us)
342 else if (devc->timebase > TIME_400ms)
345 if (devc->framesize == FRAMESIZE_SMALL)
346 tmp = timebase_small[devc->timebase - 3];
348 tmp = timebase_large[devc->timebase - 3];
350 cmdstring[4] = tmp & 0xff;
351 cmdstring[5] = (tmp >> 8) & 0xff;
353 /* Horizontal trigger position */
354 sr_dbg("Trigger position: %3.2f.", devc->triggerposition);
355 tmp = 0x77fff + 0x8000 * devc->triggerposition;
356 cmdstring[6] = tmp & 0xff;
357 cmdstring[7] = (tmp >> 8) & 0xff;
358 cmdstring[10] = (tmp >> 16) & 0xff;
360 if (send_begin(sdi) != SR_OK)
363 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
364 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
365 sr_err("Failed to set trigger/samplerate: %s.",
366 libusb_error_name(ret));
369 sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
374 static int dso_set_filters(const struct sr_dev_inst *sdi)
376 struct dev_context *devc;
377 struct sr_usb_dev_inst *usb;
379 uint8_t cmdstring[8];
381 sr_dbg("Preparing CMD_SET_FILTERS.");
386 memset(cmdstring, 0, sizeof(cmdstring));
387 cmdstring[0] = CMD_SET_FILTERS;
389 if (devc->filter[0]) {
390 sr_dbg("Turning on CH1 filter.");
391 cmdstring[2] |= 0x80;
393 if (devc->filter[1]) {
394 sr_dbg("Turning on CH2 filter.");
395 cmdstring[2] |= 0x40;
398 * Not supported: filtering on the trigger
399 * cmdstring[2] |= 0x20;
402 if (send_begin(sdi) != SR_OK)
405 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
406 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
407 sr_err("Failed to set filters: %s.", libusb_error_name(ret));
410 sr_dbg("Sent CMD_SET_FILTERS.");
415 static int dso_set_voltage(const struct sr_dev_inst *sdi)
417 struct dev_context *devc;
418 struct sr_usb_dev_inst *usb;
420 uint8_t cmdstring[8];
422 sr_dbg("Preparing CMD_SET_VOLTAGE.");
427 memset(cmdstring, 0, sizeof(cmdstring));
428 cmdstring[0] = CMD_SET_VOLTAGE;
432 /* CH1 volts/div is encoded in bits 0-1 */
433 sr_dbg("CH1 vdiv index: %d.", devc->voltage[0]);
434 switch (devc->voltage[0]) {
438 cmdstring[2] |= 0x00;
443 cmdstring[2] |= 0x01;
448 cmdstring[2] |= 0x02;
452 /* CH2 volts/div is encoded in bits 2-3 */
453 sr_dbg("CH2 vdiv index: %d.", devc->voltage[1]);
454 switch (devc->voltage[1]) {
458 cmdstring[2] |= 0x00;
463 cmdstring[2] |= 0x04;
468 cmdstring[2] |= 0x08;
472 if (send_begin(sdi) != SR_OK)
475 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
476 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
477 sr_err("Failed to set voltage: %s.", libusb_error_name(ret));
480 sr_dbg("Sent CMD_SET_VOLTAGE.");
485 static int dso_set_relays(const struct sr_dev_inst *sdi)
487 struct dev_context *devc;
488 struct sr_usb_dev_inst *usb;
491 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
492 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
494 sr_dbg("Preparing CTRL_SETRELAYS.");
499 if (devc->voltage[0] < VDIV_1V)
500 relays[1] = ~relays[1];
502 if (devc->voltage[0] < VDIV_100MV)
503 relays[2] = ~relays[2];
505 sr_dbg("CH1 coupling: %d.", devc->coupling[0]);
506 if (devc->coupling[0] != COUPLING_AC)
507 relays[3] = ~relays[3];
509 if (devc->voltage[1] < VDIV_1V)
510 relays[4] = ~relays[4];
512 if (devc->voltage[1] < VDIV_100MV)
513 relays[5] = ~relays[5];
515 sr_dbg("CH2 coupling: %d.", devc->coupling[1]);
516 if (devc->coupling[1] != COUPLING_AC)
517 relays[6] = ~relays[6];
519 if (!strcmp(devc->triggersource, "EXT"))
520 relays[7] = ~relays[7];
522 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
523 gs = g_string_sized_new(128);
524 g_string_printf(gs, "Relays:");
525 for (i = 0; i < 17; i++)
526 g_string_append_printf(gs, " %.2x", relays[i]);
527 sr_dbg("%s", gs->str);
528 g_string_free(gs, TRUE);
531 if ((ret = libusb_control_transfer(usb->devhdl,
532 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
533 0, 0, relays, 17, 100)) != sizeof(relays)) {
534 sr_err("Failed to set relays: %s.", libusb_error_name(ret));
537 sr_dbg("Sent CTRL_SETRELAYS.");
542 static int dso_set_voffsets(const struct sr_dev_inst *sdi)
544 struct dev_context *devc;
545 struct sr_usb_dev_inst *usb;
550 sr_dbg("Preparing CTRL_SETOFFSET.");
555 memset(offsets, 0, sizeof(offsets));
557 ch_levels = devc->channel_levels[0][devc->voltage[0]];
558 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
559 offsets[0] = (offset >> 8) | 0x20;
560 offsets[1] = offset & 0xff;
561 sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
562 offsets[0], offsets[1]);
565 ch_levels = devc->channel_levels[1][devc->voltage[1]];
566 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
567 offsets[2] = (offset >> 8) | 0x20;
568 offsets[3] = offset & 0xff;
569 sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
570 offsets[2], offsets[3]);
573 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
574 offsets[4] = (offset >> 8) | 0x20;
575 offsets[5] = offset & 0xff;
576 sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
577 offsets[4], offsets[5]);
579 if ((ret = libusb_control_transfer(usb->devhdl,
580 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
581 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
582 sr_err("Failed to set offsets: %s.", libusb_error_name(ret));
585 sr_dbg("Sent CTRL_SETOFFSET.");
590 SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi)
592 struct sr_usb_dev_inst *usb;
594 uint8_t cmdstring[2];
596 sr_dbg("Sending CMD_ENABLE_TRIGGER.");
600 memset(cmdstring, 0, sizeof(cmdstring));
601 cmdstring[0] = CMD_ENABLE_TRIGGER;
604 if (send_begin(sdi) != SR_OK)
607 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
608 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
609 sr_err("Failed to enable trigger: %s.", libusb_error_name(ret));
616 SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi)
618 struct sr_usb_dev_inst *usb;
620 uint8_t cmdstring[2];
622 sr_dbg("Sending CMD_FORCE_TRIGGER.");
626 memset(cmdstring, 0, sizeof(cmdstring));
627 cmdstring[0] = CMD_FORCE_TRIGGER;
630 if (send_begin(sdi) != SR_OK)
633 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
634 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
635 sr_err("Failed to force trigger: %s.", libusb_error_name(ret));
642 SR_PRIV int dso_init(const struct sr_dev_inst *sdi)
645 sr_dbg("Initializing DSO.");
647 if (get_channel_offsets(sdi) != SR_OK)
650 if (dso_set_trigger_samplerate(sdi) != SR_OK)
653 if (dso_set_filters(sdi) != SR_OK)
656 if (dso_set_voltage(sdi) != SR_OK)
659 if (dso_set_relays(sdi) != SR_OK)
662 if (dso_set_voffsets(sdi) != SR_OK)
665 if (dso_enable_trigger(sdi) != SR_OK)
671 SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
672 uint8_t *capturestate, uint32_t *trigger_offset)
674 struct sr_usb_dev_inst *usb;
676 unsigned int bitvalue, toff;
677 uint8_t cmdstring[2], inbuf[512];
679 sr_dbg("Sending CMD_GET_CAPTURESTATE.");
683 cmdstring[0] = CMD_GET_CAPTURESTATE;
686 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
687 sr_dbg("Failed to send get_capturestate command: %s.",
688 libusb_error_name(ret));
692 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_IN,
693 inbuf, 512, &tmp, 100)) != 0) {
694 sr_dbg("Failed to get capturestate: %s.",
695 libusb_error_name(ret));
698 *capturestate = inbuf[0];
699 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
702 * This conversion comes from the openhantek project.
703 * Each set bit in the 24-bit value inverts all bits with a lower
704 * value. No idea why the device reports the trigger point this way.
707 for (i = 0; i < 24; i++) {
708 /* Each set bit inverts all bits with a lower value. */
710 toff ^= bitvalue - 1;
713 *trigger_offset = toff;
718 SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi)
721 uint8_t cmdstring[2];
723 sr_dbg("Sending CMD_CAPTURE_START.");
725 cmdstring[0] = CMD_CAPTURE_START;
728 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
729 sr_err("Failed to send capture_start command: %s.",
730 libusb_error_name(ret));
737 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
738 libusb_transfer_cb_fn cb)
740 struct dev_context *devc;
741 struct sr_usb_dev_inst *usb;
742 struct libusb_transfer *transfer;
743 int num_transfers, ret, i;
744 uint8_t cmdstring[2];
747 sr_dbg("Sending CMD_GET_CHANNELDATA.");
752 cmdstring[0] = CMD_GET_CHANNELDATA;
755 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
756 sr_err("Failed to get channel data: %s.",
757 libusb_error_name(ret));
761 /* TODO: DSO-2xxx only. */
762 num_transfers = devc->framesize *
763 sizeof(unsigned short) / devc->epin_maxpacketsize;
764 sr_dbg("Queueing up %d transfers.", num_transfers);
765 for (i = 0; i < num_transfers; i++) {
766 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
767 sr_err("Failed to malloc USB endpoint buffer.");
768 return SR_ERR_MALLOC;
770 transfer = libusb_alloc_transfer(0);
771 libusb_fill_bulk_transfer(transfer, usb->devhdl, DSO_EP_IN, buf,
772 devc->epin_maxpacketsize, cb, (void *)sdi, 40);
773 if ((ret = libusb_submit_transfer(transfer)) != 0) {
774 sr_err("Failed to submit transfer: %s.",
775 libusb_error_name(ret));
776 /* TODO: Free them all. */
777 libusb_free_transfer(transfer);