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