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