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