]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/hantek-dso/api.c
drivers: Shorten some unnecessarily long arrays.
[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, const struct sr_dev_inst *sdi,
396 const struct sr_channel_group *cg)
397{
398 struct dev_context *devc;
399 struct sr_usb_dev_inst *usb;
400 char str[128];
401 const char *s;
402 const uint64_t *vdiv;
403 int ch_idx;
404
405 switch (key) {
406 case SR_CONF_NUM_HDIV:
407 *data = g_variant_new_int32(NUM_TIMEBASE);
408 break;
409 case SR_CONF_NUM_VDIV:
410 *data = g_variant_new_int32(NUM_VDIV);
411 break;
412 }
413
414 if (!sdi)
415 return SR_ERR_ARG;
416
417 devc = sdi->priv;
418 if (!cg) {
419 switch (key) {
420 case SR_CONF_CONN:
421 if (!sdi->conn)
422 return SR_ERR_ARG;
423 usb = sdi->conn;
424 if (usb->address == 255)
425 /* Device still needs to re-enumerate after firmware
426 * upload, so we don't know its (future) address. */
427 return SR_ERR;
428 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
429 *data = g_variant_new_string(str);
430 break;
431 case SR_CONF_TIMEBASE:
432 *data = g_variant_new("(tt)", timebases[devc->timebase][0],
433 timebases[devc->timebase][1]);
434 break;
435 case SR_CONF_BUFFERSIZE:
436 *data = g_variant_new_uint64(devc->framesize);
437 break;
438 case SR_CONF_TRIGGER_SOURCE:
439 *data = g_variant_new_string(devc->triggersource);
440 break;
441 case SR_CONF_TRIGGER_SLOPE:
442 s = (devc->triggerslope == SLOPE_POSITIVE) ? "r" : "f";
443 *data = g_variant_new_string(s);
444 break;
445 case SR_CONF_HORIZ_TRIGGERPOS:
446 *data = g_variant_new_double(devc->triggerposition);
447 break;
448 default:
449 return SR_ERR_NA;
450 }
451 } else {
452 if (sdi->channel_groups->data == cg)
453 ch_idx = 0;
454 else if (sdi->channel_groups->next->data == cg)
455 ch_idx = 1;
456 else
457 return SR_ERR_ARG;
458 switch (key) {
459 case SR_CONF_FILTER:
460 *data = g_variant_new_boolean(devc->filter[ch_idx]);
461 break;
462 case SR_CONF_VDIV:
463 vdiv = vdivs[devc->voltage[ch_idx]];
464 *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
465 break;
466 case SR_CONF_COUPLING:
467 *data = g_variant_new_string(coupling[devc->coupling[ch_idx]]);
468 break;
469 }
470 }
471
472 return SR_OK;
473}
474
475static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
476 const struct sr_channel_group *cg)
477{
478 struct dev_context *devc;
479 double tmp_double;
480 uint64_t tmp_u64, p, q;
481 int tmp_int, ch_idx;
482 unsigned int i;
483 const char *tmp_str;
484
485 devc = sdi->priv;
486 if (!cg) {
487 switch (key) {
488 case SR_CONF_LIMIT_FRAMES:
489 devc->limit_frames = g_variant_get_uint64(data);
490 break;
491 case SR_CONF_TRIGGER_SLOPE:
492 tmp_str = g_variant_get_string(data, NULL);
493 if (!tmp_str || !(tmp_str[0] == 'f' || tmp_str[0] == 'r'))
494 return SR_ERR_ARG;
495 devc->triggerslope = (tmp_str[0] == 'r')
496 ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
497 break;
498 case SR_CONF_HORIZ_TRIGGERPOS:
499 tmp_double = g_variant_get_double(data);
500 if (tmp_double < 0.0 || tmp_double > 1.0) {
501 sr_err("Trigger position should be between 0.0 and 1.0.");
502 return SR_ERR_ARG;
503 } else
504 devc->triggerposition = tmp_double;
505 break;
506 case SR_CONF_BUFFERSIZE:
507 tmp_u64 = g_variant_get_uint64(data);
508 for (i = 0; i < NUM_BUFFER_SIZES; i++) {
509 if (devc->profile->buffersizes[i] == tmp_u64) {
510 devc->framesize = tmp_u64;
511 break;
512 }
513 }
514 if (i == NUM_BUFFER_SIZES)
515 return SR_ERR_ARG;
516 break;
517 case SR_CONF_TIMEBASE:
518 g_variant_get(data, "(tt)", &p, &q);
519 tmp_int = -1;
520 for (i = 0; i < ARRAY_SIZE(timebases); i++) {
521 if (timebases[i][0] == p && timebases[i][1] == q) {
522 tmp_int = i;
523 break;
524 }
525 }
526 if (tmp_int >= 0)
527 devc->timebase = tmp_int;
528 else
529 return SR_ERR_ARG;
530 break;
531 case SR_CONF_TRIGGER_SOURCE:
532 tmp_str = g_variant_get_string(data, NULL);
533 for (i = 0; trigger_sources[i]; i++) {
534 if (!strcmp(tmp_str, trigger_sources[i])) {
535 devc->triggersource = g_strdup(tmp_str);
536 break;
537 }
538 }
539 if (trigger_sources[i] == 0)
540 return SR_ERR_ARG;
541 break;
542 default:
543 return SR_ERR_NA;
544 }
545 } else {
546 if (sdi->channel_groups->data == cg)
547 ch_idx = 0;
548 else if (sdi->channel_groups->next->data == cg)
549 ch_idx = 1;
550 else
551 return SR_ERR_ARG;
552 switch (key) {
553 case SR_CONF_FILTER:
554 devc->filter[ch_idx] = g_variant_get_boolean(data);
555 break;
556 case SR_CONF_VDIV:
557 g_variant_get(data, "(tt)", &p, &q);
558 tmp_int = -1;
559 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
560 if (vdivs[i][0] == p && vdivs[i][1] == q) {
561 tmp_int = i;
562 break;
563 }
564 }
565 if (tmp_int >= 0) {
566 devc->voltage[ch_idx] = tmp_int;
567 } else
568 return SR_ERR_ARG;
569 break;
570 case SR_CONF_COUPLING:
571 tmp_str = g_variant_get_string(data, NULL);
572 for (i = 0; coupling[i]; i++) {
573 if (!strcmp(tmp_str, coupling[i])) {
574 devc->coupling[ch_idx] = i;
575 break;
576 }
577 }
578 if (coupling[i] == 0)
579 return SR_ERR_ARG;
580 break;
581 default:
582 return SR_ERR_NA;
583 }
584 }
585
586 return SR_OK;
587}
588
589static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
590 const struct sr_channel_group *cg)
591{
592 struct dev_context *devc;
593
594 if (!cg) {
595 switch (key) {
596 case SR_CONF_SCAN_OPTIONS:
597 case SR_CONF_DEVICE_OPTIONS:
598 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
599 case SR_CONF_BUFFERSIZE:
600 if (!sdi)
601 return SR_ERR_ARG;
602 devc = sdi->priv;
603 *data = std_gvar_array_u64(devc->profile->buffersizes, NUM_BUFFER_SIZES);
604 break;
605 case SR_CONF_TIMEBASE:
606 *data = std_gvar_tuple_array(&timebases, ARRAY_SIZE(timebases));
607 break;
608 case SR_CONF_TRIGGER_SOURCE:
609 *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_sources));
610 break;
611 case SR_CONF_TRIGGER_SLOPE:
612 *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_slopes));
613 break;
614 default:
615 return SR_ERR_NA;
616 }
617 } else {
618 switch (key) {
619 case SR_CONF_DEVICE_OPTIONS:
620 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
621 break;
622 case SR_CONF_COUPLING:
623 *data = g_variant_new_strv(ARRAY_AND_SIZE(coupling));
624 break;
625 case SR_CONF_VDIV:
626 *data = std_gvar_tuple_array(&vdivs, ARRAY_SIZE(vdivs));
627 break;
628 default:
629 return SR_ERR_NA;
630 }
631 }
632
633 return SR_OK;
634}
635
636static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
637 int num_samples)
638{
639 struct sr_datafeed_packet packet;
640 struct sr_datafeed_analog analog;
641 struct sr_analog_encoding encoding;
642 struct sr_analog_meaning meaning;
643 struct sr_analog_spec spec;
644 struct dev_context *devc = sdi->priv;
645 GSList *channels = devc->enabled_channels;
646
647 packet.type = SR_DF_ANALOG;
648 packet.payload = &analog;
649 /* TODO: support for 5xxx series 9-bit samples */
650 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
651 analog.num_samples = num_samples;
652 analog.meaning->mq = SR_MQ_VOLTAGE;
653 analog.meaning->unit = SR_UNIT_VOLT;
654 analog.meaning->mqflags = 0;
655 /* TODO: Check malloc return value. */
656 analog.data = g_try_malloc(num_samples * sizeof(float));
657
658 for (int ch = 0; ch < 2; ch++) {
659 if (!devc->ch_enabled[ch])
660 continue;
661
662 float range = ((float)vdivs[devc->voltage[ch]][0] / vdivs[devc->voltage[ch]][1]) * 8;
663 float vdivlog = log10f(range / 255);
664 int digits = -(int)vdivlog + (vdivlog < 0.0);
665 analog.encoding->digits = digits;
666 analog.spec->spec_digits = digits;
667 analog.meaning->channels = g_slist_append(NULL, channels->data);
668
669 for (int i = 0; i < num_samples; i++) {
670 /*
671 * The device always sends data for both channels. If a channel
672 * is disabled, it contains a copy of the enabled channel's
673 * data. However, we only send the requested channels to
674 * the bus.
675 *
676 * Voltage values are encoded as a value 0-255 (0-512 on the
677 * DSO-5200*), where the value is a point in the range
678 * represented by the vdiv setting. There are 8 vertical divs,
679 * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V
680 * and 255 = +2V.
681 */
682 /* TODO: Support for DSO-5xxx series 9-bit samples. */
683 ((float *)analog.data)[i] = range / 255 * *(buf + i * 2 + 1 - ch) - range / 2;
684 }
685 sr_session_send(sdi, &packet);
686 g_slist_free(analog.meaning->channels);
687
688 channels = channels->next;
689 }
690 g_free(analog.data);
691}
692
693/*
694 * Called by libusb (as triggered by handle_event()) when a transfer comes in.
695 * Only channel data comes in asynchronously, and all transfers for this are
696 * queued up beforehand, so this just needs to chuck the incoming data onto
697 * the libsigrok session bus.
698 */
699static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
700{
701 struct sr_datafeed_packet packet;
702 struct sr_dev_inst *sdi;
703 struct dev_context *devc;
704 int num_samples, pre;
705
706 sdi = transfer->user_data;
707 devc = sdi->priv;
708 sr_spew("receive_transfer(): status %s received %d bytes.",
709 libusb_error_name(transfer->status), transfer->actual_length);
710
711 if (transfer->actual_length == 0)
712 /* Nothing to send to the bus. */
713 return;
714
715 num_samples = transfer->actual_length / 2;
716
717 sr_spew("Got %d-%d/%d samples in frame.", devc->samp_received + 1,
718 devc->samp_received + num_samples, devc->framesize);
719
720 /*
721 * The device always sends a full frame, but the beginning of the frame
722 * doesn't represent the trigger point. The offset at which the trigger
723 * happened came in with the capture state, so we need to start sending
724 * from there up the session bus. The samples in the frame buffer
725 * before that trigger point came after the end of the device's frame
726 * buffer was reached, and it wrapped around to overwrite up until the
727 * trigger point.
728 */
729 if (devc->samp_received < devc->trigger_offset) {
730 /* Trigger point not yet reached. */
731 if (devc->samp_received + num_samples < devc->trigger_offset) {
732 /* The entire chunk is before the trigger point. */
733 memcpy(devc->framebuf + devc->samp_buffered * 2,
734 transfer->buffer, num_samples * 2);
735 devc->samp_buffered += num_samples;
736 } else {
737 /*
738 * This chunk hits or overruns the trigger point.
739 * Store the part before the trigger fired, and
740 * send the rest up to the session bus.
741 */
742 pre = devc->trigger_offset - devc->samp_received;
743 memcpy(devc->framebuf + devc->samp_buffered * 2,
744 transfer->buffer, pre * 2);
745 devc->samp_buffered += pre;
746
747 /* The rest of this chunk starts with the trigger point. */
748 sr_dbg("Reached trigger point, %d samples buffered.",
749 devc->samp_buffered);
750
751 /* Avoid the corner case where the chunk ended at
752 * exactly the trigger point. */
753 if (num_samples > pre)
754 send_chunk(sdi, transfer->buffer + pre * 2,
755 num_samples - pre);
756 }
757 } else {
758 /* Already past the trigger point, just send it all out. */
759 send_chunk(sdi, transfer->buffer, num_samples);
760 }
761
762 devc->samp_received += num_samples;
763
764 /* Everything in this transfer was either copied to the buffer or
765 * sent to the session bus. */
766 g_free(transfer->buffer);
767 libusb_free_transfer(transfer);
768
769 if (devc->samp_received >= devc->framesize) {
770 /* That was the last chunk in this frame. Send the buffered
771 * pre-trigger samples out now, in one big chunk. */
772 sr_dbg("End of frame, sending %d pre-trigger buffered samples.",
773 devc->samp_buffered);
774 send_chunk(sdi, devc->framebuf, devc->samp_buffered);
775
776 /* Mark the end of this frame. */
777 packet.type = SR_DF_FRAME_END;
778 sr_session_send(sdi, &packet);
779
780 if (devc->limit_frames && ++devc->num_frames == devc->limit_frames) {
781 /* Terminate session */
782 devc->dev_state = STOPPING;
783 } else {
784 devc->dev_state = NEW_CAPTURE;
785 }
786 }
787}
788
789static int handle_event(int fd, int revents, void *cb_data)
790{
791 const struct sr_dev_inst *sdi;
792 struct sr_datafeed_packet packet;
793 struct timeval tv;
794 struct sr_dev_driver *di;
795 struct dev_context *devc;
796 struct drv_context *drvc;
797 int num_channels;
798 uint32_t trigger_offset;
799 uint8_t capturestate;
800
801 (void)fd;
802 (void)revents;
803
804 sdi = cb_data;
805 di = sdi->driver;
806 drvc = di->context;
807 devc = sdi->priv;
808 if (devc->dev_state == STOPPING) {
809 /* We've been told to wind up the acquisition. */
810 sr_dbg("Stopping acquisition.");
811 /*
812 * TODO: Doesn't really cancel pending transfers so they might
813 * come in after SR_DF_END is sent.
814 */
815 usb_source_remove(sdi->session, drvc->sr_ctx);
816
817 std_session_send_df_end(sdi);
818
819 devc->dev_state = IDLE;
820
821 return TRUE;
822 }
823
824 /* Always handle pending libusb events. */
825 tv.tv_sec = tv.tv_usec = 0;
826 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
827
828 /* TODO: ugh */
829 if (devc->dev_state == NEW_CAPTURE) {
830 if (dso_capture_start(sdi) != SR_OK)
831 return TRUE;
832 if (dso_enable_trigger(sdi) != SR_OK)
833 return TRUE;
834// if (dso_force_trigger(sdi) != SR_OK)
835// return TRUE;
836 sr_dbg("Successfully requested next chunk.");
837 devc->dev_state = CAPTURE;
838 return TRUE;
839 }
840 if (devc->dev_state != CAPTURE)
841 return TRUE;
842
843 if ((dso_get_capturestate(sdi, &capturestate, &trigger_offset)) != SR_OK)
844 return TRUE;
845
846 sr_dbg("Capturestate %d.", capturestate);
847 sr_dbg("Trigger offset 0x%.6x.", trigger_offset);
848 switch (capturestate) {
849 case CAPTURE_EMPTY:
850 if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) {
851 devc->capture_empty_count = 0;
852 if (dso_capture_start(sdi) != SR_OK)
853 break;
854 if (dso_enable_trigger(sdi) != SR_OK)
855 break;
856// if (dso_force_trigger(sdi) != SR_OK)
857// break;
858 sr_dbg("Successfully requested next chunk.");
859 }
860 break;
861 case CAPTURE_FILLING:
862 /* No data yet. */
863 break;
864 case CAPTURE_READY_8BIT:
865 /* Remember where in the captured frame the trigger is. */
866 devc->trigger_offset = trigger_offset;
867
868 num_channels = (devc->ch_enabled[0] && devc->ch_enabled[1]) ? 2 : 1;
869 devc->framebuf = g_malloc(devc->framesize * num_channels * 2);
870 devc->samp_buffered = devc->samp_received = 0;
871
872 /* Tell the scope to send us the first frame. */
873 if (dso_get_channeldata(sdi, receive_transfer) != SR_OK)
874 break;
875
876 /*
877 * Don't hit the state machine again until we're done fetching
878 * the data we just told the scope to send.
879 */
880 devc->dev_state = FETCH_DATA;
881
882 /* Tell the frontend a new frame is on the way. */
883 packet.type = SR_DF_FRAME_BEGIN;
884 sr_session_send(sdi, &packet);
885 break;
886 case CAPTURE_READY_9BIT:
887 /* TODO */
888 sr_err("Not yet supported.");
889 break;
890 case CAPTURE_TIMEOUT:
891 /* Doesn't matter, we'll try again next time. */
892 break;
893 default:
894 sr_dbg("Unknown capture state: %d.", capturestate);
895 break;
896 }
897
898 return TRUE;
899}
900
901static int dev_acquisition_start(const struct sr_dev_inst *sdi)
902{
903 struct dev_context *devc;
904 struct sr_dev_driver *di = sdi->driver;
905 struct drv_context *drvc = di->context;
906
907 devc = sdi->priv;
908
909 if (configure_channels(sdi) != SR_OK) {
910 sr_err("Failed to configure channels.");
911 return SR_ERR;
912 }
913
914 if (dso_init(sdi) != SR_OK)
915 return SR_ERR;
916
917 if (dso_capture_start(sdi) != SR_OK)
918 return SR_ERR;
919
920 devc->dev_state = CAPTURE;
921 usb_source_add(sdi->session, drvc->sr_ctx, TICK, handle_event, (void *)sdi);
922
923 std_session_send_df_header(sdi);
924
925 return SR_OK;
926}
927
928static int dev_acquisition_stop(struct sr_dev_inst *sdi)
929{
930 struct dev_context *devc;
931
932 devc = sdi->priv;
933 devc->dev_state = STOPPING;
934
935 return SR_OK;
936}
937
938static struct sr_dev_driver hantek_dso_driver_info = {
939 .name = "hantek-dso",
940 .longname = "Hantek DSO",
941 .api_version = 1,
942 .init = std_init,
943 .cleanup = std_cleanup,
944 .scan = scan,
945 .dev_list = std_dev_list,
946 .dev_clear = dev_clear,
947 .config_get = config_get,
948 .config_set = config_set,
949 .config_list = config_list,
950 .dev_open = dev_open,
951 .dev_close = dev_close,
952 .dev_acquisition_start = dev_acquisition_start,
953 .dev_acquisition_stop = dev_acquisition_stop,
954 .context = NULL,
955};
956SR_REGISTER_DEV_DRIVER(hantek_dso_driver_info);