]> sigrok.org Git - libsigrok.git/blame - hardware/link-mso19/api.c
rigol-ds: close SCPI device after using for scan.
[libsigrok.git] / hardware / link-mso19 / api.c
CommitLineData
df92e5cf 1/*
50985c20 2 * This file is part of the libsigrok project.
df92e5cf 3 *
f48cef78
UH
4 * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
5 * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
6 * Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
df92e5cf 7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#include "protocol.h"
23
a9ed6877 24static const int32_t hwcaps[] = {
365f04d6 25 SR_CONF_OSCILLOSCOPE,
1953564a
BV
26 SR_CONF_LOGIC_ANALYZER,
27 SR_CONF_SAMPLERATE,
28 SR_CONF_TRIGGER_SLOPE,
29 SR_CONF_HORIZ_TRIGGERPOS,
30// SR_CONF_CAPTURE_RATIO,
31 SR_CONF_LIMIT_SAMPLES,
32// SR_CONF_RLE,
df92e5cf 33};
34
35/*
36 * Probes are numbered 0 to 7.
37 *
38 * See also: http://www.linkinstruments.com/images/mso19_1113.gif
39 */
40SR_PRIV const char *mso19_probe_names[NUM_PROBES + 1] = {
365f04d6 41 /* Note: DSO needs to be first. */
42 "DSO", "0", "1", "2", "3", "4", "5", "6", "7", NULL,
df92e5cf 43};
44
a9ed6877
BV
45static const uint64_t samplerates[] = {
46 SR_HZ(100),
47 SR_MHZ(200),
48 SR_HZ(100),
df92e5cf 49};
50
51SR_PRIV struct sr_dev_driver link_mso19_driver_info;
52static struct sr_dev_driver *di = &link_mso19_driver_info;
53
eea49cf1
UH
54static int dev_close(struct sr_dev_inst *sdi);
55
56/* TODO: Use sr_dev_inst to store connection handle & use std_dev_clear(). */
57static int dev_clear(void)
58{
59 GSList *l;
60 struct sr_dev_inst *sdi;
61 struct drv_context *drvc;
62 struct dev_context *devc;
63 int ret = SR_OK;
64
65 if (!(drvc = di->priv))
66 return SR_OK;
67
68 /* Properly close and free all devices. */
69 for (l = drvc->instances; l; l = l->next) {
70 if (!(sdi = l->data)) {
71 /* Log error, but continue cleaning up the rest. */
72 sr_err("%s: sdi was NULL, continuing", __func__);
73 ret = SR_ERR_BUG;
74 continue;
75 }
76 if (!(devc = sdi->priv)) {
77 /* Log error, but continue cleaning up the rest. */
78 sr_err("%s: sdi->priv was NULL, continuing", __func__);
79 ret = SR_ERR_BUG;
80 continue;
81 }
82 dev_close(sdi);
83 sr_serial_dev_inst_free(devc->serial);
84 sr_dev_inst_free(sdi);
85 }
86 g_slist_free(drvc->instances);
87 drvc->instances = NULL;
88
89 return ret;
90}
91
6078d2c9 92static int init(struct sr_context *sr_ctx)
df92e5cf 93{
f6beaac5 94 return std_init(sr_ctx, di, LOG_PREFIX);
df92e5cf 95}
96
6078d2c9 97static GSList *scan(GSList *options)
df92e5cf 98{
00b44ccb
UH
99 int i;
100 GSList *devices = NULL;
101 const char *conn = NULL;
102 const char *serialcomm = NULL;
103 GSList *l;
1987b8d6 104 struct sr_config *src;
00b44ccb 105 struct udev *udev;
365f04d6 106 int ptype;
df92e5cf 107
df92e5cf 108 for (l = options; l; l = l->next) {
1987b8d6
BV
109 src = l->data;
110 switch (src->key) {
1953564a 111 case SR_CONF_CONN:
a9ed6877 112 conn = g_variant_get_string(src->data, NULL);
df92e5cf 113 break;
1953564a 114 case SR_CONF_SERIALCOMM:
06c45a66 115 serialcomm = g_variant_get_string(src->data, NULL);
df92e5cf 116 break;
117 }
118 }
119 if (!conn)
00b44ccb 120 conn = SERIALCONN;
df92e5cf 121 if (serialcomm == NULL)
122 serialcomm = SERIALCOMM;
123
00b44ccb 124 udev = udev_new();
df92e5cf 125 if (!udev) {
126 sr_err("Failed to initialize udev.");
127 }
00b44ccb 128
df92e5cf 129 struct udev_enumerate *enumerate = udev_enumerate_new(udev);
130 udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
131 udev_enumerate_scan_devices(enumerate);
132 struct udev_list_entry *devs = udev_enumerate_get_list_entry(enumerate);
133 struct udev_list_entry *dev_list_entry;
00b44ccb
UH
134 for (dev_list_entry = devs;
135 dev_list_entry != NULL;
136 dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
df92e5cf 137 const char *syspath = udev_list_entry_get_name(dev_list_entry);
00b44ccb
UH
138 struct udev_device *dev =
139 udev_device_new_from_syspath(udev, syspath);
df92e5cf 140 const char *sysname = udev_device_get_sysname(dev);
00b44ccb
UH
141 struct udev_device *parent =
142 udev_device_get_parent_with_subsystem_devtype(dev, "usb",
143 "usb_device");
df92e5cf 144
145 if (!parent) {
146 sr_err("Unable to find parent usb device for %s",
147 sysname);
148 continue;
149 }
150
00b44ccb
UH
151 const char *idVendor =
152 udev_device_get_sysattr_value(parent, "idVendor");
153 const char *idProduct =
154 udev_device_get_sysattr_value(parent, "idProduct");
df92e5cf 155 if (strcmp(USB_VENDOR, idVendor)
00b44ccb 156 || strcmp(USB_PRODUCT, idProduct))
df92e5cf 157 continue;
158
00b44ccb
UH
159 const char *iSerial =
160 udev_device_get_sysattr_value(parent, "serial");
161 const char *iProduct =
162 udev_device_get_sysattr_value(parent, "product");
df92e5cf 163
00b44ccb 164 char path[32];
df92e5cf 165 snprintf(path, sizeof(path), "/dev/%s", sysname);
00b44ccb 166 conn = path;
df92e5cf 167
168 size_t s = strcspn(iProduct, " ");
00b44ccb
UH
169 char product[32];
170 char manufacturer[32];
df92e5cf 171 if (s > sizeof(product) ||
00b44ccb
UH
172 strlen(iProduct) - s > sizeof(manufacturer)) {
173 sr_err("Could not parse iProduct: %s.", iProduct);
df92e5cf 174 continue;
175 }
176 strncpy(product, iProduct, s);
177 product[s] = 0;
4db2aaff 178 strcpy(manufacturer, iProduct + s + 1);
00b44ccb
UH
179
180 //Create the device context and set its params
181 struct dev_context *devc;
182 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
183 sr_err("Device context malloc failed.");
184 return devices;
185 }
186
187 if (mso_parse_serial(iSerial, iProduct, devc) != SR_OK) {
188 sr_err("Invalid iSerial: %s.", iSerial);
189 g_free(devc);
190 return devices;
191 }
192
193 char hwrev[32];
194 sprintf(hwrev, "r%d", devc->hwrev);
195 devc->ctlbase1 = 0;
196 devc->protocol_trigger.spimode = 0;
197 for (i = 0; i < 4; i++) {
198 devc->protocol_trigger.word[i] = 0;
199 devc->protocol_trigger.mask[i] = 0xff;
200 }
201
202 if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm))) {
203 g_free(devc);
204 return devices;
205 }
206
207 struct sr_dev_inst *sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
208 manufacturer, product, hwrev);
209
210 if (!sdi) {
211 sr_err("Unable to create device instance for %s",
212 sysname);
213 sr_dev_inst_free(sdi);
214 g_free(devc);
215 return devices;
216 }
217
218 sdi->driver = di;
219 sdi->priv = devc;
220
221 for (i = 0; i < NUM_PROBES; i++) {
222 struct sr_probe *probe;
365f04d6 223 ptype = (i == 0) ? SR_PROBE_ANALOG : SR_PROBE_LOGIC;
224 if (!(probe = sr_probe_new(i, ptype, TRUE,
00b44ccb
UH
225 mso19_probe_names[i])))
226 return 0;
227 sdi->probes = g_slist_append(sdi->probes, probe);
228 }
229
230 //Add the driver
231 struct drv_context *drvc = di->priv;
232 drvc->instances = g_slist_append(drvc->instances, sdi);
233 devices = g_slist_append(devices, sdi);
234 }
5a24e89c 235
df92e5cf 236 return devices;
237}
238
6078d2c9 239static GSList *dev_list(void)
df92e5cf 240{
0e94d524 241 return ((struct drv_context *)(di->priv))->instances;
df92e5cf 242}
243
6078d2c9 244static int dev_open(struct sr_dev_inst *sdi)
df92e5cf 245{
00b44ccb 246 int ret;
df92e5cf 247 struct dev_context *devc;
248
249 devc = sdi->priv;
250
251 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
252 return SR_ERR;
253
254 sdi->status = SR_ST_ACTIVE;
255
256 /* FIXME: discard serial buffer */
257 mso_check_trigger(devc->serial, &devc->trigger_state);
258 sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
259
00b44ccb 260 ret = mso_reset_adc(sdi);
df92e5cf 261 if (ret != SR_OK)
262 return ret;
263
264 mso_check_trigger(devc->serial, &devc->trigger_state);
265 sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
266
00b44ccb
UH
267 // ret = mso_reset_fsm(sdi);
268 // if (ret != SR_OK)
269 // return ret;
270 // return SR_ERR;
df92e5cf 271
272 return SR_OK;
273}
274
6078d2c9 275static int dev_close(struct sr_dev_inst *sdi)
df92e5cf 276{
df92e5cf 277 struct dev_context *devc;
278
279 devc = sdi->priv;
280
281 if (devc->serial && devc->serial->fd != -1) {
282 serial_close(devc->serial);
283 sdi->status = SR_ST_INACTIVE;
284 }
285
286 return SR_OK;
287}
288
6078d2c9 289static int cleanup(void)
df92e5cf 290{
eea49cf1 291 return dev_clear();
df92e5cf 292}
293
8f996b89
ML
294static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
295 const struct sr_probe_group *probe_group)
df92e5cf 296{
297 struct dev_context *devc;
298
8f996b89
ML
299 (void)probe_group;
300
035a1078 301 switch (id) {
123e1313 302 case SR_CONF_SAMPLERATE:
df92e5cf 303 if (sdi) {
304 devc = sdi->priv;
a9ed6877 305 *data = g_variant_new_uint64(devc->cur_rate);
df92e5cf 306 } else
307 return SR_ERR;
308 break;
309 default:
bd6fbf62 310 return SR_ERR_NA;
df92e5cf 311 }
312
313 return SR_OK;
314}
315
8f996b89
ML
316static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
317 const struct sr_probe_group *probe_group)
df92e5cf 318{
df92e5cf 319 int ret;
087a9161 320 struct dev_context *devc;
00b44ccb
UH
321 uint64_t num_samples, slope;
322 int trigger_pos;
a9ed6877 323 double pos;
00b44ccb 324
8f996b89 325 (void)probe_group;
00b44ccb 326 devc = sdi->priv;
087a9161 327
df92e5cf 328 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 329 return SR_ERR_DEV_CLOSED;
df92e5cf 330
035a1078 331 switch (id) {
1953564a 332 case SR_CONF_SAMPLERATE:
00b44ccb 333 // FIXME
a9ed6877 334 return mso_configure_rate(sdi, g_variant_get_uint64(data));
df92e5cf 335 ret = SR_OK;
336 break;
1953564a 337 case SR_CONF_LIMIT_SAMPLES:
a9ed6877 338 num_samples = g_variant_get_uint64(data);
5952553f 339 if (num_samples != 1024) {
340 sr_err("Only 1024 samples are supported.");
00b44ccb
UH
341 ret = SR_ERR_ARG;
342 } else {
343 devc->limit_samples = num_samples;
344 sr_dbg("setting limit_samples to %i\n",
345 num_samples);
346 ret = SR_OK;
347 }
df92e5cf 348 break;
1953564a 349 case SR_CONF_CAPTURE_RATIO:
00b44ccb
UH
350 ret = SR_OK;
351 break;
1953564a 352 case SR_CONF_TRIGGER_SLOPE:
a9ed6877 353 slope = g_variant_get_uint64(data);
00b44ccb
UH
354 if (slope != SLOPE_NEGATIVE && slope != SLOPE_POSITIVE) {
355 sr_err("Invalid trigger slope");
356 ret = SR_ERR_ARG;
357 } else {
358 devc->trigger_slope = slope;
359 ret = SR_OK;
360 }
361 break;
1953564a 362 case SR_CONF_HORIZ_TRIGGERPOS:
a9ed6877 363 pos = g_variant_get_double(data);
00b44ccb
UH
364 if (pos < 0 || pos > 255) {
365 sr_err("Trigger position (%f) should be between 0 and 255.", pos);
366 ret = SR_ERR_ARG;
367 } else {
368 trigger_pos = (int)pos;
369 devc->trigger_holdoff[0] = trigger_pos & 0xff;
370 ret = SR_OK;
371 }
df92e5cf 372 break;
1953564a 373 case SR_CONF_RLE:
00b44ccb 374 ret = SR_OK;
df92e5cf 375 break;
376 default:
bd6fbf62 377 ret = SR_ERR_NA;
00b44ccb 378 break;
df92e5cf 379 }
380
381 return ret;
382}
383
8f996b89
ML
384static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
385 const struct sr_probe_group *probe_group)
a1c743fc 386{
a9ed6877
BV
387 GVariant *gvar;
388 GVariantBuilder gvb;
a1c743fc 389
8f996b89 390 (void)probe_group;
a1c743fc
BV
391 (void)sdi;
392
393 switch (key) {
9a6517d1 394 case SR_CONF_DEVICE_OPTIONS:
a9ed6877
BV
395 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
396 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 397 break;
a1c743fc 398 case SR_CONF_SAMPLERATE:
a9ed6877
BV
399 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
400 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
401 ARRAY_SIZE(samplerates), sizeof(uint64_t));
402 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
403 *data = g_variant_builder_end(&gvb);
a1c743fc 404 break;
c50277a6 405 case SR_CONF_TRIGGER_TYPE:
a9ed6877 406 *data = g_variant_new_string(TRIGGER_TYPE);
c50277a6 407 break;
a1c743fc 408 default:
bd6fbf62 409 return SR_ERR_NA;
a1c743fc
BV
410 }
411
412 return SR_OK;
413}
414
6078d2c9 415static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
df92e5cf 416{
df92e5cf 417 struct dev_context *devc;
df92e5cf 418 int ret = SR_ERR;
00b44ccb 419
df92e5cf 420 if (sdi->status != SR_ST_ACTIVE)
e73ffd42
BV
421 return SR_ERR_DEV_CLOSED;
422
423 devc = sdi->priv;
df92e5cf 424
5a24e89c 425 if (mso_configure_probes(sdi) != SR_OK) {
426 sr_err("Failed to configure probes.");
427 return SR_ERR;
428 }
df92e5cf 429
df92e5cf 430 /* FIXME: No need to do full reconfigure every time */
00b44ccb
UH
431// ret = mso_reset_fsm(sdi);
432// if (ret != SR_OK)
433// return ret;
df92e5cf 434
435 /* FIXME: ACDC Mode */
436 devc->ctlbase1 &= 0x7f;
00b44ccb 437// devc->ctlbase1 |= devc->acdcmode;
df92e5cf 438
439 ret = mso_configure_rate(sdi, devc->cur_rate);
440 if (ret != SR_OK)
441 return ret;
442
443 /* set dac offset */
444 ret = mso_dac_out(sdi, devc->dac_offset);
445 if (ret != SR_OK)
446 return ret;
447
448 ret = mso_configure_threshold_level(sdi);
449 if (ret != SR_OK)
450 return ret;
451
452 ret = mso_configure_trigger(sdi);
453 if (ret != SR_OK)
454 return ret;
455
df92e5cf 456 /* END of config hardware part */
00b44ccb
UH
457 ret = mso_arm(sdi);
458 if (ret != SR_OK)
459 return ret;
df92e5cf 460
461 /* Start acquisition on the device. */
4db2aaff 462 mso_check_trigger(devc->serial, &devc->trigger_state);
463 ret = mso_check_trigger(devc->serial, NULL);
df92e5cf 464 if (ret != SR_OK)
465 return ret;
466
365f04d6 467 /* Reset trigger state. */
468 devc->trigger_state = 0x00;
469
4afdfd46 470 /* Send header packet to the session bus. */
29a27196 471 std_session_send_df_header(cb_data, LOG_PREFIX);
df92e5cf 472
365f04d6 473 /* Our first probe is analog, the other 8 are of type 'logic'. */
474 /* TODO. */
475
4afdfd46 476 sr_source_add(devc->serial->fd, G_IO_IN, -1, mso_receive_data, cb_data);
df92e5cf 477
478 return SR_OK;
479}
480
087a9161 481/* This stops acquisition on ALL devices, ignoring dev_index. */
6078d2c9 482static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
df92e5cf 483{
df92e5cf 484 (void)cb_data;
485
486 stop_acquisition(sdi);
487
488 return SR_OK;
489}
490
491SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
492 .name = "link-mso19",
493 .longname = "Link Instruments MSO-19",
494 .api_version = 1,
6078d2c9
UH
495 .init = init,
496 .cleanup = cleanup,
497 .scan = scan,
498 .dev_list = dev_list,
eea49cf1 499 .dev_clear = dev_clear,
035a1078
BV
500 .config_get = config_get,
501 .config_set = config_set,
a1c743fc 502 .config_list = config_list,
6078d2c9
UH
503 .dev_open = dev_open,
504 .dev_close = dev_close,
505 .dev_acquisition_start = dev_acquisition_start,
506 .dev_acquisition_stop = dev_acquisition_stop,
df92e5cf 507 .priv = NULL,
508};