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