]> sigrok.org Git - libsigrok.git/blob - src/hardware/hantek-6xxx/api.c
hantek-6xxx: Add "fx2lafw-" prefix to the firmware files.
[libsigrok.git] / src / hardware / hantek-6xxx / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2015 Christer Ekholm <christerekholm@gmail.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 "protocol.h"
23
24 /* Max time in ms before we want to check on USB events */
25 #define TICK 200
26
27 #define RANGE(ch) (((float)vdivs[devc->voltage[ch]][0] / vdivs[devc->voltage[ch]][1]) * VDIV_MULTIPLIER)
28
29 static const uint32_t scanopts[] = {
30         SR_CONF_CONN,
31 };
32
33 static const uint32_t drvopts[] = {
34         SR_CONF_OSCILLOSCOPE,
35 };
36
37 static const uint32_t devopts[] = {
38         SR_CONF_CONN | SR_CONF_GET,
39         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
40         SR_CONF_NUM_VDIV | SR_CONF_GET,
41         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
42         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
43 };
44
45 static const uint32_t devopts_cg[] = {
46         SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
47         SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
48 };
49
50 static const char *channel_names[] = {
51         "CH1", "CH2",
52 };
53
54 static const char *dc_coupling[] = {
55         "DC", "DC",
56 };
57
58 static const char *acdc_coupling[] = {
59         "AC", "DC",
60 };
61
62 static const struct hantek_6xxx_profile dev_profiles[] = {
63         {
64                 0x04b4, 0x6022, 0x1d50, 0x608e, 0x0001,
65                 "Hantek", "6022BE", "fx2lafw-hantek-6022be.fw",
66                 dc_coupling, ARRAY_SIZE(dc_coupling), FALSE,
67         },
68         {
69                 0x8102, 0x8102, 0x1d50, 0x608e, 0x0002,
70                 "Sainsmart", "DDS120", "fx2lafw-sainsmart-dds120.fw",
71                 acdc_coupling, ARRAY_SIZE(acdc_coupling), TRUE,
72         },
73         ALL_ZERO
74 };
75
76 static const uint64_t samplerates[] = {
77         SAMPLERATE_VALUES
78 };
79
80 static const uint64_t vdivs[][2] = {
81         VDIV_VALUES
82 };
83
84 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
85
86 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
87
88 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
89 {
90         struct sr_dev_inst *sdi;
91         struct sr_channel *ch;
92         struct sr_channel_group *cg;
93         struct dev_context *devc;
94         unsigned int i;
95
96         sdi = g_malloc0(sizeof(struct sr_dev_inst));
97         sdi->status = SR_ST_INITIALIZING;
98         sdi->vendor = g_strdup(prof->vendor);
99         sdi->model = g_strdup(prof->model);
100
101         for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
102                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
103                 cg = g_malloc0(sizeof(struct sr_channel_group));
104                 cg->name = g_strdup(channel_names[i]);
105                 cg->channels = g_slist_append(cg->channels, ch);
106                 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
107         }
108
109         devc = g_malloc0(sizeof(struct dev_context));
110
111         for (i = 0; i < NUM_CHANNELS; i++) {
112                 devc->ch_enabled[i] = TRUE;
113                 devc->voltage[i] = DEFAULT_VOLTAGE;
114                 devc->coupling[i] = DEFAULT_COUPLING;
115         }
116         devc->coupling_vals = prof->coupling_vals;
117         devc->coupling_tab_size = prof->coupling_tab_size;
118
119         devc->sample_buf = NULL;
120         devc->sample_buf_write = 0;
121         devc->sample_buf_size = 0;
122
123         devc->profile = prof;
124         devc->dev_state = IDLE;
125         devc->samplerate = DEFAULT_SAMPLERATE;
126
127         sdi->priv = devc;
128
129         return sdi;
130 }
131
132 static int configure_channels(const struct sr_dev_inst *sdi)
133 {
134         struct dev_context *devc;
135         const GSList *l;
136         int p;
137         struct sr_channel *ch;
138         devc = sdi->priv;
139
140         g_slist_free(devc->enabled_channels);
141         devc->enabled_channels = NULL;
142         memset(devc->ch_enabled, 0, sizeof(devc->ch_enabled));
143
144         for (l = sdi->channels, p = 0; l; l = l->next, p++) {
145                 ch = l->data;
146                 if (p < NUM_CHANNELS) {
147                         devc->ch_enabled[p] = ch->enabled;
148                         devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
149                 }
150         }
151
152         return SR_OK;
153 }
154
155 static void clear_dev_context(void *priv)
156 {
157         struct dev_context *devc;
158
159         devc = priv;
160         g_slist_free(devc->enabled_channels);
161         g_free(devc);
162 }
163
164 static int dev_clear(const struct sr_dev_driver *di)
165 {
166         return std_dev_clear(di, clear_dev_context);
167 }
168
169 static GSList *scan(struct sr_dev_driver *di, GSList *options)
170 {
171         struct drv_context *drvc;
172         struct dev_context *devc;
173         struct sr_dev_inst *sdi;
174         struct sr_usb_dev_inst *usb;
175         struct sr_config *src;
176         const struct hantek_6xxx_profile *prof;
177         GSList *l, *devices, *conn_devices;
178         struct libusb_device_descriptor des;
179         libusb_device **devlist;
180         int i, j;
181         const char *conn;
182         char connection_id[64];
183
184         drvc = di->context;
185
186         devices = 0;
187
188         conn = NULL;
189         for (l = options; l; l = l->next) {
190                 src = l->data;
191                 if (src->key == SR_CONF_CONN) {
192                         conn = g_variant_get_string(src->data, NULL);
193                         break;
194                 }
195         }
196         if (conn)
197                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
198         else
199                 conn_devices = NULL;
200
201         /* Find all Hantek 60xx devices and upload firmware to all of them. */
202         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
203         for (i = 0; devlist[i]; i++) {
204                 if (conn) {
205                         usb = NULL;
206                         for (l = conn_devices; l; l = l->next) {
207                                 usb = l->data;
208                                 if (usb->bus == libusb_get_bus_number(devlist[i])
209                                         && usb->address == libusb_get_device_address(devlist[i]))
210                                         break;
211                         }
212                         if (!l)
213                                 /* This device matched none of the ones that
214                                  * matched the conn specification. */
215                                 continue;
216                 }
217
218                 libusb_get_device_descriptor(devlist[i], &des);
219
220                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
221
222                 prof = NULL;
223                 for (j = 0; dev_profiles[j].orig_vid; j++) {
224                         if (des.idVendor == dev_profiles[j].orig_vid
225                                 && des.idProduct == dev_profiles[j].orig_pid) {
226                                 /* Device matches the pre-firmware profile. */
227                                 prof = &dev_profiles[j];
228                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
229                                 sdi = hantek_6xxx_dev_new(prof);
230                                 sdi->connection_id = g_strdup(connection_id);
231                                 devices = g_slist_append(devices, sdi);
232                                 devc = sdi->priv;
233                                 if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
234                                                 USB_CONFIGURATION, prof->firmware) == SR_OK)
235                                         /* Remember when the firmware on this device was updated. */
236                                         devc->fw_updated = g_get_monotonic_time();
237                                 else
238                                         sr_err("Firmware upload failed.");
239                                 /* Dummy USB address of 0xff will get overwritten later. */
240                                 sdi->conn = sr_usb_dev_inst_new(
241                                                 libusb_get_bus_number(devlist[i]), 0xff, NULL);
242                                 break;
243                         } else if (des.idVendor == dev_profiles[j].fw_vid
244                                 && des.idProduct == dev_profiles[j].fw_pid
245                                 && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
246                                 /* Device matches the post-firmware profile. */
247                                 prof = &dev_profiles[j];
248                                 sr_dbg("Found a %s %s.", prof->vendor, prof->model);
249                                 sdi = hantek_6xxx_dev_new(prof);
250                                 sdi->connection_id = g_strdup(connection_id);
251                                 sdi->status = SR_ST_INACTIVE;
252                                 devices = g_slist_append(devices, sdi);
253                                 sdi->inst_type = SR_INST_USB;
254                                 sdi->conn = sr_usb_dev_inst_new(
255                                                 libusb_get_bus_number(devlist[i]),
256                                                 libusb_get_device_address(devlist[i]), NULL);
257                                 break;
258                         }
259                 }
260                 if (!prof)
261                         /* Not a supported VID/PID. */
262                         continue;
263         }
264         libusb_free_device_list(devlist, 1);
265
266         return std_scan_complete(di, devices);
267 }
268
269 static int dev_open(struct sr_dev_inst *sdi)
270 {
271         struct dev_context *devc;
272         struct sr_usb_dev_inst *usb;
273         int64_t timediff_us, timediff_ms;
274         int err;
275
276         devc = sdi->priv;
277         usb = sdi->conn;
278
279         /*
280          * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
281          * for the FX2 to renumerate.
282          */
283         err = SR_ERR;
284         if (devc->fw_updated > 0) {
285                 sr_info("Waiting for device to reset.");
286                 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
287                 g_usleep(300 * 1000);
288                 timediff_ms = 0;
289                 while (timediff_ms < MAX_RENUM_DELAY_MS) {
290                         if ((err = hantek_6xxx_open(sdi)) == SR_OK)
291                                 break;
292                         g_usleep(100 * 1000);
293                         timediff_us = g_get_monotonic_time() - devc->fw_updated;
294                         timediff_ms = timediff_us / 1000;
295                         sr_spew("Waited %" PRIi64 " ms.", timediff_ms);
296                 }
297                 if (timediff_ms < MAX_RENUM_DELAY_MS)
298                         sr_info("Device came back after %"PRIu64" ms.", timediff_ms);
299         } else {
300                 err = hantek_6xxx_open(sdi);
301         }
302
303         if (err != SR_OK) {
304                 sr_err("Unable to open device.");
305                 return SR_ERR;
306         }
307
308         err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
309         if (err != 0) {
310                 sr_err("Unable to claim interface: %s.",
311                         libusb_error_name(err));
312                 return SR_ERR;
313         }
314
315         return SR_OK;
316 }
317
318 static int dev_close(struct sr_dev_inst *sdi)
319 {
320         hantek_6xxx_close(sdi);
321
322         return SR_OK;
323 }
324
325 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
326                 const struct sr_channel_group *cg)
327 {
328         struct dev_context *devc;
329         struct sr_usb_dev_inst *usb;
330         char str[128];
331         const uint64_t *vdiv;
332         int ch_idx;
333
334         switch (key) {
335         case SR_CONF_NUM_VDIV:
336                 *data = g_variant_new_int32(ARRAY_SIZE(vdivs));
337                 break;
338         }
339
340         if (!sdi)
341                 return SR_ERR_ARG;
342
343         devc = sdi->priv;
344         if (!cg) {
345                 switch (key) {
346                 case SR_CONF_SAMPLERATE:
347                         *data = g_variant_new_uint64(devc->samplerate);
348                         break;
349                 case SR_CONF_LIMIT_MSEC:
350                         *data = g_variant_new_uint64(devc->limit_msec);
351                         break;
352                 case SR_CONF_LIMIT_SAMPLES:
353                         *data = g_variant_new_uint64(devc->limit_samples);
354                         break;
355                 case SR_CONF_CONN:
356                         if (!sdi->conn)
357                                 return SR_ERR_ARG;
358                         usb = sdi->conn;
359                         if (usb->address == 255)
360                                 /* Device still needs to re-enumerate after firmware
361                                  * upload, so we don't know its (future) address. */
362                                 return SR_ERR;
363                         snprintf(str, 128, "%d.%d", usb->bus, usb->address);
364                         *data = g_variant_new_string(str);
365                         break;
366                 default:
367                         return SR_ERR_NA;
368                 }
369         } else {
370                 if (sdi->channel_groups->data == cg)
371                         ch_idx = 0;
372                 else if (sdi->channel_groups->next->data == cg)
373                         ch_idx = 1;
374                 else
375                         return SR_ERR_ARG;
376                 switch (key) {
377                 case SR_CONF_VDIV:
378                         vdiv = vdivs[devc->voltage[ch_idx]];
379                         *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
380                         break;
381                 case SR_CONF_COUPLING:
382                         *data = g_variant_new_string(devc->coupling_vals[devc->coupling[ch_idx]]);
383                         break;
384                 }
385         }
386
387         return SR_OK;
388 }
389
390 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
391                 const struct sr_channel_group *cg)
392 {
393         struct dev_context *devc;
394         uint64_t p, q;
395         int tmp_int, ch_idx, ret;
396         unsigned int i;
397         const char *tmp_str;
398
399         if (sdi->status != SR_ST_ACTIVE)
400                 return SR_ERR_DEV_CLOSED;
401
402         ret = SR_OK;
403         devc = sdi->priv;
404         if (!cg) {
405                 switch (key) {
406                 case SR_CONF_SAMPLERATE:
407                         devc->samplerate = g_variant_get_uint64(data);
408                         hantek_6xxx_update_samplerate(sdi);
409                         break;
410                 case SR_CONF_LIMIT_MSEC:
411                         devc->limit_msec = g_variant_get_uint64(data);
412                         break;
413                 case SR_CONF_LIMIT_SAMPLES:
414                         devc->limit_samples = g_variant_get_uint64(data);
415                         break;
416                 default:
417                         ret = SR_ERR_NA;
418                         break;
419                 }
420         } else {
421                 if (sdi->channel_groups->data == cg)
422                         ch_idx = 0;
423                 else if (sdi->channel_groups->next->data == cg)
424                         ch_idx = 1;
425                 else
426                         return SR_ERR_ARG;
427                 switch (key) {
428                 case SR_CONF_VDIV:
429                         g_variant_get(data, "(tt)", &p, &q);
430                         tmp_int = -1;
431                         for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
432                                 if (vdivs[i][0] == p && vdivs[i][1] == q) {
433                                         tmp_int = i;
434                                         break;
435                                 }
436                         }
437                         if (tmp_int >= 0) {
438                                 devc->voltage[ch_idx] = tmp_int;
439                                 hantek_6xxx_update_vdiv(sdi);
440                         } else
441                                 ret = SR_ERR_ARG;
442                         break;
443                 case SR_CONF_COUPLING:
444                         tmp_str = g_variant_get_string(data, NULL);
445                         for (i = 0; i < devc->coupling_tab_size; i++) {
446                                 if (!strcmp(tmp_str, devc->coupling_vals[i])) {
447                                         devc->coupling[ch_idx] = i;
448                                         break;
449                                 }
450                         }
451                         if (i == devc->coupling_tab_size)
452                                 ret = SR_ERR_ARG;
453                         break;
454                 default:
455                         ret = SR_ERR_NA;
456                         break;
457                 }
458         }
459
460         return ret;
461 }
462
463 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
464                 const struct sr_channel_group *cg)
465 {
466         GVariant *tuple, *rational[2];
467         GVariantBuilder gvb;
468         unsigned int i;
469         GVariant *gvar;
470         struct dev_context *devc = NULL;
471
472         if (key == SR_CONF_SCAN_OPTIONS) {
473                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
474                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
475                 return SR_OK;
476         } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
477                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
478                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
479                 return SR_OK;
480         }
481
482         if (sdi)
483                 devc = sdi->priv;
484
485         if (!cg) {
486                 switch (key) {
487                 case SR_CONF_DEVICE_OPTIONS:
488                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
489                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
490                         break;
491                 case SR_CONF_SAMPLERATE:
492                         g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
493                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
494                                 samplerates, ARRAY_SIZE(samplerates),
495                                 sizeof(uint64_t));
496                         g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
497                         *data = g_variant_builder_end(&gvb);
498                         break;
499                 default:
500                         return SR_ERR_NA;
501                 }
502         } else {
503                 switch (key) {
504                 case SR_CONF_DEVICE_OPTIONS:
505                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
506                                 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
507                         break;
508                 case SR_CONF_COUPLING:
509                         if (!devc)
510                                 return SR_ERR_NA;
511                         *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
512                         break;
513                 case SR_CONF_VDIV:
514                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
515                         for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
516                                 rational[0] = g_variant_new_uint64(vdivs[i][0]);
517                                 rational[1] = g_variant_new_uint64(vdivs[i][1]);
518                                 tuple = g_variant_new_tuple(rational, 2);
519                                 g_variant_builder_add_value(&gvb, tuple);
520                         }
521                         *data = g_variant_builder_end(&gvb);
522                         break;
523                 default:
524                         return SR_ERR_NA;
525                 }
526         }
527
528         return SR_OK;
529 }
530
531 /* Minimise data amount for limit_samples and limit_msec limits. */
532 static uint32_t data_amount(const struct sr_dev_inst *sdi)
533 {
534         struct dev_context *devc = sdi->priv;
535         uint32_t data_left, data_left_2, i;
536         int32_t time_left;
537
538         if (devc->limit_msec) {
539                 time_left = devc->limit_msec - (g_get_monotonic_time() - devc->aq_started) / 1000;
540                 data_left = devc->samplerate * MAX(time_left, 0) * NUM_CHANNELS / 1000;
541         } else if (devc->limit_samples) {
542                 data_left = (devc->limit_samples - devc->samp_received) * NUM_CHANNELS;
543         } else {
544                 data_left = devc->samplerate * NUM_CHANNELS;
545         }
546
547         /* Round up to nearest power of two. */
548         for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
549                 ;
550         data_left_2 = i;
551
552         sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
553
554         return data_left_2;
555 }
556
557 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
558                 int num_samples)
559 {
560         struct sr_datafeed_packet packet;
561         struct sr_datafeed_analog analog;
562         struct sr_analog_encoding encoding;
563         struct sr_analog_meaning meaning;
564         struct sr_analog_spec spec;
565         struct dev_context *devc = sdi->priv;
566         GSList *channels = devc->enabled_channels;
567
568         const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
569         const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
570
571         sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
572
573         packet.type = SR_DF_ANALOG;
574         packet.payload = &analog;
575
576         analog.num_samples = num_samples;
577         analog.meaning->mq = SR_MQ_VOLTAGE;
578         analog.meaning->unit = SR_UNIT_VOLT;
579         analog.meaning->mqflags = 0;
580
581         analog.data = g_try_malloc(num_samples * sizeof(float));
582         if (!analog.data) {
583                 sr_err("Analog data buffer malloc failed.");
584                 devc->dev_state = STOPPING;
585                 return;
586         }
587
588         for (int ch = 0; ch < 2; ch++) {
589                 if (!devc->ch_enabled[ch])
590                         continue;
591
592                 float vdivlog = log10f(ch_bit[ch]);
593                 int digits = -(int)vdivlog + (vdivlog < 0.0);
594                 analog.encoding->digits = digits;
595                 analog.spec->spec_digits = digits;
596                 analog.meaning->channels = g_slist_append(NULL, channels->data);
597
598                 for (int i = 0; i < num_samples; i++) {
599                         /*
600                          * The device always sends data for both channels. If a channel
601                          * is disabled, it contains a copy of the enabled channel's
602                          * data. However, we only send the requested channels to
603                          * the bus.
604                          *
605                          * Voltage values are encoded as a value 0-255, where the
606                          * value is a point in the range represented by the vdiv
607                          * setting. There are 10 vertical divs, so e.g. 500mV/div
608                          * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
609                          */
610                         ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
611                 }
612
613                 sr_session_send(sdi, &packet);
614                 g_slist_free(analog.meaning->channels);
615
616                 channels = channels->next;
617         }
618         g_free(analog.data);
619 }
620
621 static void send_data(struct sr_dev_inst *sdi, struct libusb_transfer *buf[], uint64_t samples)
622 {
623         int i = 0;
624         uint64_t send = 0;
625         uint32_t chunk;
626
627         while (send < samples) {
628                 chunk = MIN(samples - send, (uint64_t)(buf[i]->actual_length / NUM_CHANNELS));
629                 send += chunk;
630                 send_chunk(sdi, buf[i]->buffer, chunk);
631
632                 /*
633                  * Everything in this transfer was either copied to the buffer
634                  * or sent to the session bus.
635                  */
636                 g_free(buf[i]->buffer);
637                 libusb_free_transfer(buf[i]);
638                 i++;
639         }
640 }
641
642 /*
643  * Called by libusb (as triggered by handle_event()) when a transfer comes in.
644  * Only channel data comes in asynchronously, and all transfers for this are
645  * queued up beforehand, so this just needs to chuck the incoming data onto
646  * the libsigrok session bus.
647  */
648 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
649 {
650         struct sr_dev_inst *sdi;
651         struct dev_context *devc;
652
653         sdi = transfer->user_data;
654         devc = sdi->priv;
655
656         if (devc->dev_state == FLUSH) {
657                 g_free(transfer->buffer);
658                 libusb_free_transfer(transfer);
659                 devc->dev_state = CAPTURE;
660                 devc->aq_started = g_get_monotonic_time();
661                 read_channel(sdi, data_amount(sdi));
662                 return;
663         }
664
665         if (devc->dev_state != CAPTURE)
666                 return;
667
668         if (!devc->sample_buf) {
669                 devc->sample_buf_size = 10;
670                 devc->sample_buf = g_try_malloc(devc->sample_buf_size * sizeof(transfer));
671                 devc->sample_buf_write = 0;
672         }
673
674         if (devc->sample_buf_write >= devc->sample_buf_size) {
675                 devc->sample_buf_size += 10;
676                 devc->sample_buf = g_try_realloc(devc->sample_buf,
677                                 devc->sample_buf_size * sizeof(transfer));
678                 if (!devc->sample_buf) {
679                         sr_err("Sample buffer malloc failed.");
680                         devc->dev_state = STOPPING;
681                         return;
682                 }
683         }
684
685         devc->sample_buf[devc->sample_buf_write++] = transfer;
686         devc->samp_received += transfer->actual_length / NUM_CHANNELS;
687
688         sr_spew("receive_transfer(): calculated samplerate == %" PRIu64 "ks/s",
689                 (uint64_t)(transfer->actual_length * 1000 /
690                 (g_get_monotonic_time() - devc->read_start_ts + 1) /
691                 NUM_CHANNELS));
692
693         sr_spew("receive_transfer(): status %s received %d bytes.",
694                 libusb_error_name(transfer->status), transfer->actual_length);
695
696         if (transfer->actual_length == 0)
697                 /* Nothing to send to the bus. */
698                 return;
699
700         if (devc->limit_samples && devc->samp_received >= devc->limit_samples) {
701                 sr_info("Requested number of samples reached, stopping. %"
702                         PRIu64 " <= %" PRIu64, devc->limit_samples,
703                         devc->samp_received);
704                 send_data(sdi, devc->sample_buf, devc->limit_samples);
705                 sdi->driver->dev_acquisition_stop(sdi);
706         } else if (devc->limit_msec && (g_get_monotonic_time() -
707                         devc->aq_started) / 1000 >= devc->limit_msec) {
708                 sr_info("Requested time limit reached, stopping. %d <= %d",
709                         (uint32_t)devc->limit_msec,
710                         (uint32_t)(g_get_monotonic_time() - devc->aq_started) / 1000);
711                 send_data(sdi, devc->sample_buf, devc->samp_received);
712                 g_free(devc->sample_buf);
713                 devc->sample_buf = NULL;
714                 sdi->driver->dev_acquisition_stop(sdi);
715         } else {
716                 read_channel(sdi, data_amount(sdi));
717         }
718 }
719
720 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount)
721 {
722         int ret;
723         struct dev_context *devc;
724
725         devc = sdi->priv;
726
727         amount = MIN(amount, MAX_PACKET_SIZE);
728         ret = hantek_6xxx_get_channeldata(sdi, receive_transfer, amount);
729         devc->read_start_ts = g_get_monotonic_time();
730         devc->read_data_amount = amount;
731
732         return ret;
733 }
734
735 static int handle_event(int fd, int revents, void *cb_data)
736 {
737         const struct sr_dev_inst *sdi;
738         struct timeval tv;
739         struct sr_dev_driver *di;
740         struct dev_context *devc;
741         struct drv_context *drvc;
742
743         (void)fd;
744         (void)revents;
745
746         sdi = cb_data;
747         di = sdi->driver;
748         drvc = di->context;
749         devc = sdi->priv;
750
751         /* Always handle pending libusb events. */
752         tv.tv_sec = tv.tv_usec = 0;
753         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
754
755         if (devc->dev_state == STOPPING) {
756                 /* We've been told to wind up the acquisition. */
757                 sr_dbg("Stopping acquisition.");
758
759                 hantek_6xxx_stop_data_collecting(sdi);
760                 /*
761                  * TODO: Doesn't really cancel pending transfers so they might
762                  * come in after SR_DF_END is sent.
763                  */
764                 usb_source_remove(sdi->session, drvc->sr_ctx);
765
766                 std_session_send_df_end(sdi);
767
768                 devc->dev_state = IDLE;
769
770                 return TRUE;
771         }
772
773         return TRUE;
774 }
775
776 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
777 {
778         struct dev_context *devc;
779         struct sr_dev_driver *di = sdi->driver;
780         struct drv_context *drvc = di->context;
781
782         if (sdi->status != SR_ST_ACTIVE)
783                 return SR_ERR_DEV_CLOSED;
784
785         devc = sdi->priv;
786
787         if (configure_channels(sdi) != SR_OK) {
788                 sr_err("Failed to configure channels.");
789                 return SR_ERR;
790         }
791
792         if (hantek_6xxx_init(sdi) != SR_OK)
793                 return SR_ERR;
794
795         std_session_send_df_header(sdi);
796
797         devc->samp_received = 0;
798         devc->dev_state = FLUSH;
799
800         usb_source_add(sdi->session, drvc->sr_ctx, TICK,
801                        handle_event, (void *)sdi);
802
803         hantek_6xxx_start_data_collecting(sdi);
804
805         read_channel(sdi, FLUSH_PACKET_SIZE);
806
807         return SR_OK;
808 }
809
810 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
811 {
812         struct dev_context *devc;
813
814         if (sdi->status != SR_ST_ACTIVE)
815                 return SR_ERR;
816
817         devc = sdi->priv;
818         devc->dev_state = STOPPING;
819
820         g_free(devc->sample_buf); devc->sample_buf = NULL;
821
822         return SR_OK;
823 }
824
825 static struct sr_dev_driver hantek_6xxx_driver_info = {
826         .name = "hantek-6xxx",
827         .longname = "Hantek 6xxx",
828         .api_version = 1,
829         .init = std_init,
830         .cleanup = std_cleanup,
831         .scan = scan,
832         .dev_list = std_dev_list,
833         .dev_clear = dev_clear,
834         .config_get = config_get,
835         .config_set = config_set,
836         .config_list = config_list,
837         .dev_open = dev_open,
838         .dev_close = dev_close,
839         .dev_acquisition_start = dev_acquisition_start,
840         .dev_acquisition_stop = dev_acquisition_stop,
841         .context = NULL,
842 };
843 SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);