]> sigrok.org Git - libsigrok.git/blame - hardware/hantek-dso/api.c
Deprecate SR_DI_TRIGGER_TYPES.
[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
3b533202 288 devcnt = 0;
39cfdd75 289 devices = 0;
a873c594 290 drvc = di->priv;
269971dd 291 drvc->instances = NULL;
39cfdd75
BV
292
293 clear_instances();
294
295 /* Find all Hantek DSO devices and upload firmware to all of them. */
d4abb463 296 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
3b533202 297 for (i = 0; devlist[i]; i++) {
61136ea6 298 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
d4928d71
PS
299 sr_err("Failed to get device descriptor: %s.",
300 libusb_error_name(ret));
3b533202
BV
301 continue;
302 }
303
304 prof = NULL;
305 for (j = 0; dev_profiles[j].orig_vid; j++) {
306 if (des.idVendor == dev_profiles[j].orig_vid
307 && des.idProduct == dev_profiles[j].orig_pid) {
308 /* Device matches the pre-firmware profile. */
309 prof = &dev_profiles[j];
e98b7f1b 310 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
3b533202 311 sdi = dso_dev_new(devcnt, prof);
39cfdd75 312 devices = g_slist_append(devices, sdi);
269971dd 313 devc = sdi->priv;
3b533202
BV
314 if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
315 prof->firmware) == SR_OK)
316 /* Remember when the firmware on this device was updated */
269971dd 317 devc->fw_updated = g_get_monotonic_time();
3b533202 318 else
e98b7f1b
UH
319 sr_err("Firmware upload failed for "
320 "device %d.", devcnt);
3b533202 321 /* Dummy USB address of 0xff will get overwritten later. */
269971dd 322 devc->usb = sr_usb_dev_inst_new(
3b533202
BV
323 libusb_get_bus_number(devlist[i]), 0xff, NULL);
324 devcnt++;
325 break;
326 } else if (des.idVendor == dev_profiles[j].fw_vid
327 && des.idProduct == dev_profiles[j].fw_pid) {
328 /* Device matches the post-firmware profile. */
329 prof = &dev_profiles[j];
e98b7f1b 330 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
3b533202
BV
331 sdi = dso_dev_new(devcnt, prof);
332 sdi->status = SR_ST_INACTIVE;
39cfdd75 333 devices = g_slist_append(devices, sdi);
269971dd
BV
334 devc = sdi->priv;
335 devc->usb = sr_usb_dev_inst_new(
3b533202
BV
336 libusb_get_bus_number(devlist[i]),
337 libusb_get_device_address(devlist[i]), NULL);
338 devcnt++;
339 break;
340 }
341 }
342 if (!prof)
343 /* not a supported VID/PID */
344 continue;
345 }
346 libusb_free_device_list(devlist, 1);
347
39cfdd75 348 return devices;
3b533202
BV
349}
350
811deee4
BV
351static GSList *hw_dev_list(void)
352{
353 struct drv_context *drvc;
354
a873c594 355 drvc = di->priv;
811deee4
BV
356
357 return drvc->instances;
358}
359
25a0f108 360static int hw_dev_open(struct sr_dev_inst *sdi)
3b533202 361{
269971dd 362 struct dev_context *devc;
fc8fe3e3
BV
363 int64_t timediff_us, timediff_ms;
364 int err;
3b533202 365
269971dd 366 devc = sdi->priv;
3b533202
BV
367
368 /*
e98b7f1b
UH
369 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
370 * for the FX2 to renumerate.
3b533202 371 */
fc8fe3e3 372 err = SR_ERR;
269971dd 373 if (devc->fw_updated > 0) {
e98b7f1b
UH
374 sr_info("Waiting for device to reset.");
375 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
3b533202 376 g_usleep(300 * 1000);
fc8fe3e3
BV
377 timediff_ms = 0;
378 while (timediff_ms < MAX_RENUM_DELAY_MS) {
25a0f108 379 if ((err = dso_open(sdi)) == SR_OK)
3b533202
BV
380 break;
381 g_usleep(100 * 1000);
269971dd 382 timediff_us = g_get_monotonic_time() - devc->fw_updated;
fc8fe3e3 383 timediff_ms = timediff_us / 1000;
e98b7f1b 384 sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
3b533202 385 }
e98b7f1b 386 sr_info("Device came back after %d ms.", timediff_ms);
3b533202 387 } else {
25a0f108 388 err = dso_open(sdi);
3b533202
BV
389 }
390
391 if (err != SR_OK) {
e98b7f1b 392 sr_err("Unable to open device.");
3b533202
BV
393 return SR_ERR;
394 }
395
269971dd 396 err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
3b533202 397 if (err != 0) {
d4928d71
PS
398 sr_err("Unable to claim interface: %s.",
399 libusb_error_name(err));
3b533202
BV
400 return SR_ERR;
401 }
402
403 return SR_OK;
404}
405
25a0f108 406static int hw_dev_close(struct sr_dev_inst *sdi)
3b533202 407{
3b533202
BV
408 dso_close(sdi);
409
410 return SR_OK;
411}
412
413static int hw_cleanup(void)
414{
269971dd
BV
415 struct drv_context *drvc;
416
a873c594 417 if (!(drvc = di->priv))
269971dd 418 return SR_OK;
3b533202 419
39cfdd75 420 clear_instances();
3b533202 421
3b533202
BV
422 return SR_OK;
423}
424
035a1078 425static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
3b533202 426{
3b533202
BV
427 uint64_t tmp;
428
6f57fd96
BV
429 (void)sdi;
430
035a1078 431 switch (id) {
2ce9f046
BV
432 case SR_DI_HWCAPS:
433 *data = hwcaps;
434 break;
3b533202 435 /* TODO remove this */
123e1313 436 case SR_CONF_SAMPLERATE:
0b79bcbb 437 *data = &tmp;
3b533202 438 break;
b0c8d7ac
BV
439 default:
440 return SR_ERR_ARG;
3b533202
BV
441 }
442
0b79bcbb 443 return SR_OK;
3b533202
BV
444}
445
035a1078 446static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
3b533202 447{
269971dd 448 struct dev_context *devc;
a370ef19
BV
449 struct sr_rational tmp_rat;
450 float tmp_float;
451 uint64_t tmp_u64;
452 int ret, i;
4a090d72 453 char **targets;
3b533202 454
3b533202
BV
455 if (sdi->status != SR_ST_ACTIVE)
456 return SR_ERR;
457
a370ef19 458 ret = SR_OK;
269971dd 459 devc = sdi->priv;
035a1078 460 switch (id) {
1953564a 461 case SR_CONF_LIMIT_FRAMES:
269971dd 462 devc->limit_frames = *(const uint64_t *)value;
ae88b97b 463 break;
1953564a 464 case SR_CONF_TRIGGER_SLOPE:
62bb8840 465 tmp_u64 = *(const int *)value;
a370ef19
BV
466 if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE)
467 ret = SR_ERR_ARG;
269971dd 468 devc->triggerslope = tmp_u64;
a370ef19 469 break;
1953564a 470 case SR_CONF_HORIZ_TRIGGERPOS:
62bb8840 471 tmp_float = *(const float *)value;
a370ef19 472 if (tmp_float < 0.0 || tmp_float > 1.0) {
e98b7f1b 473 sr_err("Trigger position should be between 0.0 and 1.0.");
3b533202 474 ret = SR_ERR_ARG;
a370ef19 475 } else
269971dd 476 devc->triggerposition = tmp_float;
a370ef19 477 break;
1953564a 478 case SR_CONF_BUFFERSIZE:
62bb8840 479 tmp_u64 = *(const int *)value;
a370ef19
BV
480 for (i = 0; buffersizes[i]; i++) {
481 if (buffersizes[i] == tmp_u64) {
269971dd 482 devc->framesize = tmp_u64;
a370ef19
BV
483 break;
484 }
485 }
486 if (buffersizes[i] == 0)
487 ret = SR_ERR_ARG;
488 break;
1953564a 489 case SR_CONF_TIMEBASE:
62bb8840 490 tmp_rat = *(const struct sr_rational *)value;
a370ef19
BV
491 for (i = 0; timebases[i].p && timebases[i].q; i++) {
492 if (timebases[i].p == tmp_rat.p
493 && timebases[i].q == tmp_rat.q) {
269971dd 494 devc->timebase = i;
a370ef19
BV
495 break;
496 }
497 }
498 if (timebases[i].p == 0 && timebases[i].q == 0)
499 ret = SR_ERR_ARG;
500 break;
1953564a 501 case SR_CONF_TRIGGER_SOURCE:
a370ef19 502 for (i = 0; trigger_sources[i]; i++) {
4a090d72 503 if (!strcmp(value, trigger_sources[i])) {
269971dd 504 devc->triggersource = g_strdup(value);
a370ef19
BV
505 break;
506 }
507 }
508 if (trigger_sources[i] == 0)
509 ret = SR_ERR_ARG;
510 break;
1953564a 511 case SR_CONF_FILTER:
269971dd 512 devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0;
ebb781a6
BV
513 targets = g_strsplit(value, ",", 0);
514 for (i = 0; targets[i]; i++) {
515 if (targets[i] == '\0')
516 /* Empty filter string can be used to clear them all. */
517 ;
518 else if (!strcmp(targets[i], "CH1"))
269971dd 519 devc->filter_ch1 = TRUE;
ebb781a6 520 else if (!strcmp(targets[i], "CH2"))
269971dd 521 devc->filter_ch2 = TRUE;
ebb781a6 522 else if (!strcmp(targets[i], "TRIGGER"))
269971dd 523 devc->filter_trigger = TRUE;
ebb781a6 524 else {
e98b7f1b 525 sr_err("Invalid filter target %s.", targets[i]);
ebb781a6
BV
526 ret = SR_ERR_ARG;
527 }
528 }
529 g_strfreev(targets);
530 break;
1953564a 531 case SR_CONF_VDIV:
e98b7f1b 532 /* TODO: Not supporting vdiv per channel yet. */
62bb8840 533 tmp_rat = *(const struct sr_rational *)value;
313deed2
BV
534 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
535 if (vdivs[i].p == tmp_rat.p
536 && vdivs[i].q == tmp_rat.q) {
269971dd
BV
537 devc->voltage_ch1 = i;
538 devc->voltage_ch2 = i;
313deed2
BV
539 break;
540 }
541 }
542 if (vdivs[i].p == 0 && vdivs[i].q == 0)
543 ret = SR_ERR_ARG;
544 break;
1953564a 545 case SR_CONF_COUPLING:
e98b7f1b 546 /* TODO: Not supporting coupling per channel yet. */
b58fbd99 547 for (i = 0; coupling[i]; i++) {
4a090d72 548 if (!strcmp(value, coupling[i])) {
269971dd
BV
549 devc->coupling_ch1 = i;
550 devc->coupling_ch2 = i;
b58fbd99
BV
551 break;
552 }
553 }
554 if (coupling[i] == 0)
555 ret = SR_ERR_ARG;
556 break;
3b533202
BV
557 default:
558 ret = SR_ERR_ARG;
e98b7f1b 559 break;
3b533202
BV
560 }
561
562 return ret;
563}
564
a1c743fc
BV
565static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
566{
567
568 (void)sdi;
569
570 switch (key) {
6d1ceffa
BV
571 case SR_CONF_BUFFERSIZE:
572 *data = buffersizes;
573 break;
2a7b113d
BV
574 case SR_CONF_COUPLING:
575 *data = coupling;
576 break;
e4f2b2ad
BV
577 case SR_CONF_VDIV:
578 *data = vdivs;
579 break;
6e1fbcc4
BV
580 case SR_CONF_FILTER:
581 *data = filter_targets;
582 break;
41f5bd09
BV
583 case SR_CONF_TIMEBASE:
584 *data = timebases;
585 break;
328bafab
BV
586 case SR_CONF_TRIGGER_SOURCE:
587 *data = trigger_sources;
588 break;
a1c743fc
BV
589 default:
590 return SR_ERR_ARG;
591 }
592
593 return SR_OK;
594}
595
69e19dd7 596static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
e749a8cb 597 int num_samples)
3b533202
BV
598{
599 struct sr_datafeed_packet packet;
600 struct sr_datafeed_analog analog;
69e19dd7 601 struct dev_context *devc;
c5841b28 602 float ch1, ch2, range;
6e71ef3b 603 int num_probes, data_offset, i;
3b533202 604
69e19dd7 605 devc = sdi->priv;
269971dd 606 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
3b533202
BV
607 packet.type = SR_DF_ANALOG;
608 packet.payload = &analog;
6e71ef3b 609 /* TODO: support for 5xxx series 9-bit samples */
69e19dd7 610 analog.probes = devc->enabled_probes;
e749a8cb 611 analog.num_samples = num_samples;
9956f285
UH
612 analog.mq = SR_MQ_VOLTAGE;
613 analog.unit = SR_UNIT_VOLT;
886a52b6 614 /* TODO: Check malloc return value. */
6e71ef3b
BV
615 analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes);
616 data_offset = 0;
3b533202 617 for (i = 0; i < analog.num_samples; i++) {
e98b7f1b
UH
618 /*
619 * The device always sends data for both channels. If a channel
6e71ef3b 620 * is disabled, it contains a copy of the enabled channel's
e98b7f1b
UH
621 * data. However, we only send the requested channels to
622 * the bus.
c5841b28 623 *
e98b7f1b
UH
624 * Voltage values are encoded as a value 0-255 (0-512 on the
625 * DSO-5200*), where the value is a point in the range
626 * represented by the vdiv setting. There are 8 vertical divs,
627 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
628 * and 255 = +2V.
6e71ef3b 629 */
e98b7f1b 630 /* TODO: Support for DSO-5xxx series 9-bit samples. */
269971dd
BV
631 if (devc->ch1_enabled) {
632 range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8;
e749a8cb 633 ch1 = range / 255 * *(buf + i * 2 + 1);
c5841b28
BV
634 /* Value is centered around 0V. */
635 ch1 -= range / 2;
6e71ef3b
BV
636 analog.data[data_offset++] = ch1;
637 }
269971dd
BV
638 if (devc->ch2_enabled) {
639 range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8;
e749a8cb 640 ch2 = range / 255 * *(buf + i * 2);
c5841b28 641 ch2 -= range / 2;
6e71ef3b
BV
642 analog.data[data_offset++] = ch2;
643 }
3b533202 644 }
269971dd 645 sr_session_send(devc->cb_data, &packet);
e749a8cb
BV
646}
647
e98b7f1b
UH
648/*
649 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
e749a8cb 650 * Only channel data comes in asynchronously, and all transfers for this are
e98b7f1b 651 * queued up beforehand, so this just needs to chuck the incoming data onto
e749a8cb
BV
652 * the libsigrok session bus.
653 */
654static void receive_transfer(struct libusb_transfer *transfer)
655{
656 struct sr_datafeed_packet packet;
69e19dd7 657 struct sr_dev_inst *sdi;
269971dd 658 struct dev_context *devc;
e749a8cb
BV
659 int num_samples, pre;
660
69e19dd7
BV
661 sdi = transfer->user_data;
662 devc = sdi->priv;
e98b7f1b
UH
663 sr_dbg("receive_transfer(): status %d received %d bytes.",
664 transfer->status, transfer->actual_length);
e749a8cb
BV
665
666 if (transfer->actual_length == 0)
667 /* Nothing to send to the bus. */
668 return;
669
670 num_samples = transfer->actual_length / 2;
671
e98b7f1b
UH
672 sr_dbg("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
673 devc->samp_received + num_samples, devc->framesize);
e749a8cb 674
e98b7f1b
UH
675 /*
676 * The device always sends a full frame, but the beginning of the frame
e749a8cb
BV
677 * doesn't represent the trigger point. The offset at which the trigger
678 * happened came in with the capture state, so we need to start sending
e98b7f1b
UH
679 * from there up the session bus. The samples in the frame buffer
680 * before that trigger point came after the end of the device's frame
681 * buffer was reached, and it wrapped around to overwrite up until the
682 * trigger point.
e749a8cb 683 */
269971dd 684 if (devc->samp_received < devc->trigger_offset) {
e749a8cb 685 /* Trigger point not yet reached. */
269971dd 686 if (devc->samp_received + num_samples < devc->trigger_offset) {
e749a8cb 687 /* The entire chunk is before the trigger point. */
269971dd 688 memcpy(devc->framebuf + devc->samp_buffered * 2,
e749a8cb 689 transfer->buffer, num_samples * 2);
269971dd 690 devc->samp_buffered += num_samples;
e749a8cb 691 } else {
e98b7f1b
UH
692 /*
693 * This chunk hits or overruns the trigger point.
e749a8cb 694 * Store the part before the trigger fired, and
e98b7f1b
UH
695 * send the rest up to the session bus.
696 */
269971dd
BV
697 pre = devc->trigger_offset - devc->samp_received;
698 memcpy(devc->framebuf + devc->samp_buffered * 2,
e749a8cb 699 transfer->buffer, pre * 2);
269971dd 700 devc->samp_buffered += pre;
e749a8cb
BV
701
702 /* The rest of this chunk starts with the trigger point. */
e98b7f1b
UH
703 sr_dbg("Reached trigger point, %d samples buffered.",
704 devc->samp_buffered);
e749a8cb
BV
705
706 /* Avoid the corner case where the chunk ended at
707 * exactly the trigger point. */
708 if (num_samples > pre)
69e19dd7 709 send_chunk(sdi, transfer->buffer + pre * 2,
e749a8cb
BV
710 num_samples - pre);
711 }
712 } else {
713 /* Already past the trigger point, just send it all out. */
69e19dd7 714 send_chunk(sdi, transfer->buffer,
e749a8cb
BV
715 num_samples);
716 }
717
269971dd 718 devc->samp_received += num_samples;
e749a8cb
BV
719
720 /* Everything in this transfer was either copied to the buffer or
721 * sent to the session bus. */
3b533202
BV
722 g_free(transfer->buffer);
723 libusb_free_transfer(transfer);
3b533202 724
269971dd 725 if (devc->samp_received >= devc->framesize) {
e749a8cb
BV
726 /* That was the last chunk in this frame. Send the buffered
727 * pre-trigger samples out now, in one big chunk. */
e98b7f1b
UH
728 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
729 devc->samp_buffered);
69e19dd7 730 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
e749a8cb
BV
731
732 /* Mark the end of this frame. */
ae88b97b 733 packet.type = SR_DF_FRAME_END;
269971dd 734 sr_session_send(devc->cb_data, &packet);
ae88b97b 735
269971dd 736 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
ae88b97b 737 /* Terminate session */
a3508e33 738 devc->dev_state = STOPPING;
ae88b97b 739 } else {
269971dd 740 devc->dev_state = NEW_CAPTURE;
ae88b97b
BV
741 }
742 }
3b533202
BV
743}
744
745static int handle_event(int fd, int revents, void *cb_data)
746{
a3508e33 747 const struct sr_dev_inst *sdi;
ae88b97b 748 struct sr_datafeed_packet packet;
3b533202 749 struct timeval tv;
269971dd 750 struct dev_context *devc;
a873c594 751 struct drv_context *drvc = di->priv;
a3508e33
BV
752 const struct libusb_pollfd **lupfd;
753 int num_probes, i;
6e6eeff4
BV
754 uint32_t trigger_offset;
755 uint8_t capturestate;
3b533202 756
3b533202
BV
757 (void)fd;
758 (void)revents;
759
269971dd
BV
760 sdi = cb_data;
761 devc = sdi->priv;
a3508e33
BV
762 if (devc->dev_state == STOPPING) {
763 /* We've been told to wind up the acquisition. */
e98b7f1b
UH
764 sr_dbg("Stopping acquisition.");
765 /*
766 * TODO: Doesn't really cancel pending transfers so they might
767 * come in after SR_DF_END is sent.
768 */
d4abb463 769 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
a3508e33
BV
770 for (i = 0; lupfd[i]; i++)
771 sr_source_remove(lupfd[i]->fd);
772 free(lupfd);
773
774 packet.type = SR_DF_END;
775 sr_session_send(sdi, &packet);
776
777 devc->dev_state = IDLE;
778
779 return TRUE;
780 }
781
3b533202
BV
782 /* Always handle pending libusb events. */
783 tv.tv_sec = tv.tv_usec = 0;
d4abb463 784 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
3b533202 785
3b533202 786 /* TODO: ugh */
269971dd
BV
787 if (devc->dev_state == NEW_CAPTURE) {
788 if (dso_capture_start(devc) != SR_OK)
3b533202 789 return TRUE;
269971dd 790 if (dso_enable_trigger(devc) != SR_OK)
3b533202 791 return TRUE;
269971dd 792// if (dso_force_trigger(devc) != SR_OK)
a370ef19 793// return TRUE;
e98b7f1b 794 sr_dbg("Successfully requested next chunk.");
269971dd 795 devc->dev_state = CAPTURE;
3b533202
BV
796 return TRUE;
797 }
269971dd 798 if (devc->dev_state != CAPTURE)
3b533202
BV
799 return TRUE;
800
269971dd 801 if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK)
3b533202 802 return TRUE;
3b533202 803
e98b7f1b
UH
804 sr_dbg("Capturestate %d.", capturestate);
805 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
3b533202
BV
806 switch (capturestate) {
807 case CAPTURE_EMPTY:
269971dd
BV
808 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
809 devc->capture_empty_count = 0;
810 if (dso_capture_start(devc) != SR_OK)
3b533202 811 break;
269971dd 812 if (dso_enable_trigger(devc) != SR_OK)
3b533202 813 break;
269971dd 814// if (dso_force_trigger(devc) != SR_OK)
a370ef19 815// break;
e98b7f1b 816 sr_dbg("Successfully requested next chunk.");
3b533202
BV
817 }
818 break;
819 case CAPTURE_FILLING:
e98b7f1b 820 /* No data yet. */
3b533202
BV
821 break;
822 case CAPTURE_READY_8BIT:
e749a8cb 823 /* Remember where in the captured frame the trigger is. */
269971dd 824 devc->trigger_offset = trigger_offset;
e749a8cb 825
269971dd 826 num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1;
886a52b6 827 /* TODO: Check malloc return value. */
269971dd
BV
828 devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2);
829 devc->samp_buffered = devc->samp_received = 0;
e749a8cb 830
3b533202 831 /* Tell the scope to send us the first frame. */
69e19dd7 832 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
3b533202 833 break;
ae88b97b 834
e98b7f1b
UH
835 /*
836 * Don't hit the state machine again until we're done fetching
ae88b97b
BV
837 * the data we just told the scope to send.
838 */
269971dd 839 devc->dev_state = FETCH_DATA;
ae88b97b
BV
840
841 /* Tell the frontend a new frame is on the way. */
842 packet.type = SR_DF_FRAME_BEGIN;
269971dd 843 sr_session_send(sdi, &packet);
3b533202
BV
844 break;
845 case CAPTURE_READY_9BIT:
846 /* TODO */
e98b7f1b 847 sr_err("Not yet supported.");
3b533202
BV
848 break;
849 case CAPTURE_TIMEOUT:
850 /* Doesn't matter, we'll try again next time. */
851 break;
852 default:
e98b7f1b
UH
853 sr_dbg("Unknown capture state: %d.", capturestate);
854 break;
3b533202
BV
855 }
856
857 return TRUE;
858}
859
3ffb6964 860static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
e98b7f1b 861 void *cb_data)
3b533202
BV
862{
863 const struct libusb_pollfd **lupfd;
864 struct sr_datafeed_packet packet;
865 struct sr_datafeed_header header;
269971dd 866 struct dev_context *devc;
a873c594 867 struct drv_context *drvc = di->priv;
3b533202
BV
868 int i;
869
3b533202
BV
870 if (sdi->status != SR_ST_ACTIVE)
871 return SR_ERR;
872
269971dd
BV
873 devc = sdi->priv;
874 devc->cb_data = cb_data;
3b533202 875
014359e3 876 if (configure_probes(sdi) != SR_OK) {
e98b7f1b 877 sr_err("Failed to configure probes.");
014359e3
BV
878 return SR_ERR;
879 }
880
269971dd 881 if (dso_init(devc) != SR_OK)
3b533202
BV
882 return SR_ERR;
883
269971dd 884 if (dso_capture_start(devc) != SR_OK)
3b533202
BV
885 return SR_ERR;
886
269971dd 887 devc->dev_state = CAPTURE;
d4abb463 888 lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
3b533202 889 for (i = 0; lupfd[i]; i++)
e98b7f1b
UH
890 sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK,
891 handle_event, (void *)sdi);
3b533202
BV
892 free(lupfd);
893
894 /* Send header packet to the session bus. */
895 packet.type = SR_DF_HEADER;
896 packet.payload = (unsigned char *)&header;
897 header.feed_version = 1;
898 gettimeofday(&header.starttime, NULL);
899 sr_session_send(cb_data, &packet);
900
3b533202
BV
901 return SR_OK;
902}
903
69b07d14 904static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
3b533202 905{
269971dd
BV
906 struct dev_context *devc;
907
908 (void)cb_data;
3b533202 909
3b533202
BV
910 if (sdi->status != SR_ST_ACTIVE)
911 return SR_ERR;
912
a3508e33
BV
913 devc = sdi->priv;
914 devc->dev_state = STOPPING;
3b533202
BV
915
916 return SR_OK;
917}
918
62bb8840 919SR_PRIV struct sr_dev_driver hantek_dso_driver_info = {
3b533202
BV
920 .name = "hantek-dso",
921 .longname = "Hantek DSO",
922 .api_version = 1,
923 .init = hw_init,
924 .cleanup = hw_cleanup,
61136ea6 925 .scan = hw_scan,
811deee4
BV
926 .dev_list = hw_dev_list,
927 .dev_clear = clear_instances,
035a1078
BV
928 .config_get = config_get,
929 .config_set = config_set,
a1c743fc 930 .config_list = config_list,
3b533202
BV
931 .dev_open = hw_dev_open,
932 .dev_close = hw_dev_close,
62bb8840
UH
933 .dev_acquisition_start = hw_dev_acquisition_start,
934 .dev_acquisition_stop = hw_dev_acquisition_stop,
269971dd 935 .priv = NULL,
3b533202 936};