]> sigrok.org Git - libsigrok.git/blame - hardware/hantek-dso/api.c
sr_driver_scan(): Improve checks.
[libsigrok.git] / hardware / hantek-dso / api.c
CommitLineData
3b533202
BV
1/*
2 * This file is part of the sigrok project.
3 *
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <stdio.h>
21#include <stdint.h>
22#include <stdlib.h>
23#include <sys/types.h>
24#include <sys/stat.h>
25#include <fcntl.h>
26#include <unistd.h>
27#include <string.h>
28#include <sys/time.h>
29#include <inttypes.h>
3b533202
BV
30#include <glib.h>
31#include <libusb.h>
45c59c8b
BV
32#include "libsigrok.h"
33#include "libsigrok-internal.h"
3b533202
BV
34#include "dso.h"
35
fc8fe3e3
BV
36/* Max time in ms before we want to check on USB events */
37/* TODO tune this properly */
e98b7f1b 38#define TICK 1
3b533202 39
62bb8840 40static const int hwcaps[] = {
1953564a
BV
41 SR_CONF_OSCILLOSCOPE,
42 SR_CONF_LIMIT_SAMPLES,
43 SR_CONF_CONTINUOUS,
44 SR_CONF_TIMEBASE,
45 SR_CONF_BUFFERSIZE,
46 SR_CONF_TRIGGER_SOURCE,
47 SR_CONF_TRIGGER_SLOPE,
48 SR_CONF_HORIZ_TRIGGERPOS,
49 SR_CONF_FILTER,
50 SR_CONF_VDIV,
51 SR_CONF_COUPLING,
3b533202
BV
52 0,
53};
54
55static const char *probe_names[] = {
78693401 56 "CH1", "CH2",
3b533202
BV
57 NULL,
58};
59
62bb8840 60static const struct dso_profile dev_profiles[] = {
88a13f30 61 { 0x04b4, 0x2090, 0x04b5, 0x2090,
3b533202 62 "Hantek", "DSO-2090",
88a13f30
BV
63 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
64 { 0x04b4, 0x2150, 0x04b5, 0x2150,
65 "Hantek", "DSO-2150",
66 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
67 { 0x04b4, 0x2250, 0x04b5, 0x2250,
68 "Hantek", "DSO-2250",
69 FIRMWARE_DIR "/hantek-dso-2xxx.fw" },
70 { 0x04b4, 0x5200, 0x04b5, 0x5200,
71 "Hantek", "DSO-5200",
72 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
73 { 0x04b4, 0x520a, 0x04b5, 0x520a,
74 "Hantek", "DSO-5200A",
75 FIRMWARE_DIR "/hantek-dso-5xxx.fw" },
76 { 0, 0, 0, 0, 0, 0, 0 },
3b533202
BV
77};
78
62bb8840 79static const uint64_t buffersizes[] = {
a370ef19
BV
80 10240,
81 32768,
82 /* TODO: 65535 */
62bb8840 83 0,
a370ef19
BV
84};
85
62bb8840 86static const struct sr_rational timebases[] = {
a370ef19
BV
87 /* microseconds */
88 { 10, 1000000 },
89 { 20, 1000000 },
90 { 40, 1000000 },
91 { 100, 1000000 },
92 { 200, 1000000 },
93 { 400, 1000000 },
94 /* milliseconds */
95 { 1, 1000 },
96 { 2, 1000 },
97 { 4, 1000 },
98 { 10, 1000 },
99 { 20, 1000 },
100 { 40, 1000 },
101 { 100, 1000 },
102 { 200, 1000 },
103 { 400, 1000 },
62bb8840 104 { 0, 0},
a370ef19
BV
105};
106
62bb8840 107static const struct sr_rational vdivs[] = {
313deed2
BV
108 /* millivolts */
109 { 10, 1000 },
110 { 20, 1000 },
111 { 50, 1000 },
112 { 100, 1000 },
113 { 200, 1000 },
114 { 500, 1000 },
115 /* volts */
116 { 1, 1 },
117 { 2, 1 },
118 { 5, 1 },
62bb8840 119 { 0, 0 },
313deed2
BV
120};
121
62bb8840 122static const char *trigger_sources[] = {
a370ef19
BV
123 "CH1",
124 "CH2",
125 "EXT",
88a13f30 126 /* TODO: forced */
62bb8840 127 NULL,
a370ef19 128};
3b533202 129
62bb8840 130static const char *filter_targets[] = {
ebb781a6
BV
131 "CH1",
132 "CH2",
133 /* TODO: "TRIGGER", */
62bb8840 134 NULL,
ebb781a6
BV
135};
136
62bb8840 137static const char *coupling[] = {
b58fbd99
BV
138 "AC",
139 "DC",
140 "GND",
62bb8840 141 NULL,
b58fbd99
BV
142};
143
982947f7 144SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
a873c594 145static struct sr_dev_driver *di = &hantek_dso_driver_info;
e98b7f1b 146
69b07d14 147static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
3b533202 148
62bb8840 149static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof)
3b533202
BV
150{
151 struct sr_dev_inst *sdi;
87ca93c5 152 struct sr_probe *probe;
269971dd
BV
153 struct drv_context *drvc;
154 struct dev_context *devc;
87ca93c5 155 int i;
3b533202
BV
156
157 sdi = sr_dev_inst_new(index, SR_ST_INITIALIZING,
88a13f30 158 prof->vendor, prof->model, NULL);
3b533202
BV
159 if (!sdi)
160 return NULL;
a873c594 161 sdi->driver = di;
3b533202 162
e98b7f1b
UH
163 /*
164 * Add only the real probes -- EXT isn't a source of data, only
87ca93c5
BV
165 * a trigger source internal to the device.
166 */
167 for (i = 0; probe_names[i]; i++) {
168 if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE,
169 probe_names[i])))
170 return NULL;
171 sdi->probes = g_slist_append(sdi->probes, probe);
172 }
173
269971dd 174 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
e98b7f1b 175 sr_err("Device context malloc failed.");
3b533202
BV
176 return NULL;
177 }
e98b7f1b 178
269971dd
BV
179 devc->profile = prof;
180 devc->dev_state = IDLE;
181 devc->timebase = DEFAULT_TIMEBASE;
182 devc->ch1_enabled = TRUE;
183 devc->ch2_enabled = TRUE;
184 devc->voltage_ch1 = DEFAULT_VOLTAGE;
185 devc->voltage_ch2 = DEFAULT_VOLTAGE;
186 devc->coupling_ch1 = DEFAULT_COUPLING;
187 devc->coupling_ch2 = DEFAULT_COUPLING;
188 devc->voffset_ch1 = DEFAULT_VERT_OFFSET;
189 devc->voffset_ch2 = DEFAULT_VERT_OFFSET;
190 devc->voffset_trigger = DEFAULT_VERT_TRIGGERPOS;
191 devc->framesize = DEFAULT_FRAMESIZE;
192 devc->triggerslope = SLOPE_POSITIVE;
193 devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE);
194 devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS;
195 sdi->priv = devc;
a873c594 196 drvc = di->priv;
269971dd 197 drvc->instances = g_slist_append(drvc->instances, sdi);
3b533202
BV
198
199 return sdi;
200}
201
014359e3 202static int configure_probes(const struct sr_dev_inst *sdi)
3b533202 203{
014359e3 204 struct dev_context *devc;
69e19dd7 205 struct sr_probe *probe;
62bb8840 206 const GSList *l;
69e19dd7 207 int p;
3b533202 208
014359e3
BV
209 devc = sdi->priv;
210
69e19dd7 211 g_slist_free(devc->enabled_probes);
269971dd 212 devc->ch1_enabled = devc->ch2_enabled = FALSE;
69e19dd7
BV
213 for (l = sdi->probes, p = 0; l; l = l->next, p++) {
214 probe = l->data;
215 if (p == 0)
269971dd 216 devc->ch1_enabled = probe->enabled;
69e19dd7 217 else
269971dd 218 devc->ch2_enabled = probe->enabled;
69e19dd7
BV
219 if (probe->enabled)
220 devc->enabled_probes = g_slist_append(devc->enabled_probes, probe);
3b533202
BV
221 }
222
223 return SR_OK;
224}
225
39cfdd75 226/* Properly close and free all devices. */
811deee4 227static int clear_instances(void)
39cfdd75
BV
228{
229 struct sr_dev_inst *sdi;
269971dd
BV
230 struct drv_context *drvc;
231 struct dev_context *devc;
39cfdd75
BV
232 GSList *l;
233
a873c594 234 drvc = di->priv;
269971dd 235 for (l = drvc->instances; l; l = l->next) {
39cfdd75
BV
236 if (!(sdi = l->data)) {
237 /* Log error, but continue cleaning up the rest. */
e98b7f1b 238 sr_err("%s: sdi was NULL, continuing", __func__);
39cfdd75
BV
239 continue;
240 }
269971dd 241 if (!(devc = sdi->priv)) {
39cfdd75 242 /* Log error, but continue cleaning up the rest. */
e98b7f1b 243 sr_err("%s: sdi->priv was NULL, continuing", __func__);
39cfdd75
BV
244 continue;
245 }
246 dso_close(sdi);
269971dd
BV
247 sr_usb_dev_inst_free(devc->usb);
248 g_free(devc->triggersource);
69e19dd7 249 g_slist_free(devc->enabled_probes);
39cfdd75
BV
250
251 sr_dev_inst_free(sdi);
252 }
253
269971dd
BV
254 g_slist_free(drvc->instances);
255 drvc->instances = NULL;
39cfdd75 256
811deee4 257 return SR_OK;
39cfdd75
BV
258}
259
34f06b90 260static int hw_init(struct sr_context *sr_ctx)
61136ea6 261{
269971dd
BV
262 struct drv_context *drvc;
263
264 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
e98b7f1b 265 sr_err("Driver context malloc failed.");
886a52b6 266 return SR_ERR_MALLOC;
269971dd 267 }
61136ea6 268
1ebe4b4e 269 drvc->sr_ctx = sr_ctx;
a873c594 270 di->priv = drvc;
269971dd 271
61136ea6
BV
272 return SR_OK;
273}
274
39cfdd75 275static GSList *hw_scan(GSList *options)
3b533202
BV
276{
277 struct sr_dev_inst *sdi;
62bb8840 278 const struct dso_profile *prof;
269971dd
BV
279 struct drv_context *drvc;
280 struct dev_context *devc;
39cfdd75
BV
281 GSList *devices;
282 struct libusb_device_descriptor des;
3b533202 283 libusb_device **devlist;
61136ea6 284 int devcnt, ret, i, j;
3b533202 285
39cfdd75 286 (void)options;
e98b7f1b 287
a873c594 288 drvc = di->priv;
269971dd 289 drvc->instances = NULL;
39cfdd75 290
4b97c74e
UH
291 devcnt = 0;
292 devices = 0;
293
39cfdd75
BV
294 clear_instances();
295
296 /* Find all Hantek DSO devices and upload firmware to all of them. */
d4abb463 297 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
3b533202 298 for (i = 0; devlist[i]; i++) {
61136ea6 299 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
d4928d71
PS
300 sr_err("Failed to get device descriptor: %s.",
301 libusb_error_name(ret));
3b533202
BV
302 continue;
303 }
304
305 prof = NULL;
306 for (j = 0; dev_profiles[j].orig_vid; j++) {
307 if (des.idVendor == dev_profiles[j].orig_vid
308 && des.idProduct == dev_profiles[j].orig_pid) {
309 /* Device matches the pre-firmware profile. */
310 prof = &dev_profiles[j];
e98b7f1b 311 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
3b533202 312 sdi = dso_dev_new(devcnt, prof);
39cfdd75 313 devices = g_slist_append(devices, sdi);
269971dd 314 devc = sdi->priv;
3b533202
BV
315 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
316 prof->firmware) == SR_OK)
317 /* Remember when the firmware on this device was updated */
269971dd 318 devc->fw_updated = g_get_monotonic_time();
3b533202 319 else
e98b7f1b
UH
320 sr_err("Firmware upload failed for "
321 "device %d.", devcnt);
3b533202 322 /* Dummy USB address of 0xff will get overwritten later. */
269971dd 323 devc->usb = sr_usb_dev_inst_new(
3b533202
BV
324 libusb_get_bus_number(devlist[i]), 0xff, NULL);
325 devcnt++;
326 break;
327 } else if (des.idVendor == dev_profiles[j].fw_vid
328 && des.idProduct == dev_profiles[j].fw_pid) {
329 /* Device matches the post-firmware profile. */
330 prof = &dev_profiles[j];
e98b7f1b 331 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
3b533202
BV
332 sdi = dso_dev_new(devcnt, prof);
333 sdi->status = SR_ST_INACTIVE;
39cfdd75 334 devices = g_slist_append(devices, sdi);
269971dd
BV
335 devc = sdi->priv;
336 devc->usb = sr_usb_dev_inst_new(
3b533202
BV
337 libusb_get_bus_number(devlist[i]),
338 libusb_get_device_address(devlist[i]), NULL);
339 devcnt++;
340 break;
341 }
342 }
343 if (!prof)
344 /* not a supported VID/PID */
345 continue;
346 }
347 libusb_free_device_list(devlist, 1);
348
39cfdd75 349 return devices;
3b533202
BV
350}
351
811deee4
BV
352static GSList *hw_dev_list(void)
353{
354 struct drv_context *drvc;
355
a873c594 356 drvc = di->priv;
811deee4
BV
357
358 return drvc->instances;
359}
360
25a0f108 361static int hw_dev_open(struct sr_dev_inst *sdi)
3b533202 362{
269971dd 363 struct dev_context *devc;
fc8fe3e3
BV
364 int64_t timediff_us, timediff_ms;
365 int err;
3b533202 366
269971dd 367 devc = sdi->priv;
3b533202
BV
368
369 /*
e98b7f1b
UH
370 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
371 * for the FX2 to renumerate.
3b533202 372 */
fc8fe3e3 373 err = SR_ERR;
269971dd 374 if (devc->fw_updated > 0) {
e98b7f1b
UH
375 sr_info("Waiting for device to reset.");
376 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
3b533202 377 g_usleep(300 * 1000);
fc8fe3e3
BV
378 timediff_ms = 0;
379 while (timediff_ms < MAX_RENUM_DELAY_MS) {
25a0f108 380 if ((err = dso_open(sdi)) == SR_OK)
3b533202
BV
381 break;
382 g_usleep(100 * 1000);
269971dd 383 timediff_us = g_get_monotonic_time() - devc->fw_updated;
fc8fe3e3 384 timediff_ms = timediff_us / 1000;
e98b7f1b 385 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
3b533202 386 }
e98b7f1b 387 sr_info("Device came back after %d ms.", timediff_ms);
3b533202 388 } else {
25a0f108 389 err = dso_open(sdi);
3b533202
BV
390 }
391
392 if (err != SR_OK) {
e98b7f1b 393 sr_err("Unable to open device.");
3b533202
BV
394 return SR_ERR;
395 }
396
269971dd 397 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
3b533202 398 if (err != 0) {
d4928d71
PS
399 sr_err("Unable to claim interface: %s.",
400 libusb_error_name(err));
3b533202
BV
401 return SR_ERR;
402 }
403
404 return SR_OK;
405}
406
25a0f108 407static int hw_dev_close(struct sr_dev_inst *sdi)
3b533202 408{
3b533202
BV
409 dso_close(sdi);
410
411 return SR_OK;
412}
413
414static int hw_cleanup(void)
415{
269971dd
BV
416 struct drv_context *drvc;
417
a873c594 418 if (!(drvc = di->priv))
269971dd 419 return SR_OK;
3b533202 420
39cfdd75 421 clear_instances();
3b533202 422
3b533202
BV
423 return SR_OK;
424}
425
035a1078 426static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
3b533202 427{
269971dd 428 struct dev_context *devc;
a370ef19
BV
429 struct sr_rational tmp_rat;
430 float tmp_float;
431 uint64_t tmp_u64;
432 int ret, i;
4a090d72 433 char **targets;
3b533202 434
3b533202
BV
435 if (sdi->status != SR_ST_ACTIVE)
436 return SR_ERR;
437
a370ef19 438 ret = SR_OK;
269971dd 439 devc = sdi->priv;
035a1078 440 switch (id) {
1953564a 441 case SR_CONF_LIMIT_FRAMES:
269971dd 442 devc->limit_frames = *(const uint64_t *)value;
ae88b97b 443 break;
1953564a 444 case SR_CONF_TRIGGER_SLOPE:
62bb8840 445 tmp_u64 = *(const int *)value;
a370ef19
BV
446 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
447 ret = SR_ERR_ARG;
269971dd 448 devc->triggerslope = tmp_u64;
a370ef19 449 break;
1953564a 450 case SR_CONF_HORIZ_TRIGGERPOS:
62bb8840 451 tmp_float = *(const float *)value;
a370ef19 452 if (tmp_float < 0.0 || tmp_float > 1.0) {
e98b7f1b 453 sr_err("Trigger position should be between 0.0 and 1.0.");
3b533202 454 ret = SR_ERR_ARG;
a370ef19 455 } else
269971dd 456 devc->triggerposition = tmp_float;
a370ef19 457 break;
1953564a 458 case SR_CONF_BUFFERSIZE:
62bb8840 459 tmp_u64 = *(const int *)value;
a370ef19
BV
460 for (i = 0; buffersizes[i]; i++) {
461 if (buffersizes[i] == tmp_u64) {
269971dd 462 devc->framesize = tmp_u64;
a370ef19
BV
463 break;
464 }
465 }
466 if (buffersizes[i] == 0)
467 ret = SR_ERR_ARG;
468 break;
1953564a 469 case SR_CONF_TIMEBASE:
62bb8840 470 tmp_rat = *(const struct sr_rational *)value;
a370ef19
BV
471 for (i = 0; timebases[i].p && timebases[i].q; i++) {
472 if (timebases[i].p == tmp_rat.p
473 && timebases[i].q == tmp_rat.q) {
269971dd 474 devc->timebase = i;
a370ef19
BV
475 break;
476 }
477 }
478 if (timebases[i].p == 0 && timebases[i].q == 0)
479 ret = SR_ERR_ARG;
480 break;
1953564a 481 case SR_CONF_TRIGGER_SOURCE:
a370ef19 482 for (i = 0; trigger_sources[i]; i++) {
4a090d72 483 if (!strcmp(value, trigger_sources[i])) {
269971dd 484 devc->triggersource = g_strdup(value);
a370ef19
BV
485 break;
486 }
487 }
488 if (trigger_sources[i] == 0)
489 ret = SR_ERR_ARG;
490 break;
1953564a 491 case SR_CONF_FILTER:
269971dd 492 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
ebb781a6
BV
493 targets = g_strsplit(value, ",", 0);
494 for (i = 0; targets[i]; i++) {
495 if (targets[i] == '\0')
496 /* Empty filter string can be used to clear them all. */
497 ;
498 else if (!strcmp(targets[i], "CH1"))
269971dd 499 devc->filter_ch1 = TRUE;
ebb781a6 500 else if (!strcmp(targets[i], "CH2"))
269971dd 501 devc->filter_ch2 = TRUE;
ebb781a6 502 else if (!strcmp(targets[i], "TRIGGER"))
269971dd 503 devc->filter_trigger = TRUE;
ebb781a6 504 else {
e98b7f1b 505 sr_err("Invalid filter target %s.", targets[i]);
ebb781a6
BV
506 ret = SR_ERR_ARG;
507 }
508 }
509 g_strfreev(targets);
510 break;
1953564a 511 case SR_CONF_VDIV:
e98b7f1b 512 /* TODO: Not supporting vdiv per channel yet. */
62bb8840 513 tmp_rat = *(const struct sr_rational *)value;
313deed2
BV
514 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
515 if (vdivs[i].p == tmp_rat.p
516 && vdivs[i].q == tmp_rat.q) {
269971dd
BV
517 devc->voltage_ch1 = i;
518 devc->voltage_ch2 = i;
313deed2
BV
519 break;
520 }
521 }
522 if (vdivs[i].p == 0 && vdivs[i].q == 0)
523 ret = SR_ERR_ARG;
524 break;
1953564a 525 case SR_CONF_COUPLING:
e98b7f1b 526 /* TODO: Not supporting coupling per channel yet. */
b58fbd99 527 for (i = 0; coupling[i]; i++) {
4a090d72 528 if (!strcmp(value, coupling[i])) {
269971dd
BV
529 devc->coupling_ch1 = i;
530 devc->coupling_ch2 = i;
b58fbd99
BV
531 break;
532 }
533 }
534 if (coupling[i] == 0)
535 ret = SR_ERR_ARG;
536 break;
3b533202
BV
537 default:
538 ret = SR_ERR_ARG;
e98b7f1b 539 break;
3b533202
BV
540 }
541
542 return ret;
543}
544
a1c743fc
BV
545static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
546{
547
548 (void)sdi;
549
550 switch (key) {
9a6517d1
BV
551 case SR_CONF_DEVICE_OPTIONS:
552 *data = hwcaps;
553 break;
6d1ceffa
BV
554 case SR_CONF_BUFFERSIZE:
555 *data = buffersizes;
556 break;
2a7b113d
BV
557 case SR_CONF_COUPLING:
558 *data = coupling;
559 break;
e4f2b2ad
BV
560 case SR_CONF_VDIV:
561 *data = vdivs;
562 break;
6e1fbcc4
BV
563 case SR_CONF_FILTER:
564 *data = filter_targets;
565 break;
41f5bd09
BV
566 case SR_CONF_TIMEBASE:
567 *data = timebases;
568 break;
328bafab
BV
569 case SR_CONF_TRIGGER_SOURCE:
570 *data = trigger_sources;
571 break;
a1c743fc
BV
572 default:
573 return SR_ERR_ARG;
574 }
575
576 return SR_OK;
577}
578
69e19dd7 579static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
e749a8cb 580 int num_samples)
3b533202
BV
581{
582 struct sr_datafeed_packet packet;
583 struct sr_datafeed_analog analog;
69e19dd7 584 struct dev_context *devc;
c5841b28 585 float ch1, ch2, range;
6e71ef3b 586 int num_probes, data_offset, i;
3b533202 587
69e19dd7 588 devc = sdi->priv;
269971dd 589 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
3b533202
BV
590 packet.type = SR_DF_ANALOG;
591 packet.payload = &analog;
6e71ef3b 592 /* TODO: support for 5xxx series 9-bit samples */
69e19dd7 593 analog.probes = devc->enabled_probes;
e749a8cb 594 analog.num_samples = num_samples;
9956f285
UH
595 analog.mq = SR_MQ_VOLTAGE;
596 analog.unit = SR_UNIT_VOLT;
886a52b6 597 /* TODO: Check malloc return value. */
6e71ef3b
BV
598 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
599 data_offset = 0;
3b533202 600 for (i = 0; i < analog.num_samples; i++) {
e98b7f1b
UH
601 /*
602 * The device always sends data for both channels. If a channel
6e71ef3b 603 * is disabled, it contains a copy of the enabled channel's
e98b7f1b
UH
604 * data. However, we only send the requested channels to
605 * the bus.
c5841b28 606 *
e98b7f1b
UH
607 * Voltage values are encoded as a value 0-255 (0-512 on the
608 * DSO-5200*), where the value is a point in the range
609 * represented by the vdiv setting. There are 8 vertical divs,
610 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
611 * and 255 = +2V.
6e71ef3b 612 */
e98b7f1b 613 /* TODO: Support for DSO-5xxx series 9-bit samples. */
269971dd
BV
614 if (devc->ch1_enabled) {
615 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
e749a8cb 616 ch1 = range / 255 * *(buf + i * 2 + 1);
c5841b28
BV
617 /* Value is centered around 0V. */
618 ch1 -= range / 2;
6e71ef3b
BV
619 analog.data[data_offset++] = ch1;
620 }
269971dd
BV
621 if (devc->ch2_enabled) {
622 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
e749a8cb 623 ch2 = range / 255 * *(buf + i * 2);
c5841b28 624 ch2 -= range / 2;
6e71ef3b
BV
625 analog.data[data_offset++] = ch2;
626 }
3b533202 627 }
269971dd 628 sr_session_send(devc->cb_data, &packet);
e749a8cb
BV
629}
630
e98b7f1b
UH
631/*
632 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
e749a8cb 633 * Only channel data comes in asynchronously, and all transfers for this are
e98b7f1b 634 * queued up beforehand, so this just needs to chuck the incoming data onto
e749a8cb
BV
635 * the libsigrok session bus.
636 */
637static void receive_transfer(struct libusb_transfer *transfer)
638{
639 struct sr_datafeed_packet packet;
69e19dd7 640 struct sr_dev_inst *sdi;
269971dd 641 struct dev_context *devc;
e749a8cb
BV
642 int num_samples, pre;
643
69e19dd7
BV
644 sdi = transfer->user_data;
645 devc = sdi->priv;
e98b7f1b
UH
646 sr_dbg("receive_transfer(): status %d received %d bytes.",
647 transfer->status, transfer->actual_length);
e749a8cb
BV
648
649 if (transfer->actual_length == 0)
650 /* Nothing to send to the bus. */
651 return;
652
653 num_samples = transfer->actual_length / 2;
654
e98b7f1b
UH
655 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
656 devc->samp_received + num_samples, devc->framesize);
e749a8cb 657
e98b7f1b
UH
658 /*
659 * The device always sends a full frame, but the beginning of the frame
e749a8cb
BV
660 * doesn't represent the trigger point. The offset at which the trigger
661 * happened came in with the capture state, so we need to start sending
e98b7f1b
UH
662 * from there up the session bus. The samples in the frame buffer
663 * before that trigger point came after the end of the device's frame
664 * buffer was reached, and it wrapped around to overwrite up until the
665 * trigger point.
e749a8cb 666 */
269971dd 667 if (devc->samp_received < devc->trigger_offset) {
e749a8cb 668 /* Trigger point not yet reached. */
269971dd 669 if (devc->samp_received + num_samples < devc->trigger_offset) {
e749a8cb 670 /* The entire chunk is before the trigger point. */
269971dd 671 memcpy(devc->framebuf + devc->samp_buffered * 2,
e749a8cb 672 transfer->buffer, num_samples * 2);
269971dd 673 devc->samp_buffered += num_samples;
e749a8cb 674 } else {
e98b7f1b
UH
675 /*
676 * This chunk hits or overruns the trigger point.
e749a8cb 677 * Store the part before the trigger fired, and
e98b7f1b
UH
678 * send the rest up to the session bus.
679 */
269971dd
BV
680 pre = devc->trigger_offset - devc->samp_received;
681 memcpy(devc->framebuf + devc->samp_buffered * 2,
e749a8cb 682 transfer->buffer, pre * 2);
269971dd 683 devc->samp_buffered += pre;
e749a8cb
BV
684
685 /* The rest of this chunk starts with the trigger point. */
e98b7f1b
UH
686 sr_dbg("Reached trigger point, %d samples buffered.",
687 devc->samp_buffered);
e749a8cb
BV
688
689 /* Avoid the corner case where the chunk ended at
690 * exactly the trigger point. */
691 if (num_samples > pre)
69e19dd7 692 send_chunk(sdi, transfer->buffer + pre * 2,
e749a8cb
BV
693 num_samples - pre);
694 }
695 } else {
696 /* Already past the trigger point, just send it all out. */
69e19dd7 697 send_chunk(sdi, transfer->buffer,
e749a8cb
BV
698 num_samples);
699 }
700
269971dd 701 devc->samp_received += num_samples;
e749a8cb
BV
702
703 /* Everything in this transfer was either copied to the buffer or
704 * sent to the session bus. */
3b533202
BV
705 g_free(transfer->buffer);
706 libusb_free_transfer(transfer);
3b533202 707
269971dd 708 if (devc->samp_received >= devc->framesize) {
e749a8cb
BV
709 /* That was the last chunk in this frame. Send the buffered
710 * pre-trigger samples out now, in one big chunk. */
e98b7f1b
UH
711 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
712 devc->samp_buffered);
69e19dd7 713 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
e749a8cb
BV
714
715 /* Mark the end of this frame. */
ae88b97b 716 packet.type = SR_DF_FRAME_END;
269971dd 717 sr_session_send(devc->cb_data, &packet);
ae88b97b 718
269971dd 719 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
ae88b97b 720 /* Terminate session */
a3508e33 721 devc->dev_state = STOPPING;
ae88b97b 722 } else {
269971dd 723 devc->dev_state = NEW_CAPTURE;
ae88b97b
BV
724 }
725 }
3b533202
BV
726}
727
728static int handle_event(int fd, int revents, void *cb_data)
729{
a3508e33 730 const struct sr_dev_inst *sdi;
ae88b97b 731 struct sr_datafeed_packet packet;
3b533202 732 struct timeval tv;
269971dd 733 struct dev_context *devc;
a873c594 734 struct drv_context *drvc = di->priv;
a3508e33
BV
735 const struct libusb_pollfd **lupfd;
736 int num_probes, i;
6e6eeff4
BV
737 uint32_t trigger_offset;
738 uint8_t capturestate;
3b533202 739
3b533202
BV
740 (void)fd;
741 (void)revents;
742
269971dd
BV
743 sdi = cb_data;
744 devc = sdi->priv;
a3508e33
BV
745 if (devc->dev_state == STOPPING) {
746 /* We've been told to wind up the acquisition. */
e98b7f1b
UH
747 sr_dbg("Stopping acquisition.");
748 /*
749 * TODO: Doesn't really cancel pending transfers so they might
750 * come in after SR_DF_END is sent.
751 */
d4abb463 752 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
a3508e33
BV
753 for (i = 0; lupfd[i]; i++)
754 sr_source_remove(lupfd[i]->fd);
755 free(lupfd);
756
757 packet.type = SR_DF_END;
758 sr_session_send(sdi, &packet);
759
760 devc->dev_state = IDLE;
761
762 return TRUE;
763 }
764
3b533202
BV
765 /* Always handle pending libusb events. */
766 tv.tv_sec = tv.tv_usec = 0;
d4abb463 767 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
3b533202 768
3b533202 769 /* TODO: ugh */
269971dd
BV
770 if (devc->dev_state == NEW_CAPTURE) {
771 if (dso_capture_start(devc) != SR_OK)
3b533202 772 return TRUE;
269971dd 773 if (dso_enable_trigger(devc) != SR_OK)
3b533202 774 return TRUE;
269971dd 775// if (dso_force_trigger(devc) != SR_OK)
a370ef19 776// return TRUE;
e98b7f1b 777 sr_dbg("Successfully requested next chunk.");
269971dd 778 devc->dev_state = CAPTURE;
3b533202
BV
779 return TRUE;
780 }
269971dd 781 if (devc->dev_state != CAPTURE)
3b533202
BV
782 return TRUE;
783
269971dd 784 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
3b533202 785 return TRUE;
3b533202 786
e98b7f1b
UH
787 sr_dbg("Capturestate %d.", capturestate);
788 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
3b533202
BV
789 switch (capturestate) {
790 case CAPTURE_EMPTY:
269971dd
BV
791 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
792 devc->capture_empty_count = 0;
793 if (dso_capture_start(devc) != SR_OK)
3b533202 794 break;
269971dd 795 if (dso_enable_trigger(devc) != SR_OK)
3b533202 796 break;
269971dd 797// if (dso_force_trigger(devc) != SR_OK)
a370ef19 798// break;
e98b7f1b 799 sr_dbg("Successfully requested next chunk.");
3b533202
BV
800 }
801 break;
802 case CAPTURE_FILLING:
e98b7f1b 803 /* No data yet. */
3b533202
BV
804 break;
805 case CAPTURE_READY_8BIT:
e749a8cb 806 /* Remember where in the captured frame the trigger is. */
269971dd 807 devc->trigger_offset = trigger_offset;
e749a8cb 808
269971dd 809 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
886a52b6 810 /* TODO: Check malloc return value. */
269971dd
BV
811 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
812 devc->samp_buffered = devc->samp_received = 0;
e749a8cb 813
3b533202 814 /* Tell the scope to send us the first frame. */
69e19dd7 815 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
3b533202 816 break;
ae88b97b 817
e98b7f1b
UH
818 /*
819 * Don't hit the state machine again until we're done fetching
ae88b97b
BV
820 * the data we just told the scope to send.
821 */
269971dd 822 devc->dev_state = FETCH_DATA;
ae88b97b
BV
823
824 /* Tell the frontend a new frame is on the way. */
825 packet.type = SR_DF_FRAME_BEGIN;
269971dd 826 sr_session_send(sdi, &packet);
3b533202
BV
827 break;
828 case CAPTURE_READY_9BIT:
829 /* TODO */
e98b7f1b 830 sr_err("Not yet supported.");
3b533202
BV
831 break;
832 case CAPTURE_TIMEOUT:
833 /* Doesn't matter, we'll try again next time. */
834 break;
835 default:
e98b7f1b
UH
836 sr_dbg("Unknown capture state: %d.", capturestate);
837 break;
3b533202
BV
838 }
839
840 return TRUE;
841}
842
3ffb6964 843static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
e98b7f1b 844 void *cb_data)
3b533202
BV
845{
846 const struct libusb_pollfd **lupfd;
847 struct sr_datafeed_packet packet;
848 struct sr_datafeed_header header;
269971dd 849 struct dev_context *devc;
a873c594 850 struct drv_context *drvc = di->priv;
3b533202
BV
851 int i;
852
3b533202
BV
853 if (sdi->status != SR_ST_ACTIVE)
854 return SR_ERR;
855
269971dd
BV
856 devc = sdi->priv;
857 devc->cb_data = cb_data;
3b533202 858
014359e3 859 if (configure_probes(sdi) != SR_OK) {
e98b7f1b 860 sr_err("Failed to configure probes.");
014359e3
BV
861 return SR_ERR;
862 }
863
269971dd 864 if (dso_init(devc) != SR_OK)
3b533202
BV
865 return SR_ERR;
866
269971dd 867 if (dso_capture_start(devc) != SR_OK)
3b533202
BV
868 return SR_ERR;
869
269971dd 870 devc->dev_state = CAPTURE;
d4abb463 871 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
3b533202 872 for (i = 0; lupfd[i]; i++)
e98b7f1b
UH
873 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
874 handle_event, (void *)sdi);
3b533202
BV
875 free(lupfd);
876
877 /* Send header packet to the session bus. */
878 packet.type = SR_DF_HEADER;
879 packet.payload = (unsigned char *)&header;
880 header.feed_version = 1;
881 gettimeofday(&header.starttime, NULL);
882 sr_session_send(cb_data, &packet);
883
3b533202
BV
884 return SR_OK;
885}
886
69b07d14 887static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
3b533202 888{
269971dd
BV
889 struct dev_context *devc;
890
891 (void)cb_data;
3b533202 892
3b533202
BV
893 if (sdi->status != SR_ST_ACTIVE)
894 return SR_ERR;
895
a3508e33
BV
896 devc = sdi->priv;
897 devc->dev_state = STOPPING;
3b533202
BV
898
899 return SR_OK;
900}
901
62bb8840 902SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
3b533202
BV
903 .name = "hantek-dso",
904 .longname = "Hantek DSO",
905 .api_version = 1,
906 .init = hw_init,
907 .cleanup = hw_cleanup,
61136ea6 908 .scan = hw_scan,
811deee4
BV
909 .dev_list = hw_dev_list,
910 .dev_clear = clear_instances,
035a1078 911 .config_set = config_set,
a1c743fc 912 .config_list = config_list,
3b533202
BV
913 .dev_open = hw_dev_open,
914 .dev_close = hw_dev_close,
62bb8840
UH
915 .dev_acquisition_start = hw_dev_acquisition_start,
916 .dev_acquisition_stop = hw_dev_acquisition_stop,
269971dd 917 .priv = NULL,
3b533202 918};