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 /* ?? */
50 unsigned int channels;
51 unsigned int sample_depth; /* In Ksamples/channel */
52 unsigned int max_sampling_freq;
56 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
57 * same 128K sample depth.
59 static model_t zeroplus_models[] = {
60 {0x0c12, 0x7009, "LAP-C(16064)", 16, 64, 100},
61 {0x0c12, 0x700A, "LAP-C(16128)", 16, 128, 200},
62 /* TODO: we don't know anything about these
63 {0x0c12, 0x700B, "LAP-C(32128)", 32, 128, 200},
64 {0x0c12, 0x700C, "LAP-C(321000)", 32, 1024, 200},
65 {0x0c12, 0x700D, "LAP-C(322000)", 32, 2048, 200},
67 {0x0c12, 0x700E, "LAP-C(16032)", 16, 32, 100},
68 {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
72 static const int hwcaps[] = {
73 SR_HWCAP_LOGIC_ANALYZER,
75 SR_HWCAP_CAPTURE_RATIO,
77 /* These are really implemented in the driver, not the hardware. */
78 SR_HWCAP_LIMIT_SAMPLES,
83 * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
84 * We currently ignore other untested/unsupported devices here.
86 static const char *probe_names[NUM_PROBES + 1] = {
106 /* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
107 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
108 static struct sr_dev_driver *zdi = &zeroplus_logic_cube_driver_info;
110 static libusb_context *usb_context = NULL;
113 * The hardware supports more samplerates than these, but these are the
114 * options hardcoded into the vendor's Windows GUI.
118 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
121 static const uint64_t supported_samplerates[] = {
143 static const struct sr_samplerates samplerates = {
147 supported_samplerates,
150 /* Private driver context. */
155 /* Private, per-device-instance driver context. */
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 /* TODO: this belongs in the device instance */
167 struct sr_usb_dev_inst *usb;
170 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
172 static int hw_dev_close(struct sr_dev_inst *sdi);
174 static unsigned int get_memory_size(int type)
176 if (type == MEMORY_SIZE_8K)
178 else if (type == MEMORY_SIZE_64K)
180 else if (type == MEMORY_SIZE_128K)
182 else if (type == MEMORY_SIZE_512K)
188 static int configure_probes(const struct sr_dev_inst *sdi)
190 struct dev_context *devc;
191 const struct sr_probe *probe;
193 int probe_bit, stage, i;
196 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
199 devc->probe_mask = 0;
200 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
201 devc->trigger_mask[i] = 0;
202 devc->trigger_value[i] = 0;
206 for (l = sdi->probes; l; l = l->next) {
207 probe = (struct sr_probe *)l->data;
208 if (probe->enabled == FALSE)
210 probe_bit = 1 << (probe->index);
211 devc->probe_mask |= probe_bit;
213 if (probe->trigger) {
215 for (tc = probe->trigger; *tc; tc++) {
216 devc->trigger_mask[stage] |= probe_bit;
218 devc->trigger_value[stage] |= probe_bit;
220 if (stage > NUM_TRIGGER_STAGES)
229 static void clear_instances(void)
232 struct sr_dev_inst *sdi;
233 struct drv_context *drvc;
234 struct dev_context *devc;
237 for (l = drvc->instances; l; l = l->next) {
239 if (!(devc = sdi->priv)) {
240 /* Log error, but continue cleaning up the rest. */
241 sr_err("zeroplus: %s: sdi->priv was NULL, continuing", __func__);
244 sr_usb_dev_inst_free(devc->usb);
245 /* Properly close all devices... */
247 /* ...and free all their memory. */
248 sr_dev_inst_free(sdi);
250 g_slist_free(drvc->instances);
251 drvc->instances = NULL;
259 static int hw_init(void)
261 struct drv_context *drvc;
263 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
264 sr_err("zeroplus: driver context malloc failed.");
269 if (libusb_init(&usb_context) != 0) {
270 sr_err("zp: Failed to initialize USB.");
277 static GSList *hw_scan(GSList *options)
279 struct sr_dev_inst *sdi;
280 struct sr_probe *probe;
281 struct drv_context *drvc;
282 struct dev_context *devc;
284 struct libusb_device_descriptor des;
285 libusb_device **devlist;
287 int ret, devcnt, i, j;
295 /* Find all ZEROPLUS analyzers and add them to device list. */
297 libusb_get_device_list(usb_context, &devlist); /* TODO: Errors. */
299 for (i = 0; devlist[i]; i++) {
300 ret = libusb_get_device_descriptor(devlist[i], &des);
302 sr_err("zp: failed to get device descriptor: %d", ret);
307 for (j = 0; j < zeroplus_models[j].vid; j++) {
308 if (des.idVendor == zeroplus_models[j].vid &&
309 des.idProduct == zeroplus_models[j].pid) {
310 prof = &zeroplus_models[j];
313 /* Skip if the device was not found */
316 sr_info("zp: Found ZEROPLUS model %s", prof->model_name);
318 /* Register the device with libsigrok. */
319 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
320 VENDOR_NAME, prof->model_name, NULL))) {
321 sr_err("zp: %s: sr_dev_inst_new failed", __func__);
326 /* Allocate memory for our private driver context. */
327 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
328 sr_err("zp: %s: devc malloc failed", __func__);
332 devc->num_channels = prof->channels;
333 devc->memory_size = prof->sample_depth * 1024;
334 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
336 /* Fill in probelist according to this device's profile. */
337 for (j = 0; j < devc->num_channels; j++) {
338 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
341 sdi->probes = g_slist_append(sdi->probes, probe);
344 devices = g_slist_append(devices, sdi);
345 drvc->instances = g_slist_append(drvc->instances, sdi);
346 devc->usb = sr_usb_dev_inst_new(
347 libusb_get_bus_number(devlist[i]),
348 libusb_get_device_address(devlist[i]), NULL);
352 libusb_free_device_list(devlist, 1);
357 static int hw_dev_open(struct sr_dev_inst *sdi)
359 struct dev_context *devc;
360 libusb_device **devlist, *dev;
361 struct libusb_device_descriptor des;
362 int device_count, ret, i;
364 if (!(devc = sdi->priv)) {
365 sr_err("zp: %s: sdi->priv was NULL", __func__);
369 device_count = libusb_get_device_list(usb_context, &devlist);
370 if (device_count < 0) {
371 sr_err("zp: Failed to retrieve device list");
376 for (i = 0; i < device_count; i++) {
377 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
378 sr_err("fx2lafw: Failed to get device descriptor: %d.",
382 if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
383 && libusb_get_device_address(devlist[i]) == devc->usb->address) {
389 sr_err("device on bus %d address %d disappeared!",
390 devc->usb->bus, devc->usb->address);
394 if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
395 sdi->status = SR_ST_ACTIVE;
396 sr_info("zp: opened device %d on %d.%d interface %d",
397 sdi->index, devc->usb->bus,
398 devc->usb->address, USB_INTERFACE);
400 sr_err("zp: failed to open device: %d", ret);
404 ret = libusb_set_configuration(devc->usb->devhdl, USB_CONFIGURATION);
406 sr_err("zp: Unable to set USB configuration %d: %d",
407 USB_CONFIGURATION, ret);
411 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
413 sr_err("zp: Unable to claim interface: %d", ret);
417 analyzer_reset(devc->usb->devhdl);
418 analyzer_initialize(devc->usb->devhdl);
420 analyzer_set_memory_size(MEMORY_SIZE_512K);
421 // analyzer_set_freq(g_freq, g_freq_scale);
422 analyzer_set_trigger_count(1);
423 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
424 // * get_memory_size(g_memory_size)) / 100) >> 2);
425 analyzer_set_ramsize_trigger_address(
426 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
429 if (g_double_mode == 1)
430 analyzer_set_compression(COMPRESSION_DOUBLE);
431 else if (g_compression == 1)
432 analyzer_set_compression(COMPRESSION_ENABLE);
435 analyzer_set_compression(COMPRESSION_NONE);
437 if (devc->cur_samplerate == 0) {
438 /* Samplerate hasn't been set. Default to the slowest one. */
439 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
440 &samplerates.list[0]) == SR_ERR)
447 static int hw_dev_close(struct sr_dev_inst *sdi)
449 struct dev_context *devc;
451 if (!(devc = sdi->priv)) {
452 sr_err("zp: %s: sdi->priv was NULL", __func__);
456 if (!devc->usb->devhdl)
459 sr_info("zp: closing device %d on %d.%d interface %d", sdi->index,
460 devc->usb->bus, devc->usb->address, USB_INTERFACE);
461 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
462 libusb_reset_device(devc->usb->devhdl);
463 libusb_close(devc->usb->devhdl);
464 devc->usb->devhdl = NULL;
465 sdi->status = SR_ST_INACTIVE;
470 static int hw_cleanup(void)
472 struct drv_context *drvc;
474 if (!(drvc = zdi->priv))
480 libusb_exit(usb_context);
486 static int hw_info_get(int info_id, const void **data,
487 const struct sr_dev_inst *sdi)
489 struct dev_context *devc;
495 case SR_DI_NUM_PROBES:
498 *data = GINT_TO_POINTER(devc->num_channels);
499 sr_spew("zp: %s: Returning number of channels: %d.",
500 __func__, devc->num_channels);
504 case SR_DI_PROBE_NAMES:
506 sr_spew("zp: %s: Returning probenames.", __func__);
508 case SR_DI_SAMPLERATES:
509 *data = &samplerates;
510 sr_spew("zp: %s: Returning samplerates.", __func__);
512 case SR_DI_TRIGGER_TYPES:
513 *data = TRIGGER_TYPES;
514 sr_spew("zp: %s: Returning triggertypes: %s.", __func__, TRIGGER_TYPES);
516 case SR_DI_CUR_SAMPLERATE:
519 *data = &devc->cur_samplerate;
520 sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
521 __func__, devc->cur_samplerate);
532 static int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
534 struct dev_context *devc;
537 sr_err("zp: %s: sdi was NULL", __func__);
541 if (!(devc = sdi->priv)) {
542 sr_err("zp: %s: sdi->priv was NULL", __func__);
546 sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
548 if (samplerate > SR_MHZ(1))
549 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
550 else if (samplerate > SR_KHZ(1))
551 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
553 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
555 devc->cur_samplerate = samplerate;
560 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
563 struct dev_context *devc;
565 if (!(devc = sdi->priv)) {
566 sr_err("zp: %s: sdi->priv was NULL", __func__);
571 case SR_HWCAP_SAMPLERATE:
572 return set_samplerate(sdi, *(const uint64_t *)value);
573 case SR_HWCAP_LIMIT_SAMPLES:
574 devc->limit_samples = *(const uint64_t *)value;
581 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
584 struct sr_datafeed_packet packet;
585 struct sr_datafeed_logic logic;
586 struct sr_datafeed_header header;
587 struct sr_datafeed_meta_logic meta;
588 uint64_t samples_read;
590 unsigned int packet_num;
592 struct dev_context *devc;
594 if (!(devc = sdi->priv)) {
595 sr_err("zp: %s: sdi->priv was NULL", __func__);
599 if (configure_probes(sdi) != SR_OK) {
600 sr_err("zp: failed to configured probes");
604 /* push configured settings to device */
605 analyzer_configure(devc->usb->devhdl);
607 analyzer_start(devc->usb->devhdl);
608 sr_info("zp: Waiting for data");
609 analyzer_wait_data(devc->usb->devhdl);
611 sr_info("zp: Stop address = 0x%x",
612 analyzer_get_stop_address(devc->usb->devhdl));
613 sr_info("zp: Now address = 0x%x",
614 analyzer_get_now_address(devc->usb->devhdl));
615 sr_info("zp: Trigger address = 0x%x",
616 analyzer_get_trigger_address(devc->usb->devhdl));
618 packet.type = SR_DF_HEADER;
619 packet.payload = &header;
620 header.feed_version = 1;
621 gettimeofday(&header.starttime, NULL);
622 sr_session_send(cb_data, &packet);
624 /* Send metadata about the SR_DF_LOGIC packets to come. */
625 packet.type = SR_DF_META_LOGIC;
626 packet.payload = &meta;
627 meta.samplerate = devc->cur_samplerate;
628 meta.num_probes = devc->num_channels;
629 sr_session_send(cb_data, &packet);
631 if (!(buf = g_try_malloc(PACKET_SIZE))) {
632 sr_err("zp: %s: buf malloc failed", __func__);
633 return SR_ERR_MALLOC;
637 analyzer_read_start(devc->usb->devhdl);
638 /* Send the incoming transfer to the session bus. */
639 for (packet_num = 0; packet_num < (devc->memory_size * 4 / PACKET_SIZE);
641 res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
642 sr_info("zp: Tried to read %llx bytes, actually read %x bytes",
645 packet.type = SR_DF_LOGIC;
646 packet.payload = &logic;
647 logic.length = PACKET_SIZE;
650 sr_session_send(cb_data, &packet);
651 samples_read += res / 4;
653 analyzer_read_stop(devc->usb->devhdl);
656 packet.type = SR_DF_END;
657 sr_session_send(cb_data, &packet);
662 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
663 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
666 struct sr_datafeed_packet packet;
667 struct dev_context *devc;
669 packet.type = SR_DF_END;
670 sr_session_send(cb_data, &packet);
672 if (!(devc = sdi->priv)) {
673 sr_err("zp: %s: sdi->priv was NULL", __func__);
677 analyzer_reset(devc->usb->devhdl);
678 /* TODO: Need to cancel and free any queued up transfers. */
683 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
684 .name = "zeroplus-logic-cube",
685 .longname = "ZEROPLUS Logic Cube LAP-C series",
688 .cleanup = hw_cleanup,
690 .dev_open = hw_dev_open,
691 .dev_close = hw_dev_close,
692 .info_get = hw_info_get,
693 .dev_config_set = hw_dev_config_set,
694 .dev_acquisition_start = hw_dev_acquisition_start,
695 .dev_acquisition_stop = hw_dev_acquisition_stop,