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