]> sigrok.org Git - libsigrok.git/blame - src/hardware/link-mso19/api.c
Don't check sr_channel_new() return value (always succeeds).
[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
22#include "protocol.h"
23
f254bc4b 24static const uint32_t devopts[] = {
365f04d6 25 SR_CONF_OSCILLOSCOPE,
1953564a 26 SR_CONF_LOGIC_ANALYZER,
5827f61b
BV
27 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
28 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
29 SR_CONF_TRIGGER_TYPE | SR_CONF_LIST,
30 SR_CONF_TRIGGER_SLOPE | SR_CONF_SET,
31 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_SET,
32 SR_CONF_CAPTURE_RATIO | SR_CONF_SET,
33 SR_CONF_RLE | SR_CONF_SET,
df92e5cf 34};
35
36/*
ba7dd8bb 37 * Channels are numbered 0 to 7.
df92e5cf 38 *
39 * See also: http://www.linkinstruments.com/images/mso19_1113.gif
40 */
3f239f08 41SR_PRIV const char *mso19_channel_names[NUM_CHANNELS + 1] = {
365f04d6 42 /* Note: DSO needs to be first. */
43 "DSO", "0", "1", "2", "3", "4", "5", "6", "7", NULL,
df92e5cf 44};
45
a9ed6877
BV
46static const uint64_t samplerates[] = {
47 SR_HZ(100),
48 SR_MHZ(200),
49 SR_HZ(100),
df92e5cf 50};
51
52SR_PRIV struct sr_dev_driver link_mso19_driver_info;
53static struct sr_dev_driver *di = &link_mso19_driver_info;
54
eea49cf1
UH
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 }
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
6078d2c9 91static int init(struct sr_context *sr_ctx)
df92e5cf 92{
f6beaac5 93 return std_init(sr_ctx, di, LOG_PREFIX);
df92e5cf 94}
95
6078d2c9 96static GSList *scan(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;
df92e5cf 120 if (serialcomm == NULL)
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
198 if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm))) {
199 g_free(devc);
200 return devices;
201 }
202
aac29cc1
UH
203 struct sr_dev_inst *sdi = g_malloc0(sizeof(struct sr_dev_inst));
204 sdi->status = SR_ST_INACTIVE;
205 sdi->vendor = g_strdup(manufacturer);
206 sdi->model = g_strdup(product);
207 sdi->version = g_strdup(hwrev);
00b44ccb
UH
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
3f239f08 220 for (i = 0; i < NUM_CHANNELS; i++) {
ba7dd8bb 221 struct sr_channel *ch;
fca75cbb 222 chtype = (i == 0) ? SR_CHANNEL_ANALOG : SR_CHANNEL_LOGIC;
c368e6f3
UH
223 ch = sr_channel_new(i, chtype, TRUE,
224 mso19_channel_names[i]);
ba7dd8bb 225 sdi->channels = g_slist_append(sdi->channels, ch);
00b44ccb
UH
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 }
5a24e89c 233
df92e5cf 234 return devices;
235}
236
6078d2c9 237static GSList *dev_list(void)
df92e5cf 238{
0e94d524 239 return ((struct drv_context *)(di->priv))->instances;
df92e5cf 240}
241
6078d2c9 242static int dev_open(struct sr_dev_inst *sdi)
df92e5cf 243{
00b44ccb 244 int ret;
df92e5cf 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
00b44ccb 258 ret = mso_reset_adc(sdi);
df92e5cf 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
00b44ccb
UH
265 // ret = mso_reset_fsm(sdi);
266 // if (ret != SR_OK)
267 // return ret;
268 // return SR_ERR;
df92e5cf 269
270 return SR_OK;
271}
272
6078d2c9 273static int cleanup(void)
df92e5cf 274{
eea49cf1 275 return dev_clear();
df92e5cf 276}
277
8f996b89 278static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 279 const struct sr_channel_group *cg)
df92e5cf 280{
281 struct dev_context *devc;
282
53b4680f 283 (void)cg;
8f996b89 284
035a1078 285 switch (id) {
123e1313 286 case SR_CONF_SAMPLERATE:
df92e5cf 287 if (sdi) {
288 devc = sdi->priv;
a9ed6877 289 *data = g_variant_new_uint64(devc->cur_rate);
df92e5cf 290 } else
291 return SR_ERR;
292 break;
293 default:
bd6fbf62 294 return SR_ERR_NA;
df92e5cf 295 }
296
297 return SR_OK;
298}
299
8f996b89 300static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 301 const struct sr_channel_group *cg)
df92e5cf 302{
df92e5cf 303 int ret;
087a9161 304 struct dev_context *devc;
ca9b9f48
DE
305 uint64_t num_samples;
306 const char *slope;
00b44ccb 307 int trigger_pos;
a9ed6877 308 double pos;
00b44ccb 309
53b4680f 310 (void)cg;
00b44ccb 311 devc = sdi->priv;
087a9161 312
df92e5cf 313 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 314 return SR_ERR_DEV_CLOSED;
df92e5cf 315
035a1078 316 switch (id) {
1953564a 317 case SR_CONF_SAMPLERATE:
00b44ccb 318 // FIXME
a9ed6877 319 return mso_configure_rate(sdi, g_variant_get_uint64(data));
df92e5cf 320 ret = SR_OK;
321 break;
1953564a 322 case SR_CONF_LIMIT_SAMPLES:
a9ed6877 323 num_samples = g_variant_get_uint64(data);
5952553f 324 if (num_samples != 1024) {
325 sr_err("Only 1024 samples are supported.");
00b44ccb
UH
326 ret = SR_ERR_ARG;
327 } else {
328 devc->limit_samples = num_samples;
329 sr_dbg("setting limit_samples to %i\n",
330 num_samples);
331 ret = SR_OK;
332 }
df92e5cf 333 break;
1953564a 334 case SR_CONF_CAPTURE_RATIO:
00b44ccb
UH
335 ret = SR_OK;
336 break;
1953564a 337 case SR_CONF_TRIGGER_SLOPE:
ca9b9f48
DE
338 slope = g_variant_get_string(data, NULL);
339
340 if (!slope || !(slope[0] == 'f' || slope[0] == 'r'))
00b44ccb
UH
341 sr_err("Invalid trigger slope");
342 ret = SR_ERR_ARG;
343 } else {
ca9b9f48
DE
344 devc->trigger_slope = (slope[0] == 'r')
345 ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
00b44ccb
UH
346 ret = SR_OK;
347 }
348 break;
1953564a 349 case SR_CONF_HORIZ_TRIGGERPOS:
a9ed6877 350 pos = g_variant_get_double(data);
00b44ccb
UH
351 if (pos < 0 || pos > 255) {
352 sr_err("Trigger position (%f) should be between 0 and 255.", pos);
353 ret = SR_ERR_ARG;
354 } else {
355 trigger_pos = (int)pos;
356 devc->trigger_holdoff[0] = trigger_pos & 0xff;
357 ret = SR_OK;
358 }
df92e5cf 359 break;
1953564a 360 case SR_CONF_RLE:
00b44ccb 361 ret = SR_OK;
df92e5cf 362 break;
363 default:
bd6fbf62 364 ret = SR_ERR_NA;
00b44ccb 365 break;
df92e5cf 366 }
367
368 return ret;
369}
370
8f996b89 371static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 372 const struct sr_channel_group *cg)
a1c743fc 373{
a9ed6877
BV
374 GVariant *gvar;
375 GVariantBuilder gvb;
a1c743fc 376
53b4680f 377 (void)cg;
a1c743fc
BV
378 (void)sdi;
379
380 switch (key) {
9a6517d1 381 case SR_CONF_DEVICE_OPTIONS:
584560f1 382 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 383 devopts, ARRAY_SIZE(devopts), sizeof(uint32_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
6078d2c9 402static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
df92e5cf 403{
df92e5cf 404 struct dev_context *devc;
df92e5cf 405 int ret = SR_ERR;
00b44ccb 406
df92e5cf 407 if (sdi->status != SR_ST_ACTIVE)
e73ffd42
BV
408 return SR_ERR_DEV_CLOSED;
409
410 devc = sdi->priv;
df92e5cf 411
ba7dd8bb
UH
412 if (mso_configure_channels(sdi) != SR_OK) {
413 sr_err("Failed to configure channels.");
5a24e89c 414 return SR_ERR;
415 }
df92e5cf 416
df92e5cf 417 /* FIXME: No need to do full reconfigure every time */
00b44ccb
UH
418// ret = mso_reset_fsm(sdi);
419// if (ret != SR_OK)
420// return ret;
df92e5cf 421
422 /* FIXME: ACDC Mode */
423 devc->ctlbase1 &= 0x7f;
00b44ccb 424// devc->ctlbase1 |= devc->acdcmode;
df92e5cf 425
426 ret = mso_configure_rate(sdi, devc->cur_rate);
427 if (ret != SR_OK)
428 return ret;
429
430 /* set dac offset */
431 ret = mso_dac_out(sdi, devc->dac_offset);
432 if (ret != SR_OK)
433 return ret;
434
435 ret = mso_configure_threshold_level(sdi);
436 if (ret != SR_OK)
437 return ret;
438
439 ret = mso_configure_trigger(sdi);
440 if (ret != SR_OK)
441 return ret;
442
df92e5cf 443 /* END of config hardware part */
00b44ccb
UH
444 ret = mso_arm(sdi);
445 if (ret != SR_OK)
446 return ret;
df92e5cf 447
448 /* Start acquisition on the device. */
4db2aaff 449 mso_check_trigger(devc->serial, &devc->trigger_state);
450 ret = mso_check_trigger(devc->serial, NULL);
df92e5cf 451 if (ret != SR_OK)
452 return ret;
453
365f04d6 454 /* Reset trigger state. */
455 devc->trigger_state = 0x00;
456
4afdfd46 457 /* Send header packet to the session bus. */
29a27196 458 std_session_send_df_header(cb_data, LOG_PREFIX);
df92e5cf 459
ba7dd8bb 460 /* Our first channel is analog, the other 8 are of type 'logic'. */
365f04d6 461 /* TODO. */
462
102f1239
BV
463 serial_source_add(sdi->session, devc->serial, G_IO_IN, -1,
464 mso_receive_data, cb_data);
df92e5cf 465
466 return SR_OK;
467}
468
087a9161 469/* This stops acquisition on ALL devices, ignoring dev_index. */
6078d2c9 470static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
df92e5cf 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,
6078d2c9
UH
483 .init = init,
484 .cleanup = cleanup,
485 .scan = scan,
486 .dev_list = dev_list,
eea49cf1 487 .dev_clear = dev_clear,
035a1078
BV
488 .config_get = config_get,
489 .config_set = config_set,
a1c743fc 490 .config_list = config_list,
6078d2c9 491 .dev_open = dev_open,
bf2c987f 492 .dev_close = std_serial_dev_close,
6078d2c9
UH
493 .dev_acquisition_start = dev_acquisition_start,
494 .dev_acquisition_stop = dev_acquisition_stop,
df92e5cf 495 .priv = NULL,
496};