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