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