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