]> sigrok.org Git - libsigrok.git/blob - src/hardware/sysclk-lwla/api.c
drivers: Drop unneeded or duplicate comments.
[libsigrok.git] / src / hardware / sysclk-lwla / api.c
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 drvopts[] = {
34         SR_CONF_LOGIC_ANALYZER,
35 };
36
37 static const int32_t trigger_matches[] = {
38         SR_TRIGGER_ZERO,
39         SR_TRIGGER_ONE,
40         SR_TRIGGER_RISING,
41         SR_TRIGGER_FALLING,
42 };
43
44 static const char *const trigger_source_names[] = {
45         [TRIGGER_CHANNELS] = "CH",
46         [TRIGGER_EXT_TRG] = "TRG",
47 };
48
49 static const char *const signal_edge_names[] = {
50         [EDGE_POSITIVE] = "r",
51         [EDGE_NEGATIVE] = "f",
52 };
53
54 static struct sr_dev_inst *dev_inst_new(const struct model_info *model)
55 {
56         struct sr_dev_inst *sdi;
57         struct dev_context *devc;
58         int i;
59         char name[8];
60
61         devc = g_malloc0(sizeof(struct dev_context));
62         devc->model = model;
63         devc->active_fpga_config = FPGA_NOCONF;
64         devc->cfg_rle = TRUE;
65         devc->samplerate = model->samplerates[0];
66         devc->channel_mask = (UINT64_C(1) << model->num_channels) - 1;
67
68         sdi = g_malloc0(sizeof(struct sr_dev_inst));
69         sdi->status = SR_ST_INACTIVE;
70         sdi->vendor = g_strdup(VENDOR_NAME);
71         sdi->model = g_strdup(model->name);
72         sdi->priv = devc;
73
74         for (i = 0; i < model->num_channels; i++) {
75                 g_snprintf(name, sizeof(name), "CH%d", i + 1);
76                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
77         }
78
79         return sdi;
80 }
81
82 /* Create a new device instance for a libusb device if it is a SysClk LWLA
83  * device and also matches the connection specification.
84  */
85 static struct sr_dev_inst *dev_inst_new_matching(GSList *conn_matches,
86                                                  libusb_device *dev)
87 {
88         GSList *node;
89         struct sr_usb_dev_inst *usb;
90         const struct model_info *model;
91         struct sr_dev_inst *sdi;
92         struct libusb_device_descriptor des;
93         int bus, address, ret;
94         unsigned int vid, pid;
95
96         bus = libusb_get_bus_number(dev);
97         address = libusb_get_device_address(dev);
98
99         for (node = conn_matches; node != NULL; node = node->next) {
100                 usb = node->data;
101                 if (usb && usb->bus == bus && usb->address == address)
102                         break; /* found */
103         }
104         if (conn_matches && !node)
105                 return NULL; /* no match */
106
107         ret = libusb_get_device_descriptor(dev, &des);
108         if (ret != 0) {
109                 sr_err("Failed to get USB device descriptor: %s.",
110                         libusb_error_name(ret));
111                 return NULL;
112         }
113         vid = des.idVendor;
114         pid = des.idProduct;
115
116         /* Create sigrok device instance. */
117         if (vid == USB_VID_SYSCLK && pid == USB_PID_LWLA1016) {
118                 model = &lwla1016_info;
119         } else if (vid == USB_VID_SYSCLK && pid == USB_PID_LWLA1034) {
120                 model = &lwla1034_info;
121         } else {
122                 if (conn_matches)
123                         sr_warn("USB device %d.%d (%04x:%04x) is not a"
124                                 " SysClk LWLA.", bus, address, vid, pid);
125                 return NULL;
126         }
127         sdi = dev_inst_new(model);
128
129         sdi->inst_type = SR_INST_USB;
130         sdi->conn = sr_usb_dev_inst_new(bus, address, NULL);
131
132         return sdi;
133 }
134
135 static GSList *scan(struct sr_dev_driver *di, GSList *options)
136 {
137         GSList *conn_devices, *devices, *node;
138         struct drv_context *drvc;
139         struct sr_dev_inst *sdi;
140         struct sr_config *src;
141         const char *conn;
142         libusb_device **devlist;
143         ssize_t num_devs, i;
144
145         drvc = di->context;
146         conn = NULL;
147         conn_devices = NULL;
148         devices = NULL;
149
150         for (node = options; node != NULL; node = node->next) {
151                 src = node->data;
152                 if (src->key == SR_CONF_CONN) {
153                         conn = g_variant_get_string(src->data, NULL);
154                         break;
155                 }
156         }
157         if (conn) {
158                 /* Find devices matching the connection specification. */
159                 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
160         }
161
162         /* List all libusb devices. */
163         num_devs = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
164         if (num_devs < 0) {
165                 sr_err("Failed to list USB devices: %s.",
166                         libusb_error_name(num_devs));
167                 g_slist_free_full(conn_devices,
168                         (GDestroyNotify)&sr_usb_dev_inst_free);
169                 return NULL;
170         }
171
172         /* Scan the USB device list for matching LWLA devices. */
173         for (i = 0; i < num_devs; i++) {
174                 sdi = dev_inst_new_matching(conn_devices, devlist[i]);
175                 if (!sdi)
176                         continue; /* no match */
177
178                 /* Register device instance with driver. */
179                 devices = g_slist_append(devices, sdi);
180         }
181
182         libusb_free_device_list(devlist, 1);
183         g_slist_free_full(conn_devices, (GDestroyNotify)&sr_usb_dev_inst_free);
184
185         return std_scan_complete(di, devices);
186 }
187
188 /* Drain any pending data from the USB transfer buffers on the device.
189  * This may be necessary e.g. after a crash or generally to clean up after
190  * an abnormal condition.
191  */
192 static int drain_usb(struct sr_usb_dev_inst *usb, unsigned int endpoint)
193 {
194         int drained, xfer_len, ret;
195         unsigned char buf[512];
196         const unsigned int drain_timeout_ms = 10;
197
198         drained = 0;
199         do {
200                 xfer_len = 0;
201                 ret = libusb_bulk_transfer(usb->devhdl, endpoint,
202                                            buf, sizeof(buf), &xfer_len,
203                                            drain_timeout_ms);
204                 drained += xfer_len;
205         } while (ret == LIBUSB_SUCCESS && xfer_len != 0);
206
207         if (ret != LIBUSB_SUCCESS && ret != LIBUSB_ERROR_TIMEOUT) {
208                 sr_err("Failed to drain USB endpoint %u: %s.",
209                        endpoint & (LIBUSB_ENDPOINT_IN - 1),
210                        libusb_error_name(ret));
211                 return SR_ERR;
212         }
213         if (drained > 0) {
214                 sr_warn("Drained %d bytes from USB endpoint %u.",
215                         drained, endpoint & (LIBUSB_ENDPOINT_IN - 1));
216         }
217
218         return SR_OK;
219 }
220
221 static int dev_open(struct sr_dev_inst *sdi)
222 {
223         struct drv_context *drvc;
224         struct dev_context *devc;
225         struct sr_usb_dev_inst *usb;
226         int i, ret;
227
228         drvc = sdi->driver->context;
229         devc = sdi->priv;
230         usb = sdi->conn;
231
232         /* Try the whole shebang three times, fingers crossed. */
233         for (i = 0; i < 3; i++) {
234                 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
235                 if (ret != SR_OK)
236                         return ret;
237
238                 ret = libusb_set_configuration(usb->devhdl, USB_CONFIG);
239                 if (ret != LIBUSB_SUCCESS) {
240                         sr_err("Failed to set USB configuration: %s.",
241                                 libusb_error_name(ret));
242                         sr_usb_close(usb);
243                         return SR_ERR;
244                 }
245
246                 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
247                 if (ret != LIBUSB_SUCCESS) {
248                         sr_err("Failed to claim interface: %s.",
249                                 libusb_error_name(ret));
250                         sr_usb_close(usb);
251                         return SR_ERR;
252                 }
253
254                 ret = drain_usb(usb, EP_REPLY);
255                 if (ret != SR_OK) {
256                         sr_usb_close(usb);
257                         return ret;
258                 }
259                 /* This delay appears to be necessary for reliable operation. */
260                 g_usleep(30 * 1000);
261
262                 devc->active_fpga_config = FPGA_NOCONF;
263                 devc->short_transfer_quirk = FALSE;
264                 devc->state = STATE_IDLE;
265
266                 ret = (*devc->model->apply_fpga_config)(sdi);
267
268                 if (ret == SR_OK)
269                         ret = (*devc->model->device_init_check)(sdi);
270                 if (ret == SR_OK)
271                         break;
272
273                 /* Rinse and repeat. */
274                 sr_usb_close(usb);
275         }
276
277         if (ret == SR_OK && devc->short_transfer_quirk)
278                 sr_warn("Short transfer quirk detected! "
279                         "Memory reads will be slow.");
280         return ret;
281 }
282
283 static int dev_close(struct sr_dev_inst *sdi)
284 {
285         struct dev_context *devc;
286         struct sr_usb_dev_inst *usb;
287         int ret;
288
289         devc = sdi->priv;
290         usb = sdi->conn;
291
292         if (devc->acquisition) {
293                 sr_err("Cannot close device during acquisition!");
294                 /* Request stop, leak handle, and prepare for the worst. */
295                 devc->cancel_requested = TRUE;
296                 return SR_ERR_BUG;
297         }
298
299         /* Download of the shutdown bitstream, if any. */
300         ret = (*devc->model->apply_fpga_config)(sdi);
301         if (ret != SR_OK)
302                 sr_warn("Unable to shut down device.");
303
304         libusb_release_interface(usb->devhdl, USB_INTERFACE);
305
306         sr_usb_close(usb);
307
308         return SR_OK;
309 }
310
311 /* Check whether the device options contain a specific key.
312  * Also match against get/set/list bits if specified.
313  */
314 static int has_devopt(const struct model_info *model, uint32_t key)
315 {
316         unsigned int i;
317
318         for (i = 0; i < model->num_devopts; i++) {
319                 if ((model->devopts[i] & (SR_CONF_MASK | key)) == key)
320                         return TRUE;
321         }
322
323         return FALSE;
324 }
325
326 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
327                       const struct sr_channel_group *cg)
328 {
329         struct dev_context *devc;
330         unsigned int idx;
331
332         (void)cg;
333
334         if (!sdi)
335                 return SR_ERR_ARG;
336
337         devc = sdi->priv;
338
339         if (!has_devopt(devc->model, key | SR_CONF_GET))
340                 return SR_ERR_NA;
341
342         switch (key) {
343         case SR_CONF_SAMPLERATE:
344                 *data = g_variant_new_uint64(devc->samplerate);
345                 break;
346         case SR_CONF_LIMIT_MSEC:
347                 *data = g_variant_new_uint64(devc->limit_msec);
348                 break;
349         case SR_CONF_LIMIT_SAMPLES:
350                 *data = g_variant_new_uint64(devc->limit_samples);
351                 break;
352         case SR_CONF_RLE:
353                 *data = g_variant_new_boolean(devc->cfg_rle);
354                 break;
355         case SR_CONF_EXTERNAL_CLOCK:
356                 *data = g_variant_new_boolean(devc->cfg_clock_source
357                                                 == CLOCK_EXT_CLK);
358                 break;
359         case SR_CONF_CLOCK_EDGE:
360                 idx = devc->cfg_clock_edge;
361                 if (idx >= ARRAY_SIZE(signal_edge_names))
362                         return SR_ERR_BUG;
363                 *data = g_variant_new_string(signal_edge_names[idx]);
364                 break;
365         case SR_CONF_TRIGGER_SOURCE:
366                 idx = devc->cfg_trigger_source;
367                 if (idx >= ARRAY_SIZE(trigger_source_names))
368                         return SR_ERR_BUG;
369                 *data = g_variant_new_string(trigger_source_names[idx]);
370                 break;
371         case SR_CONF_TRIGGER_SLOPE:
372                 idx = devc->cfg_trigger_slope;
373                 if (idx >= ARRAY_SIZE(signal_edge_names))
374                         return SR_ERR_BUG;
375                 *data = g_variant_new_string(signal_edge_names[idx]);
376                 break;
377         default:
378                 /* Must not happen for a key listed in devopts. */
379                 return SR_ERR_BUG;
380         }
381
382         return SR_OK;
383 }
384
385 /* Helper for mapping a string-typed configuration value to an index
386  * within a table of possible values.
387  */
388 static int lookup_index(GVariant *value, const char *const *table, int len)
389 {
390         const char *entry;
391         int i;
392
393         entry = g_variant_get_string(value, NULL);
394         if (!entry)
395                 return -1;
396
397         /* Linear search is fine for very small tables. */
398         for (i = 0; i < len; i++) {
399                 if (strcmp(entry, table[i]) == 0)
400                         return i;
401         }
402
403         return -1;
404 }
405
406 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
407                       const struct sr_channel_group *cg)
408 {
409         uint64_t value;
410         struct dev_context *devc;
411         int idx;
412
413         (void)cg;
414
415         if (!sdi)
416                 return SR_ERR_ARG;
417
418         devc = sdi->priv;
419
420         if (!has_devopt(devc->model, key | SR_CONF_SET))
421                 return SR_ERR_NA;
422
423         switch (key) {
424         case SR_CONF_SAMPLERATE:
425                 value = g_variant_get_uint64(data);
426                 if (value < devc->model->samplerates[devc->model->num_samplerates - 1]
427                                 || value > devc->model->samplerates[0])
428                         return SR_ERR_SAMPLERATE;
429                 devc->samplerate = value;
430                 break;
431         case SR_CONF_LIMIT_MSEC:
432                 value = g_variant_get_uint64(data);
433                 if (value > MAX_LIMIT_MSEC)
434                         return SR_ERR_ARG;
435                 devc->limit_msec = value;
436                 break;
437         case SR_CONF_LIMIT_SAMPLES:
438                 value = g_variant_get_uint64(data);
439                 if (value > MAX_LIMIT_SAMPLES)
440                         return SR_ERR_ARG;
441                 devc->limit_samples = value;
442                 break;
443         case SR_CONF_RLE:
444                 devc->cfg_rle = g_variant_get_boolean(data);
445                 break;
446         case SR_CONF_EXTERNAL_CLOCK:
447                 devc->cfg_clock_source = (g_variant_get_boolean(data))
448                         ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
449                 break;
450         case SR_CONF_CLOCK_EDGE:
451                 idx = lookup_index(data, signal_edge_names,
452                                    ARRAY_SIZE(signal_edge_names));
453                 if (idx < 0)
454                         return SR_ERR_ARG;
455                 devc->cfg_clock_edge = idx;
456                 break;
457         case SR_CONF_TRIGGER_SOURCE:
458                 idx = lookup_index(data, trigger_source_names,
459                                    ARRAY_SIZE(trigger_source_names));
460                 if (idx < 0)
461                         return SR_ERR_ARG;
462                 devc->cfg_trigger_source = idx;
463                 break;
464         case SR_CONF_TRIGGER_SLOPE:
465                 idx = lookup_index(data, signal_edge_names,
466                                    ARRAY_SIZE(signal_edge_names));
467                 if (idx < 0)
468                         return SR_ERR_ARG;
469                 devc->cfg_trigger_slope = idx;
470                 break;
471         default:
472                 /* Must not happen for a key listed in devopts. */
473                 return SR_ERR_BUG;
474         }
475
476         return SR_OK;
477 }
478
479 static int config_channel_set(const struct sr_dev_inst *sdi,
480                               struct sr_channel *ch, unsigned int changes)
481 {
482         uint64_t channel_bit;
483         struct dev_context *devc;
484
485         if (!sdi)
486                 return SR_ERR_ARG;
487
488         devc = sdi->priv;
489
490         if (ch->index < 0 || ch->index >= devc->model->num_channels) {
491                 sr_err("Channel index %d out of range.", ch->index);
492                 return SR_ERR_BUG;
493         }
494
495         if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
496                 channel_bit = UINT64_C(1) << ch->index;
497
498                 /* Enable or disable logic input for this channel. */
499                 if (ch->enabled)
500                         devc->channel_mask |= channel_bit;
501                 else
502                         devc->channel_mask &= ~channel_bit;
503         }
504
505         return SR_OK;
506 }
507
508 /* Derive trigger masks from the session's trigger configuration. */
509 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
510 {
511         uint64_t trigger_mask, trigger_values, trigger_edge_mask;
512         uint64_t level_bit, type_bit;
513         struct dev_context *devc;
514         struct sr_trigger *trigger;
515         struct sr_trigger_stage *stage;
516         struct sr_trigger_match *match;
517         const GSList *node;
518         int idx;
519         enum sr_trigger_matches trg;
520
521         devc = sdi->priv;
522
523         trigger = sr_session_trigger_get(sdi->session);
524         if (!trigger || !trigger->stages)
525                 return SR_OK;
526
527         if (trigger->stages->next) {
528                 sr_err("This device only supports 1 trigger stage.");
529                 return SR_ERR_ARG;
530         }
531         stage = trigger->stages->data;
532
533         trigger_mask = 0;
534         trigger_values = 0;
535         trigger_edge_mask = 0;
536
537         for (node = stage->matches; node; node = node->next) {
538                 match = node->data;
539
540                 if (!match->channel->enabled)
541                         continue; /* Ignore disabled channel. */
542
543                 idx = match->channel->index;
544                 trg = match->match;
545
546                 if (idx < 0 || idx >= devc->model->num_channels) {
547                         sr_err("Channel index %d out of range.", idx);
548                         return SR_ERR_BUG; /* Should not happen. */
549                 }
550                 if (trg != SR_TRIGGER_ZERO
551                                 && trg != SR_TRIGGER_ONE
552                                 && trg != SR_TRIGGER_RISING
553                                 && trg != SR_TRIGGER_FALLING) {
554                         sr_err("Unsupported trigger match for CH%d.", idx + 1);
555                         return SR_ERR_ARG;
556                 }
557                 level_bit = (trg == SR_TRIGGER_ONE
558                         || trg == SR_TRIGGER_RISING) ? 1 : 0;
559                 type_bit = (trg == SR_TRIGGER_RISING
560                         || trg == SR_TRIGGER_FALLING) ? 1 : 0;
561
562                 trigger_mask |= UINT64_C(1) << idx;
563                 trigger_values |= level_bit << idx;
564                 trigger_edge_mask |= type_bit << idx;
565         }
566         devc->trigger_mask = trigger_mask;
567         devc->trigger_values = trigger_values;
568         devc->trigger_edge_mask = trigger_edge_mask;
569
570         return SR_OK;
571 }
572
573 static int config_commit(const struct sr_dev_inst *sdi)
574 {
575         struct dev_context *devc;
576         int ret;
577
578         devc = sdi->priv;
579
580         if (devc->acquisition) {
581                 sr_err("Acquisition still in progress?");
582                 return SR_ERR;
583         }
584
585         ret = prepare_trigger_masks(sdi);
586         if (ret != SR_OK)
587                 return ret;
588
589         ret = (*devc->model->apply_fpga_config)(sdi);
590         if (ret != SR_OK) {
591                 sr_err("Failed to apply FPGA configuration.");
592                 return ret;
593         }
594
595         return SR_OK;
596 }
597
598 static int config_list(uint32_t key, GVariant **data,
599                        const struct sr_dev_inst *sdi,
600                        const struct sr_channel_group *cg)
601 {
602         struct dev_context *devc;
603         GVariant *gvar;
604         GVariantBuilder gvb;
605
606         devc = (sdi) ? sdi->priv : NULL;
607
608         switch (key) {
609         case SR_CONF_SCAN_OPTIONS:
610         case SR_CONF_DEVICE_OPTIONS:
611                 return std_opts_config_list(key, data, sdi, cg,
612                         scanopts, ARRAY_SIZE(scanopts),
613                         drvopts, ARRAY_SIZE(drvopts),
614                         (devc) ? devc->model->devopts : NULL,
615                         (devc) ? devc->model->num_devopts : 0);
616         }
617
618         if (!has_devopt(devc->model, key | SR_CONF_LIST))
619                 return SR_ERR_NA;
620
621         switch (key) {
622         case SR_CONF_SAMPLERATE:
623                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_VARDICT);
624                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
625                         devc->model->samplerates, devc->model->num_samplerates,
626                         sizeof(devc->model->samplerates[0]));
627                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
628                 *data = g_variant_builder_end(&gvb);
629                 break;
630         case SR_CONF_TRIGGER_MATCH:
631                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
632                         trigger_matches, ARRAY_SIZE(trigger_matches),
633                         sizeof(trigger_matches[0]));
634                 break;
635         case SR_CONF_TRIGGER_SOURCE:
636                 *data = g_variant_new_strv(trigger_source_names,
637                         ARRAY_SIZE(trigger_source_names));
638                 break;
639         case SR_CONF_TRIGGER_SLOPE:
640         case SR_CONF_CLOCK_EDGE:
641                 *data = g_variant_new_strv(signal_edge_names,
642                         ARRAY_SIZE(signal_edge_names));
643                 break;
644         default:
645                 /* Must not happen for a key listed in devopts. */
646                 return SR_ERR_BUG;
647         }
648
649         return SR_OK;
650 }
651
652 /* Set up the device hardware to begin capturing samples as soon as the
653  * configured trigger conditions are met, or immediately if no triggers
654  * are configured.
655  */
656 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
657 {
658         return lwla_start_acquisition(sdi);
659 }
660
661 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
662 {
663         struct dev_context *devc;
664
665         devc = sdi->priv;
666
667         if (devc->state != STATE_IDLE && !devc->cancel_requested) {
668                 devc->cancel_requested = TRUE;
669                 sr_dbg("Requesting cancel.");
670         }
671
672         return SR_OK;
673 }
674
675 static struct sr_dev_driver sysclk_lwla_driver_info = {
676         .name = "sysclk-lwla",
677         .longname = "SysClk LWLA series",
678         .api_version = 1,
679         .init = std_init,
680         .cleanup = std_cleanup,
681         .scan = scan,
682         .dev_list = std_dev_list,
683         .dev_clear = std_dev_clear,
684         .config_get = config_get,
685         .config_set = config_set,
686         .config_channel_set = config_channel_set,
687         .config_commit = config_commit,
688         .config_list = config_list,
689         .dev_open = dev_open,
690         .dev_close = dev_close,
691         .dev_acquisition_start = dev_acquisition_start,
692         .dev_acquisition_stop = dev_acquisition_stop,
693         .context = NULL,
694 };
695 SR_REGISTER_DEV_DRIVER(sysclk_lwla_driver_info);