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,
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;
111 static libusb_context *usb_context = NULL;
114 * The hardware supports more samplerates than these, but these are the
115 * options hardcoded into the vendor's Windows GUI.
119 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
122 static const uint64_t supported_samplerates[] = {
144 static const struct sr_samplerates samplerates = {
148 supported_samplerates,
151 /* Private driver context. */
156 /* Private, per-device-instance driver context. */
158 uint64_t cur_samplerate;
159 uint64_t limit_samples;
160 int num_channels; /* TODO: This isn't initialized before it's needed :( */
161 uint64_t memory_size;
163 uint8_t trigger_mask[NUM_TRIGGER_STAGES];
164 uint8_t trigger_value[NUM_TRIGGER_STAGES];
165 // uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
167 /* TODO: this belongs in the device instance */
168 struct sr_usb_dev_inst *usb;
171 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
173 static int hw_dev_close(struct sr_dev_inst *sdi);
175 static unsigned int get_memory_size(int type)
177 if (type == MEMORY_SIZE_8K)
179 else if (type == MEMORY_SIZE_64K)
181 else if (type == MEMORY_SIZE_128K)
183 else if (type == MEMORY_SIZE_512K)
189 static int configure_probes(const struct sr_dev_inst *sdi, const GSList *probes)
191 struct dev_context *devc;
192 const struct sr_probe *probe;
194 int probe_bit, stage, i;
197 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
200 devc->probe_mask = 0;
201 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
202 devc->trigger_mask[i] = 0;
203 devc->trigger_value[i] = 0;
207 for (l = probes; l; l = l->next) {
208 probe = (struct sr_probe *)l->data;
209 if (probe->enabled == FALSE)
211 probe_bit = 1 << (probe->index);
212 devc->probe_mask |= probe_bit;
214 if (probe->trigger) {
216 for (tc = probe->trigger; *tc; tc++) {
217 devc->trigger_mask[stage] |= probe_bit;
219 devc->trigger_value[stage] |= probe_bit;
221 if (stage > NUM_TRIGGER_STAGES)
230 static void clear_instances(void)
233 struct sr_dev_inst *sdi;
234 struct drv_context *drvc;
235 struct dev_context *devc;
238 for (l = drvc->instances; l; l = l->next) {
240 if (!(devc = sdi->priv)) {
241 /* Log error, but continue cleaning up the rest. */
242 sr_err("zeroplus: %s: sdi->priv was NULL, continuing", __func__);
245 sr_usb_dev_inst_free(devc->usb);
246 /* Properly close all devices... */
248 /* ...and free all their memory. */
249 sr_dev_inst_free(sdi);
251 g_slist_free(drvc->instances);
252 drvc->instances = NULL;
260 static int hw_init(void)
262 struct drv_context *drvc;
264 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
265 sr_err("zeroplus: driver context malloc failed.");
270 if (libusb_init(&usb_context) != 0) {
271 sr_err("zp: Failed to initialize USB.");
278 static GSList *hw_scan(GSList *options)
280 struct sr_dev_inst *sdi;
281 struct sr_probe *probe;
282 struct drv_context *drvc;
283 struct dev_context *devc;
285 struct libusb_device_descriptor des;
286 libusb_device **devlist;
288 int ret, devcnt, i, j;
296 /* Find all ZEROPLUS analyzers and add them to device list. */
298 libusb_get_device_list(usb_context, &devlist); /* TODO: Errors. */
300 for (i = 0; devlist[i]; i++) {
301 ret = libusb_get_device_descriptor(devlist[i], &des);
303 sr_err("zp: failed to get device descriptor: %d", ret);
308 for (j = 0; j < zeroplus_models[j].vid; j++) {
309 if (des.idVendor == zeroplus_models[j].vid &&
310 des.idProduct == zeroplus_models[j].pid) {
311 prof = &zeroplus_models[j];
314 /* Skip if the device was not found */
317 sr_info("zp: Found ZEROPLUS model %s", prof->model_name);
319 /* Register the device with libsigrok. */
320 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
321 VENDOR_NAME, prof->model_name, NULL))) {
322 sr_err("zp: %s: sr_dev_inst_new failed", __func__);
327 /* Allocate memory for our private driver context. */
328 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
329 sr_err("zp: %s: devc malloc failed", __func__);
333 devc->num_channels = prof->channels;
334 devc->memory_size = prof->sample_depth * 1024;
335 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
337 /* Fill in probelist according to this device's profile. */
338 for (j = 0; j < devc->num_channels; j++) {
339 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
342 sdi->probes = g_slist_append(sdi->probes, probe);
345 devices = g_slist_append(devices, sdi);
346 drvc->instances = g_slist_append(drvc->instances, sdi);
347 devc->usb = sr_usb_dev_inst_new(
348 libusb_get_bus_number(devlist[i]),
349 libusb_get_device_address(devlist[i]), NULL);
353 libusb_free_device_list(devlist, 1);
358 static int hw_dev_open(struct sr_dev_inst *sdi)
360 struct dev_context *devc;
361 libusb_device **devlist, *dev;
362 struct libusb_device_descriptor des;
363 int device_count, ret, i;
365 if (!(devc = sdi->priv)) {
366 sr_err("zp: %s: sdi->priv was NULL", __func__);
370 device_count = libusb_get_device_list(usb_context, &devlist);
371 if (device_count < 0) {
372 sr_err("zp: Failed to retrieve device list");
377 for (i = 0; i < device_count; i++) {
378 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
379 sr_err("fx2lafw: Failed to get device descriptor: %d.",
383 if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
384 && libusb_get_device_address(devlist[i]) == devc->usb->address) {
390 sr_err("device on bus %d address %d disappeared!",
391 devc->usb->bus, devc->usb->address);
395 if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
396 sdi->status = SR_ST_ACTIVE;
397 sr_info("zp: opened device %d on %d.%d interface %d",
398 sdi->index, devc->usb->bus,
399 devc->usb->address, USB_INTERFACE);
401 sr_err("zp: failed to open device: %d", ret);
405 ret = libusb_set_configuration(devc->usb->devhdl, USB_CONFIGURATION);
407 sr_err("zp: Unable to set USB configuration %d: %d",
408 USB_CONFIGURATION, ret);
412 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
414 sr_err("zp: Unable to claim interface: %d", ret);
418 analyzer_reset(devc->usb->devhdl);
419 analyzer_initialize(devc->usb->devhdl);
421 analyzer_set_memory_size(MEMORY_SIZE_512K);
422 // analyzer_set_freq(g_freq, g_freq_scale);
423 analyzer_set_trigger_count(1);
424 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
425 // * get_memory_size(g_memory_size)) / 100) >> 2);
426 analyzer_set_ramsize_trigger_address(
427 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
430 if (g_double_mode == 1)
431 analyzer_set_compression(COMPRESSION_DOUBLE);
432 else if (g_compression == 1)
433 analyzer_set_compression(COMPRESSION_ENABLE);
436 analyzer_set_compression(COMPRESSION_NONE);
438 if (devc->cur_samplerate == 0) {
439 /* Samplerate hasn't been set. Default to the slowest one. */
440 if (hw_dev_config_set(sdi, SR_HWCAP_SAMPLERATE,
441 &samplerates.list[0]) == SR_ERR)
448 static int hw_dev_close(struct sr_dev_inst *sdi)
450 struct dev_context *devc;
452 if (!(devc = sdi->priv)) {
453 sr_err("zp: %s: sdi->priv was NULL", __func__);
457 if (!devc->usb->devhdl)
460 sr_info("zp: closing device %d on %d.%d interface %d", sdi->index,
461 devc->usb->bus, devc->usb->address, USB_INTERFACE);
462 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
463 libusb_reset_device(devc->usb->devhdl);
464 libusb_close(devc->usb->devhdl);
465 devc->usb->devhdl = NULL;
466 sdi->status = SR_ST_INACTIVE;
471 static int hw_cleanup(void)
473 struct drv_context *drvc;
475 if (!(drvc = zdi->priv))
481 libusb_exit(usb_context);
487 static int hw_info_get(int info_id, const void **data,
488 const struct sr_dev_inst *sdi)
490 struct dev_context *devc;
496 case SR_DI_NUM_PROBES:
499 *data = GINT_TO_POINTER(devc->num_channels);
500 sr_spew("zp: %s: Returning number of channels: %d.",
501 __func__, devc->num_channels);
505 case SR_DI_PROBE_NAMES:
507 sr_spew("zp: %s: Returning probenames.", __func__);
509 case SR_DI_SAMPLERATES:
510 *data = &samplerates;
511 sr_spew("zp: %s: Returning samplerates.", __func__);
513 case SR_DI_TRIGGER_TYPES:
514 *data = TRIGGER_TYPES;
515 sr_spew("zp: %s: Returning triggertypes: %s.", __func__, TRIGGER_TYPES);
517 case SR_DI_CUR_SAMPLERATE:
520 *data = &devc->cur_samplerate;
521 sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
522 __func__, devc->cur_samplerate);
533 static int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
535 struct dev_context *devc;
538 sr_err("zp: %s: sdi was NULL", __func__);
542 if (!(devc = sdi->priv)) {
543 sr_err("zp: %s: sdi->priv was NULL", __func__);
547 sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
549 if (samplerate > SR_MHZ(1))
550 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
551 else if (samplerate > SR_KHZ(1))
552 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
554 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
556 devc->cur_samplerate = samplerate;
561 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
564 struct dev_context *devc;
566 if (!(devc = sdi->priv)) {
567 sr_err("zp: %s: sdi->priv was NULL", __func__);
572 case SR_HWCAP_SAMPLERATE:
573 return set_samplerate(sdi, *(const uint64_t *)value);
574 case SR_HWCAP_PROBECONFIG:
575 return configure_probes(sdi, (const GSList *)value);
576 case SR_HWCAP_LIMIT_SAMPLES:
577 devc->limit_samples = *(const uint64_t *)value;
584 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
587 struct sr_datafeed_packet packet;
588 struct sr_datafeed_logic logic;
589 struct sr_datafeed_header header;
590 struct sr_datafeed_meta_logic meta;
591 uint64_t samples_read;
593 unsigned int packet_num;
595 struct dev_context *devc;
597 if (!(devc = sdi->priv)) {
598 sr_err("zp: %s: sdi->priv was NULL", __func__);
602 /* push configured settings to device */
603 analyzer_configure(devc->usb->devhdl);
605 analyzer_start(devc->usb->devhdl);
606 sr_info("zp: Waiting for data");
607 analyzer_wait_data(devc->usb->devhdl);
609 sr_info("zp: Stop address = 0x%x",
610 analyzer_get_stop_address(devc->usb->devhdl));
611 sr_info("zp: Now address = 0x%x",
612 analyzer_get_now_address(devc->usb->devhdl));
613 sr_info("zp: Trigger address = 0x%x",
614 analyzer_get_trigger_address(devc->usb->devhdl));
616 packet.type = SR_DF_HEADER;
617 packet.payload = &header;
618 header.feed_version = 1;
619 gettimeofday(&header.starttime, NULL);
620 sr_session_send(cb_data, &packet);
622 /* Send metadata about the SR_DF_LOGIC packets to come. */
623 packet.type = SR_DF_META_LOGIC;
624 packet.payload = &meta;
625 meta.samplerate = devc->cur_samplerate;
626 meta.num_probes = devc->num_channels;
627 sr_session_send(cb_data, &packet);
629 if (!(buf = g_try_malloc(PACKET_SIZE))) {
630 sr_err("zp: %s: buf malloc failed", __func__);
631 return SR_ERR_MALLOC;
635 analyzer_read_start(devc->usb->devhdl);
636 /* Send the incoming transfer to the session bus. */
637 for (packet_num = 0; packet_num < (devc->memory_size * 4 / PACKET_SIZE);
639 res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
640 sr_info("zp: Tried to read %llx bytes, actually read %x bytes",
643 packet.type = SR_DF_LOGIC;
644 packet.payload = &logic;
645 logic.length = PACKET_SIZE;
648 sr_session_send(cb_data, &packet);
649 samples_read += res / 4;
651 analyzer_read_stop(devc->usb->devhdl);
654 packet.type = SR_DF_END;
655 sr_session_send(cb_data, &packet);
660 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
661 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
664 struct sr_datafeed_packet packet;
665 struct dev_context *devc;
667 packet.type = SR_DF_END;
668 sr_session_send(cb_data, &packet);
670 if (!(devc = sdi->priv)) {
671 sr_err("zp: %s: sdi->priv was NULL", __func__);
675 analyzer_reset(devc->usb->devhdl);
676 /* TODO: Need to cancel and free any queued up transfers. */
681 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
682 .name = "zeroplus-logic-cube",
683 .longname = "ZEROPLUS Logic Cube LAP-C series",
686 .cleanup = hw_cleanup,
688 .dev_open = hw_dev_open,
689 .dev_close = hw_dev_close,
690 .info_get = hw_info_get,
691 .dev_config_set = hw_dev_config_set,
692 .dev_acquisition_start = hw_dev_acquisition_start,
693 .dev_acquisition_stop = hw_dev_acquisition_stop,