2 * This file is part of the libsigrok 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/>.
22 #define VENDOR_NAME "ZEROPLUS"
23 #define USB_INTERFACE 0
24 #define USB_CONFIGURATION 1
25 #define NUM_TRIGGER_STAGES 4
26 #define PACKET_SIZE 2048 /* ?? */
28 //#define ZP_EXPERIMENTAL
34 unsigned int channels;
35 unsigned int sample_depth; /* In Ksamples/channel */
36 unsigned int max_sampling_freq;
40 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
41 * same 128K sample depth.
43 static const struct zp_model zeroplus_models[] = {
44 {0x0c12, 0x7002, "LAP-16128U", 16, 128, 200},
45 {0x0c12, 0x7009, "LAP-C(16064)", 16, 64, 100},
46 {0x0c12, 0x700a, "LAP-C(16128)", 16, 128, 200},
47 {0x0c12, 0x700b, "LAP-C(32128)", 32, 128, 200},
48 {0x0c12, 0x700c, "LAP-C(321000)", 32, 1024, 200},
49 {0x0c12, 0x700d, "LAP-C(322000)", 32, 2048, 200},
50 {0x0c12, 0x700e, "LAP-C(16032)", 16, 32, 100},
51 {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
55 static const uint32_t devopts[] = {
56 SR_CONF_LOGIC_ANALYZER,
57 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
58 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
59 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
60 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
61 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
64 static const int32_t trigger_matches[] = {
70 * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
71 * We currently ignore other untested/unsupported devices here.
73 static const char *channel_names[] = {
74 "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
75 "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
76 "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
77 "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
81 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
82 static struct sr_dev_driver *di = &zeroplus_logic_cube_driver_info;
85 * The hardware supports more samplerates than these, but these are the
86 * options hardcoded into the vendor's Windows GUI.
89 static const uint64_t samplerates_100[] = {
108 const uint64_t samplerates_200[] = {
129 static int dev_close(struct sr_dev_inst *sdi);
131 SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
135 for (i = 0; ARRAY_SIZE(samplerates_200); i++)
136 if (samplerate == samplerates_200[i])
139 if (i == ARRAY_SIZE(samplerates_200) || samplerate > devc->max_samplerate) {
140 sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
144 sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
146 if (samplerate >= SR_MHZ(1))
147 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
148 else if (samplerate >= SR_KHZ(1))
149 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
151 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
153 devc->cur_samplerate = samplerate;
158 static int init(struct sr_context *sr_ctx)
160 return std_init(sr_ctx, di, LOG_PREFIX);
163 static GSList *scan(GSList *options)
165 struct sr_dev_inst *sdi;
166 struct sr_channel *ch;
167 struct drv_context *drvc;
168 struct dev_context *devc;
169 const struct zp_model *prof;
170 struct libusb_device_descriptor des;
171 struct libusb_device_handle *hdl;
172 libusb_device **devlist;
175 char serial_num[64], connection_id[64];
183 /* Find all ZEROPLUS analyzers and add them to device list. */
184 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
186 for (i = 0; devlist[i]; i++) {
187 ret = libusb_get_device_descriptor(devlist[i], &des);
189 sr_err("Failed to get device descriptor: %s.",
190 libusb_error_name(ret));
194 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
197 if (des.iSerialNumber == 0) {
198 serial_num[0] = '\0';
199 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
200 des.iSerialNumber, (unsigned char *) serial_num,
201 sizeof(serial_num))) < 0) {
202 sr_warn("Failed to get serial number string descriptor: %s.",
203 libusb_error_name(ret));
209 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
212 for (j = 0; j < zeroplus_models[j].vid; j++) {
213 if (des.idVendor == zeroplus_models[j].vid &&
214 des.idProduct == zeroplus_models[j].pid) {
215 prof = &zeroplus_models[j];
218 /* Skip if the device was not found. */
221 sr_info("Found ZEROPLUS %s.", prof->model_name);
223 /* Register the device with libsigrok. */
224 if (!(sdi = sr_dev_inst_new(SR_ST_INACTIVE,
225 VENDOR_NAME, prof->model_name, NULL))) {
226 sr_err("%s: sr_dev_inst_new failed", __func__);
230 sdi->serial_num = g_strdup(serial_num);
231 sdi->connection_id = g_strdup(connection_id);
233 /* Allocate memory for our private driver context. */
234 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
235 sr_err("Device context malloc failed.");
241 devc->num_channels = prof->channels;
242 #ifdef ZP_EXPERIMENTAL
243 devc->max_sample_depth = 128 * 1024;
244 devc->max_samplerate = 200;
246 devc->max_sample_depth = prof->sample_depth * 1024;
247 devc->max_samplerate = prof->max_sampling_freq;
249 devc->max_samplerate *= SR_MHZ(1);
250 devc->memory_size = MEMORY_SIZE_8K;
251 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
253 /* Fill in channellist according to this device's profile. */
254 for (j = 0; j < devc->num_channels; j++) {
255 if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
258 sdi->channels = g_slist_append(sdi->channels, ch);
261 devices = g_slist_append(devices, sdi);
262 drvc->instances = g_slist_append(drvc->instances, sdi);
263 sdi->inst_type = SR_INST_USB;
264 sdi->conn = sr_usb_dev_inst_new(
265 libusb_get_bus_number(devlist[i]),
266 libusb_get_device_address(devlist[i]), NULL);
268 libusb_free_device_list(devlist, 1);
273 static GSList *dev_list(void)
275 return ((struct drv_context *)(di->priv))->instances;
278 static int dev_open(struct sr_dev_inst *sdi)
280 struct dev_context *devc;
281 struct drv_context *drvc;
282 struct sr_usb_dev_inst *usb;
283 libusb_device **devlist, *dev;
284 int device_count, ret, i;
285 char connection_id[64];
290 if (!(devc = sdi->priv)) {
291 sr_err("%s: sdi->priv was NULL", __func__);
295 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
297 if (device_count < 0) {
298 sr_err("Failed to retrieve device list.");
303 for (i = 0; i < device_count; i++) {
304 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
305 if (!strcmp(sdi->connection_id, connection_id)) {
311 sr_err("Device on %d.%d (logical) / %s (physical) disappeared!",
312 usb->bus, usb->address, sdi->connection_id);
316 if (!(ret = libusb_open(dev, &(usb->devhdl)))) {
317 sdi->status = SR_ST_ACTIVE;
318 sr_info("Opened device on %d.%d (logical) / %s (physical) interface %d.",
319 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
321 sr_err("Failed to open device: %s.", libusb_error_name(ret));
325 ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
327 sr_err("Unable to set USB configuration %d: %s.",
328 USB_CONFIGURATION, libusb_error_name(ret));
332 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
334 sr_err("Unable to claim interface: %s.",
335 libusb_error_name(ret));
339 /* Set default configuration after power on. */
340 if (analyzer_read_status(usb->devhdl) == 0)
341 analyzer_configure(usb->devhdl);
343 analyzer_reset(usb->devhdl);
344 analyzer_initialize(usb->devhdl);
346 //analyzer_set_memory_size(MEMORY_SIZE_512K);
347 // analyzer_set_freq(g_freq, g_freq_scale);
348 analyzer_set_trigger_count(1);
349 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
350 // * get_memory_size(g_memory_size)) / 100) >> 2);
353 if (g_double_mode == 1)
354 analyzer_set_compression(COMPRESSION_DOUBLE);
355 else if (g_compression == 1)
356 analyzer_set_compression(COMPRESSION_ENABLE);
359 analyzer_set_compression(COMPRESSION_NONE);
361 if (devc->cur_samplerate == 0) {
362 /* Samplerate hasn't been set. Default to 1MHz. */
363 analyzer_set_freq(1, FREQ_SCALE_MHZ);
364 devc->cur_samplerate = SR_MHZ(1);
367 if (devc->cur_threshold == 0)
368 set_voltage_threshold(devc, 1.5);
373 static int dev_close(struct sr_dev_inst *sdi)
375 struct sr_usb_dev_inst *usb;
382 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
383 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
384 libusb_release_interface(usb->devhdl, USB_INTERFACE);
385 libusb_reset_device(usb->devhdl);
386 libusb_close(usb->devhdl);
388 sdi->status = SR_ST_INACTIVE;
393 static int cleanup(void)
395 return std_dev_clear(di, NULL);
398 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
399 const struct sr_channel_group *cg)
401 struct dev_context *devc;
406 case SR_CONF_SAMPLERATE:
409 *data = g_variant_new_uint64(devc->cur_samplerate);
410 sr_spew("Returning samplerate: %" PRIu64 "Hz.",
411 devc->cur_samplerate);
415 case SR_CONF_CAPTURE_RATIO:
418 *data = g_variant_new_uint64(devc->capture_ratio);
422 case SR_CONF_VOLTAGE_THRESHOLD:
426 range[0] = g_variant_new_double(devc->cur_threshold);
427 range[1] = g_variant_new_double(devc->cur_threshold);
428 *data = g_variant_new_tuple(range, 2);
439 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
440 const struct sr_channel_group *cg)
442 struct dev_context *devc;
447 if (sdi->status != SR_ST_ACTIVE)
448 return SR_ERR_DEV_CLOSED;
450 if (!(devc = sdi->priv)) {
451 sr_err("%s: sdi->priv was NULL", __func__);
456 case SR_CONF_SAMPLERATE:
457 return zp_set_samplerate(devc, g_variant_get_uint64(data));
458 case SR_CONF_LIMIT_SAMPLES:
459 return set_limit_samples(devc, g_variant_get_uint64(data));
460 case SR_CONF_CAPTURE_RATIO:
461 return set_capture_ratio(devc, g_variant_get_uint64(data));
462 case SR_CONF_VOLTAGE_THRESHOLD:
463 g_variant_get(data, "(dd)", &low, &high);
464 return set_voltage_threshold(devc, (low + high) / 2.0);
472 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
473 const struct sr_channel_group *cg)
475 struct dev_context *devc;
476 GVariant *gvar, *grange[2];
484 case SR_CONF_DEVICE_OPTIONS:
485 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
486 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
488 case SR_CONF_SAMPLERATE:
490 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
491 if (devc->prof->max_sampling_freq == 100) {
492 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
493 samplerates_100, ARRAY_SIZE(samplerates_100),
495 } else if (devc->prof->max_sampling_freq == 200) {
496 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
497 samplerates_200, ARRAY_SIZE(samplerates_200),
500 sr_err("Internal error: Unknown max. samplerate: %d.",
501 devc->prof->max_sampling_freq);
504 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
505 *data = g_variant_builder_end(&gvb);
507 case SR_CONF_TRIGGER_MATCH:
508 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
509 trigger_matches, ARRAY_SIZE(trigger_matches),
512 case SR_CONF_VOLTAGE_THRESHOLD:
513 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
514 for (v = -6.0; v <= 6.0; v += 0.1) {
515 range[0] = g_variant_new_double(v);
516 range[1] = g_variant_new_double(v);
517 gvar = g_variant_new_tuple(range, 2);
518 g_variant_builder_add_value(&gvb, gvar);
520 *data = g_variant_builder_end(&gvb);
522 case SR_CONF_LIMIT_SAMPLES:
526 grange[0] = g_variant_new_uint64(0);
527 grange[1] = g_variant_new_uint64(devc->max_sample_depth);
528 *data = g_variant_new_tuple(grange, 2);
537 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
540 struct dev_context *devc;
541 struct sr_usb_dev_inst *usb;
542 struct sr_datafeed_packet packet;
543 struct sr_datafeed_logic logic;
544 unsigned int samples_read;
546 unsigned int packet_num, n;
549 unsigned int stop_address;
550 unsigned int now_address;
551 unsigned int trigger_address;
552 unsigned int trigger_offset;
553 unsigned int triggerbar;
554 unsigned int ramsize_trigger;
555 unsigned int memory_size;
556 unsigned int valid_samples;
557 unsigned int discard;
560 if (sdi->status != SR_ST_ACTIVE)
561 return SR_ERR_DEV_CLOSED;
563 if (!(devc = sdi->priv)) {
564 sr_err("%s: sdi->priv was NULL", __func__);
568 if (analyzer_add_triggers(sdi) != SR_OK) {
569 sr_err("Failed to configure triggers.");
575 set_triggerbar(devc);
577 /* Push configured settings to device. */
578 analyzer_configure(usb->devhdl);
580 analyzer_start(usb->devhdl);
581 sr_info("Waiting for data.");
582 analyzer_wait_data(usb->devhdl);
584 status = analyzer_read_status(usb->devhdl);
585 stop_address = analyzer_get_stop_address(usb->devhdl);
586 now_address = analyzer_get_now_address(usb->devhdl);
587 trigger_address = analyzer_get_trigger_address(usb->devhdl);
589 triggerbar = analyzer_get_triggerbar_address();
590 ramsize_trigger = analyzer_get_ramsize_trigger_address();
592 n = get_memory_size(devc->memory_size);
595 sr_info("Status = 0x%x.", status);
596 sr_info("Stop address = 0x%x.", stop_address);
597 sr_info("Now address = 0x%x.", now_address);
598 sr_info("Trigger address = 0x%x.", trigger_address);
599 sr_info("Triggerbar address = 0x%x.", triggerbar);
600 sr_info("Ramsize trigger = 0x%x.", ramsize_trigger);
601 sr_info("Memory size = 0x%x.", memory_size);
603 /* Send header packet to the session bus. */
604 std_session_send_df_header(cb_data, LOG_PREFIX);
606 /* Check for empty capture */
607 if ((status & STATUS_READY) && !stop_address) {
608 packet.type = SR_DF_END;
609 sr_session_send(cb_data, &packet);
613 if (!(buf = g_try_malloc(PACKET_SIZE))) {
614 sr_err("Packet buffer malloc failed.");
615 return SR_ERR_MALLOC;
618 /* Check if the trigger is in the samples we are throwing away */
619 trigger_now = now_address == trigger_address ||
620 ((now_address + 1) % memory_size) == trigger_address;
623 * STATUS_READY doesn't clear until now_address advances past
624 * addr 0, but for our logic, clear it in that case
627 status &= ~STATUS_READY;
629 analyzer_read_start(usb->devhdl);
631 /* Calculate how much data to discard */
633 if (status & STATUS_READY) {
635 * We haven't wrapped around, we need to throw away data from
636 * our current position to the end of the buffer.
637 * Additionally, the first two samples captured are always
640 discard += memory_size - now_address + 2;
644 /* If we have more samples than we need, discard them */
645 valid_samples = (stop_address - now_address) % memory_size;
646 if (valid_samples > ramsize_trigger + triggerbar) {
647 discard += valid_samples - (ramsize_trigger + triggerbar);
648 now_address += valid_samples - (ramsize_trigger + triggerbar);
651 sr_info("Need to discard %d samples.", discard);
653 /* Calculate how far in the trigger is */
657 trigger_offset = (trigger_address - now_address) % memory_size;
659 /* Recalculate the number of samples available */
660 valid_samples = (stop_address - now_address) % memory_size;
662 /* Send the incoming transfer to the session bus. */
664 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
666 unsigned int buf_offset;
668 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
669 sr_info("Tried to read %d bytes, actually read %d bytes.",
672 if (discard >= PACKET_SIZE / 4) {
673 discard -= PACKET_SIZE / 4;
677 len = PACKET_SIZE - discard * 4;
678 buf_offset = discard * 4;
681 /* Check if we've read all the samples */
682 if (samples_read + len / 4 >= valid_samples)
683 len = (valid_samples - samples_read) * 4;
687 if (samples_read < trigger_offset &&
688 samples_read + len / 4 > trigger_offset) {
689 /* Send out samples remaining before trigger */
690 packet.type = SR_DF_LOGIC;
691 packet.payload = &logic;
692 logic.length = (trigger_offset - samples_read) * 4;
694 logic.data = buf + buf_offset;
695 sr_session_send(cb_data, &packet);
697 samples_read += logic.length / 4;
698 buf_offset += logic.length;
701 if (samples_read == trigger_offset) {
702 /* Send out trigger */
703 packet.type = SR_DF_TRIGGER;
704 packet.payload = NULL;
705 sr_session_send(cb_data, &packet);
708 /* Send out data (or data after trigger) */
709 packet.type = SR_DF_LOGIC;
710 packet.payload = &logic;
713 logic.data = buf + buf_offset;
714 sr_session_send(cb_data, &packet);
715 samples_read += len / 4;
717 analyzer_read_stop(usb->devhdl);
720 packet.type = SR_DF_END;
721 sr_session_send(cb_data, &packet);
726 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
727 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
729 struct dev_context *devc;
730 struct sr_usb_dev_inst *usb;
731 struct sr_datafeed_packet packet;
733 packet.type = SR_DF_END;
734 sr_session_send(cb_data, &packet);
736 if (!(devc = sdi->priv)) {
737 sr_err("%s: sdi->priv was NULL", __func__);
742 analyzer_reset(usb->devhdl);
743 /* TODO: Need to cancel and free any queued up transfers. */
748 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
749 .name = "zeroplus-logic-cube",
750 .longname = "ZEROPLUS Logic Cube LAP-C series",
755 .dev_list = dev_list,
757 .config_get = config_get,
758 .config_set = config_set,
759 .config_list = config_list,
760 .dev_open = dev_open,
761 .dev_close = dev_close,
762 .dev_acquisition_start = dev_acquisition_start,
763 .dev_acquisition_stop = dev_acquisition_stop,