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