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