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