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