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