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