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