2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
28 #include "libsigrok.h"
29 #include "libsigrok-internal.h"
32 #define USB_VENDOR 0x0c12
34 #define VENDOR_NAME "ZEROPLUS"
35 #define MODEL_NAME "Logic Cube LAP-C"
36 #define MODEL_VERSION NULL
39 #define USB_INTERFACE 0
40 #define USB_CONFIGURATION 1
41 #define NUM_TRIGGER_STAGES 4
42 #define TRIGGER_TYPES "01"
44 #define PACKET_SIZE 2048 /* ?? */
49 unsigned int channels;
50 unsigned int sample_depth; /* In Ksamples/channel */
51 unsigned int max_sampling_freq;
55 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
56 * same 128K sample depth.
58 static model_t zeroplus_models[] = {
59 {0x7009, "LAP-C(16064)", 16, 64, 100},
60 {0x700A, "LAP-C(16128)", 16, 128, 200},
61 {0x700B, "LAP-C(32128)", 32, 128, 200},
62 {0x700C, "LAP-C(321000)", 32, 1024, 200},
63 {0x700D, "LAP-C(322000)", 32, 2048, 200},
64 {0x700E, "LAP-C(16032)", 16, 32, 100},
65 {0x7016, "LAP-C(162000)", 16, 2048, 200},
68 static const int hwcaps[] = {
69 SR_HWCAP_LOGIC_ANALYZER,
72 SR_HWCAP_CAPTURE_RATIO,
74 /* These are really implemented in the driver, not the hardware. */
75 SR_HWCAP_LIMIT_SAMPLES,
80 * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
81 * We currently ignore other untested/unsupported devices here.
83 static const char *probe_names[NUM_PROBES + 1] = {
103 /* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
104 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
105 static struct sr_dev_driver *zdi = &zeroplus_logic_cube_driver_info;
107 static libusb_context *usb_context = NULL;
110 * The hardware supports more samplerates than these, but these are the
111 * options hardcoded into the vendor's Windows GUI.
115 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
118 static const uint64_t supported_samplerates[] = {
140 static const struct sr_samplerates samplerates = {
144 supported_samplerates,
147 /* Private, per-device-instance driver context. */
149 uint64_t cur_samplerate;
150 uint64_t limit_samples;
151 int num_channels; /* TODO: This isn't initialized before it's needed :( */
152 uint64_t memory_size;
154 uint8_t trigger_mask[NUM_TRIGGER_STAGES];
155 uint8_t trigger_value[NUM_TRIGGER_STAGES];
156 // uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
158 /* TODO: this belongs in the device instance */
159 struct sr_usb_dev_inst *usb;
162 static int hw_dev_config_set(int dev_index, int hwcap, const void *value);
164 static unsigned int get_memory_size(int type)
166 if (type == MEMORY_SIZE_8K)
168 else if (type == MEMORY_SIZE_64K)
170 else if (type == MEMORY_SIZE_128K)
172 else if (type == MEMORY_SIZE_512K)
178 static int opendev4(struct sr_dev_inst **sdi, libusb_device *dev,
179 struct libusb_device_descriptor *des)
185 /* Note: sdi is non-NULL, the caller already checked this. */
187 if (!(ctx = (*sdi)->priv)) {
188 sr_err("zp: %s: (*sdi)->priv was NULL", __func__);
192 if ((ret = libusb_get_device_descriptor(dev, des))) {
193 sr_err("zp: failed to get device descriptor: %d", ret);
197 if (des->idVendor != USB_VENDOR)
200 if (libusb_get_bus_number(dev) == ctx->usb->bus
201 && libusb_get_device_address(dev) == ctx->usb->address) {
203 for (i = 0; i < ARRAY_SIZE(zeroplus_models); i++) {
204 if (!(des->idProduct == zeroplus_models[i].pid))
207 sr_info("zp: Found ZEROPLUS device 0x%04x (%s)",
208 des->idProduct, zeroplus_models[i].model_name);
209 ctx->num_channels = zeroplus_models[i].channels;
210 ctx->memory_size = zeroplus_models[i].sample_depth * 1024;
214 if (ctx->num_channels == 0) {
215 sr_err("zp: Unknown ZEROPLUS device 0x%04x",
221 if (!(ret = libusb_open(dev, &(ctx->usb->devhdl)))) {
222 (*sdi)->status = SR_ST_ACTIVE;
223 sr_info("zp: opened device %d on %d.%d interface %d",
224 (*sdi)->index, ctx->usb->bus,
225 ctx->usb->address, USB_INTERFACE);
227 sr_err("zp: failed to open device: %d", ret);
235 static struct sr_dev_inst *zp_open_dev(int dev_index)
237 struct sr_dev_inst *sdi;
238 libusb_device **devlist;
239 struct libusb_device_descriptor des;
242 if (!(sdi = sr_dev_inst_get(zdi->instances, dev_index)))
245 libusb_get_device_list(usb_context, &devlist);
246 if (sdi->status == SR_ST_INACTIVE) {
247 /* Find the device by vendor, product, bus and address. */
248 libusb_get_device_list(usb_context, &devlist);
249 for (i = 0; devlist[i]; i++) {
250 /* TODO: Error handling. */
251 opendev4(&sdi, devlist[i], &des);
254 /* Status must be SR_ST_ACTIVE, i.e. already in use... */
257 libusb_free_device_list(devlist, 1);
259 if (sdi && sdi->status != SR_ST_ACTIVE)
265 static void close_dev(struct sr_dev_inst *sdi)
269 if (!(ctx = sdi->priv)) {
270 sr_err("zp: %s: sdi->priv was NULL", __func__);
274 if (!ctx->usb->devhdl)
277 sr_info("zp: closing device %d on %d.%d interface %d", sdi->index,
278 ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
279 libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
280 libusb_reset_device(ctx->usb->devhdl);
281 libusb_close(ctx->usb->devhdl);
282 ctx->usb->devhdl = NULL;
283 /* TODO: Call libusb_exit() here or only in hw_cleanup()? */
284 sdi->status = SR_ST_INACTIVE;
287 static int configure_probes(struct sr_dev_inst *sdi, const GSList *probes)
290 const struct sr_probe *probe;
292 int probe_bit, stage, i;
295 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
299 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
300 ctx->trigger_mask[i] = 0;
301 ctx->trigger_value[i] = 0;
305 for (l = probes; l; l = l->next) {
306 probe = (struct sr_probe *)l->data;
307 if (probe->enabled == FALSE)
309 probe_bit = 1 << (probe->index - 1);
310 ctx->probe_mask |= probe_bit;
312 if (probe->trigger) {
314 for (tc = probe->trigger; *tc; tc++) {
315 ctx->trigger_mask[stage] |= probe_bit;
317 ctx->trigger_value[stage] |= probe_bit;
319 if (stage > NUM_TRIGGER_STAGES)
328 static void clear_instances(void)
331 struct sr_dev_inst *sdi;
333 for (l = zdi->instances; l; l = l->next) {
335 /* Properly close all devices... */
337 /* ...and free all their memory. */
338 sr_dev_inst_free(sdi);
340 g_slist_free(zdi->instances);
341 zdi->instances = NULL;
349 static int hw_init(void)
352 if (libusb_init(&usb_context) != 0) {
353 sr_err("zp: Failed to initialize USB.");
360 static GSList *hw_scan(GSList *options)
362 struct sr_dev_inst *sdi;
363 struct libusb_device_descriptor des;
365 libusb_device **devlist;
374 /* Allocate memory for our private driver context. */
375 if (!(ctx = g_try_malloc(sizeof(struct context)))) {
376 sr_err("zp: %s: ctx malloc failed", __func__);
380 /* Set some sane defaults. */
381 ctx->cur_samplerate = 0;
382 ctx->limit_samples = 0;
383 /* TODO: num_channels isn't initialized before it's needed :( */
384 ctx->num_channels = NUM_PROBES;
385 ctx->memory_size = 0;
387 memset(ctx->trigger_mask, 0, NUM_TRIGGER_STAGES);
388 memset(ctx->trigger_value, 0, NUM_TRIGGER_STAGES);
389 // memset(ctx->trigger_buffer, 0, NUM_TRIGGER_STAGES);
391 /* Find all ZEROPLUS analyzers and add them to device list. */
393 libusb_get_device_list(usb_context, &devlist); /* TODO: Errors. */
395 for (i = 0; devlist[i]; i++) {
396 ret = libusb_get_device_descriptor(devlist[i], &des);
398 sr_err("zp: failed to get device descriptor: %d", ret);
402 if (des.idVendor == USB_VENDOR) {
404 * Definitely a ZEROPLUS.
405 * TODO: Any way to detect specific model/version in
406 * the ZEROPLUS range?
408 /* Register the device with libsigrok. */
409 if (!(sdi = sr_dev_inst_new(devcnt,
410 SR_ST_INACTIVE, VENDOR_NAME,
411 MODEL_NAME, MODEL_VERSION))) {
412 sr_err("zp: %s: sr_dev_inst_new failed",
419 devices = g_slist_append(devices, sdi);
420 zdi->instances = g_slist_append(zdi->instances, sdi);
421 ctx->usb = sr_usb_dev_inst_new(
422 libusb_get_bus_number(devlist[i]),
423 libusb_get_device_address(devlist[i]), NULL);
427 libusb_free_device_list(devlist, 1);
432 static int hw_dev_open(int dev_index)
434 struct sr_dev_inst *sdi;
438 if (!(sdi = zp_open_dev(dev_index))) {
439 sr_err("zp: unable to open device");
443 /* TODO: Note: sdi is retrieved in zp_open_dev(). */
445 if (!(ctx = sdi->priv)) {
446 sr_err("zp: %s: sdi->priv was NULL", __func__);
450 ret = libusb_set_configuration(ctx->usb->devhdl, USB_CONFIGURATION);
452 sr_err("zp: Unable to set USB configuration %d: %d",
453 USB_CONFIGURATION, ret);
457 ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
459 sr_err("zp: Unable to claim interface: %d", ret);
463 analyzer_reset(ctx->usb->devhdl);
464 analyzer_initialize(ctx->usb->devhdl);
466 analyzer_set_memory_size(MEMORY_SIZE_512K);
467 // analyzer_set_freq(g_freq, g_freq_scale);
468 analyzer_set_trigger_count(1);
469 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
470 // * get_memory_size(g_memory_size)) / 100) >> 2);
471 analyzer_set_ramsize_trigger_address(
472 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
475 if (g_double_mode == 1)
476 analyzer_set_compression(COMPRESSION_DOUBLE);
477 else if (g_compression == 1)
478 analyzer_set_compression(COMPRESSION_ENABLE);
481 analyzer_set_compression(COMPRESSION_NONE);
483 if (ctx->cur_samplerate == 0) {
484 /* Samplerate hasn't been set. Default to the slowest one. */
485 if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
486 &samplerates.list[0]) == SR_ERR)
493 static int hw_dev_close(int dev_index)
495 struct sr_dev_inst *sdi;
497 if (!(sdi = sr_dev_inst_get(zdi->instances, dev_index))) {
498 sr_err("zp: %s: sdi was NULL", __func__);
499 return SR_ERR; /* TODO: SR_ERR_ARG? */
508 static int hw_cleanup(void)
514 libusb_exit(usb_context);
520 static int hw_info_get(int info_id, const void **data,
521 const struct sr_dev_inst *sdi)
528 sr_spew("zp: %s: Returning sdi.", __func__);
533 case SR_DI_NUM_PROBES:
536 *data = GINT_TO_POINTER(ctx->num_channels);
537 sr_spew("zp: %s: Returning number of channels: %d.",
538 __func__, ctx->num_channels);
542 case SR_DI_PROBE_NAMES:
544 sr_spew("zp: %s: Returning probenames.", __func__);
546 case SR_DI_SAMPLERATES:
547 *data = &samplerates;
548 sr_spew("zp: %s: Returning samplerates.", __func__);
550 case SR_DI_TRIGGER_TYPES:
551 *data = TRIGGER_TYPES;
552 sr_spew("zp: %s: Returning triggertypes: %s.", __func__, TRIGGER_TYPES);
554 case SR_DI_CUR_SAMPLERATE:
557 *data = &ctx->cur_samplerate;
558 sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
559 __func__, ctx->cur_samplerate);
570 static int hw_dev_status_get(int dev_index)
572 struct sr_dev_inst *sdi;
574 sdi = sr_dev_inst_get(zdi->instances, dev_index);
578 return SR_ST_NOT_FOUND;
581 static int set_samplerate(struct sr_dev_inst *sdi, uint64_t samplerate)
586 sr_err("zp: %s: sdi was NULL", __func__);
590 if (!(ctx = sdi->priv)) {
591 sr_err("zp: %s: sdi->priv was NULL", __func__);
595 sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
597 if (samplerate > SR_MHZ(1))
598 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
599 else if (samplerate > SR_KHZ(1))
600 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
602 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
604 ctx->cur_samplerate = samplerate;
609 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
611 struct sr_dev_inst *sdi;
614 if (!(sdi = sr_dev_inst_get(zdi->instances, dev_index))) {
615 sr_err("zp: %s: sdi was NULL", __func__);
619 if (!(ctx = sdi->priv)) {
620 sr_err("zp: %s: sdi->priv was NULL", __func__);
625 case SR_HWCAP_SAMPLERATE:
626 return set_samplerate(sdi, *(const uint64_t *)value);
627 case SR_HWCAP_PROBECONFIG:
628 return configure_probes(sdi, (const GSList *)value);
629 case SR_HWCAP_LIMIT_SAMPLES:
630 ctx->limit_samples = *(const uint64_t *)value;
637 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
639 struct sr_dev_inst *sdi;
640 struct sr_datafeed_packet packet;
641 struct sr_datafeed_logic logic;
642 struct sr_datafeed_header header;
643 struct sr_datafeed_meta_logic meta;
644 uint64_t samples_read;
646 unsigned int packet_num;
650 if (!(sdi = sr_dev_inst_get(zdi->instances, dev_index))) {
651 sr_err("zp: %s: sdi was NULL", __func__);
655 if (!(ctx = sdi->priv)) {
656 sr_err("zp: %s: sdi->priv was NULL", __func__);
660 /* push configured settings to device */
661 analyzer_configure(ctx->usb->devhdl);
663 analyzer_start(ctx->usb->devhdl);
664 sr_info("zp: Waiting for data");
665 analyzer_wait_data(ctx->usb->devhdl);
667 sr_info("zp: Stop address = 0x%x",
668 analyzer_get_stop_address(ctx->usb->devhdl));
669 sr_info("zp: Now address = 0x%x",
670 analyzer_get_now_address(ctx->usb->devhdl));
671 sr_info("zp: Trigger address = 0x%x",
672 analyzer_get_trigger_address(ctx->usb->devhdl));
674 packet.type = SR_DF_HEADER;
675 packet.payload = &header;
676 header.feed_version = 1;
677 gettimeofday(&header.starttime, NULL);
678 sr_session_send(cb_data, &packet);
680 /* Send metadata about the SR_DF_LOGIC packets to come. */
681 packet.type = SR_DF_META_LOGIC;
682 packet.payload = &meta;
683 meta.samplerate = ctx->cur_samplerate;
684 meta.num_probes = ctx->num_channels;
685 sr_session_send(cb_data, &packet);
687 if (!(buf = g_try_malloc(PACKET_SIZE))) {
688 sr_err("zp: %s: buf malloc failed", __func__);
689 return SR_ERR_MALLOC;
693 analyzer_read_start(ctx->usb->devhdl);
694 /* Send the incoming transfer to the session bus. */
695 for (packet_num = 0; packet_num < (ctx->memory_size * 4 / PACKET_SIZE);
697 res = analyzer_read_data(ctx->usb->devhdl, buf, PACKET_SIZE);
698 sr_info("zp: Tried to read %llx bytes, actually read %x bytes",
701 packet.type = SR_DF_LOGIC;
702 packet.payload = &logic;
703 logic.length = PACKET_SIZE;
706 sr_session_send(cb_data, &packet);
707 samples_read += res / 4;
709 analyzer_read_stop(ctx->usb->devhdl);
712 packet.type = SR_DF_END;
713 sr_session_send(cb_data, &packet);
718 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
719 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
721 struct sr_datafeed_packet packet;
722 struct sr_dev_inst *sdi;
725 packet.type = SR_DF_END;
726 sr_session_send(cb_data, &packet);
728 if (!(sdi = sr_dev_inst_get(zdi->instances, dev_index))) {
729 sr_err("zp: %s: sdi was NULL", __func__);
733 if (!(ctx = sdi->priv)) {
734 sr_err("zp: %s: sdi->priv was NULL", __func__);
738 analyzer_reset(ctx->usb->devhdl);
739 /* TODO: Need to cancel and free any queued up transfers. */
744 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
745 .name = "zeroplus-logic-cube",
746 .longname = "ZEROPLUS Logic Cube LAP-C series",
749 .cleanup = hw_cleanup,
751 .dev_open = hw_dev_open,
752 .dev_close = hw_dev_close,
753 .info_get = hw_info_get,
754 .dev_status_get = hw_dev_status_get,
755 .dev_config_set = hw_dev_config_set,
756 .dev_acquisition_start = hw_dev_acquisition_start,
757 .dev_acquisition_stop = hw_dev_acquisition_stop,