]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.com> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <config.h> | |
21 | #include <glib.h> | |
22 | #include <libusb.h> | |
23 | #include <stdlib.h> | |
24 | #include <string.h> | |
25 | #include <libsigrok/libsigrok.h> | |
26 | #include "libsigrok-internal.h" | |
27 | #include "protocol.h" | |
28 | ||
29 | static const uint32_t scanopts[] = { | |
30 | SR_CONF_CONN, | |
31 | }; | |
32 | ||
33 | static const uint32_t devopts[] = { | |
34 | SR_CONF_LOGIC_ANALYZER, | |
35 | SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET, | |
36 | SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET, | |
37 | SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
38 | SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET, | |
39 | SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
40 | SR_CONF_TRIGGER_MATCH | SR_CONF_LIST, | |
41 | SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
42 | SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
43 | }; | |
44 | ||
45 | static const int32_t trigger_matches[] = { | |
46 | SR_TRIGGER_ZERO, | |
47 | SR_TRIGGER_ONE, | |
48 | SR_TRIGGER_RISING, | |
49 | SR_TRIGGER_FALLING, | |
50 | }; | |
51 | ||
52 | /* The hardware supports more samplerates than these, but these are the | |
53 | * options hardcoded into the vendor's Windows GUI. | |
54 | */ | |
55 | static const uint64_t samplerates[] = { | |
56 | SR_MHZ(125), SR_MHZ(100), | |
57 | SR_MHZ(50), SR_MHZ(20), SR_MHZ(10), | |
58 | SR_MHZ(5), SR_MHZ(2), SR_MHZ(1), | |
59 | SR_KHZ(500), SR_KHZ(200), SR_KHZ(100), | |
60 | SR_KHZ(50), SR_KHZ(20), SR_KHZ(10), | |
61 | SR_KHZ(5), SR_KHZ(2), SR_KHZ(1), | |
62 | SR_HZ(500), SR_HZ(200), SR_HZ(100), | |
63 | }; | |
64 | ||
65 | /* Names assigned to available trigger sources. Indices must match | |
66 | * trigger_source enum values. | |
67 | */ | |
68 | static const char *const trigger_source_names[] = { "CH", "TRG" }; | |
69 | ||
70 | /* Names assigned to available trigger slope choices. Indices must | |
71 | * match the signal_edge enum values. | |
72 | */ | |
73 | static const char *const signal_edge_names[] = { "r", "f" }; | |
74 | ||
75 | SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info; | |
76 | static struct sr_dev_driver *const di = &sysclk_lwla_driver_info; | |
77 | ||
78 | static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx) | |
79 | { | |
80 | return std_init(sr_ctx, di, LOG_PREFIX); | |
81 | } | |
82 | ||
83 | static struct sr_dev_inst *dev_inst_new(void) | |
84 | { | |
85 | struct sr_dev_inst *sdi; | |
86 | struct dev_context *devc; | |
87 | int i; | |
88 | char name[8]; | |
89 | ||
90 | /* Allocate memory for our private driver context. */ | |
91 | devc = g_malloc0(sizeof(struct dev_context)); | |
92 | ||
93 | /* Register the device with libsigrok. */ | |
94 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
95 | sdi->status = SR_ST_INACTIVE; | |
96 | sdi->vendor = g_strdup(VENDOR_NAME); | |
97 | sdi->model = g_strdup(MODEL_NAME); | |
98 | ||
99 | /* Enable all channels to match the default channel configuration. */ | |
100 | devc->channel_mask = ALL_CHANNELS_MASK; | |
101 | devc->samplerate = DEFAULT_SAMPLERATE; | |
102 | ||
103 | sdi->priv = devc; | |
104 | for (i = 0; i < NUM_CHANNELS; ++i) { | |
105 | /* The LWLA series simply number channels from CH1 to CHxx. */ | |
106 | g_snprintf(name, sizeof(name), "CH%d", i + 1); | |
107 | sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name); | |
108 | } | |
109 | ||
110 | return sdi; | |
111 | } | |
112 | ||
113 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
114 | { | |
115 | GSList *usb_devices, *devices, *node; | |
116 | struct drv_context *drvc; | |
117 | struct sr_dev_inst *sdi; | |
118 | struct sr_usb_dev_inst *usb; | |
119 | struct sr_config *src; | |
120 | const char *conn; | |
121 | ||
122 | drvc = di->context; | |
123 | conn = USB_VID_PID; | |
124 | ||
125 | for (node = options; node != NULL; node = node->next) { | |
126 | src = node->data; | |
127 | if (src->key == SR_CONF_CONN) { | |
128 | conn = g_variant_get_string(src->data, NULL); | |
129 | break; | |
130 | } | |
131 | } | |
132 | usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn); | |
133 | devices = NULL; | |
134 | ||
135 | for (node = usb_devices; node != NULL; node = node->next) { | |
136 | usb = node->data; | |
137 | ||
138 | /* Create sigrok device instance. */ | |
139 | sdi = dev_inst_new(); | |
140 | if (!sdi) { | |
141 | sr_usb_dev_inst_free(usb); | |
142 | continue; | |
143 | } | |
144 | sdi->driver = di; | |
145 | sdi->inst_type = SR_INST_USB; | |
146 | sdi->conn = usb; | |
147 | ||
148 | /* Register device instance with driver. */ | |
149 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
150 | devices = g_slist_append(devices, sdi); | |
151 | } | |
152 | ||
153 | g_slist_free(usb_devices); | |
154 | ||
155 | return devices; | |
156 | } | |
157 | ||
158 | static GSList *dev_list(const struct sr_dev_driver *di) | |
159 | { | |
160 | struct drv_context *drvc; | |
161 | ||
162 | drvc = di->context; | |
163 | ||
164 | return drvc->instances; | |
165 | } | |
166 | ||
167 | static void clear_dev_context(void *priv) | |
168 | { | |
169 | struct dev_context *devc; | |
170 | ||
171 | devc = priv; | |
172 | ||
173 | sr_dbg("Device context cleared."); | |
174 | ||
175 | lwla_free_acquisition_state(devc->acquisition); | |
176 | g_free(devc); | |
177 | } | |
178 | ||
179 | static int dev_clear(const struct sr_dev_driver *di) | |
180 | { | |
181 | return std_dev_clear(di, &clear_dev_context); | |
182 | } | |
183 | ||
184 | static int dev_open(struct sr_dev_inst *sdi) | |
185 | { | |
186 | struct drv_context *drvc; | |
187 | struct sr_usb_dev_inst *usb; | |
188 | int ret; | |
189 | ||
190 | drvc = di->context; | |
191 | ||
192 | if (!drvc) { | |
193 | sr_err("Driver was not initialized."); | |
194 | return SR_ERR; | |
195 | } | |
196 | ||
197 | usb = sdi->conn; | |
198 | ||
199 | ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb); | |
200 | if (ret != SR_OK) | |
201 | return ret; | |
202 | ||
203 | ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE); | |
204 | if (ret < 0) { | |
205 | sr_err("Failed to claim interface: %s.", | |
206 | libusb_error_name(ret)); | |
207 | return SR_ERR; | |
208 | } | |
209 | ||
210 | sdi->status = SR_ST_INITIALIZING; | |
211 | ||
212 | ret = lwla_init_device(sdi); | |
213 | ||
214 | if (ret == SR_OK) | |
215 | sdi->status = SR_ST_ACTIVE; | |
216 | ||
217 | return ret; | |
218 | } | |
219 | ||
220 | static int dev_close(struct sr_dev_inst *sdi) | |
221 | { | |
222 | struct sr_usb_dev_inst *usb; | |
223 | ||
224 | if (!di->context) { | |
225 | sr_err("Driver was not initialized."); | |
226 | return SR_ERR; | |
227 | } | |
228 | ||
229 | usb = sdi->conn; | |
230 | if (!usb->devhdl) | |
231 | return SR_OK; | |
232 | ||
233 | sdi->status = SR_ST_INACTIVE; | |
234 | ||
235 | /* Trigger download of the shutdown bitstream. */ | |
236 | if (lwla_set_clock_config(sdi) != SR_OK) | |
237 | sr_err("Unable to shut down device."); | |
238 | ||
239 | libusb_release_interface(usb->devhdl, USB_INTERFACE); | |
240 | libusb_close(usb->devhdl); | |
241 | ||
242 | usb->devhdl = NULL; | |
243 | ||
244 | return SR_OK; | |
245 | } | |
246 | ||
247 | static int cleanup(const struct sr_dev_driver *di) | |
248 | { | |
249 | return dev_clear(di); | |
250 | } | |
251 | ||
252 | static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, | |
253 | const struct sr_channel_group *cg) | |
254 | { | |
255 | struct dev_context *devc; | |
256 | size_t idx; | |
257 | ||
258 | (void)cg; | |
259 | ||
260 | if (!sdi) | |
261 | return SR_ERR_ARG; | |
262 | ||
263 | devc = sdi->priv; | |
264 | ||
265 | switch (key) { | |
266 | case SR_CONF_SAMPLERATE: | |
267 | *data = g_variant_new_uint64(devc->samplerate); | |
268 | break; | |
269 | case SR_CONF_LIMIT_MSEC: | |
270 | *data = g_variant_new_uint64(devc->limit_msec); | |
271 | break; | |
272 | case SR_CONF_LIMIT_SAMPLES: | |
273 | *data = g_variant_new_uint64(devc->limit_samples); | |
274 | break; | |
275 | case SR_CONF_EXTERNAL_CLOCK: | |
276 | *data = g_variant_new_boolean(devc->cfg_clock_source | |
277 | == CLOCK_EXT_CLK); | |
278 | break; | |
279 | case SR_CONF_CLOCK_EDGE: | |
280 | idx = devc->cfg_clock_edge; | |
281 | if (idx >= ARRAY_SIZE(signal_edge_names)) | |
282 | return SR_ERR_BUG; | |
283 | *data = g_variant_new_string(signal_edge_names[idx]); | |
284 | break; | |
285 | case SR_CONF_TRIGGER_SOURCE: | |
286 | idx = devc->cfg_trigger_source; | |
287 | if (idx >= ARRAY_SIZE(trigger_source_names)) | |
288 | return SR_ERR_BUG; | |
289 | *data = g_variant_new_string(trigger_source_names[idx]); | |
290 | break; | |
291 | case SR_CONF_TRIGGER_SLOPE: | |
292 | idx = devc->cfg_trigger_slope; | |
293 | if (idx >= ARRAY_SIZE(signal_edge_names)) | |
294 | return SR_ERR_BUG; | |
295 | *data = g_variant_new_string(signal_edge_names[idx]); | |
296 | break; | |
297 | default: | |
298 | return SR_ERR_NA; | |
299 | } | |
300 | ||
301 | return SR_OK; | |
302 | } | |
303 | ||
304 | /* Helper for mapping a string-typed configuration value to an index | |
305 | * within a table of possible values. | |
306 | */ | |
307 | static int lookup_index(GVariant *value, const char *const *table, int len) | |
308 | { | |
309 | const char *entry; | |
310 | int i; | |
311 | ||
312 | entry = g_variant_get_string(value, NULL); | |
313 | if (!entry) | |
314 | return -1; | |
315 | ||
316 | /* Linear search is fine for very small tables. */ | |
317 | for (i = 0; i < len; ++i) { | |
318 | if (strcmp(entry, table[i]) == 0) | |
319 | return i; | |
320 | } | |
321 | return -1; | |
322 | } | |
323 | ||
324 | static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, | |
325 | const struct sr_channel_group *cg) | |
326 | { | |
327 | uint64_t value; | |
328 | struct dev_context *devc; | |
329 | int idx; | |
330 | ||
331 | (void)cg; | |
332 | ||
333 | devc = sdi->priv; | |
334 | if (!devc) | |
335 | return SR_ERR_DEV_CLOSED; | |
336 | ||
337 | switch (key) { | |
338 | case SR_CONF_SAMPLERATE: | |
339 | value = g_variant_get_uint64(data); | |
340 | if (value < samplerates[ARRAY_SIZE(samplerates) - 1] | |
341 | || value > samplerates[0]) | |
342 | return SR_ERR_SAMPLERATE; | |
343 | devc->samplerate = value; | |
344 | break; | |
345 | case SR_CONF_LIMIT_MSEC: | |
346 | value = g_variant_get_uint64(data); | |
347 | if (value > MAX_LIMIT_MSEC) | |
348 | return SR_ERR_ARG; | |
349 | devc->limit_msec = value; | |
350 | break; | |
351 | case SR_CONF_LIMIT_SAMPLES: | |
352 | value = g_variant_get_uint64(data); | |
353 | if (value > MAX_LIMIT_SAMPLES) | |
354 | return SR_ERR_ARG; | |
355 | devc->limit_samples = value; | |
356 | break; | |
357 | case SR_CONF_EXTERNAL_CLOCK: | |
358 | devc->cfg_clock_source = (g_variant_get_boolean(data)) | |
359 | ? CLOCK_EXT_CLK : CLOCK_INTERNAL; | |
360 | break; | |
361 | case SR_CONF_CLOCK_EDGE: | |
362 | idx = lookup_index(data, signal_edge_names, | |
363 | ARRAY_SIZE(signal_edge_names)); | |
364 | if (idx < 0) | |
365 | return SR_ERR_ARG; | |
366 | devc->cfg_clock_edge = idx; | |
367 | break; | |
368 | case SR_CONF_TRIGGER_SOURCE: | |
369 | idx = lookup_index(data, trigger_source_names, | |
370 | ARRAY_SIZE(trigger_source_names)); | |
371 | if (idx < 0) | |
372 | return SR_ERR_ARG; | |
373 | devc->cfg_trigger_source = idx; | |
374 | break; | |
375 | case SR_CONF_TRIGGER_SLOPE: | |
376 | idx = lookup_index(data, signal_edge_names, | |
377 | ARRAY_SIZE(signal_edge_names)); | |
378 | if (idx < 0) | |
379 | return SR_ERR_ARG; | |
380 | devc->cfg_trigger_slope = idx; | |
381 | break; | |
382 | default: | |
383 | return SR_ERR_NA; | |
384 | } | |
385 | ||
386 | return SR_OK; | |
387 | } | |
388 | ||
389 | static int config_channel_set(const struct sr_dev_inst *sdi, | |
390 | struct sr_channel *ch, unsigned int changes) | |
391 | { | |
392 | uint64_t channel_bit; | |
393 | struct dev_context *devc; | |
394 | ||
395 | devc = sdi->priv; | |
396 | if (!devc) | |
397 | return SR_ERR_DEV_CLOSED; | |
398 | ||
399 | if (ch->index < 0 || ch->index >= NUM_CHANNELS) { | |
400 | sr_err("Channel index %d out of range.", ch->index); | |
401 | return SR_ERR_BUG; | |
402 | } | |
403 | channel_bit = (uint64_t)1 << ch->index; | |
404 | ||
405 | if ((changes & SR_CHANNEL_SET_ENABLED) != 0) { | |
406 | /* Enable or disable input channel for this channel. */ | |
407 | if (ch->enabled) | |
408 | devc->channel_mask |= channel_bit; | |
409 | else | |
410 | devc->channel_mask &= ~channel_bit; | |
411 | } | |
412 | ||
413 | return SR_OK; | |
414 | } | |
415 | ||
416 | static int config_commit(const struct sr_dev_inst *sdi) | |
417 | { | |
418 | if (sdi->status != SR_ST_ACTIVE) { | |
419 | sr_err("Device not ready (status %d).", (int)sdi->status); | |
420 | return SR_ERR; | |
421 | } | |
422 | ||
423 | return lwla_set_clock_config(sdi); | |
424 | } | |
425 | ||
426 | static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, | |
427 | const struct sr_channel_group *cg) | |
428 | { | |
429 | GVariant *gvar; | |
430 | GVariantBuilder gvb; | |
431 | ||
432 | (void)sdi; | |
433 | (void)cg; | |
434 | ||
435 | switch (key) { | |
436 | case SR_CONF_SCAN_OPTIONS: | |
437 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
438 | scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); | |
439 | break; | |
440 | case SR_CONF_DEVICE_OPTIONS: | |
441 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
442 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); | |
443 | break; | |
444 | case SR_CONF_SAMPLERATE: | |
445 | g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}")); | |
446 | gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), | |
447 | samplerates, ARRAY_SIZE(samplerates), | |
448 | sizeof(uint64_t)); | |
449 | g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar); | |
450 | *data = g_variant_builder_end(&gvb); | |
451 | break; | |
452 | case SR_CONF_TRIGGER_MATCH: | |
453 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, | |
454 | trigger_matches, ARRAY_SIZE(trigger_matches), | |
455 | sizeof(int32_t)); | |
456 | break; | |
457 | case SR_CONF_TRIGGER_SOURCE: | |
458 | *data = g_variant_new_strv(trigger_source_names, | |
459 | ARRAY_SIZE(trigger_source_names)); | |
460 | break; | |
461 | case SR_CONF_TRIGGER_SLOPE: | |
462 | case SR_CONF_CLOCK_EDGE: | |
463 | *data = g_variant_new_strv(signal_edge_names, | |
464 | ARRAY_SIZE(signal_edge_names)); | |
465 | break; | |
466 | default: | |
467 | return SR_ERR_NA; | |
468 | } | |
469 | ||
470 | return SR_OK; | |
471 | } | |
472 | ||
473 | static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data) | |
474 | { | |
475 | struct drv_context *drvc; | |
476 | struct dev_context *devc; | |
477 | struct acquisition_state *acq; | |
478 | int ret; | |
479 | ||
480 | (void)cb_data; | |
481 | ||
482 | if (sdi->status != SR_ST_ACTIVE) | |
483 | return SR_ERR_DEV_CLOSED; | |
484 | ||
485 | devc = sdi->priv; | |
486 | drvc = di->context; | |
487 | ||
488 | if (devc->acquisition) { | |
489 | sr_err("Acquisition still in progress?"); | |
490 | return SR_ERR; | |
491 | } | |
492 | acq = lwla_alloc_acquisition_state(); | |
493 | if (!acq) | |
494 | return SR_ERR_MALLOC; | |
495 | ||
496 | devc->stopping_in_progress = FALSE; | |
497 | devc->transfer_error = FALSE; | |
498 | ||
499 | sr_info("Starting acquisition."); | |
500 | ||
501 | devc->acquisition = acq; | |
502 | lwla_convert_trigger(sdi); | |
503 | ret = lwla_setup_acquisition(sdi); | |
504 | if (ret != SR_OK) { | |
505 | sr_err("Failed to set up acquisition."); | |
506 | devc->acquisition = NULL; | |
507 | lwla_free_acquisition_state(acq); | |
508 | return ret; | |
509 | } | |
510 | ||
511 | ret = lwla_start_acquisition(sdi); | |
512 | if (ret != SR_OK) { | |
513 | sr_err("Failed to start acquisition."); | |
514 | devc->acquisition = NULL; | |
515 | lwla_free_acquisition_state(acq); | |
516 | return ret; | |
517 | } | |
518 | usb_source_add(sdi->session, drvc->sr_ctx, 100, &lwla_receive_data, | |
519 | (struct sr_dev_inst *)sdi); | |
520 | ||
521 | sr_info("Waiting for data."); | |
522 | ||
523 | /* Send header packet to the session bus. */ | |
524 | std_session_send_df_header(sdi, LOG_PREFIX); | |
525 | ||
526 | return SR_OK; | |
527 | } | |
528 | ||
529 | static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) | |
530 | { | |
531 | (void)cb_data; | |
532 | ||
533 | if (sdi->status != SR_ST_ACTIVE) | |
534 | return SR_ERR_DEV_CLOSED; | |
535 | ||
536 | sr_dbg("Stopping acquisition."); | |
537 | ||
538 | sdi->status = SR_ST_STOPPING; | |
539 | ||
540 | return SR_OK; | |
541 | } | |
542 | ||
543 | SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = { | |
544 | .name = "sysclk-lwla", | |
545 | .longname = "SysClk LWLA series", | |
546 | .api_version = 1, | |
547 | .init = init, | |
548 | .cleanup = cleanup, | |
549 | .scan = scan, | |
550 | .dev_list = dev_list, | |
551 | .dev_clear = dev_clear, | |
552 | .config_get = config_get, | |
553 | .config_set = config_set, | |
554 | .config_channel_set = config_channel_set, | |
555 | .config_commit = config_commit, | |
556 | .config_list = config_list, | |
557 | .dev_open = dev_open, | |
558 | .dev_close = dev_close, | |
559 | .dev_acquisition_start = dev_acquisition_start, | |
560 | .dev_acquisition_stop = dev_acquisition_stop, | |
561 | .context = NULL, | |
562 | }; |