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/>.
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
31 #define USB_VENDOR 0x0c12
33 #define VENDOR_NAME "ZEROPLUS"
34 #define MODEL_NAME "Logic Cube LAP-C"
35 #define MODEL_VERSION NULL
38 #define USB_INTERFACE 0
39 #define USB_CONFIGURATION 1
40 #define NUM_TRIGGER_STAGES 4
41 #define TRIGGER_TYPES "01"
43 #define PACKET_SIZE 2048 /* ?? */
45 //#define ZP_EXPERIMENTAL
51 unsigned int channels;
52 unsigned int sample_depth; /* In Ksamples/channel */
53 unsigned int max_sampling_freq;
57 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
58 * same 128K sample depth.
60 static model_t zeroplus_models[] = {
61 {0x0c12, 0x7009, "LAP-C(16064)", 16, 64, 100},
62 {0x0c12, 0x700A, "LAP-C(16128)", 16, 128, 200},
63 /* TODO: we don't know anything about these
64 {0x0c12, 0x700B, "LAP-C(32128)", 32, 128, 200},
65 {0x0c12, 0x700C, "LAP-C(321000)", 32, 1024, 200},
66 {0x0c12, 0x700D, "LAP-C(322000)", 32, 2048, 200},
68 {0x0c12, 0x700E, "LAP-C(16032)", 16, 32, 100},
69 {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
73 static const int hwcaps[] = {
74 SR_HWCAP_LOGIC_ANALYZER,
76 SR_HWCAP_CAPTURE_RATIO,
78 /* These are really implemented in the driver, not the hardware. */
79 SR_HWCAP_LIMIT_SAMPLES,
84 * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
85 * We currently ignore other untested/unsupported devices here.
87 static const char *probe_names[NUM_PROBES + 1] = {
107 /* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
108 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
109 static struct sr_dev_driver *zdi = &zeroplus_logic_cube_driver_info;
112 * The hardware supports more samplerates than these, but these are the
113 * options hardcoded into the vendor's Windows GUI.
117 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
120 static const uint64_t supported_samplerates[] = {
142 static const struct sr_samplerates samplerates = {
146 supported_samplerates,
149 /* Private, per-device-instance driver context. */
151 uint64_t cur_samplerate;
152 uint64_t max_samplerate;
153 uint64_t limit_samples;
154 int num_channels; /* TODO: This isn't initialized before it's needed :( */
156 unsigned int max_memory_size;
157 //uint8_t probe_mask;
158 //uint8_t trigger_mask[NUM_TRIGGER_STAGES];
159 //uint8_t trigger_value[NUM_TRIGGER_STAGES];
160 // uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
162 unsigned int capture_ratio;
164 /* TODO: this belongs in the device instance */
165 struct sr_usb_dev_inst *usb;
168 static int hw_dev_close(struct sr_dev_inst *sdi);
170 static unsigned int get_memory_size(int type)
172 if (type == MEMORY_SIZE_8K)
174 else if (type == MEMORY_SIZE_64K)
176 else if (type == MEMORY_SIZE_128K)
178 else if (type == MEMORY_SIZE_512K)
185 static int configure_probes(const struct sr_dev_inst *sdi)
187 struct dev_context *devc;
188 const struct sr_probe *probe;
190 int probe_bit, stage, i;
193 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
196 devc->probe_mask = 0;
197 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
198 devc->trigger_mask[i] = 0;
199 devc->trigger_value[i] = 0;
203 for (l = sdi->probes; l; l = l->next) {
204 probe = (struct sr_probe *)l->data;
205 if (probe->enabled == FALSE)
207 probe_bit = 1 << (probe->index);
208 devc->probe_mask |= probe_bit;
210 if (probe->trigger) {
212 for (tc = probe->trigger; *tc; tc++) {
213 devc->trigger_mask[stage] |= probe_bit;
215 devc->trigger_value[stage] |= probe_bit;
217 if (stage > NUM_TRIGGER_STAGES)
227 static int configure_probes(const struct sr_dev_inst *sdi)
229 struct dev_context *devc;
231 const struct sr_probe *probe;
235 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
238 for (l = sdi->probes; l; l = l->next) {
239 probe = (struct sr_probe *)l->data;
240 if (probe->enabled == FALSE)
243 if ((tc = probe->trigger)) {
253 type = TRIGGER_POSEDGE;
256 type = TRIGGER_NEGEDGE;
259 type = TRIGGER_ANYEDGE;
265 analyzer_add_trigger(probe->index, type);
273 static int clear_instances(void)
276 struct sr_dev_inst *sdi;
277 struct drv_context *drvc;
278 struct dev_context *devc;
281 for (l = drvc->instances; l; l = l->next) {
283 if (!(devc = sdi->priv)) {
284 /* Log error, but continue cleaning up the rest. */
285 sr_err("zeroplus: %s: sdi->priv was NULL, continuing", __func__);
288 sr_usb_dev_inst_free(devc->usb);
289 /* Properly close all devices... */
291 /* ...and free all their memory. */
292 sr_dev_inst_free(sdi);
294 g_slist_free(drvc->instances);
295 drvc->instances = NULL;
304 static int hw_init(struct sr_context *sr_ctx)
306 struct drv_context *drvc;
308 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
309 sr_err("zeroplus: driver context malloc failed.");
310 return SR_ERR_MALLOC;
312 drvc->sr_ctx = sr_ctx;
318 static GSList *hw_scan(GSList *options)
320 struct sr_dev_inst *sdi;
321 struct sr_probe *probe;
322 struct drv_context *drvc;
323 struct dev_context *devc;
325 struct libusb_device_descriptor des;
326 libusb_device **devlist;
328 int ret, devcnt, i, j;
337 /* Find all ZEROPLUS analyzers and add them to device list. */
339 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
341 for (i = 0; devlist[i]; i++) {
342 ret = libusb_get_device_descriptor(devlist[i], &des);
344 sr_err("zp: failed to get device descriptor: %d", ret);
349 for (j = 0; j < zeroplus_models[j].vid; j++) {
350 if (des.idVendor == zeroplus_models[j].vid &&
351 des.idProduct == zeroplus_models[j].pid) {
352 prof = &zeroplus_models[j];
355 /* Skip if the device was not found */
358 sr_info("zp: Found ZEROPLUS model %s", prof->model_name);
360 /* Register the device with libsigrok. */
361 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
362 VENDOR_NAME, prof->model_name, NULL))) {
363 sr_err("zp: %s: sr_dev_inst_new failed", __func__);
368 /* Allocate memory for our private driver context. */
369 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
370 sr_err("zp: %s: devc malloc failed", __func__);
374 devc->num_channels = prof->channels;
375 #ifdef ZP_EXPERIMENTAL
376 devc->max_memory_size = 128 * 1024;
377 devc->max_samplerate = 200;
379 devc->max_memory_size = prof->sample_depth * 1024;
380 devc->max_samplerate = prof->max_sampling_freq;
382 devc->max_samplerate *= SR_MHZ(1);
383 devc->memory_size = MEMORY_SIZE_8K;
384 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
386 /* Fill in probelist according to this device's profile. */
387 for (j = 0; j < devc->num_channels; j++) {
388 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
391 sdi->probes = g_slist_append(sdi->probes, probe);
394 devices = g_slist_append(devices, sdi);
395 drvc->instances = g_slist_append(drvc->instances, sdi);
396 devc->usb = sr_usb_dev_inst_new(
397 libusb_get_bus_number(devlist[i]),
398 libusb_get_device_address(devlist[i]), NULL);
402 libusb_free_device_list(devlist, 1);
407 static GSList *hw_dev_list(void)
409 struct drv_context *drvc;
413 return drvc->instances;
416 static int hw_dev_open(struct sr_dev_inst *sdi)
418 struct dev_context *devc;
419 struct drv_context *drvc = zdi->priv;
420 libusb_device **devlist, *dev;
421 struct libusb_device_descriptor des;
422 int device_count, ret, i;
424 if (!(devc = sdi->priv)) {
425 sr_err("zp: %s: sdi->priv was NULL", __func__);
429 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
431 if (device_count < 0) {
432 sr_err("zp: Failed to retrieve device list");
437 for (i = 0; i < device_count; i++) {
438 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
439 sr_err("fx2lafw: Failed to get device descriptor: %d.",
443 if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
444 && libusb_get_device_address(devlist[i]) == devc->usb->address) {
450 sr_err("device on bus %d address %d disappeared!",
451 devc->usb->bus, devc->usb->address);
455 if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
456 sdi->status = SR_ST_ACTIVE;
457 sr_info("zp: opened device %d on %d.%d interface %d",
458 sdi->index, devc->usb->bus,
459 devc->usb->address, USB_INTERFACE);
461 sr_err("zp: failed to open device: %d", ret);
465 ret = libusb_set_configuration(devc->usb->devhdl, USB_CONFIGURATION);
467 sr_err("zp: Unable to set USB configuration %d: %d",
468 USB_CONFIGURATION, ret);
472 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
474 sr_err("zp: Unable to claim interface: %d", ret);
478 /* Set default configuration after power on */
479 if (analyzer_read_status(devc->usb->devhdl) == 0)
480 analyzer_configure(devc->usb->devhdl);
482 analyzer_reset(devc->usb->devhdl);
483 analyzer_initialize(devc->usb->devhdl);
485 //analyzer_set_memory_size(MEMORY_SIZE_512K);
486 // analyzer_set_freq(g_freq, g_freq_scale);
487 analyzer_set_trigger_count(1);
488 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
489 // * get_memory_size(g_memory_size)) / 100) >> 2);
492 if (g_double_mode == 1)
493 analyzer_set_compression(COMPRESSION_DOUBLE);
494 else if (g_compression == 1)
495 analyzer_set_compression(COMPRESSION_ENABLE);
498 analyzer_set_compression(COMPRESSION_NONE);
500 if (devc->cur_samplerate == 0) {
501 /* Samplerate hasn't been set. Default to 1MHz. */
502 analyzer_set_freq(1, FREQ_SCALE_MHZ);
503 devc->cur_samplerate = SR_MHZ(1);
509 static int hw_dev_close(struct sr_dev_inst *sdi)
511 struct dev_context *devc;
513 if (!(devc = sdi->priv)) {
514 sr_err("zp: %s: sdi->priv was NULL", __func__);
518 if (!devc->usb->devhdl)
521 sr_info("zp: closing device %d on %d.%d interface %d", sdi->index,
522 devc->usb->bus, devc->usb->address, USB_INTERFACE);
523 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
524 libusb_reset_device(devc->usb->devhdl);
525 libusb_close(devc->usb->devhdl);
526 devc->usb->devhdl = NULL;
527 sdi->status = SR_ST_INACTIVE;
532 static int hw_cleanup(void)
534 struct drv_context *drvc;
536 if (!(drvc = zdi->priv))
544 static int hw_info_get(int info_id, const void **data,
545 const struct sr_dev_inst *sdi)
547 struct dev_context *devc;
553 case SR_DI_NUM_PROBES:
556 *data = GINT_TO_POINTER(devc->num_channels);
557 sr_spew("zp: %s: Returning number of channels: %d.",
558 __func__, devc->num_channels);
562 case SR_DI_PROBE_NAMES:
564 sr_spew("zp: %s: Returning probenames.", __func__);
566 case SR_DI_SAMPLERATES:
567 *data = &samplerates;
568 sr_spew("zp: %s: Returning samplerates.", __func__);
570 case SR_DI_TRIGGER_TYPES:
571 *data = TRIGGER_TYPES;
572 sr_spew("zp: %s: Returning triggertypes: %s.", __func__, TRIGGER_TYPES);
574 case SR_DI_CUR_SAMPLERATE:
577 *data = &devc->cur_samplerate;
578 sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
579 __func__, devc->cur_samplerate);
590 static int set_samplerate(struct dev_context *devc, uint64_t samplerate)
594 for (i = 0; supported_samplerates[i]; i++)
595 if (samplerate == supported_samplerates[i])
597 if (!supported_samplerates[i] || samplerate > devc->max_samplerate) {
598 sr_err("zp: %s: unsupported samplerate", __func__);
602 sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
604 if (samplerate >= SR_MHZ(1))
605 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
606 else if (samplerate >= SR_KHZ(1))
607 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
609 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
611 devc->cur_samplerate = samplerate;
616 static int set_limit_samples(struct dev_context *devc, uint64_t samples)
618 devc->limit_samples = samples;
620 if (samples <= 2 * 1024)
621 devc->memory_size = MEMORY_SIZE_8K;
622 else if (samples <= 16 * 1024)
623 devc->memory_size = MEMORY_SIZE_64K;
624 else if (samples <= 32 * 1024 ||
625 devc->max_memory_size <= 32 * 1024)
626 devc->memory_size = MEMORY_SIZE_128K;
628 devc->memory_size = MEMORY_SIZE_512K;
630 sr_info("zp: Setting memory size to %dK.",
631 get_memory_size(devc->memory_size) / 1024);
633 analyzer_set_memory_size(devc->memory_size);
638 static int set_capture_ratio(struct dev_context *devc, uint64_t ratio)
641 sr_err("zp: %s: invalid capture ratio", __func__);
645 devc->capture_ratio = ratio;
647 sr_info("zp: Setting capture ratio to %d%%.", devc->capture_ratio);
652 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
655 struct dev_context *devc;
658 sr_err("zp: %s: sdi was NULL", __func__);
662 if (!(devc = sdi->priv)) {
663 sr_err("zp: %s: sdi->priv was NULL", __func__);
668 case SR_HWCAP_SAMPLERATE:
669 return set_samplerate(devc, *(const uint64_t *)value);
670 case SR_HWCAP_LIMIT_SAMPLES:
671 return set_limit_samples(devc, *(const uint64_t *)value);
672 case SR_HWCAP_CAPTURE_RATIO:
673 return set_capture_ratio(devc, *(const uint64_t *)value);
679 static void set_triggerbar(struct dev_context *devc)
681 unsigned int ramsize;
683 unsigned int triggerbar;
685 ramsize = get_memory_size(devc->memory_size) / 4;
688 if (devc->max_memory_size < n)
689 n = devc->max_memory_size;
690 if (devc->limit_samples < n)
691 n = devc->limit_samples;
692 n = n * devc->capture_ratio / 100;
694 triggerbar = ramsize - 8;
700 analyzer_set_triggerbar_address(triggerbar);
701 analyzer_set_ramsize_trigger_address(ramsize - triggerbar);
703 sr_dbg("zp: triggerbar_address = %d(0x%x)", triggerbar, triggerbar);
704 sr_dbg("zp: ramsize_triggerbar_address = %d(0x%x)",
705 ramsize - triggerbar, ramsize - triggerbar);
708 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
711 struct sr_datafeed_packet packet;
712 struct sr_datafeed_logic logic;
713 struct sr_datafeed_header header;
714 struct sr_datafeed_meta_logic meta;
715 //uint64_t samples_read;
717 unsigned int packet_num;
720 struct dev_context *devc;
722 if (!(devc = sdi->priv)) {
723 sr_err("zp: %s: sdi->priv was NULL", __func__);
727 if (configure_probes(sdi) != SR_OK) {
728 sr_err("zp: failed to configured probes");
732 set_triggerbar(devc);
734 /* push configured settings to device */
735 analyzer_configure(devc->usb->devhdl);
737 analyzer_start(devc->usb->devhdl);
738 sr_info("zp: Waiting for data");
739 analyzer_wait_data(devc->usb->devhdl);
741 sr_info("zp: Stop address = 0x%x",
742 analyzer_get_stop_address(devc->usb->devhdl));
743 sr_info("zp: Now address = 0x%x",
744 analyzer_get_now_address(devc->usb->devhdl));
745 sr_info("zp: Trigger address = 0x%x",
746 analyzer_get_trigger_address(devc->usb->devhdl));
748 packet.type = SR_DF_HEADER;
749 packet.payload = &header;
750 header.feed_version = 1;
751 gettimeofday(&header.starttime, NULL);
752 sr_session_send(cb_data, &packet);
754 /* Send metadata about the SR_DF_LOGIC packets to come. */
755 packet.type = SR_DF_META_LOGIC;
756 packet.payload = &meta;
757 meta.samplerate = devc->cur_samplerate;
758 meta.num_probes = devc->num_channels;
759 sr_session_send(cb_data, &packet);
761 if (!(buf = g_try_malloc(PACKET_SIZE))) {
762 sr_err("zp: %s: buf malloc failed", __func__);
763 return SR_ERR_MALLOC;
767 analyzer_read_start(devc->usb->devhdl);
768 /* Send the incoming transfer to the session bus. */
769 n = get_memory_size(devc->memory_size);
770 if (devc->max_memory_size * 4 < n)
771 n = devc->max_memory_size * 4;
772 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
773 res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
774 sr_info("zp: Tried to read %d bytes, actually read %d bytes",
777 packet.type = SR_DF_LOGIC;
778 packet.payload = &logic;
779 logic.length = PACKET_SIZE;
782 sr_session_send(cb_data, &packet);
783 //samples_read += res / 4;
785 analyzer_read_stop(devc->usb->devhdl);
788 packet.type = SR_DF_END;
789 sr_session_send(cb_data, &packet);
794 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
795 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
797 struct sr_datafeed_packet packet;
798 struct dev_context *devc;
800 packet.type = SR_DF_END;
801 sr_session_send(cb_data, &packet);
803 if (!(devc = sdi->priv)) {
804 sr_err("zp: %s: sdi->priv was NULL", __func__);
808 analyzer_reset(devc->usb->devhdl);
809 /* TODO: Need to cancel and free any queued up transfers. */
814 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
815 .name = "zeroplus-logic-cube",
816 .longname = "ZEROPLUS Logic Cube LAP-C series",
819 .cleanup = hw_cleanup,
821 .dev_list = hw_dev_list,
822 .dev_clear = hw_cleanup,
823 .dev_open = hw_dev_open,
824 .dev_close = hw_dev_close,
825 .info_get = hw_info_get,
826 .dev_config_set = hw_dev_config_set,
827 .dev_acquisition_start = hw_dev_acquisition_start,
828 .dev_acquisition_stop = hw_dev_acquisition_stop,