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