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},
52 {0x0c12, 0x7100, "AKIP-9101", 16, 256, 200},
56 static const uint32_t devopts[] = {
57 SR_CONF_LOGIC_ANALYZER,
58 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
59 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
60 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
61 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
62 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
65 static const int32_t trigger_matches[] = {
71 * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
72 * We currently ignore other untested/unsupported devices here.
74 static const char *channel_names[] = {
75 "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
76 "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
77 "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
78 "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
81 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
84 * The hardware supports more samplerates than these, but these are the
85 * options hardcoded into the vendor's Windows GUI.
88 static const uint64_t samplerates_100[] = {
107 const uint64_t samplerates_200[] = {
128 static int dev_close(struct sr_dev_inst *sdi);
130 SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
134 for (i = 0; ARRAY_SIZE(samplerates_200); i++)
135 if (samplerate == samplerates_200[i])
138 if (i == ARRAY_SIZE(samplerates_200) || samplerate > devc->max_samplerate) {
139 sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
143 sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
145 if (samplerate >= SR_MHZ(1))
146 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
147 else if (samplerate >= SR_KHZ(1))
148 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
150 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
152 devc->cur_samplerate = samplerate;
157 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
159 return std_init(sr_ctx, di, LOG_PREFIX);
162 static GSList *scan(struct sr_dev_driver *di, GSList *options)
164 struct sr_dev_inst *sdi;
165 struct drv_context *drvc;
166 struct dev_context *devc;
167 const struct zp_model *prof;
168 struct libusb_device_descriptor des;
169 struct libusb_device_handle *hdl;
170 libusb_device **devlist;
173 char serial_num[64], connection_id[64];
181 /* Find all ZEROPLUS analyzers and add them to device list. */
182 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
184 for (i = 0; devlist[i]; i++) {
185 ret = libusb_get_device_descriptor(devlist[i], &des);
187 sr_err("Failed to get device descriptor: %s.",
188 libusb_error_name(ret));
192 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
195 if (des.iSerialNumber == 0) {
196 serial_num[0] = '\0';
197 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
198 des.iSerialNumber, (unsigned char *) serial_num,
199 sizeof(serial_num))) < 0) {
200 sr_warn("Failed to get serial number string descriptor: %s.",
201 libusb_error_name(ret));
207 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
210 for (j = 0; j < zeroplus_models[j].vid; j++) {
211 if (des.idVendor == zeroplus_models[j].vid &&
212 des.idProduct == zeroplus_models[j].pid) {
213 prof = &zeroplus_models[j];
216 /* Skip if the device was not found. */
219 sr_info("Found ZEROPLUS %s.", prof->model_name);
221 /* Register the device with libsigrok. */
222 sdi = g_malloc0(sizeof(struct sr_dev_inst));
223 sdi->status = SR_ST_INACTIVE;
224 sdi->vendor = g_strdup(VENDOR_NAME);
225 sdi->model = g_strdup(prof->model_name);
227 sdi->serial_num = g_strdup(serial_num);
228 sdi->connection_id = g_strdup(connection_id);
230 /* Allocate memory for our private driver context. */
231 devc = g_malloc0(sizeof(struct dev_context));
234 devc->num_channels = prof->channels;
235 #ifdef ZP_EXPERIMENTAL
236 devc->max_sample_depth = 128 * 1024;
237 devc->max_samplerate = 200;
239 devc->max_sample_depth = prof->sample_depth * 1024;
240 devc->max_samplerate = prof->max_sampling_freq;
242 devc->max_samplerate *= SR_MHZ(1);
243 devc->memory_size = MEMORY_SIZE_8K;
244 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
246 /* Fill in channellist according to this device's profile. */
247 for (j = 0; j < devc->num_channels; j++)
248 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
251 devices = g_slist_append(devices, sdi);
252 drvc->instances = g_slist_append(drvc->instances, sdi);
253 sdi->inst_type = SR_INST_USB;
254 sdi->conn = sr_usb_dev_inst_new(
255 libusb_get_bus_number(devlist[i]),
256 libusb_get_device_address(devlist[i]), NULL);
258 libusb_free_device_list(devlist, 1);
263 static GSList *dev_list(const struct sr_dev_driver *di)
265 return ((struct drv_context *)(di->priv))->instances;
268 static int dev_open(struct sr_dev_inst *sdi)
270 struct sr_dev_driver *di = sdi->driver;
271 struct dev_context *devc;
272 struct drv_context *drvc;
273 struct sr_usb_dev_inst *usb;
274 libusb_device **devlist, *dev;
275 int device_count, ret, i;
276 char connection_id[64];
281 if (!(devc = sdi->priv)) {
282 sr_err("%s: sdi->priv was NULL", __func__);
286 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
288 if (device_count < 0) {
289 sr_err("Failed to retrieve device list.");
294 for (i = 0; i < device_count; i++) {
295 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
296 if (!strcmp(sdi->connection_id, connection_id)) {
302 sr_err("Device on %d.%d (logical) / %s (physical) disappeared!",
303 usb->bus, usb->address, sdi->connection_id);
307 if (!(ret = libusb_open(dev, &(usb->devhdl)))) {
308 sdi->status = SR_ST_ACTIVE;
309 sr_info("Opened device on %d.%d (logical) / %s (physical) interface %d.",
310 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
312 sr_err("Failed to open device: %s.", libusb_error_name(ret));
316 ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
318 sr_err("Unable to set USB configuration %d: %s.",
319 USB_CONFIGURATION, libusb_error_name(ret));
323 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
325 sr_err("Unable to claim interface: %s.",
326 libusb_error_name(ret));
330 /* Set default configuration after power on. */
331 if (analyzer_read_status(usb->devhdl) == 0)
332 analyzer_configure(usb->devhdl);
334 analyzer_reset(usb->devhdl);
335 analyzer_initialize(usb->devhdl);
337 //analyzer_set_memory_size(MEMORY_SIZE_512K);
338 // analyzer_set_freq(g_freq, g_freq_scale);
339 analyzer_set_trigger_count(1);
340 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
341 // * get_memory_size(g_memory_size)) / 100) >> 2);
344 if (g_double_mode == 1)
345 analyzer_set_compression(COMPRESSION_DOUBLE);
346 else if (g_compression == 1)
347 analyzer_set_compression(COMPRESSION_ENABLE);
350 analyzer_set_compression(COMPRESSION_NONE);
352 if (devc->cur_samplerate == 0) {
353 /* Samplerate hasn't been set. Default to 1MHz. */
354 analyzer_set_freq(1, FREQ_SCALE_MHZ);
355 devc->cur_samplerate = SR_MHZ(1);
358 if (devc->cur_threshold == 0)
359 set_voltage_threshold(devc, 1.5);
364 static int dev_close(struct sr_dev_inst *sdi)
366 struct sr_usb_dev_inst *usb;
373 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
374 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
375 libusb_release_interface(usb->devhdl, USB_INTERFACE);
376 libusb_reset_device(usb->devhdl);
377 libusb_close(usb->devhdl);
379 sdi->status = SR_ST_INACTIVE;
384 static int cleanup(const struct sr_dev_driver *di)
386 return std_dev_clear(di, NULL);
389 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
390 const struct sr_channel_group *cg)
392 struct dev_context *devc;
403 case SR_CONF_SAMPLERATE:
404 *data = g_variant_new_uint64(devc->cur_samplerate);
406 case SR_CONF_CAPTURE_RATIO:
407 *data = g_variant_new_uint64(devc->capture_ratio);
409 case SR_CONF_VOLTAGE_THRESHOLD:
410 range[0] = g_variant_new_double(devc->cur_threshold);
411 range[1] = g_variant_new_double(devc->cur_threshold);
412 *data = g_variant_new_tuple(range, 2);
421 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
422 const struct sr_channel_group *cg)
424 struct dev_context *devc;
429 if (sdi->status != SR_ST_ACTIVE)
430 return SR_ERR_DEV_CLOSED;
432 if (!(devc = sdi->priv)) {
433 sr_err("%s: sdi->priv was NULL", __func__);
438 case SR_CONF_SAMPLERATE:
439 return zp_set_samplerate(devc, g_variant_get_uint64(data));
440 case SR_CONF_LIMIT_SAMPLES:
441 return set_limit_samples(devc, g_variant_get_uint64(data));
442 case SR_CONF_CAPTURE_RATIO:
443 return set_capture_ratio(devc, g_variant_get_uint64(data));
444 case SR_CONF_VOLTAGE_THRESHOLD:
445 g_variant_get(data, "(dd)", &low, &high);
446 return set_voltage_threshold(devc, (low + high) / 2.0);
454 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
455 const struct sr_channel_group *cg)
457 struct dev_context *devc;
458 GVariant *gvar, *grange[2];
466 case SR_CONF_DEVICE_OPTIONS:
467 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
468 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
470 case SR_CONF_SAMPLERATE:
472 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
473 if (devc->prof->max_sampling_freq == 100) {
474 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
475 samplerates_100, ARRAY_SIZE(samplerates_100),
477 } else if (devc->prof->max_sampling_freq == 200) {
478 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
479 samplerates_200, ARRAY_SIZE(samplerates_200),
482 sr_err("Internal error: Unknown max. samplerate: %d.",
483 devc->prof->max_sampling_freq);
486 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
487 *data = g_variant_builder_end(&gvb);
489 case SR_CONF_TRIGGER_MATCH:
490 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
491 trigger_matches, ARRAY_SIZE(trigger_matches),
494 case SR_CONF_VOLTAGE_THRESHOLD:
495 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
496 for (v = -6.0; v <= 6.0; v += 0.1) {
497 range[0] = g_variant_new_double(v);
498 range[1] = g_variant_new_double(v);
499 gvar = g_variant_new_tuple(range, 2);
500 g_variant_builder_add_value(&gvb, gvar);
502 *data = g_variant_builder_end(&gvb);
504 case SR_CONF_LIMIT_SAMPLES:
508 grange[0] = g_variant_new_uint64(0);
509 grange[1] = g_variant_new_uint64(devc->max_sample_depth);
510 *data = g_variant_new_tuple(grange, 2);
519 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
522 struct dev_context *devc;
523 struct sr_usb_dev_inst *usb;
524 struct sr_datafeed_packet packet;
525 struct sr_datafeed_logic logic;
526 unsigned int samples_read;
528 unsigned int packet_num, n;
531 unsigned int stop_address;
532 unsigned int now_address;
533 unsigned int trigger_address;
534 unsigned int trigger_offset;
535 unsigned int triggerbar;
536 unsigned int ramsize_trigger;
537 unsigned int memory_size;
538 unsigned int valid_samples;
539 unsigned int discard;
542 if (sdi->status != SR_ST_ACTIVE)
543 return SR_ERR_DEV_CLOSED;
545 if (!(devc = sdi->priv)) {
546 sr_err("%s: sdi->priv was NULL", __func__);
550 if (analyzer_add_triggers(sdi) != SR_OK) {
551 sr_err("Failed to configure triggers.");
557 set_triggerbar(devc);
559 /* Push configured settings to device. */
560 analyzer_configure(usb->devhdl);
562 analyzer_start(usb->devhdl);
563 sr_info("Waiting for data.");
564 analyzer_wait_data(usb->devhdl);
566 status = analyzer_read_status(usb->devhdl);
567 stop_address = analyzer_get_stop_address(usb->devhdl);
568 now_address = analyzer_get_now_address(usb->devhdl);
569 trigger_address = analyzer_get_trigger_address(usb->devhdl);
571 triggerbar = analyzer_get_triggerbar_address();
572 ramsize_trigger = analyzer_get_ramsize_trigger_address();
574 n = get_memory_size(devc->memory_size);
577 sr_info("Status = 0x%x.", status);
578 sr_info("Stop address = 0x%x.", stop_address);
579 sr_info("Now address = 0x%x.", now_address);
580 sr_info("Trigger address = 0x%x.", trigger_address);
581 sr_info("Triggerbar address = 0x%x.", triggerbar);
582 sr_info("Ramsize trigger = 0x%x.", ramsize_trigger);
583 sr_info("Memory size = 0x%x.", memory_size);
585 /* Send header packet to the session bus. */
586 std_session_send_df_header(cb_data, LOG_PREFIX);
588 /* Check for empty capture */
589 if ((status & STATUS_READY) && !stop_address) {
590 packet.type = SR_DF_END;
591 sr_session_send(cb_data, &packet);
595 buf = g_malloc(PACKET_SIZE);
597 /* Check if the trigger is in the samples we are throwing away */
598 trigger_now = now_address == trigger_address ||
599 ((now_address + 1) % memory_size) == trigger_address;
602 * STATUS_READY doesn't clear until now_address advances past
603 * addr 0, but for our logic, clear it in that case
606 status &= ~STATUS_READY;
608 analyzer_read_start(usb->devhdl);
610 /* Calculate how much data to discard */
612 if (status & STATUS_READY) {
614 * We haven't wrapped around, we need to throw away data from
615 * our current position to the end of the buffer.
616 * Additionally, the first two samples captured are always
619 discard += memory_size - now_address + 2;
623 /* If we have more samples than we need, discard them */
624 valid_samples = (stop_address - now_address) % memory_size;
625 if (valid_samples > ramsize_trigger + triggerbar) {
626 discard += valid_samples - (ramsize_trigger + triggerbar);
627 now_address += valid_samples - (ramsize_trigger + triggerbar);
630 sr_info("Need to discard %d samples.", discard);
632 /* Calculate how far in the trigger is */
636 trigger_offset = (trigger_address - now_address) % memory_size;
638 /* Recalculate the number of samples available */
639 valid_samples = (stop_address - now_address) % memory_size;
641 /* Send the incoming transfer to the session bus. */
643 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
645 unsigned int buf_offset;
647 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
648 sr_info("Tried to read %d bytes, actually read %d bytes.",
651 if (discard >= PACKET_SIZE / 4) {
652 discard -= PACKET_SIZE / 4;
656 len = PACKET_SIZE - discard * 4;
657 buf_offset = discard * 4;
660 /* Check if we've read all the samples */
661 if (samples_read + len / 4 >= valid_samples)
662 len = (valid_samples - samples_read) * 4;
666 if (samples_read < trigger_offset &&
667 samples_read + len / 4 > trigger_offset) {
668 /* Send out samples remaining before trigger */
669 packet.type = SR_DF_LOGIC;
670 packet.payload = &logic;
671 logic.length = (trigger_offset - samples_read) * 4;
673 logic.data = buf + buf_offset;
674 sr_session_send(cb_data, &packet);
676 samples_read += logic.length / 4;
677 buf_offset += logic.length;
680 if (samples_read == trigger_offset) {
681 /* Send out trigger */
682 packet.type = SR_DF_TRIGGER;
683 packet.payload = NULL;
684 sr_session_send(cb_data, &packet);
687 /* Send out data (or data after trigger) */
688 packet.type = SR_DF_LOGIC;
689 packet.payload = &logic;
692 logic.data = buf + buf_offset;
693 sr_session_send(cb_data, &packet);
694 samples_read += len / 4;
696 analyzer_read_stop(usb->devhdl);
699 packet.type = SR_DF_END;
700 sr_session_send(cb_data, &packet);
705 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
706 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
708 struct dev_context *devc;
709 struct sr_usb_dev_inst *usb;
710 struct sr_datafeed_packet packet;
712 packet.type = SR_DF_END;
713 sr_session_send(cb_data, &packet);
715 if (!(devc = sdi->priv)) {
716 sr_err("%s: sdi->priv was NULL", __func__);
721 analyzer_reset(usb->devhdl);
722 /* TODO: Need to cancel and free any queued up transfers. */
727 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
728 .name = "zeroplus-logic-cube",
729 .longname = "ZEROPLUS Logic Cube LAP-C series",
734 .dev_list = dev_list,
736 .config_get = config_get,
737 .config_set = config_set,
738 .config_list = config_list,
739 .dev_open = dev_open,
740 .dev_close = dev_close,
741 .dev_acquisition_start = dev_acquisition_start,
742 .dev_acquisition_stop = dev_acquisition_stop,