]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/link-mso19/api.c
ols/link-mso19: Consistency fixes.
[libsigrok.git] / hardware / link-mso19 / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
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>
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
24static const int32_t hwcaps[] = {
25 SR_CONF_OSCILLOSCOPE,
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,
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] = {
41 /* Note: DSO needs to be first. */
42 "DSO", "0", "1", "2", "3", "4", "5", "6", "7", NULL,
43};
44
45static const uint64_t samplerates[] = {
46 SR_HZ(100),
47 SR_MHZ(200),
48 SR_HZ(100),
49};
50
51SR_PRIV struct sr_dev_driver link_mso19_driver_info;
52static struct sr_dev_driver *di = &link_mso19_driver_info;
53
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
92static int init(struct sr_context *sr_ctx)
93{
94 return std_init(sr_ctx, di, LOG_PREFIX);
95}
96
97static GSList *scan(GSList *options)
98{
99 int i;
100 GSList *devices = NULL;
101 const char *conn = NULL;
102 const char *serialcomm = NULL;
103 GSList *l;
104 struct sr_config *src;
105 struct udev *udev;
106 int ptype;
107
108 for (l = options; l; l = l->next) {
109 src = l->data;
110 switch (src->key) {
111 case SR_CONF_CONN:
112 conn = g_variant_get_string(src->data, NULL);
113 break;
114 case SR_CONF_SERIALCOMM:
115 serialcomm = g_variant_get_string(src->data, NULL);
116 break;
117 }
118 }
119 if (!conn)
120 conn = SERIALCONN;
121 if (serialcomm == NULL)
122 serialcomm = SERIALCOMM;
123
124 udev = udev_new();
125 if (!udev) {
126 sr_err("Failed to initialize udev.");
127 }
128
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;
134 for (dev_list_entry = devs;
135 dev_list_entry != NULL;
136 dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
137 const char *syspath = udev_list_entry_get_name(dev_list_entry);
138 struct udev_device *dev =
139 udev_device_new_from_syspath(udev, syspath);
140 const char *sysname = udev_device_get_sysname(dev);
141 struct udev_device *parent =
142 udev_device_get_parent_with_subsystem_devtype(dev, "usb",
143 "usb_device");
144
145 if (!parent) {
146 sr_err("Unable to find parent usb device for %s",
147 sysname);
148 continue;
149 }
150
151 const char *idVendor =
152 udev_device_get_sysattr_value(parent, "idVendor");
153 const char *idProduct =
154 udev_device_get_sysattr_value(parent, "idProduct");
155 if (strcmp(USB_VENDOR, idVendor)
156 || strcmp(USB_PRODUCT, idProduct))
157 continue;
158
159 const char *iSerial =
160 udev_device_get_sysattr_value(parent, "serial");
161 const char *iProduct =
162 udev_device_get_sysattr_value(parent, "product");
163
164 char path[32];
165 snprintf(path, sizeof(path), "/dev/%s", sysname);
166 conn = path;
167
168 size_t s = strcspn(iProduct, " ");
169 char product[32];
170 char manufacturer[32];
171 if (s > sizeof(product) ||
172 strlen(iProduct) - s > sizeof(manufacturer)) {
173 sr_err("Could not parse iProduct: %s.", iProduct);
174 continue;
175 }
176 strncpy(product, iProduct, s);
177 product[s] = 0;
178 strcpy(manufacturer, iProduct + s + 1);
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;
223 ptype = (i == 0) ? SR_PROBE_ANALOG : SR_PROBE_LOGIC;
224 if (!(probe = sr_probe_new(i, ptype, TRUE,
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 }
235
236 return devices;
237}
238
239static GSList *dev_list(void)
240{
241 return ((struct drv_context *)(di->priv))->instances;
242}
243
244static int dev_open(struct sr_dev_inst *sdi)
245{
246 int ret;
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
260 ret = mso_reset_adc(sdi);
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
267 // ret = mso_reset_fsm(sdi);
268 // if (ret != SR_OK)
269 // return ret;
270 // return SR_ERR;
271
272 return SR_OK;
273}
274
275static int dev_close(struct sr_dev_inst *sdi)
276{
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
289static int cleanup(void)
290{
291 return dev_clear();
292}
293
294static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
295{
296 struct dev_context *devc;
297
298 switch (id) {
299 case SR_CONF_SAMPLERATE:
300 if (sdi) {
301 devc = sdi->priv;
302 *data = g_variant_new_uint64(devc->cur_rate);
303 } else
304 return SR_ERR;
305 break;
306 default:
307 return SR_ERR_NA;
308 }
309
310 return SR_OK;
311}
312
313static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
314{
315 int ret;
316 struct dev_context *devc;
317 uint64_t num_samples, slope;
318 int trigger_pos;
319 double pos;
320
321 devc = sdi->priv;
322
323 if (sdi->status != SR_ST_ACTIVE)
324 return SR_ERR_DEV_CLOSED;
325
326 switch (id) {
327 case SR_CONF_SAMPLERATE:
328 // FIXME
329 return mso_configure_rate(sdi, g_variant_get_uint64(data));
330 ret = SR_OK;
331 break;
332 case SR_CONF_LIMIT_SAMPLES:
333 num_samples = g_variant_get_uint64(data);
334 if (num_samples != 1024) {
335 sr_err("Only 1024 samples are supported.");
336 ret = SR_ERR_ARG;
337 } else {
338 devc->limit_samples = num_samples;
339 sr_dbg("setting limit_samples to %i\n",
340 num_samples);
341 ret = SR_OK;
342 }
343 break;
344 case SR_CONF_CAPTURE_RATIO:
345 ret = SR_OK;
346 break;
347 case SR_CONF_TRIGGER_SLOPE:
348 slope = g_variant_get_uint64(data);
349 if (slope != SLOPE_NEGATIVE && slope != SLOPE_POSITIVE) {
350 sr_err("Invalid trigger slope");
351 ret = SR_ERR_ARG;
352 } else {
353 devc->trigger_slope = slope;
354 ret = SR_OK;
355 }
356 break;
357 case SR_CONF_HORIZ_TRIGGERPOS:
358 pos = g_variant_get_double(data);
359 if (pos < 0 || pos > 255) {
360 sr_err("Trigger position (%f) should be between 0 and 255.", pos);
361 ret = SR_ERR_ARG;
362 } else {
363 trigger_pos = (int)pos;
364 devc->trigger_holdoff[0] = trigger_pos & 0xff;
365 ret = SR_OK;
366 }
367 break;
368 case SR_CONF_RLE:
369 ret = SR_OK;
370 break;
371 default:
372 ret = SR_ERR_NA;
373 break;
374 }
375
376 return ret;
377}
378
379static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
380{
381 GVariant *gvar;
382 GVariantBuilder gvb;
383
384 (void)sdi;
385
386 switch (key) {
387 case SR_CONF_DEVICE_OPTIONS:
388 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
389 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
390 break;
391 case SR_CONF_SAMPLERATE:
392 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
393 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
394 ARRAY_SIZE(samplerates), sizeof(uint64_t));
395 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
396 *data = g_variant_builder_end(&gvb);
397 break;
398 case SR_CONF_TRIGGER_TYPE:
399 *data = g_variant_new_string(TRIGGER_TYPE);
400 break;
401 default:
402 return SR_ERR_NA;
403 }
404
405 return SR_OK;
406}
407
408static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
409{
410 struct dev_context *devc;
411 int ret = SR_ERR;
412
413 if (sdi->status != SR_ST_ACTIVE)
414 return SR_ERR_DEV_CLOSED;
415
416 devc = sdi->priv;
417
418 if (mso_configure_probes(sdi) != SR_OK) {
419 sr_err("Failed to configure probes.");
420 return SR_ERR;
421 }
422
423 /* FIXME: No need to do full reconfigure every time */
424// ret = mso_reset_fsm(sdi);
425// if (ret != SR_OK)
426// return ret;
427
428 /* FIXME: ACDC Mode */
429 devc->ctlbase1 &= 0x7f;
430// devc->ctlbase1 |= devc->acdcmode;
431
432 ret = mso_configure_rate(sdi, devc->cur_rate);
433 if (ret != SR_OK)
434 return ret;
435
436 /* set dac offset */
437 ret = mso_dac_out(sdi, devc->dac_offset);
438 if (ret != SR_OK)
439 return ret;
440
441 ret = mso_configure_threshold_level(sdi);
442 if (ret != SR_OK)
443 return ret;
444
445 ret = mso_configure_trigger(sdi);
446 if (ret != SR_OK)
447 return ret;
448
449 /* END of config hardware part */
450 ret = mso_arm(sdi);
451 if (ret != SR_OK)
452 return ret;
453
454 /* Start acquisition on the device. */
455 mso_check_trigger(devc->serial, &devc->trigger_state);
456 ret = mso_check_trigger(devc->serial, NULL);
457 if (ret != SR_OK)
458 return ret;
459
460 /* Reset trigger state. */
461 devc->trigger_state = 0x00;
462
463 /* Send header packet to the session bus. */
464 std_session_send_df_header(cb_data, LOG_PREFIX);
465
466 /* Our first probe is analog, the other 8 are of type 'logic'. */
467 /* TODO. */
468
469 sr_source_add(devc->serial->fd, G_IO_IN, -1, mso_receive_data, cb_data);
470
471 return SR_OK;
472}
473
474/* This stops acquisition on ALL devices, ignoring dev_index. */
475static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
476{
477 (void)cb_data;
478
479 stop_acquisition(sdi);
480
481 return SR_OK;
482}
483
484SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
485 .name = "link-mso19",
486 .longname = "Link Instruments MSO-19",
487 .api_version = 1,
488 .init = init,
489 .cleanup = cleanup,
490 .scan = scan,
491 .dev_list = dev_list,
492 .dev_clear = dev_clear,
493 .config_get = config_get,
494 .config_set = config_set,
495 .config_list = config_list,
496 .dev_open = dev_open,
497 .dev_close = dev_close,
498 .dev_acquisition_start = dev_acquisition_start,
499 .dev_acquisition_stop = dev_acquisition_stop,
500 .priv = NULL,
501};