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