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