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