]> sigrok.org Git - libsigrok.git/blob - src/hardware/sysclk-lwla/api.c
231df4dbf270b2181c6f8ea3f7f59e98aa6116f1
[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 *trigger_sources[] = {
45         [TRIGGER_CHANNELS] = "CH",
46         [TRIGGER_EXT_TRG] = "TRG",
47 };
48
49 static const char *signal_edges[] = {
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("SysClk");
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                 sdi->status = SR_ST_ACTIVE;
263
264                 devc->active_fpga_config = FPGA_NOCONF;
265                 devc->short_transfer_quirk = FALSE;
266                 devc->state = STATE_IDLE;
267
268                 ret = (*devc->model->apply_fpga_config)(sdi);
269
270                 if (ret == SR_OK)
271                         ret = (*devc->model->device_init_check)(sdi);
272                 if (ret == SR_OK)
273                         break;
274
275                 /* Rinse and repeat. */
276                 sdi->status = SR_ST_INACTIVE;
277                 sr_usb_close(usb);
278         }
279
280         if (ret == SR_OK && devc->short_transfer_quirk)
281                 sr_warn("Short transfer quirk detected! "
282                         "Memory reads will be slow.");
283         return ret;
284 }
285
286 static int dev_close(struct sr_dev_inst *sdi)
287 {
288         struct dev_context *devc;
289         struct sr_usb_dev_inst *usb;
290         int ret;
291
292         devc = sdi->priv;
293         usb = sdi->conn;
294
295         if (devc->acquisition) {
296                 sr_err("Cannot close device during acquisition!");
297                 /* Request stop, leak handle, and prepare for the worst. */
298                 devc->cancel_requested = TRUE;
299                 return SR_ERR_BUG;
300         }
301
302         /* Download of the shutdown bitstream, if any. */
303         ret = (*devc->model->apply_fpga_config)(sdi);
304         if (ret != SR_OK)
305                 sr_warn("Unable to shut down device.");
306
307         if (usb->devhdl)
308                 libusb_release_interface(usb->devhdl, USB_INTERFACE);
309
310         sr_usb_close(usb);
311
312         return ret;
313 }
314
315 /* Check whether the device options contain a specific key.
316  * Also match against get/set/list bits if specified.
317  */
318 static int has_devopt(const struct model_info *model, uint32_t key)
319 {
320         unsigned int i;
321
322         for (i = 0; i < model->num_devopts; i++) {
323                 if ((model->devopts[i] & (SR_CONF_MASK | key)) == key)
324                         return TRUE;
325         }
326
327         return FALSE;
328 }
329
330 static int config_get(uint32_t key, GVariant **data,
331         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
332 {
333         struct dev_context *devc;
334         unsigned int idx;
335
336         (void)cg;
337
338         if (!sdi)
339                 return SR_ERR_ARG;
340
341         devc = sdi->priv;
342
343         if (!has_devopt(devc->model, key | SR_CONF_GET))
344                 return SR_ERR_NA;
345
346         switch (key) {
347         case SR_CONF_SAMPLERATE:
348                 *data = g_variant_new_uint64(devc->samplerate);
349                 break;
350         case SR_CONF_LIMIT_MSEC:
351                 *data = g_variant_new_uint64(devc->limit_msec);
352                 break;
353         case SR_CONF_LIMIT_SAMPLES:
354                 *data = g_variant_new_uint64(devc->limit_samples);
355                 break;
356         case SR_CONF_RLE:
357                 *data = g_variant_new_boolean(devc->cfg_rle);
358                 break;
359         case SR_CONF_EXTERNAL_CLOCK:
360                 *data = g_variant_new_boolean(devc->cfg_clock_source
361                                                 == CLOCK_EXT_CLK);
362                 break;
363         case SR_CONF_CLOCK_EDGE:
364                 idx = devc->cfg_clock_edge;
365                 if (idx >= ARRAY_SIZE(signal_edges))
366                         return SR_ERR_BUG;
367                 *data = g_variant_new_string(signal_edges[idx]);
368                 break;
369         case SR_CONF_TRIGGER_SOURCE:
370                 idx = devc->cfg_trigger_source;
371                 if (idx >= ARRAY_SIZE(trigger_sources))
372                         return SR_ERR_BUG;
373                 *data = g_variant_new_string(trigger_sources[idx]);
374                 break;
375         case SR_CONF_TRIGGER_SLOPE:
376                 idx = devc->cfg_trigger_slope;
377                 if (idx >= ARRAY_SIZE(signal_edges))
378                         return SR_ERR_BUG;
379                 *data = g_variant_new_string(signal_edges[idx]);
380                 break;
381         default:
382                 /* Must not happen for a key listed in devopts. */
383                 return SR_ERR_BUG;
384         }
385
386         return SR_OK;
387 }
388
389 static int config_set(uint32_t key, GVariant *data,
390         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
391 {
392         uint64_t value;
393         struct dev_context *devc;
394         int idx;
395
396         (void)cg;
397
398         if (!sdi)
399                 return SR_ERR_ARG;
400
401         devc = sdi->priv;
402
403         if (!has_devopt(devc->model, key | SR_CONF_SET))
404                 return SR_ERR_NA;
405
406         switch (key) {
407         case SR_CONF_SAMPLERATE:
408                 value = g_variant_get_uint64(data);
409                 if (value < devc->model->samplerates[devc->model->num_samplerates - 1]
410                                 || value > devc->model->samplerates[0])
411                         return SR_ERR_SAMPLERATE;
412                 devc->samplerate = value;
413                 break;
414         case SR_CONF_LIMIT_MSEC:
415                 value = g_variant_get_uint64(data);
416                 if (value > MAX_LIMIT_MSEC)
417                         return SR_ERR_ARG;
418                 devc->limit_msec = value;
419                 break;
420         case SR_CONF_LIMIT_SAMPLES:
421                 value = g_variant_get_uint64(data);
422                 if (value > MAX_LIMIT_SAMPLES)
423                         return SR_ERR_ARG;
424                 devc->limit_samples = value;
425                 break;
426         case SR_CONF_RLE:
427                 devc->cfg_rle = g_variant_get_boolean(data);
428                 break;
429         case SR_CONF_EXTERNAL_CLOCK:
430                 devc->cfg_clock_source = (g_variant_get_boolean(data))
431                         ? CLOCK_EXT_CLK : CLOCK_INTERNAL;
432                 break;
433         case SR_CONF_CLOCK_EDGE:
434                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(signal_edges))) < 0)
435                         return SR_ERR_ARG;
436                 devc->cfg_clock_edge = idx;
437                 break;
438         case SR_CONF_TRIGGER_SOURCE:
439                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_sources))) < 0)
440                         return SR_ERR_ARG;
441                 devc->cfg_trigger_source = idx;
442                 break;
443         case SR_CONF_TRIGGER_SLOPE:
444                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(signal_edges))) < 0)
445                         return SR_ERR_ARG;
446                 devc->cfg_trigger_slope = idx;
447                 break;
448         default:
449                 /* Must not happen for a key listed in devopts. */
450                 return SR_ERR_BUG;
451         }
452
453         return SR_OK;
454 }
455
456 static int config_channel_set(const struct sr_dev_inst *sdi,
457         struct sr_channel *ch, unsigned int changes)
458 {
459         uint64_t channel_bit;
460         struct dev_context *devc;
461
462         if (!sdi)
463                 return SR_ERR_ARG;
464
465         devc = sdi->priv;
466
467         if (ch->index < 0 || ch->index >= devc->model->num_channels) {
468                 sr_err("Channel index %d out of range.", ch->index);
469                 return SR_ERR_BUG;
470         }
471
472         if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
473                 channel_bit = UINT64_C(1) << ch->index;
474
475                 /* Enable or disable logic input for this channel. */
476                 if (ch->enabled)
477                         devc->channel_mask |= channel_bit;
478                 else
479                         devc->channel_mask &= ~channel_bit;
480         }
481
482         return SR_OK;
483 }
484
485 /* Derive trigger masks from the session's trigger configuration. */
486 static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
487 {
488         uint64_t trigger_mask, trigger_values, trigger_edge_mask;
489         uint64_t level_bit, type_bit;
490         struct dev_context *devc;
491         struct sr_trigger *trigger;
492         struct sr_trigger_stage *stage;
493         struct sr_trigger_match *match;
494         const GSList *node;
495         int idx;
496         enum sr_trigger_matches trg;
497
498         devc = sdi->priv;
499
500         trigger = sr_session_trigger_get(sdi->session);
501         if (!trigger || !trigger->stages)
502                 return SR_OK;
503
504         if (trigger->stages->next) {
505                 sr_err("This device only supports 1 trigger stage.");
506                 return SR_ERR_ARG;
507         }
508         stage = trigger->stages->data;
509
510         trigger_mask = 0;
511         trigger_values = 0;
512         trigger_edge_mask = 0;
513
514         for (node = stage->matches; node; node = node->next) {
515                 match = node->data;
516
517                 if (!match->channel->enabled)
518                         continue; /* Ignore disabled channel. */
519
520                 idx = match->channel->index;
521                 trg = match->match;
522
523                 if (idx < 0 || idx >= devc->model->num_channels) {
524                         sr_err("Channel index %d out of range.", idx);
525                         return SR_ERR_BUG; /* Should not happen. */
526                 }
527                 if (trg != SR_TRIGGER_ZERO
528                                 && trg != SR_TRIGGER_ONE
529                                 && trg != SR_TRIGGER_RISING
530                                 && trg != SR_TRIGGER_FALLING) {
531                         sr_err("Unsupported trigger match for CH%d.", idx + 1);
532                         return SR_ERR_ARG;
533                 }
534                 level_bit = (trg == SR_TRIGGER_ONE
535                         || trg == SR_TRIGGER_RISING) ? 1 : 0;
536                 type_bit = (trg == SR_TRIGGER_RISING
537                         || trg == SR_TRIGGER_FALLING) ? 1 : 0;
538
539                 trigger_mask |= UINT64_C(1) << idx;
540                 trigger_values |= level_bit << idx;
541                 trigger_edge_mask |= type_bit << idx;
542         }
543         devc->trigger_mask = trigger_mask;
544         devc->trigger_values = trigger_values;
545         devc->trigger_edge_mask = trigger_edge_mask;
546
547         return SR_OK;
548 }
549
550 static int config_commit(const struct sr_dev_inst *sdi)
551 {
552         struct dev_context *devc;
553         int ret;
554
555         devc = sdi->priv;
556
557         if (devc->acquisition) {
558                 sr_err("Acquisition still in progress?");
559                 return SR_ERR;
560         }
561
562         ret = prepare_trigger_masks(sdi);
563         if (ret != SR_OK)
564                 return ret;
565
566         ret = (*devc->model->apply_fpga_config)(sdi);
567         if (ret != SR_OK) {
568                 sr_err("Failed to apply FPGA configuration.");
569                 return ret;
570         }
571
572         return SR_OK;
573 }
574
575 static int config_list(uint32_t key, GVariant **data,
576         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
577 {
578         struct dev_context *devc;
579
580         devc = (sdi) ? sdi->priv : NULL;
581
582         switch (key) {
583         case SR_CONF_SCAN_OPTIONS:
584         case SR_CONF_DEVICE_OPTIONS:
585                 return std_opts_config_list(key, data, sdi, cg,
586                         ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
587                         (devc) ? devc->model->devopts : NULL,
588                         (devc) ? devc->model->num_devopts : 0);
589         }
590
591         if (!devc)
592                 return SR_ERR_ARG;
593         if (!has_devopt(devc->model, key | SR_CONF_LIST))
594                 return SR_ERR_NA;
595
596         switch (key) {
597         case SR_CONF_SAMPLERATE:
598                 *data = std_gvar_samplerates(devc->model->samplerates, devc->model->num_samplerates);
599                 break;
600         case SR_CONF_TRIGGER_MATCH:
601                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
602                 break;
603         case SR_CONF_TRIGGER_SOURCE:
604                 *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_sources));
605                 break;
606         case SR_CONF_TRIGGER_SLOPE:
607         case SR_CONF_CLOCK_EDGE:
608                 *data = g_variant_new_strv(ARRAY_AND_SIZE(signal_edges));
609                 break;
610         default:
611                 /* Must not happen for a key listed in devopts. */
612                 return SR_ERR_BUG;
613         }
614
615         return SR_OK;
616 }
617
618 /* Set up the device hardware to begin capturing samples as soon as the
619  * configured trigger conditions are met, or immediately if no triggers
620  * are configured.
621  */
622 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
623 {
624         return lwla_start_acquisition(sdi);
625 }
626
627 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
628 {
629         struct dev_context *devc;
630
631         devc = sdi->priv;
632
633         if (devc->state != STATE_IDLE && !devc->cancel_requested) {
634                 devc->cancel_requested = TRUE;
635                 sr_dbg("Requesting cancel.");
636         }
637
638         return SR_OK;
639 }
640
641 static struct sr_dev_driver sysclk_lwla_driver_info = {
642         .name = "sysclk-lwla",
643         .longname = "SysClk LWLA series",
644         .api_version = 1,
645         .init = std_init,
646         .cleanup = std_cleanup,
647         .scan = scan,
648         .dev_list = std_dev_list,
649         .dev_clear = std_dev_clear,
650         .config_get = config_get,
651         .config_set = config_set,
652         .config_channel_set = config_channel_set,
653         .config_commit = config_commit,
654         .config_list = config_list,
655         .dev_open = dev_open,
656         .dev_close = dev_close,
657         .dev_acquisition_start = dev_acquisition_start,
658         .dev_acquisition_stop = dev_acquisition_stop,
659         .context = NULL,
660 };
661 SR_REGISTER_DEV_DRIVER(sysclk_lwla_driver_info);