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