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 static int send_begin(const struct sr_dev_inst *sdi)
34 struct sr_usb_dev_inst *usb;
36 unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
39 sr_dbg("Sending CTRL_BEGINCOMMAND.");
42 if ((ret = libusb_control_transfer(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: %s.",
46 libusb_error_name(ret));
53 static int send_bulkcmd(const struct sr_dev_inst *sdi, uint8_t *cmdstring, int cmdlen)
55 struct sr_usb_dev_inst *usb;
60 if (send_begin(sdi) != SR_OK)
63 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT, cmdstring,
64 cmdlen, &tmp, 200)) != 0)
70 static int dso_getmps(libusb_device *dev)
72 struct libusb_device_descriptor des;
73 struct libusb_config_descriptor *conf_dsc;
74 const struct libusb_interface_descriptor *intf_dsc;
77 libusb_get_device_descriptor(dev, &des);
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 = sdi->driver->context;
113 struct sr_usb_dev_inst *usb;
114 struct libusb_device_descriptor des;
115 libusb_device **devlist;
117 char connection_id[64];
122 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
123 for (i = 0; devlist[i]; i++) {
124 libusb_get_device_descriptor(devlist[i], &des);
126 if (des.idVendor != devc->profile->fw_vid
127 || des.idProduct != devc->profile->fw_pid)
130 if ((sdi->status == SR_ST_INITIALIZING) ||
131 (sdi->status == SR_ST_INACTIVE)) {
133 * Check device by its physical USB bus/port address.
135 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
136 if (strcmp(sdi->connection_id, connection_id))
137 /* This is not the one. */
141 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
142 if (usb->address == 0xff)
144 * first time we touch this device after firmware upload,
145 * so we don't know the address yet.
147 usb->address = libusb_get_device_address(devlist[i]);
149 if (!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
150 sr_err("Wrong endpoint profile.");
152 sdi->status = SR_ST_ACTIVE;
153 sr_info("Opened device on %d.%d (logical) / "
154 "%s (physical) interface %d.",
155 usb->bus, usb->address,
156 sdi->connection_id, USB_INTERFACE);
159 sr_err("Failed to open device: %s.",
160 libusb_error_name(err));
163 /* If we made it here, we handled the device (somehow). */
166 libusb_free_device_list(devlist, 1);
168 if (sdi->status != SR_ST_ACTIVE)
174 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
176 struct sr_usb_dev_inst *usb;
183 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
184 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
185 libusb_release_interface(usb->devhdl, USB_INTERFACE);
186 libusb_close(usb->devhdl);
188 sdi->status = SR_ST_INACTIVE;
192 static int get_channel_offsets(const struct sr_dev_inst *sdi)
194 struct dev_context *devc;
195 struct sr_usb_dev_inst *usb;
199 sr_dbg("Getting channel offsets.");
204 ret = libusb_control_transfer(usb->devhdl,
205 LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
206 CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
207 (unsigned char *)&devc->channel_levels,
208 sizeof(devc->channel_levels), 200);
209 if (ret != sizeof(devc->channel_levels)) {
210 sr_err("Failed to get channel offsets: %s.",
211 libusb_error_name(ret));
215 /* Comes in as 16-bit numbers with the second byte always 0 on
216 * the DSO-2090. Guessing this is supposed to be big-endian,
217 * since that's how voltage offsets are submitted back to the DSO.
218 * Convert to host order now, so we can use them natively.
220 for (chan = 0; chan < NUM_CHANNELS; chan++) {
221 for (v = 0; v < 9; v++) {
222 devc->channel_levels[chan][v][0] =
223 g_ntohs(devc->channel_levels[chan][v][0]);
224 devc->channel_levels[chan][v][1] =
225 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 < NUM_CHANNELS; chan++) {
232 g_string_printf(gs, "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]);
238 sr_dbg("%s", gs->str);
240 g_string_free(gs, TRUE);
246 static int dso_set_trigger_samplerate(const struct sr_dev_inst *sdi)
248 struct dev_context *devc;
249 struct sr_usb_dev_inst *usb;
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.");
262 memset(cmdstring, 0, sizeof(cmdstring));
264 cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
267 sr_dbg("Trigger source %s.", devc->triggersource);
268 if (!strcmp("CH2", devc->triggersource))
270 else if (!strcmp("CH1", devc->triggersource))
272 else if (!strcmp("EXT", devc->triggersource))
275 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
281 sr_dbg("Frame size: %d.", devc->framesize);
282 cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
285 sr_dbg("Time base index: %d.", devc->timebase);
286 if (devc->framesize == FRAMESIZE_SMALL) {
287 if (devc->timebase < TIME_20us)
289 else if (devc->timebase == TIME_20us)
291 else if (devc->timebase == TIME_40us)
293 else if (devc->timebase == TIME_100us)
295 else if (devc->timebase >= TIME_200us)
298 if (devc->timebase < TIME_40us) {
299 sr_err("Timebase < 40us only supported with 10K buffer.");
302 else if (devc->timebase == TIME_40us)
304 else if (devc->timebase == TIME_100us)
306 else if (devc->timebase == TIME_200us)
308 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->ch_enabled[0], devc->ch_enabled[1]);
315 tmp = (((devc->ch_enabled[1] ? 1 : 0) << 1) + (devc->ch_enabled[0] ? 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(sdi) != SR_OK)
352 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
353 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
354 sr_err("Failed to set trigger/samplerate: %s.",
355 libusb_error_name(ret));
358 sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
363 static int dso_set_filters(const struct sr_dev_inst *sdi)
365 struct dev_context *devc;
366 struct sr_usb_dev_inst *usb;
368 uint8_t cmdstring[8];
370 sr_dbg("Preparing CMD_SET_FILTERS.");
375 memset(cmdstring, 0, sizeof(cmdstring));
376 cmdstring[0] = CMD_SET_FILTERS;
378 if (devc->filter[0]) {
379 sr_dbg("Turning on CH1 filter.");
380 cmdstring[2] |= 0x80;
382 if (devc->filter[1]) {
383 sr_dbg("Turning on CH2 filter.");
384 cmdstring[2] |= 0x40;
387 * Not supported: filtering on the trigger
388 * cmdstring[2] |= 0x20;
391 if (send_begin(sdi) != SR_OK)
394 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
395 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
396 sr_err("Failed to set filters: %s.", libusb_error_name(ret));
399 sr_dbg("Sent CMD_SET_FILTERS.");
404 static int dso_set_voltage(const struct sr_dev_inst *sdi)
406 struct dev_context *devc;
407 struct sr_usb_dev_inst *usb;
409 uint8_t cmdstring[8];
411 sr_dbg("Preparing CMD_SET_VOLTAGE.");
416 memset(cmdstring, 0, sizeof(cmdstring));
417 cmdstring[0] = CMD_SET_VOLTAGE;
421 /* CH1 volts/div is encoded in bits 0-1 */
422 sr_dbg("CH1 vdiv index: %d.", devc->voltage[0]);
423 switch (devc->voltage[0]) {
427 cmdstring[2] |= 0x00;
432 cmdstring[2] |= 0x01;
437 cmdstring[2] |= 0x02;
441 /* CH2 volts/div is encoded in bits 2-3 */
442 sr_dbg("CH2 vdiv index: %d.", devc->voltage[1]);
443 switch (devc->voltage[1]) {
447 cmdstring[2] |= 0x00;
452 cmdstring[2] |= 0x04;
457 cmdstring[2] |= 0x08;
461 if (send_begin(sdi) != SR_OK)
464 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
465 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
466 sr_err("Failed to set voltage: %s.", libusb_error_name(ret));
469 sr_dbg("Sent CMD_SET_VOLTAGE.");
474 static int dso_set_relays(const struct sr_dev_inst *sdi)
476 struct dev_context *devc;
477 struct sr_usb_dev_inst *usb;
480 uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
481 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
483 sr_dbg("Preparing CTRL_SETRELAYS.");
488 if (devc->voltage[0] < VDIV_1V)
489 relays[1] = ~relays[1];
491 if (devc->voltage[0] < VDIV_100MV)
492 relays[2] = ~relays[2];
494 sr_dbg("CH1 coupling: %d.", devc->coupling[0]);
495 if (devc->coupling[0] != COUPLING_AC)
496 relays[3] = ~relays[3];
498 if (devc->voltage[1] < VDIV_1V)
499 relays[4] = ~relays[4];
501 if (devc->voltage[1] < VDIV_100MV)
502 relays[5] = ~relays[5];
504 sr_dbg("CH2 coupling: %d.", devc->coupling[1]);
505 if (devc->coupling[1] != COUPLING_AC)
506 relays[6] = ~relays[6];
508 if (!strcmp(devc->triggersource, "EXT"))
509 relays[7] = ~relays[7];
511 if (sr_log_loglevel_get() >= SR_LOG_DBG) {
512 gs = g_string_sized_new(128);
513 g_string_printf(gs, "Relays:");
514 for (i = 0; i < 17; i++)
515 g_string_append_printf(gs, " %.2x", relays[i]);
516 sr_dbg("%s", gs->str);
517 g_string_free(gs, TRUE);
520 if ((ret = libusb_control_transfer(usb->devhdl,
521 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
522 0, 0, relays, 17, 100)) != sizeof(relays)) {
523 sr_err("Failed to set relays: %s.", libusb_error_name(ret));
526 sr_dbg("Sent CTRL_SETRELAYS.");
531 static int dso_set_voffsets(const struct sr_dev_inst *sdi)
533 struct dev_context *devc;
534 struct sr_usb_dev_inst *usb;
539 sr_dbg("Preparing CTRL_SETOFFSET.");
544 memset(offsets, 0, sizeof(offsets));
546 ch_levels = devc->channel_levels[0][devc->voltage[0]];
547 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
548 offsets[0] = (offset >> 8) | 0x20;
549 offsets[1] = offset & 0xff;
550 sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
551 offsets[0], offsets[1]);
554 ch_levels = devc->channel_levels[1][devc->voltage[1]];
555 offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
556 offsets[2] = (offset >> 8) | 0x20;
557 offsets[3] = offset & 0xff;
558 sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
559 offsets[2], offsets[3]);
562 offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
563 offsets[4] = (offset >> 8) | 0x20;
564 offsets[5] = offset & 0xff;
565 sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
566 offsets[4], offsets[5]);
568 if ((ret = libusb_control_transfer(usb->devhdl,
569 LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
570 0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
571 sr_err("Failed to set offsets: %s.", libusb_error_name(ret));
574 sr_dbg("Sent CTRL_SETOFFSET.");
579 SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi)
581 struct sr_usb_dev_inst *usb;
583 uint8_t cmdstring[2];
585 sr_dbg("Sending CMD_ENABLE_TRIGGER.");
589 memset(cmdstring, 0, sizeof(cmdstring));
590 cmdstring[0] = CMD_ENABLE_TRIGGER;
593 if (send_begin(sdi) != SR_OK)
596 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
597 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
598 sr_err("Failed to enable trigger: %s.", libusb_error_name(ret));
605 SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi)
607 struct sr_usb_dev_inst *usb;
609 uint8_t cmdstring[2];
611 sr_dbg("Sending CMD_FORCE_TRIGGER.");
615 memset(cmdstring, 0, sizeof(cmdstring));
616 cmdstring[0] = CMD_FORCE_TRIGGER;
619 if (send_begin(sdi) != SR_OK)
622 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
623 cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
624 sr_err("Failed to force trigger: %s.", libusb_error_name(ret));
631 SR_PRIV int dso_init(const struct sr_dev_inst *sdi)
634 sr_dbg("Initializing DSO.");
636 if (get_channel_offsets(sdi) != SR_OK)
639 if (dso_set_trigger_samplerate(sdi) != SR_OK)
642 if (dso_set_filters(sdi) != SR_OK)
645 if (dso_set_voltage(sdi) != SR_OK)
648 if (dso_set_relays(sdi) != SR_OK)
651 if (dso_set_voffsets(sdi) != SR_OK)
654 if (dso_enable_trigger(sdi) != SR_OK)
660 SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
661 uint8_t *capturestate, uint32_t *trigger_offset)
663 struct sr_usb_dev_inst *usb;
665 unsigned int bitvalue, toff;
666 uint8_t cmdstring[2], inbuf[512];
668 sr_dbg("Sending CMD_GET_CAPTURESTATE.");
672 cmdstring[0] = CMD_GET_CAPTURESTATE;
675 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
676 sr_dbg("Failed to send get_capturestate command: %s.",
677 libusb_error_name(ret));
681 if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_IN,
682 inbuf, 512, &tmp, 100)) != 0) {
683 sr_dbg("Failed to get capturestate: %s.",
684 libusb_error_name(ret));
687 *capturestate = inbuf[0];
688 toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
691 * This conversion comes from the openhantek project.
692 * Each set bit in the 24-bit value inverts all bits with a lower
693 * value. No idea why the device reports the trigger point this way.
696 for (i = 0; i < 24; i++) {
697 /* Each set bit inverts all bits with a lower value. */
699 toff ^= bitvalue - 1;
702 *trigger_offset = toff;
707 SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi)
710 uint8_t cmdstring[2];
712 sr_dbg("Sending CMD_CAPTURE_START.");
714 cmdstring[0] = CMD_CAPTURE_START;
717 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
718 sr_err("Failed to send capture_start command: %s.",
719 libusb_error_name(ret));
726 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
727 libusb_transfer_cb_fn cb)
729 struct dev_context *devc;
730 struct sr_usb_dev_inst *usb;
731 struct libusb_transfer *transfer;
732 int num_transfers, ret, i;
733 uint8_t cmdstring[2];
736 sr_dbg("Sending CMD_GET_CHANNELDATA.");
741 cmdstring[0] = CMD_GET_CHANNELDATA;
744 if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
745 sr_err("Failed to get channel data: %s.",
746 libusb_error_name(ret));
750 /* TODO: DSO-2xxx only. */
751 num_transfers = devc->framesize *
752 sizeof(unsigned short) / devc->epin_maxpacketsize;
753 sr_dbg("Queueing up %d transfers.", num_transfers);
754 for (i = 0; i < num_transfers; i++) {
755 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
756 sr_err("Failed to malloc USB endpoint buffer.");
757 return SR_ERR_MALLOC;
759 transfer = libusb_alloc_transfer(0);
760 libusb_fill_bulk_transfer(transfer, usb->devhdl, DSO_EP_IN, buf,
761 devc->epin_maxpacketsize, cb, (void *)sdi, 40);
762 if ((ret = libusb_submit_transfer(transfer)) != 0) {
763 sr_err("Failed to submit transfer: %s.",
764 libusb_error_name(ret));
765 /* TODO: Free them all. */
766 libusb_free_transfer(transfer);