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