]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/link-mso19/api.c
log prefixes: Cosmetics, consistency fixes, typo 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
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 }
80 std_serial_dev_close(sdi);
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
90static int init(struct sr_context *sr_ctx)
91{
92 return std_init(sr_ctx, di, LOG_PREFIX);
93}
94
95static GSList *scan(GSList *options)
96{
97 int i;
98 GSList *devices = NULL;
99 const char *conn = NULL;
100 const char *serialcomm = NULL;
101 GSList *l;
102 struct sr_config *src;
103 struct udev *udev;
104 int ptype;
105
106 for (l = options; l; l = l->next) {
107 src = l->data;
108 switch (src->key) {
109 case SR_CONF_CONN:
110 conn = g_variant_get_string(src->data, NULL);
111 break;
112 case SR_CONF_SERIALCOMM:
113 serialcomm = g_variant_get_string(src->data, NULL);
114 break;
115 }
116 }
117 if (!conn)
118 conn = SERIALCONN;
119 if (serialcomm == NULL)
120 serialcomm = SERIALCOMM;
121
122 udev = udev_new();
123 if (!udev) {
124 sr_err("Failed to initialize udev.");
125 }
126
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;
132 for (dev_list_entry = devs;
133 dev_list_entry != NULL;
134 dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
135 const char *syspath = udev_list_entry_get_name(dev_list_entry);
136 struct udev_device *dev =
137 udev_device_new_from_syspath(udev, syspath);
138 const char *sysname = udev_device_get_sysname(dev);
139 struct udev_device *parent =
140 udev_device_get_parent_with_subsystem_devtype(dev, "usb",
141 "usb_device");
142
143 if (!parent) {
144 sr_err("Unable to find parent usb device for %s",
145 sysname);
146 continue;
147 }
148
149 const char *idVendor =
150 udev_device_get_sysattr_value(parent, "idVendor");
151 const char *idProduct =
152 udev_device_get_sysattr_value(parent, "idProduct");
153 if (strcmp(USB_VENDOR, idVendor)
154 || strcmp(USB_PRODUCT, idProduct))
155 continue;
156
157 const char *iSerial =
158 udev_device_get_sysattr_value(parent, "serial");
159 const char *iProduct =
160 udev_device_get_sysattr_value(parent, "product");
161
162 char path[32];
163 snprintf(path, sizeof(path), "/dev/%s", sysname);
164 conn = path;
165
166 size_t s = strcspn(iProduct, " ");
167 char product[32];
168 char manufacturer[32];
169 if (s > sizeof(product) ||
170 strlen(iProduct) - s > sizeof(manufacturer)) {
171 sr_err("Could not parse iProduct: %s.", iProduct);
172 continue;
173 }
174 strncpy(product, iProduct, s);
175 product[s] = 0;
176 strcpy(manufacturer, iProduct + s + 1);
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;
221 ptype = (i == 0) ? SR_PROBE_ANALOG : SR_PROBE_LOGIC;
222 if (!(probe = sr_probe_new(i, ptype, TRUE,
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 }
233
234 return devices;
235}
236
237static GSList *dev_list(void)
238{
239 return ((struct drv_context *)(di->priv))->instances;
240}
241
242static int dev_open(struct sr_dev_inst *sdi)
243{
244 int ret;
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
258 ret = mso_reset_adc(sdi);
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
265 // ret = mso_reset_fsm(sdi);
266 // if (ret != SR_OK)
267 // return ret;
268 // return SR_ERR;
269
270 return SR_OK;
271}
272
273static int cleanup(void)
274{
275 return dev_clear();
276}
277
278static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
279 const struct sr_probe_group *probe_group)
280{
281 struct dev_context *devc;
282
283 (void)probe_group;
284
285 switch (id) {
286 case SR_CONF_SAMPLERATE:
287 if (sdi) {
288 devc = sdi->priv;
289 *data = g_variant_new_uint64(devc->cur_rate);
290 } else
291 return SR_ERR;
292 break;
293 default:
294 return SR_ERR_NA;
295 }
296
297 return SR_OK;
298}
299
300static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
301 const struct sr_probe_group *probe_group)
302{
303 int ret;
304 struct dev_context *devc;
305 uint64_t num_samples, slope;
306 int trigger_pos;
307 double pos;
308
309 (void)probe_group;
310 devc = sdi->priv;
311
312 if (sdi->status != SR_ST_ACTIVE)
313 return SR_ERR_DEV_CLOSED;
314
315 switch (id) {
316 case SR_CONF_SAMPLERATE:
317 // FIXME
318 return mso_configure_rate(sdi, g_variant_get_uint64(data));
319 ret = SR_OK;
320 break;
321 case SR_CONF_LIMIT_SAMPLES:
322 num_samples = g_variant_get_uint64(data);
323 if (num_samples != 1024) {
324 sr_err("Only 1024 samples are supported.");
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 }
332 break;
333 case SR_CONF_CAPTURE_RATIO:
334 ret = SR_OK;
335 break;
336 case SR_CONF_TRIGGER_SLOPE:
337 slope = g_variant_get_uint64(data);
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;
346 case SR_CONF_HORIZ_TRIGGERPOS:
347 pos = g_variant_get_double(data);
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 }
356 break;
357 case SR_CONF_RLE:
358 ret = SR_OK;
359 break;
360 default:
361 ret = SR_ERR_NA;
362 break;
363 }
364
365 return ret;
366}
367
368static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
369 const struct sr_probe_group *probe_group)
370{
371 GVariant *gvar;
372 GVariantBuilder gvb;
373
374 (void)probe_group;
375 (void)sdi;
376
377 switch (key) {
378 case SR_CONF_DEVICE_OPTIONS:
379 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
380 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
381 break;
382 case SR_CONF_SAMPLERATE:
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);
388 break;
389 case SR_CONF_TRIGGER_TYPE:
390 *data = g_variant_new_string(TRIGGER_TYPE);
391 break;
392 default:
393 return SR_ERR_NA;
394 }
395
396 return SR_OK;
397}
398
399static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
400{
401 struct dev_context *devc;
402 int ret = SR_ERR;
403
404 if (sdi->status != SR_ST_ACTIVE)
405 return SR_ERR_DEV_CLOSED;
406
407 devc = sdi->priv;
408
409 if (mso_configure_probes(sdi) != SR_OK) {
410 sr_err("Failed to configure probes.");
411 return SR_ERR;
412 }
413
414 /* FIXME: No need to do full reconfigure every time */
415// ret = mso_reset_fsm(sdi);
416// if (ret != SR_OK)
417// return ret;
418
419 /* FIXME: ACDC Mode */
420 devc->ctlbase1 &= 0x7f;
421// devc->ctlbase1 |= devc->acdcmode;
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
440 /* END of config hardware part */
441 ret = mso_arm(sdi);
442 if (ret != SR_OK)
443 return ret;
444
445 /* Start acquisition on the device. */
446 mso_check_trigger(devc->serial, &devc->trigger_state);
447 ret = mso_check_trigger(devc->serial, NULL);
448 if (ret != SR_OK)
449 return ret;
450
451 /* Reset trigger state. */
452 devc->trigger_state = 0x00;
453
454 /* Send header packet to the session bus. */
455 std_session_send_df_header(cb_data, LOG_PREFIX);
456
457 /* Our first probe is analog, the other 8 are of type 'logic'. */
458 /* TODO. */
459
460 serial_source_add(devc->serial, G_IO_IN, -1, mso_receive_data, cb_data);
461
462 return SR_OK;
463}
464
465/* This stops acquisition on ALL devices, ignoring dev_index. */
466static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
467{
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,
479 .init = init,
480 .cleanup = cleanup,
481 .scan = scan,
482 .dev_list = dev_list,
483 .dev_clear = dev_clear,
484 .config_get = config_get,
485 .config_set = config_set,
486 .config_list = config_list,
487 .dev_open = dev_open,
488 .dev_close = std_serial_dev_close,
489 .dev_acquisition_start = dev_acquisition_start,
490 .dev_acquisition_stop = dev_acquisition_stop,
491 .priv = NULL,
492};