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