]> sigrok.org Git - libsigrok.git/blame - src/hardware/link-mso19/api.c
Put driver pointers into special section
[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
196 if (!sdi) {
197 sr_err("Unable to create device instance for %s",
198 sysname);
199 sr_dev_inst_free(sdi);
200 g_free(devc);
201 return devices;
202 }
203
204 sdi->driver = di;
205 sdi->priv = devc;
206
07962655 207 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
fca75cbb 208 chtype = (i == 0) ? SR_CHANNEL_ANALOG : SR_CHANNEL_LOGIC;
0f34cb47 209 sr_channel_new(sdi, i, chtype, TRUE, channel_names[i]);
00b44ccb
UH
210 }
211
212 //Add the driver
41812aca 213 struct drv_context *drvc = di->context;
00b44ccb
UH
214 drvc->instances = g_slist_append(drvc->instances, sdi);
215 devices = g_slist_append(devices, sdi);
216 }
5a24e89c 217
df92e5cf 218 return devices;
219}
220
6078d2c9 221static int dev_open(struct sr_dev_inst *sdi)
df92e5cf 222{
00b44ccb 223 int ret;
df92e5cf 224 struct dev_context *devc;
225
226 devc = sdi->priv;
227
228 if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
229 return SR_ERR;
230
231 sdi->status = SR_ST_ACTIVE;
232
233 /* FIXME: discard serial buffer */
234 mso_check_trigger(devc->serial, &devc->trigger_state);
235 sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
236
00b44ccb 237 ret = mso_reset_adc(sdi);
df92e5cf 238 if (ret != SR_OK)
239 return ret;
240
241 mso_check_trigger(devc->serial, &devc->trigger_state);
242 sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
243
00b44ccb
UH
244 // ret = mso_reset_fsm(sdi);
245 // if (ret != SR_OK)
246 // return ret;
247 // return SR_ERR;
df92e5cf 248
249 return SR_OK;
250}
251
2ea67fc9 252static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 253 const struct sr_channel_group *cg)
df92e5cf 254{
255 struct dev_context *devc;
256
53b4680f 257 (void)cg;
8f996b89 258
709468ba
UH
259 if (!sdi)
260 return SR_ERR_ARG;
261
262 devc = sdi->priv;
263
2ea67fc9 264 switch (key) {
123e1313 265 case SR_CONF_SAMPLERATE:
709468ba 266 *data = g_variant_new_uint64(devc->cur_rate);
df92e5cf 267 break;
268 default:
bd6fbf62 269 return SR_ERR_NA;
df92e5cf 270 }
271
272 return SR_OK;
273}
274
2ea67fc9 275static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 276 const struct sr_channel_group *cg)
df92e5cf 277{
df92e5cf 278 int ret;
087a9161 279 struct dev_context *devc;
ca9b9f48
DE
280 uint64_t num_samples;
281 const char *slope;
00b44ccb 282 int trigger_pos;
a9ed6877 283 double pos;
00b44ccb 284
53b4680f 285 (void)cg;
b0baddef 286
00b44ccb 287 devc = sdi->priv;
087a9161 288
df92e5cf 289 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 290 return SR_ERR_DEV_CLOSED;
df92e5cf 291
2ea67fc9 292 switch (key) {
1953564a 293 case SR_CONF_SAMPLERATE:
00b44ccb 294 // FIXME
a9ed6877 295 return mso_configure_rate(sdi, g_variant_get_uint64(data));
df92e5cf 296 ret = SR_OK;
297 break;
1953564a 298 case SR_CONF_LIMIT_SAMPLES:
a9ed6877 299 num_samples = g_variant_get_uint64(data);
5952553f 300 if (num_samples != 1024) {
301 sr_err("Only 1024 samples are supported.");
00b44ccb
UH
302 ret = SR_ERR_ARG;
303 } else {
304 devc->limit_samples = num_samples;
00b44ccb
UH
305 ret = SR_OK;
306 }
df92e5cf 307 break;
1953564a 308 case SR_CONF_CAPTURE_RATIO:
00b44ccb
UH
309 ret = SR_OK;
310 break;
1953564a 311 case SR_CONF_TRIGGER_SLOPE:
ca9b9f48
DE
312 slope = g_variant_get_string(data, NULL);
313
314 if (!slope || !(slope[0] == 'f' || slope[0] == 'r'))
00b44ccb
UH
315 sr_err("Invalid trigger slope");
316 ret = SR_ERR_ARG;
317 } else {
ca9b9f48
DE
318 devc->trigger_slope = (slope[0] == 'r')
319 ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
00b44ccb
UH
320 ret = SR_OK;
321 }
322 break;
1953564a 323 case SR_CONF_HORIZ_TRIGGERPOS:
a9ed6877 324 pos = g_variant_get_double(data);
00b44ccb
UH
325 if (pos < 0 || pos > 255) {
326 sr_err("Trigger position (%f) should be between 0 and 255.", pos);
327 ret = SR_ERR_ARG;
328 } else {
329 trigger_pos = (int)pos;
330 devc->trigger_holdoff[0] = trigger_pos & 0xff;
331 ret = SR_OK;
332 }
df92e5cf 333 break;
1953564a 334 case SR_CONF_RLE:
00b44ccb 335 ret = SR_OK;
df92e5cf 336 break;
337 default:
bd6fbf62 338 ret = SR_ERR_NA;
00b44ccb 339 break;
df92e5cf 340 }
341
342 return ret;
343}
344
8f996b89 345static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 346 const struct sr_channel_group *cg)
a1c743fc 347{
a9ed6877
BV
348 GVariant *gvar;
349 GVariantBuilder gvb;
a1c743fc 350
53b4680f 351 (void)cg;
a1c743fc
BV
352 (void)sdi;
353
354 switch (key) {
9a6517d1 355 case SR_CONF_DEVICE_OPTIONS:
584560f1 356 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 357 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 358 break;
a1c743fc 359 case SR_CONF_SAMPLERATE:
a9ed6877
BV
360 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
361 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
362 ARRAY_SIZE(samplerates), sizeof(uint64_t));
363 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
364 *data = g_variant_builder_end(&gvb);
a1c743fc 365 break;
c50277a6 366 case SR_CONF_TRIGGER_TYPE:
a9ed6877 367 *data = g_variant_new_string(TRIGGER_TYPE);
c50277a6 368 break;
a1c743fc 369 default:
bd6fbf62 370 return SR_ERR_NA;
a1c743fc
BV
371 }
372
373 return SR_OK;
374}
375
695dc859 376static int dev_acquisition_start(const struct sr_dev_inst *sdi)
df92e5cf 377{
df92e5cf 378 struct dev_context *devc;
df92e5cf 379 int ret = SR_ERR;
00b44ccb 380
df92e5cf 381 if (sdi->status != SR_ST_ACTIVE)
e73ffd42
BV
382 return SR_ERR_DEV_CLOSED;
383
384 devc = sdi->priv;
df92e5cf 385
ba7dd8bb
UH
386 if (mso_configure_channels(sdi) != SR_OK) {
387 sr_err("Failed to configure channels.");
5a24e89c 388 return SR_ERR;
389 }
df92e5cf 390
df92e5cf 391 /* FIXME: No need to do full reconfigure every time */
00b44ccb
UH
392// ret = mso_reset_fsm(sdi);
393// if (ret != SR_OK)
394// return ret;
df92e5cf 395
396 /* FIXME: ACDC Mode */
397 devc->ctlbase1 &= 0x7f;
00b44ccb 398// devc->ctlbase1 |= devc->acdcmode;
df92e5cf 399
400 ret = mso_configure_rate(sdi, devc->cur_rate);
401 if (ret != SR_OK)
402 return ret;
403
404 /* set dac offset */
405 ret = mso_dac_out(sdi, devc->dac_offset);
406 if (ret != SR_OK)
407 return ret;
408
409 ret = mso_configure_threshold_level(sdi);
410 if (ret != SR_OK)
411 return ret;
412
413 ret = mso_configure_trigger(sdi);
414 if (ret != SR_OK)
415 return ret;
416
df92e5cf 417 /* END of config hardware part */
00b44ccb
UH
418 ret = mso_arm(sdi);
419 if (ret != SR_OK)
420 return ret;
df92e5cf 421
422 /* Start acquisition on the device. */
4db2aaff 423 mso_check_trigger(devc->serial, &devc->trigger_state);
424 ret = mso_check_trigger(devc->serial, NULL);
df92e5cf 425 if (ret != SR_OK)
426 return ret;
427
365f04d6 428 /* Reset trigger state. */
429 devc->trigger_state = 0x00;
430
695dc859 431 std_session_send_df_header(sdi, LOG_PREFIX);
df92e5cf 432
ba7dd8bb 433 /* Our first channel is analog, the other 8 are of type 'logic'. */
365f04d6 434 /* TODO. */
435
102f1239 436 serial_source_add(sdi->session, devc->serial, G_IO_IN, -1,
695dc859 437 mso_receive_data, sdi);
df92e5cf 438
439 return SR_OK;
440}
441
087a9161 442/* This stops acquisition on ALL devices, ignoring dev_index. */
695dc859 443static int dev_acquisition_stop(struct sr_dev_inst *sdi)
df92e5cf 444{
df92e5cf 445 stop_acquisition(sdi);
446
447 return SR_OK;
448}
449
dd5c48a6 450static struct sr_dev_driver link_mso19_driver_info = {
df92e5cf 451 .name = "link-mso19",
452 .longname = "Link Instruments MSO-19",
453 .api_version = 1,
c2fdcc25 454 .init = std_init,
700d6b64 455 .cleanup = std_cleanup,
6078d2c9 456 .scan = scan,
c01bf34c 457 .dev_list = std_dev_list,
eea49cf1 458 .dev_clear = dev_clear,
035a1078
BV
459 .config_get = config_get,
460 .config_set = config_set,
a1c743fc 461 .config_list = config_list,
6078d2c9 462 .dev_open = dev_open,
bf2c987f 463 .dev_close = std_serial_dev_close,
6078d2c9
UH
464 .dev_acquisition_start = dev_acquisition_start,
465 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 466 .context = NULL,
df92e5cf 467};
dd5c48a6 468SR_REGISTER_DEV_DRIVER(link_mso19_driver_info);