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