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