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