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