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