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