]> sigrok.org Git - libsigrok.git/blame - src/hardware/link-mso19/api.c
Introduce standard cleanup helper
[libsigrok.git] / src / 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
6ec6c43b 22#include <config.h>
df92e5cf 23#include "protocol.h"
24
f254bc4b 25static const uint32_t devopts[] = {
365f04d6 26 SR_CONF_OSCILLOSCOPE,
1953564a 27 SR_CONF_LOGIC_ANALYZER,
5827f61b
BV
28 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
29 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
30 SR_CONF_TRIGGER_TYPE | SR_CONF_LIST,
31 SR_CONF_TRIGGER_SLOPE | SR_CONF_SET,
32 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_SET,
33 SR_CONF_CAPTURE_RATIO | SR_CONF_SET,
34 SR_CONF_RLE | SR_CONF_SET,
df92e5cf 35};
36
37/*
ba7dd8bb 38 * Channels are numbered 0 to 7.
df92e5cf 39 *
40 * See also: http://www.linkinstruments.com/images/mso19_1113.gif
41 */
0f34cb47 42static const char *channel_names[] = {
365f04d6 43 /* Note: DSO needs to be first. */
0f34cb47 44 "DSO", "0", "1", "2", "3", "4", "5", "6", "7",
df92e5cf 45};
46
a9ed6877
BV
47static const uint64_t samplerates[] = {
48 SR_HZ(100),
49 SR_MHZ(200),
50 SR_HZ(100),
df92e5cf 51};
52
53SR_PRIV struct sr_dev_driver link_mso19_driver_info;
df92e5cf 54
eea49cf1 55/* TODO: Use sr_dev_inst to store connection handle & use std_dev_clear(). */
4f840ce9 56static int dev_clear(const struct sr_dev_driver *di)
eea49cf1
UH
57{
58 GSList *l;
59 struct sr_dev_inst *sdi;
60 struct drv_context *drvc;
61 struct dev_context *devc;
62 int ret = SR_OK;
63
41812aca 64 if (!(drvc = di->context))
eea49cf1
UH
65 return SR_OK;
66
67 /* Properly close and free all devices. */
68 for (l = drvc->instances; l; l = l->next) {
69 if (!(sdi = l->data)) {
70 /* Log error, but continue cleaning up the rest. */
71 sr_err("%s: sdi was NULL, continuing", __func__);
72 ret = SR_ERR_BUG;
73 continue;
74 }
75 if (!(devc = sdi->priv)) {
76 /* Log error, but continue cleaning up the rest. */
77 sr_err("%s: sdi->priv was NULL, continuing", __func__);
78 ret = SR_ERR_BUG;
79 continue;
80 }
bf2c987f 81 std_serial_dev_close(sdi);
eea49cf1
UH
82 sr_serial_dev_inst_free(devc->serial);
83 sr_dev_inst_free(sdi);
84 }
85 g_slist_free(drvc->instances);
86 drvc->instances = NULL;
87
88 return ret;
89}
90
4f840ce9 91static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
df92e5cf 92{
f6beaac5 93 return std_init(sr_ctx, di, LOG_PREFIX);
df92e5cf 94}
95
4f840ce9 96static GSList *scan(struct sr_dev_driver *di, GSList *options)
df92e5cf 97{
00b44ccb
UH
98 int i;
99 GSList *devices = NULL;
100 const char *conn = NULL;
101 const char *serialcomm = NULL;
102 GSList *l;
1987b8d6 103 struct sr_config *src;
00b44ccb 104 struct udev *udev;
fca75cbb 105 int chtype;
df92e5cf 106
df92e5cf 107 for (l = options; l; l = l->next) {
1987b8d6
BV
108 src = l->data;
109 switch (src->key) {
1953564a 110 case SR_CONF_CONN:
a9ed6877 111 conn = g_variant_get_string(src->data, NULL);
df92e5cf 112 break;
1953564a 113 case SR_CONF_SERIALCOMM:
06c45a66 114 serialcomm = g_variant_get_string(src->data, NULL);
df92e5cf 115 break;
116 }
117 }
118 if (!conn)
00b44ccb 119 conn = SERIALCONN;
98fec29e 120 if (!serialcomm)
df92e5cf 121 serialcomm = SERIALCOMM;
122
00b44ccb 123 udev = udev_new();
df92e5cf 124 if (!udev) {
125 sr_err("Failed to initialize udev.");
126 }
00b44ccb 127
df92e5cf 128 struct udev_enumerate *enumerate = udev_enumerate_new(udev);
129 udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
130 udev_enumerate_scan_devices(enumerate);
131 struct udev_list_entry *devs = udev_enumerate_get_list_entry(enumerate);
132 struct udev_list_entry *dev_list_entry;
00b44ccb
UH
133 for (dev_list_entry = devs;
134 dev_list_entry != NULL;
135 dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
df92e5cf 136 const char *syspath = udev_list_entry_get_name(dev_list_entry);
00b44ccb
UH
137 struct udev_device *dev =
138 udev_device_new_from_syspath(udev, syspath);
df92e5cf 139 const char *sysname = udev_device_get_sysname(dev);
00b44ccb
UH
140 struct udev_device *parent =
141 udev_device_get_parent_with_subsystem_devtype(dev, "usb",
142 "usb_device");
df92e5cf 143
144 if (!parent) {
145 sr_err("Unable to find parent usb device for %s",
146 sysname);
147 continue;
148 }
149
00b44ccb
UH
150 const char *idVendor =
151 udev_device_get_sysattr_value(parent, "idVendor");
152 const char *idProduct =
153 udev_device_get_sysattr_value(parent, "idProduct");
df92e5cf 154 if (strcmp(USB_VENDOR, idVendor)
00b44ccb 155 || strcmp(USB_PRODUCT, idProduct))
df92e5cf 156 continue;
157
00b44ccb
UH
158 const char *iSerial =
159 udev_device_get_sysattr_value(parent, "serial");
160 const char *iProduct =
161 udev_device_get_sysattr_value(parent, "product");
df92e5cf 162
00b44ccb 163 char path[32];
df92e5cf 164 snprintf(path, sizeof(path), "/dev/%s", sysname);
00b44ccb 165 conn = path;
df92e5cf 166
167 size_t s = strcspn(iProduct, " ");
00b44ccb
UH
168 char product[32];
169 char manufacturer[32];
df92e5cf 170 if (s > sizeof(product) ||
00b44ccb
UH
171 strlen(iProduct) - s > sizeof(manufacturer)) {
172 sr_err("Could not parse iProduct: %s.", iProduct);
df92e5cf 173 continue;
174 }
175 strncpy(product, iProduct, s);
176 product[s] = 0;
4db2aaff 177 strcpy(manufacturer, iProduct + s + 1);
00b44ccb
UH
178
179 //Create the device context and set its params
180 struct dev_context *devc;
f57d8ffe 181 devc = g_malloc0(sizeof(struct dev_context));
00b44ccb
UH
182
183 if (mso_parse_serial(iSerial, iProduct, devc) != SR_OK) {
184 sr_err("Invalid iSerial: %s.", iSerial);
185 g_free(devc);
186 return devices;
187 }
188
189 char hwrev[32];
190 sprintf(hwrev, "r%d", devc->hwrev);
191 devc->ctlbase1 = 0;
192 devc->protocol_trigger.spimode = 0;
193 for (i = 0; i < 4; i++) {
194 devc->protocol_trigger.word[i] = 0;
195 devc->protocol_trigger.mask[i] = 0xff;
196 }
197
91219afc 198 devc->serial = sr_serial_dev_inst_new(conn, serialcomm);
00b44ccb 199
aac29cc1
UH
200 struct sr_dev_inst *sdi = g_malloc0(sizeof(struct sr_dev_inst));
201 sdi->status = SR_ST_INACTIVE;
202 sdi->vendor = g_strdup(manufacturer);
203 sdi->model = g_strdup(product);
204 sdi->version = g_strdup(hwrev);
00b44ccb
UH
205
206 if (!sdi) {
207 sr_err("Unable to create device instance for %s",
208 sysname);
209 sr_dev_inst_free(sdi);
210 g_free(devc);
211 return devices;
212 }
213
214 sdi->driver = di;
215 sdi->priv = devc;
216
07962655 217 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
fca75cbb 218 chtype = (i == 0) ? SR_CHANNEL_ANALOG : SR_CHANNEL_LOGIC;
0f34cb47 219 sr_channel_new(sdi, i, chtype, TRUE, channel_names[i]);
00b44ccb
UH
220 }
221
222 //Add the driver
41812aca 223 struct drv_context *drvc = di->context;
00b44ccb
UH
224 drvc->instances = g_slist_append(drvc->instances, sdi);
225 devices = g_slist_append(devices, sdi);
226 }
5a24e89c 227
df92e5cf 228 return devices;
229}
230
4f840ce9 231static GSList *dev_list(const struct sr_dev_driver *di)
df92e5cf 232{
41812aca 233 return ((struct drv_context *)(di->context))->instances;
df92e5cf 234}
235
6078d2c9 236static int dev_open(struct sr_dev_inst *sdi)
df92e5cf 237{
00b44ccb 238 int ret;
df92e5cf 239 struct dev_context *devc;
240
241 devc = sdi->priv;
242
243 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
244 return SR_ERR;
245
246 sdi->status = SR_ST_ACTIVE;
247
248 /* FIXME: discard serial buffer */
249 mso_check_trigger(devc->serial, &devc->trigger_state);
250 sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
251
00b44ccb 252 ret = mso_reset_adc(sdi);
df92e5cf 253 if (ret != SR_OK)
254 return ret;
255
256 mso_check_trigger(devc->serial, &devc->trigger_state);
257 sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
258
00b44ccb
UH
259 // ret = mso_reset_fsm(sdi);
260 // if (ret != SR_OK)
261 // return ret;
262 // return SR_ERR;
df92e5cf 263
264 return SR_OK;
265}
266
2ea67fc9 267static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 268 const struct sr_channel_group *cg)
df92e5cf 269{
270 struct dev_context *devc;
271
53b4680f 272 (void)cg;
8f996b89 273
2ea67fc9 274 switch (key) {
123e1313 275 case SR_CONF_SAMPLERATE:
df92e5cf 276 if (sdi) {
277 devc = sdi->priv;
a9ed6877 278 *data = g_variant_new_uint64(devc->cur_rate);
df92e5cf 279 } else
280 return SR_ERR;
281 break;
282 default:
bd6fbf62 283 return SR_ERR_NA;
df92e5cf 284 }
285
286 return SR_OK;
287}
288
2ea67fc9 289static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 290 const struct sr_channel_group *cg)
df92e5cf 291{
df92e5cf 292 int ret;
087a9161 293 struct dev_context *devc;
ca9b9f48
DE
294 uint64_t num_samples;
295 const char *slope;
00b44ccb 296 int trigger_pos;
a9ed6877 297 double pos;
00b44ccb 298
53b4680f 299 (void)cg;
00b44ccb 300 devc = sdi->priv;
087a9161 301
df92e5cf 302 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 303 return SR_ERR_DEV_CLOSED;
df92e5cf 304
2ea67fc9 305 switch (key) {
1953564a 306 case SR_CONF_SAMPLERATE:
00b44ccb 307 // FIXME
a9ed6877 308 return mso_configure_rate(sdi, g_variant_get_uint64(data));
df92e5cf 309 ret = SR_OK;
310 break;
1953564a 311 case SR_CONF_LIMIT_SAMPLES:
a9ed6877 312 num_samples = g_variant_get_uint64(data);
5952553f 313 if (num_samples != 1024) {
314 sr_err("Only 1024 samples are supported.");
00b44ccb
UH
315 ret = SR_ERR_ARG;
316 } else {
317 devc->limit_samples = num_samples;
00b44ccb
UH
318 ret = SR_OK;
319 }
df92e5cf 320 break;
1953564a 321 case SR_CONF_CAPTURE_RATIO:
00b44ccb
UH
322 ret = SR_OK;
323 break;
1953564a 324 case SR_CONF_TRIGGER_SLOPE:
ca9b9f48
DE
325 slope = g_variant_get_string(data, NULL);
326
327 if (!slope || !(slope[0] == 'f' || slope[0] == 'r'))
00b44ccb
UH
328 sr_err("Invalid trigger slope");
329 ret = SR_ERR_ARG;
330 } else {
ca9b9f48
DE
331 devc->trigger_slope = (slope[0] == 'r')
332 ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
00b44ccb
UH
333 ret = SR_OK;
334 }
335 break;
1953564a 336 case SR_CONF_HORIZ_TRIGGERPOS:
a9ed6877 337 pos = g_variant_get_double(data);
00b44ccb
UH
338 if (pos < 0 || pos > 255) {
339 sr_err("Trigger position (%f) should be between 0 and 255.", pos);
340 ret = SR_ERR_ARG;
341 } else {
342 trigger_pos = (int)pos;
343 devc->trigger_holdoff[0] = trigger_pos & 0xff;
344 ret = SR_OK;
345 }
df92e5cf 346 break;
1953564a 347 case SR_CONF_RLE:
00b44ccb 348 ret = SR_OK;
df92e5cf 349 break;
350 default:
bd6fbf62 351 ret = SR_ERR_NA;
00b44ccb 352 break;
df92e5cf 353 }
354
355 return ret;
356}
357
8f996b89 358static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 359 const struct sr_channel_group *cg)
a1c743fc 360{
a9ed6877
BV
361 GVariant *gvar;
362 GVariantBuilder gvb;
a1c743fc 363
53b4680f 364 (void)cg;
a1c743fc
BV
365 (void)sdi;
366
367 switch (key) {
9a6517d1 368 case SR_CONF_DEVICE_OPTIONS:
584560f1 369 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 370 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 371 break;
a1c743fc 372 case SR_CONF_SAMPLERATE:
a9ed6877
BV
373 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
374 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
375 ARRAY_SIZE(samplerates), sizeof(uint64_t));
376 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
377 *data = g_variant_builder_end(&gvb);
a1c743fc 378 break;
c50277a6 379 case SR_CONF_TRIGGER_TYPE:
a9ed6877 380 *data = g_variant_new_string(TRIGGER_TYPE);
c50277a6 381 break;
a1c743fc 382 default:
bd6fbf62 383 return SR_ERR_NA;
a1c743fc
BV
384 }
385
386 return SR_OK;
387}
388
695dc859 389static int dev_acquisition_start(const struct sr_dev_inst *sdi)
df92e5cf 390{
df92e5cf 391 struct dev_context *devc;
df92e5cf 392 int ret = SR_ERR;
00b44ccb 393
df92e5cf 394 if (sdi->status != SR_ST_ACTIVE)
e73ffd42
BV
395 return SR_ERR_DEV_CLOSED;
396
397 devc = sdi->priv;
df92e5cf 398
ba7dd8bb
UH
399 if (mso_configure_channels(sdi) != SR_OK) {
400 sr_err("Failed to configure channels.");
5a24e89c 401 return SR_ERR;
402 }
df92e5cf 403
df92e5cf 404 /* FIXME: No need to do full reconfigure every time */
00b44ccb
UH
405// ret = mso_reset_fsm(sdi);
406// if (ret != SR_OK)
407// return ret;
df92e5cf 408
409 /* FIXME: ACDC Mode */
410 devc->ctlbase1 &= 0x7f;
00b44ccb 411// devc->ctlbase1 |= devc->acdcmode;
df92e5cf 412
413 ret = mso_configure_rate(sdi, devc->cur_rate);
414 if (ret != SR_OK)
415 return ret;
416
417 /* set dac offset */
418 ret = mso_dac_out(sdi, devc->dac_offset);
419 if (ret != SR_OK)
420 return ret;
421
422 ret = mso_configure_threshold_level(sdi);
423 if (ret != SR_OK)
424 return ret;
425
426 ret = mso_configure_trigger(sdi);
427 if (ret != SR_OK)
428 return ret;
429
df92e5cf 430 /* END of config hardware part */
00b44ccb
UH
431 ret = mso_arm(sdi);
432 if (ret != SR_OK)
433 return ret;
df92e5cf 434
435 /* Start acquisition on the device. */
4db2aaff 436 mso_check_trigger(devc->serial, &devc->trigger_state);
437 ret = mso_check_trigger(devc->serial, NULL);
df92e5cf 438 if (ret != SR_OK)
439 return ret;
440
365f04d6 441 /* Reset trigger state. */
442 devc->trigger_state = 0x00;
443
695dc859 444 std_session_send_df_header(sdi, LOG_PREFIX);
df92e5cf 445
ba7dd8bb 446 /* Our first channel is analog, the other 8 are of type 'logic'. */
365f04d6 447 /* TODO. */
448
102f1239 449 serial_source_add(sdi->session, devc->serial, G_IO_IN, -1,
695dc859 450 mso_receive_data, sdi);
df92e5cf 451
452 return SR_OK;
453}
454
087a9161 455/* This stops acquisition on ALL devices, ignoring dev_index. */
695dc859 456static int dev_acquisition_stop(struct sr_dev_inst *sdi)
df92e5cf 457{
df92e5cf 458 stop_acquisition(sdi);
459
460 return SR_OK;
461}
462
463SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
464 .name = "link-mso19",
465 .longname = "Link Instruments MSO-19",
466 .api_version = 1,
6078d2c9 467 .init = init,
700d6b64 468 .cleanup = std_cleanup,
6078d2c9
UH
469 .scan = scan,
470 .dev_list = dev_list,
eea49cf1 471 .dev_clear = dev_clear,
035a1078
BV
472 .config_get = config_get,
473 .config_set = config_set,
a1c743fc 474 .config_list = config_list,
6078d2c9 475 .dev_open = dev_open,
bf2c987f 476 .dev_close = std_serial_dev_close,
6078d2c9
UH
477 .dev_acquisition_start = dev_acquisition_start,
478 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 479 .context = NULL,
df92e5cf 480};