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