2 * This file is part of the sigrok project.
4 * Copyright (C) 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/>.
29 #include "sigrok-internal.h"
32 #define USB_VENDOR 0x0c12
33 #define USB_VENDOR_NAME "Zeroplus"
34 #define USB_MODEL_NAME "Logic Cube"
35 #define USB_MODEL_VERSION ""
37 #define USB_INTERFACE 0
38 #define USB_CONFIGURATION 1
39 #define NUM_TRIGGER_STAGES 4
40 #define TRIGGER_TYPES "01"
42 #define PACKET_SIZE 2048 /* ?? */
47 unsigned int channels;
48 unsigned int sample_depth; /* In Ksamples/channel */
49 unsigned int max_sampling_freq;
53 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
54 * same 128K sample depth.
56 static model_t zeroplus_models[] = {
57 {0x7009, "LAP-C(16064)", 16, 64, 100},
58 {0x700A, "LAP-C(16128)", 16, 128, 200},
59 {0x700B, "LAP-C(32128)", 32, 128, 200},
60 {0x700C, "LAP-C(321000)", 32, 1024, 200},
61 {0x700D, "LAP-C(322000)", 32, 2048, 200},
62 {0x700E, "LAP-C(16032)", 16, 32, 100},
63 {0x7016, "LAP-C(162000)", 16, 2048, 200},
66 static int capabilities[] = {
67 SR_HWCAP_LOGIC_ANALYZER,
70 SR_HWCAP_CAPTURE_RATIO,
72 /* These are really implemented in the driver, not the hardware. */
73 SR_HWCAP_LIMIT_SAMPLES,
77 static const char *probe_names[] = {
113 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
114 static GSList *device_instances = NULL;
116 static libusb_context *usb_context = NULL;
119 * The hardware supports more samplerates than these, but these are the
120 * options hardcoded into the vendor's Windows GUI.
124 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
127 static uint64_t supported_samplerates[] = {
149 static struct sr_samplerates samplerates = {
153 supported_samplerates,
157 uint64_t cur_samplerate;
158 uint64_t limit_samples;
159 int num_channels; /* TODO: This isn't initialized before it's needed :( */
160 uint64_t memory_size;
162 uint8_t trigger_mask[NUM_TRIGGER_STAGES];
163 uint8_t trigger_value[NUM_TRIGGER_STAGES];
164 // uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
166 struct sr_usb_device_instance *usb;
169 static int hw_set_configuration(int device_index, int capability, void *value);
171 static unsigned int get_memory_size(int type)
173 if (type == MEMORY_SIZE_8K)
175 else if (type == MEMORY_SIZE_64K)
177 else if (type == MEMORY_SIZE_128K)
179 else if (type == MEMORY_SIZE_512K)
185 static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
186 struct libusb_device_descriptor *des)
192 /* Note: sdi is non-NULL, the caller already checked this. */
194 if (!(zp = (*sdi)->priv)) {
195 sr_err("zp: %s: (*sdi)->priv was NULL", __func__);
199 if ((err = libusb_get_device_descriptor(dev, des))) {
200 sr_err("failed to get device descriptor: %d", err);
204 if (des->idVendor != USB_VENDOR)
207 if (libusb_get_bus_number(dev) == zp->usb->bus
208 && libusb_get_device_address(dev) == zp->usb->address) {
210 for (i = 0; i < ARRAY_SIZE(zeroplus_models); i++) {
211 if (!(des->idProduct == zeroplus_models[i].pid))
214 sr_info("Found PID=%04X (%s)", des->idProduct,
215 zeroplus_models[i].model_name);
216 zp->num_channels = zeroplus_models[i].channels;
217 zp->memory_size = zeroplus_models[i].sample_depth * 1024;
221 if (zp->num_channels == 0) {
222 sr_err("Unknown ZeroPlus device %04X", des->idProduct);
227 if (!(err = libusb_open(dev, &(zp->usb->devhdl)))) {
228 (*sdi)->status = SR_ST_ACTIVE;
229 sr_info("opened device %d on %d.%d interface %d",
230 (*sdi)->index, zp->usb->bus,
231 zp->usb->address, USB_INTERFACE);
233 sr_err("failed to open device: %d", err);
241 static struct sr_device_instance *zp_open_device(int device_index)
243 struct sr_device_instance *sdi;
244 libusb_device **devlist;
245 struct libusb_device_descriptor des;
248 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
251 libusb_get_device_list(usb_context, &devlist);
252 if (sdi->status == SR_ST_INACTIVE) {
253 /* Find the device by vendor, product, bus and address. */
254 libusb_get_device_list(usb_context, &devlist);
255 for (i = 0; devlist[i]; i++) {
256 /* TODO: Error handling. */
257 err = opendev4(&sdi, devlist[i], &des);
260 /* Status must be SR_ST_ACTIVE, i.e. already in use... */
263 libusb_free_device_list(devlist, 1);
265 if (sdi && sdi->status != SR_ST_ACTIVE)
271 static void close_device(struct sr_device_instance *sdi)
275 if (!(zp = sdi->priv)) {
276 sr_err("zp: %s: sdi->priv was NULL", __func__);
280 if (!zp->usb->devhdl)
283 sr_info("closing device %d on %d.%d interface %d", sdi->index,
284 zp->usb->bus, zp->usb->address, USB_INTERFACE);
285 libusb_release_interface(zp->usb->devhdl, USB_INTERFACE);
286 libusb_reset_device(zp->usb->devhdl);
287 libusb_close(zp->usb->devhdl);
288 zp->usb->devhdl = NULL;
289 /* TODO: Call libusb_exit() here or only in hw_cleanup()? */
290 sdi->status = SR_ST_INACTIVE;
293 static int configure_probes(struct sr_device_instance *sdi, GSList *probes)
296 struct sr_probe *probe;
298 int probe_bit, stage, i;
301 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
305 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
306 zp->trigger_mask[i] = 0;
307 zp->trigger_value[i] = 0;
311 for (l = probes; l; l = l->next) {
312 probe = (struct sr_probe *)l->data;
313 if (probe->enabled == FALSE)
315 probe_bit = 1 << (probe->index - 1);
316 zp->probe_mask |= probe_bit;
318 if (probe->trigger) {
320 for (tc = probe->trigger; *tc; tc++) {
321 zp->trigger_mask[stage] |= probe_bit;
323 zp->trigger_value[stage] |= probe_bit;
325 if (stage > NUM_TRIGGER_STAGES)
338 static int hw_init(const char *deviceinfo)
340 struct sr_device_instance *sdi;
341 struct libusb_device_descriptor des;
342 libusb_device **devlist;
346 /* Avoid compiler warnings. */
349 /* Allocate memory for our private driver context. */
350 if (!(zp = g_try_malloc(sizeof(struct zp)))) {
351 sr_err("zp: %s: struct zp malloc failed", __func__);
355 /* Set some sane defaults. */
356 zp->cur_samplerate = 0;
357 zp->limit_samples = 0;
358 zp->num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
361 memset(zp->trigger_mask, 0, NUM_TRIGGER_STAGES);
362 memset(zp->trigger_value, 0, NUM_TRIGGER_STAGES);
363 // memset(zp->trigger_buffer, 0, NUM_TRIGGER_STAGES);
365 if (libusb_init(&usb_context) != 0) {
366 sr_err("Failed to initialize USB.");
370 /* Find all ZeroPlus analyzers and add them to device list. */
372 libusb_get_device_list(usb_context, &devlist); /* TODO: Errors. */
374 for (i = 0; devlist[i]; i++) {
375 err = libusb_get_device_descriptor(devlist[i], &des);
377 sr_err("failed to get device descriptor: %d", err);
381 if (des.idVendor == USB_VENDOR) {
383 * Definitely a Zeroplus.
384 * TODO: Any way to detect specific model/version in
385 * the zeroplus range?
387 /* Register the device with libsigrok. */
388 sdi = sr_device_instance_new(devcnt,
389 SR_ST_INACTIVE, USB_VENDOR_NAME,
390 USB_MODEL_NAME, USB_MODEL_VERSION);
392 sr_err("zp: %s: sr_device_instance_new failed",
400 g_slist_append(device_instances, sdi);
401 zp->usb = sr_usb_device_instance_new(
402 libusb_get_bus_number(devlist[i]),
403 libusb_get_device_address(devlist[i]), NULL);
407 libusb_free_device_list(devlist, 1);
412 static int hw_opendev(int device_index)
414 struct sr_device_instance *sdi;
418 if (!(sdi = zp_open_device(device_index))) {
419 sr_err("unable to open device");
423 /* TODO: Note: sdi is retrieved in zp_open_device(). */
425 if (!(zp = sdi->priv)) {
426 sr_err("zp: %s: sdi->priv was NULL", __func__);
430 err = libusb_set_configuration(zp->usb->devhdl, USB_CONFIGURATION);
432 sr_err("zp: Unable to set USB configuration %d: %d",
433 USB_CONFIGURATION, err);
437 err = libusb_claim_interface(zp->usb->devhdl, USB_INTERFACE);
439 sr_err("Unable to claim interface: %d", err);
443 analyzer_reset(zp->usb->devhdl);
444 analyzer_initialize(zp->usb->devhdl);
446 analyzer_set_memory_size(MEMORY_SIZE_512K);
447 // analyzer_set_freq(g_freq, g_freq_scale);
448 analyzer_set_trigger_count(1);
449 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
450 // * get_memory_size(g_memory_size)) / 100) >> 2);
451 analyzer_set_ramsize_trigger_address(
452 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
455 if (g_double_mode == 1)
456 analyzer_set_compression(COMPRESSION_DOUBLE);
457 else if (g_compression == 1)
458 analyzer_set_compression(COMPRESSION_ENABLE);
461 analyzer_set_compression(COMPRESSION_NONE);
463 if (zp->cur_samplerate == 0) {
464 /* Samplerate hasn't been set. Default to the slowest one. */
465 if (hw_set_configuration(device_index, SR_HWCAP_SAMPLERATE,
466 &samplerates.list[0]) == SR_ERR)
473 static int hw_closedev(int device_index)
475 struct sr_device_instance *sdi;
477 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
478 sr_err("zp: %s: sdi was NULL", __func__);
479 return SR_ERR; /* TODO: SR_ERR_ARG? */
488 static void hw_cleanup(void)
492 /* Properly close all devices... */
493 for (l = device_instances; l; l = l->next)
494 close_device((struct sr_device_instance *)l->data);
496 /* ...and free all their memory. */
497 for (l = device_instances; l; l = l->next)
499 g_slist_free(device_instances);
500 device_instances = NULL;
503 libusb_exit(usb_context);
507 static void *hw_get_device_info(int device_index, int device_info_id)
509 struct sr_device_instance *sdi;
513 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
514 sr_err("zp: %s: sdi was NULL", __func__);
518 if (!(zp = sdi->priv)) {
519 sr_err("zp: %s: sdi->priv was NULL", __func__);
523 switch (device_info_id) {
527 case SR_DI_NUM_PROBES:
528 info = GINT_TO_POINTER(zp->num_channels);
530 case SR_DI_PROBE_NAMES:
533 case SR_DI_SAMPLERATES:
536 case SR_DI_TRIGGER_TYPES:
537 info = TRIGGER_TYPES;
539 case SR_DI_CUR_SAMPLERATE:
540 info = &zp->cur_samplerate;
543 /* Unknown device info ID, return NULL. */
544 sr_err("zp: %s: Unknown device info ID", __func__);
552 static int hw_get_status(int device_index)
554 struct sr_device_instance *sdi;
556 sdi = sr_get_device_instance(device_instances, device_index);
560 return SR_ST_NOT_FOUND;
563 static int *hw_get_capabilities(void)
568 static int set_configuration_samplerate(struct sr_device_instance *sdi,
574 sr_err("zp: %s: sdi was NULL", __func__);
578 if (!(zp = sdi->priv)) {
579 sr_err("zp: %s: sdi->priv was NULL", __func__);
583 sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
585 if (samplerate > SR_MHZ(1))
586 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
587 else if (samplerate > SR_KHZ(1))
588 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
590 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
592 zp->cur_samplerate = samplerate;
597 static int hw_set_configuration(int device_index, int capability, void *value)
599 struct sr_device_instance *sdi;
603 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
604 sr_err("zp: %s: sdi was NULL", __func__);
608 if (!(zp = sdi->priv)) {
609 sr_err("zp: %s: sdi->priv was NULL", __func__);
613 switch (capability) {
614 case SR_HWCAP_SAMPLERATE:
616 return set_configuration_samplerate(sdi, *tmp_u64);
617 case SR_HWCAP_PROBECONFIG:
618 return configure_probes(sdi, (GSList *)value);
619 case SR_HWCAP_LIMIT_SAMPLES:
621 zp->limit_samples = *tmp_u64;
628 static int hw_start_acquisition(int device_index, gpointer session_data)
630 struct sr_device_instance *sdi;
631 struct sr_datafeed_packet packet;
632 struct sr_datafeed_logic logic;
633 struct sr_datafeed_header header;
634 uint64_t samples_read;
636 unsigned int packet_num;
640 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
641 sr_err("zp: %s: sdi was NULL", __func__);
645 if (!(zp = sdi->priv)) {
646 sr_err("zp: %s: sdi->priv was NULL", __func__);
650 /* push configured settings to device */
651 analyzer_configure(zp->usb->devhdl);
653 analyzer_start(zp->usb->devhdl);
654 sr_info("Waiting for data");
655 analyzer_wait_data(zp->usb->devhdl);
657 sr_info("Stop address = 0x%x", analyzer_get_stop_address(zp->usb->devhdl));
658 sr_info("Now address = 0x%x", analyzer_get_now_address(zp->usb->devhdl));
659 sr_info("Trigger address = 0x%x", analyzer_get_trigger_address(zp->usb->devhdl));
661 packet.type = SR_DF_HEADER;
662 packet.payload = &header;
663 header.feed_version = 1;
664 gettimeofday(&header.starttime, NULL);
665 header.samplerate = zp->cur_samplerate;
666 header.num_logic_probes = zp->num_channels;
667 sr_session_bus(session_data, &packet);
669 if (!(buf = g_try_malloc(PACKET_SIZE))) {
670 sr_err("zp: %s: buf malloc failed", __func__);
671 return SR_ERR_MALLOC;
675 analyzer_read_start(zp->usb->devhdl);
676 /* Send the incoming transfer to the session bus. */
677 for (packet_num = 0; packet_num < (zp->memory_size * 4 / PACKET_SIZE);
679 res = analyzer_read_data(zp->usb->devhdl, buf, PACKET_SIZE);
680 sr_info("Tried to read %llx bytes, actually read %x bytes",
683 packet.type = SR_DF_LOGIC;
684 packet.payload = &logic;
685 logic.length = PACKET_SIZE;
688 sr_session_bus(session_data, &packet);
689 samples_read += res / 4;
691 analyzer_read_stop(zp->usb->devhdl);
694 packet.type = SR_DF_END;
695 sr_session_bus(session_data, &packet);
700 /* This stops acquisition on ALL devices, ignoring device_index. */
701 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
703 struct sr_datafeed_packet packet;
704 struct sr_device_instance *sdi;
707 packet.type = SR_DF_END;
708 sr_session_bus(session_device_id, &packet);
710 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
711 sr_err("zp: %s: sdi was NULL", __func__);
715 if (!(zp = sdi->priv)) {
716 sr_err("zp: %s: sdi->priv was NULL", __func__);
720 analyzer_reset(zp->usb->devhdl);
721 /* TODO: Need to cancel and free any queued up transfers. */
724 SR_PRIV struct sr_device_plugin zeroplus_logic_cube_plugin_info = {
725 .name = "zeroplus-logic-cube",
726 .longname = "Zeroplus Logic Cube LAP-C series",
729 .cleanup = hw_cleanup,
730 .opendev = hw_opendev,
731 .closedev = hw_closedev,
732 .get_device_info = hw_get_device_info,
733 .get_status = hw_get_status,
734 .get_capabilities = hw_get_capabilities,
735 .set_configuration = hw_set_configuration,
736 .start_acquisition = hw_start_acquisition,
737 .stop_acquisition = hw_stop_acquisition,