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"
29 extern struct sr_dev_driver hantek_dso_driver_info;
31 static int send_begin(struct dev_context *devc)
34 unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
37 sr_dbg("Sending CTRL_BEGINCOMMAND.");
39 if ((ret = libusb_control_transfer(devc->usb->devhdl,
40 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_BEGINCOMMAND,
41 0, 0, buffer, sizeof(buffer), 200)) != sizeof(buffer)) {
42 sr_err("Failed to send begincommand: %s.",
43 libusb_error_name(ret));
50 static int send_bulkcmd(struct dev_context *devc, uint8_t *cmdstring, int cmdlen)
54 if (send_begin(devc) != SR_OK)
57 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
58 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
59 cmdstring, cmdlen, &tmp, 200)) != 0)
65 SR_PRIV int dso_getmps(libusb_device *dev)
67 struct libusb_device_descriptor des;
68 struct libusb_config_descriptor *conf_dsc;
69 const struct libusb_interface_descriptor *intf_dsc;
72 if (libusb_get_device_descriptor(dev, &des) != 0)
75 if (des.bNumConfigurations != 1)
78 if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
82 intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
83 if (intf_dsc->bNumEndpoints != 2)
86 if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
87 (2 | LIBUSB_ENDPOINT_OUT))
88 /* The first endpoint should be 2 (outbound). */
91 if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
92 (6 | LIBUSB_ENDPOINT_IN))
93 /* The second endpoint should be 6 (inbound). */
96 mps = intf_dsc->endpoint[1].wMaxPacketSize;
100 libusb_free_config_descriptor(conf_dsc);
105 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
107 libusb_device **devlist;
108 struct libusb_device_descriptor des;
109 struct dev_context *devc;
110 struct drv_context *drvc = hantek_dso_driver_info.priv;
115 if (sdi->status == SR_ST_ACTIVE)
120 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
121 for (i = 0; devlist[i]; i++) {
122 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
123 sr_err("Failed to get device descriptor: %s.",
124 libusb_error_name(err));
128 if (des.idVendor != devc->profile->fw_vid
129 || des.idProduct != devc->profile->fw_pid)
132 if (sdi->status == SR_ST_INITIALIZING) {
133 if (skip != sdi->index) {
134 /* Skip devices of this type that aren't the one we want. */
138 } else if (sdi->status == SR_ST_INACTIVE) {
140 * This device is fully enumerated, so we need to find
141 * this device by vendor, product, bus and address.
143 if (libusb_get_bus_number(devlist[i]) != devc->usb->bus
144 || libusb_get_device_address(devlist[i]) != devc->usb->address)
145 /* this is not the one */
149 if (!(err = libusb_open(devlist[i], &devc->usb->devhdl))) {
150 if (devc->usb->address == 0xff)
152 * first time we touch this device after firmware upload,
153 * so we don't know the address yet.
155 devc->usb->address = libusb_get_device_address(devlist[i]);
157 if (!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
158 sr_err("Wrong endpoint profile.");
160 sdi->status = SR_ST_ACTIVE;
161 sr_info("Opened device %d on %d.%d interface %d.",
162 sdi->index, devc->usb->bus,
163 devc->usb->address, USB_INTERFACE);
166 sr_err("Failed to open device: %s.",
167 libusb_error_name(err));
170 /* If we made it here, we handled the device (somehow). */
173 libusb_free_device_list(devlist, 1);
175 if (sdi->status != SR_ST_ACTIVE)
181 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
183 struct dev_context *devc;
187 if (devc->usb->devhdl == NULL)
190 sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
191 devc->usb->bus, devc->usb->address, USB_INTERFACE);
192 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
193 libusb_close(devc->usb->devhdl);
194 devc->usb->devhdl = NULL;
195 sdi->status = SR_ST_INACTIVE;
199 static int get_channel_offsets(struct dev_context *devc)
204 sr_dbg("Getting channel offsets.");
206 ret = libusb_control_transfer(devc->usb->devhdl,
207 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
208 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
209 (unsigned char *)&devc->channel_levels,
210 sizeof(devc->channel_levels), 200);
211 if (ret != sizeof(devc->channel_levels)) {
212 sr_err("Failed to get channel offsets: %s.",
213 libusb_error_name(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] =
225 g_ntohs(devc->channel_levels[chan][v][0]);
226 devc->channel_levels[chan][v][1] =
227 g_ntohs(devc->channel_levels[chan][v][1]);
231 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
232 gs = g_string_sized_new(128);
233 for (chan = 0; chan < 2; chan++) {
234 g_string_printf(gs, "CH%d:", chan + 1);
235 for (v = 0; v < 9; v++) {
236 g_string_append_printf(gs, " %.4x-%.4x",
237 devc->channel_levels[chan][v][0],
238 devc->channel_levels[chan][v][1]);
240 sr_dbg("%s", gs->str);
242 g_string_free(gs, TRUE);
248 SR_PRIV int dso_set_trigger_samplerate(struct dev_context *devc)
251 uint8_t cmdstring[12];
252 uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
253 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
254 uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
255 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
257 sr_dbg("Preparing CMD_SET_TRIGGER_SAMPLERATE.");
259 memset(cmdstring, 0, sizeof(cmdstring));
261 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
264 sr_dbg("Trigger source %s.", devc->triggersource);
265 if (!strcmp("CH2", devc->triggersource))
267 else if (!strcmp("CH1", devc->triggersource))
269 else if (!strcmp("EXT", devc->triggersource))
272 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
278 sr_dbg("Frame size: %d.", devc->framesize);
279 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
282 sr_dbg("Time base index: %d.", devc->timebase);
283 switch (devc->framesize) {
284 case FRAMESIZE_SMALL:
285 if (devc->timebase < TIME_20us)
287 else if (devc->timebase == TIME_20us)
289 else if (devc->timebase == TIME_40us)
291 else if (devc->timebase == TIME_100us)
293 else if (devc->timebase >= TIME_200us)
296 case FRAMESIZE_LARGE:
297 if (devc->timebase < TIME_40us) {
298 sr_err("Timebase < 40us only supported with 10K buffer.");
301 else if (devc->timebase == TIME_40us)
303 else if (devc->timebase == TIME_100us)
305 else if (devc->timebase == TIME_200us)
307 else if (devc->timebase >= TIME_400us)
311 cmdstring[2] |= (tmp & 0x07) << 5;
313 /* Enabled channels: 00=CH1 01=CH2 10=both */
314 sr_dbg("Channels CH1=%d CH2=%d", devc->ch1_enabled, devc->ch2_enabled);
315 tmp = (((devc->ch2_enabled ? 1 : 0) << 1) + (devc->ch1_enabled ? 1 : 0)) - 1;
318 /* Fast rates channel */
319 /* TODO: Is this right? */
320 tmp = devc->timebase < TIME_10us ? 1 : 0;
321 cmdstring[3] |= tmp << 2;
323 /* Trigger slope: 0=positive 1=negative */
324 /* TODO: Does this work? */
325 sr_dbg("Trigger slope: %d.", devc->triggerslope);
326 cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
329 if (devc->timebase < TIME_100us)
331 else if (devc->timebase > TIME_400ms)
334 if (devc->framesize == FRAMESIZE_SMALL)
335 tmp = timebase_small[devc->timebase - 3];
337 tmp = timebase_large[devc->timebase - 3];
339 cmdstring[4] = tmp & 0xff;
340 cmdstring[5] = (tmp >> 8) & 0xff;
342 /* Horizontal trigger position */
343 sr_dbg("Trigger position: %3.2f.", devc->triggerposition);
344 tmp = 0x77fff + 0x8000 * devc->triggerposition;
345 cmdstring[6] = tmp & 0xff;
346 cmdstring[7] = (tmp >> 8) & 0xff;
347 cmdstring[10] = (tmp >> 16) & 0xff;
349 if (send_begin(devc) != SR_OK)
352 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
353 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
354 cmdstring, sizeof(cmdstring),
356 sr_err("Failed to set trigger/samplerate: %s.",
357 libusb_error_name(ret));
360 sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
365 SR_PRIV int dso_set_filters(struct dev_context *devc)
368 uint8_t cmdstring[8];
370 sr_dbg("Preparing CMD_SET_FILTERS.");
372 memset(cmdstring, 0, sizeof(cmdstring));
373 cmdstring[0] = CMD_SET_FILTERS;
375 if (devc->filter_ch1) {
376 sr_dbg("Turning on CH1 filter.");
377 cmdstring[2] |= 0x80;
379 if (devc->filter_ch2) {
380 sr_dbg("Turning on CH2 filter.");
381 cmdstring[2] |= 0x40;
383 if (devc->filter_trigger) {
384 /* TODO: supported on the DSO-2090? */
385 sr_dbg("Turning on trigger filter.");
386 cmdstring[2] |= 0x20;
389 if (send_begin(devc) != SR_OK)
392 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
393 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
394 cmdstring, sizeof(cmdstring),
396 sr_err("Failed to set filters: %s.", libusb_error_name(ret));
399 sr_dbg("Sent CMD_SET_FILTERS.");
404 SR_PRIV int dso_set_voltage(struct dev_context *devc)
407 uint8_t cmdstring[8];
409 sr_dbg("Preparing CMD_SET_VOLTAGE.");
411 memset(cmdstring, 0, sizeof(cmdstring));
412 cmdstring[0] = CMD_SET_VOLTAGE;
416 /* CH1 volts/div is encoded in bits 0-1 */
417 sr_dbg("CH1 vdiv index: %d.", devc->voltage_ch1);
418 switch (devc->voltage_ch1) {
422 cmdstring[2] |= 0x00;
427 cmdstring[2] |= 0x01;
432 cmdstring[2] |= 0x02;
436 /* CH2 volts/div is encoded in bits 2-3 */
437 sr_dbg("CH2 vdiv index: %d.", devc->voltage_ch2);
438 switch (devc->voltage_ch2) {
442 cmdstring[2] |= 0x00;
447 cmdstring[2] |= 0x04;
452 cmdstring[2] |= 0x08;
456 if (send_begin(devc) != SR_OK)
459 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
460 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
461 cmdstring, sizeof(cmdstring),
463 sr_err("Failed to set voltage: %s.", libusb_error_name(ret));
466 sr_dbg("Sent CMD_SET_VOLTAGE.");
471 SR_PRIV int dso_set_relays(struct dev_context *devc)
475 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
476 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
478 sr_dbg("Preparing CTRL_SETRELAYS.");
480 if (devc->voltage_ch1 < VDIV_1V)
481 relays[1] = ~relays[1];
483 if (devc->voltage_ch1 < VDIV_100MV)
484 relays[2] = ~relays[2];
486 sr_dbg("CH1 coupling: %d.", devc->coupling_ch1);
487 if (devc->coupling_ch1 != COUPLING_AC)
488 relays[3] = ~relays[3];
490 if (devc->voltage_ch2 < VDIV_1V)
491 relays[4] = ~relays[4];
493 if (devc->voltage_ch2 < VDIV_100MV)
494 relays[5] = ~relays[5];
496 sr_dbg("CH2 coupling: %d.", devc->coupling_ch1);
497 if (devc->coupling_ch2 != COUPLING_AC)
498 relays[6] = ~relays[6];
500 if (!strcmp(devc->triggersource, "EXT"))
501 relays[7] = ~relays[7];
503 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
504 gs = g_string_sized_new(128);
505 g_string_printf(gs, "Relays:");
506 for (i = 0; i < 17; i++)
507 g_string_append_printf(gs, " %.2x", relays[i]);
508 sr_dbg("%s", gs->str);
509 g_string_free(gs, TRUE);
512 if ((ret = libusb_control_transfer(devc->usb->devhdl,
513 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
514 0, 0, relays, 17, 100)) != sizeof(relays)) {
515 sr_err("Failed to set relays: %s.", libusb_error_name(ret));
518 sr_dbg("Sent CTRL_SETRELAYS.");
523 SR_PRIV int dso_set_voffsets(struct dev_context *devc)
529 sr_dbg("Preparing CTRL_SETOFFSET.");
531 memset(offsets, 0, sizeof(offsets));
533 ch_levels = devc->channel_levels[0][devc->voltage_ch1];
534 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
535 offsets[0] = (offset >> 8) | 0x20;
536 offsets[1] = offset & 0xff;
537 sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
538 offsets[0], offsets[1]);
541 ch_levels = devc->channel_levels[1][devc->voltage_ch2];
542 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
543 offsets[2] = (offset >> 8) | 0x20;
544 offsets[3] = offset & 0xff;
545 sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
546 offsets[2], offsets[3]);
549 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
550 offsets[4] = (offset >> 8) | 0x20;
551 offsets[5] = offset & 0xff;
552 sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
553 offsets[4], offsets[5]);
555 if ((ret = libusb_control_transfer(devc->usb->devhdl,
556 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
557 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
558 sr_err("Failed to set offsets: %s.", libusb_error_name(ret));
561 sr_dbg("Sent CTRL_SETOFFSET.");
566 SR_PRIV int dso_enable_trigger(struct dev_context *devc)
569 uint8_t cmdstring[2];
571 sr_dbg("Sending CMD_ENABLE_TRIGGER.");
573 memset(cmdstring, 0, sizeof(cmdstring));
574 cmdstring[0] = CMD_ENABLE_TRIGGER;
577 if (send_begin(devc) != SR_OK)
580 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
581 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
582 cmdstring, sizeof(cmdstring),
584 sr_err("Failed to enable trigger: %s.", libusb_error_name(ret));
591 SR_PRIV int dso_force_trigger(struct dev_context *devc)
594 uint8_t cmdstring[2];
596 sr_dbg("Sending CMD_FORCE_TRIGGER.");
598 memset(cmdstring, 0, sizeof(cmdstring));
599 cmdstring[0] = CMD_FORCE_TRIGGER;
602 if (send_begin(devc) != SR_OK)
605 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
606 DSO_EP_OUT | LIBUSB_ENDPOINT_OUT,
607 cmdstring, sizeof(cmdstring),
609 sr_err("Failed to force trigger: %s.", libusb_error_name(ret));
616 SR_PRIV int dso_init(struct dev_context *devc)
619 sr_dbg("Initializing DSO.");
621 if (get_channel_offsets(devc) != SR_OK)
624 if (dso_set_trigger_samplerate(devc) != SR_OK)
627 if (dso_set_filters(devc) != SR_OK)
630 if (dso_set_voltage(devc) != SR_OK)
633 if (dso_set_relays(devc) != SR_OK)
636 if (dso_set_voffsets(devc) != SR_OK)
639 if (dso_enable_trigger(devc) != SR_OK)
645 SR_PRIV int dso_get_capturestate(struct dev_context *devc,
646 uint8_t *capturestate,
647 uint32_t *trigger_offset)
650 unsigned int bitvalue, toff;
651 uint8_t cmdstring[2], inbuf[512];
653 sr_dbg("Sending CMD_GET_CAPTURESTATE.");
655 cmdstring[0] = CMD_GET_CAPTURESTATE;
658 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
659 sr_dbg("Failed to send get_capturestate command: %s.",
660 libusb_error_name(ret));
664 if ((ret = libusb_bulk_transfer(devc->usb->devhdl,
665 DSO_EP_IN | LIBUSB_ENDPOINT_IN,
666 inbuf, 512, &tmp, 100)) != 0) {
667 sr_dbg("Failed to get capturestate: %s.",
668 libusb_error_name(ret));
671 *capturestate = inbuf[0];
672 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
675 * This conversion comes from the openhantek project.
676 * Each set bit in the 24-bit value inverts all bits with a lower
677 * value. No idea why the device reports the trigger point this way.
680 for (i = 0; i < 24; i++) {
681 /* Each set bit inverts all bits with a lower value. */
683 toff ^= bitvalue - 1;
686 *trigger_offset = toff;
691 SR_PRIV int dso_capture_start(struct dev_context *devc)
694 uint8_t cmdstring[2];
696 sr_dbg("Sending CMD_CAPTURE_START.");
698 cmdstring[0] = CMD_CAPTURE_START;
701 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
702 sr_err("Failed to send capture_start command: %s.",
703 libusb_error_name(ret));
710 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
711 libusb_transfer_cb_fn cb)
713 struct dev_context *devc;
714 struct libusb_transfer *transfer;
715 int num_transfers, ret, i;
716 uint8_t cmdstring[2];
720 sr_dbg("Sending CMD_GET_CHANNELDATA.");
722 cmdstring[0] = CMD_GET_CHANNELDATA;
725 if ((ret = send_bulkcmd(devc, cmdstring, sizeof(cmdstring))) != SR_OK) {
726 sr_err("Failed to get channel data: %s.",
727 libusb_error_name(ret));
731 /* TODO: DSO-2xxx only. */
732 num_transfers = devc->framesize *
733 sizeof(unsigned short) / devc->epin_maxpacketsize;
734 sr_dbg("Queueing up %d transfers.", num_transfers);
735 for (i = 0; i < num_transfers; i++) {
736 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
737 sr_err("Failed to malloc USB endpoint buffer.");
738 return SR_ERR_MALLOC;
740 transfer = libusb_alloc_transfer(0);
741 libusb_fill_bulk_transfer(transfer, devc->usb->devhdl,
742 DSO_EP_IN | LIBUSB_ENDPOINT_IN, buf,
743 devc->epin_maxpacketsize, cb, (void *)sdi, 40);
744 if ((ret = libusb_submit_transfer(transfer)) != 0) {
745 sr_err("Failed to submit transfer: %s.",
746 libusb_error_name(ret));
747 /* TODO: Free them all. */
748 libusb_free_transfer(transfer);