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