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