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