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/>.
23 #define VENDOR_NAME "ZEROPLUS"
24 #define USB_INTERFACE 0
25 #define USB_CONFIGURATION 1
26 #define NUM_TRIGGER_STAGES 4
27 #define PACKET_SIZE 2048 /* ?? */
29 //#define ZP_EXPERIMENTAL
34 const char *model_name;
35 unsigned int channels;
36 unsigned int sample_depth; /* In Ksamples/channel */
37 unsigned int max_sampling_freq;
41 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
42 * same 128K sample depth.
44 static const struct zp_model zeroplus_models[] = {
45 {0x0c12, 0x7002, "LAP-16128U", 16, 128, 200},
46 {0x0c12, 0x7009, "LAP-C(16064)", 16, 64, 100},
47 {0x0c12, 0x700a, "LAP-C(16128)", 16, 128, 200},
48 {0x0c12, 0x700b, "LAP-C(32128)", 32, 128, 200},
49 {0x0c12, 0x700c, "LAP-C(321000)", 32, 1024, 200},
50 {0x0c12, 0x700d, "LAP-C(322000)", 32, 2048, 200},
51 {0x0c12, 0x700e, "LAP-C(16032)", 16, 32, 100},
52 {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
53 {0x0c12, 0x7100, "AKIP-9101", 16, 256, 200},
57 static const uint32_t devopts[] = {
58 SR_CONF_LOGIC_ANALYZER,
59 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
60 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
61 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
62 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
63 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
66 static const int32_t trigger_matches[] = {
72 * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
73 * We currently ignore other untested/unsupported devices here.
75 static const char *channel_names[] = {
76 "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
77 "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
78 "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
79 "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
82 SR_PRIV struct sr_dev_driver 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_dev_driver *di, struct sr_context *sr_ctx)
160 return std_init(sr_ctx, di, LOG_PREFIX);
163 static GSList *scan(struct sr_dev_driver *di, GSList *options)
165 struct sr_dev_inst *sdi;
166 struct drv_context *drvc;
167 struct dev_context *devc;
168 const struct zp_model *prof;
169 struct libusb_device_descriptor des;
170 struct libusb_device_handle *hdl;
171 libusb_device **devlist;
174 char serial_num[64], connection_id[64];
182 /* Find all ZEROPLUS analyzers and add them to device list. */
183 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
185 for (i = 0; devlist[i]; i++) {
186 libusb_get_device_descriptor(devlist[i], &des);
188 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
191 if (des.iSerialNumber == 0) {
192 serial_num[0] = '\0';
193 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
194 des.iSerialNumber, (unsigned char *) serial_num,
195 sizeof(serial_num))) < 0) {
196 sr_warn("Failed to get serial number string descriptor: %s.",
197 libusb_error_name(ret));
203 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
206 for (j = 0; j < zeroplus_models[j].vid; j++) {
207 if (des.idVendor == zeroplus_models[j].vid &&
208 des.idProduct == zeroplus_models[j].pid) {
209 prof = &zeroplus_models[j];
212 /* Skip if the device was not found. */
215 sr_info("Found ZEROPLUS %s.", prof->model_name);
217 /* Register the device with libsigrok. */
218 sdi = g_malloc0(sizeof(struct sr_dev_inst));
219 sdi->status = SR_ST_INACTIVE;
220 sdi->vendor = g_strdup(VENDOR_NAME);
221 sdi->model = g_strdup(prof->model_name);
223 sdi->serial_num = g_strdup(serial_num);
224 sdi->connection_id = g_strdup(connection_id);
226 /* Allocate memory for our private driver context. */
227 devc = g_malloc0(sizeof(struct dev_context));
230 devc->num_channels = prof->channels;
231 #ifdef ZP_EXPERIMENTAL
232 devc->max_sample_depth = 128 * 1024;
233 devc->max_samplerate = 200;
235 devc->max_sample_depth = prof->sample_depth * 1024;
236 devc->max_samplerate = prof->max_sampling_freq;
238 devc->max_samplerate *= SR_MHZ(1);
239 devc->memory_size = MEMORY_SIZE_8K;
240 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
242 /* Fill in channellist according to this device's profile. */
243 for (j = 0; j < devc->num_channels; j++)
244 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
247 devices = g_slist_append(devices, sdi);
248 drvc->instances = g_slist_append(drvc->instances, sdi);
249 sdi->inst_type = SR_INST_USB;
250 sdi->conn = sr_usb_dev_inst_new(
251 libusb_get_bus_number(devlist[i]),
252 libusb_get_device_address(devlist[i]), NULL);
254 libusb_free_device_list(devlist, 1);
259 static GSList *dev_list(const struct sr_dev_driver *di)
261 return ((struct drv_context *)(di->context))->instances;
264 static int dev_open(struct sr_dev_inst *sdi)
266 struct sr_dev_driver *di = sdi->driver;
267 struct dev_context *devc;
268 struct drv_context *drvc;
269 struct sr_usb_dev_inst *usb;
270 libusb_device **devlist, *dev;
271 int device_count, ret, i;
272 char connection_id[64];
278 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
280 if (device_count < 0) {
281 sr_err("Failed to retrieve device list.");
286 for (i = 0; i < device_count; i++) {
287 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
288 if (!strcmp(sdi->connection_id, connection_id)) {
294 sr_err("Device on %d.%d (logical) / %s (physical) disappeared!",
295 usb->bus, usb->address, sdi->connection_id);
299 if (!(ret = libusb_open(dev, &(usb->devhdl)))) {
300 sdi->status = SR_ST_ACTIVE;
301 sr_info("Opened device on %d.%d (logical) / %s (physical) interface %d.",
302 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
304 sr_err("Failed to open device: %s.", libusb_error_name(ret));
308 ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
310 sr_err("Unable to set USB configuration %d: %s.",
311 USB_CONFIGURATION, libusb_error_name(ret));
315 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
317 sr_err("Unable to claim interface: %s.",
318 libusb_error_name(ret));
322 /* Set default configuration after power on. */
323 if (analyzer_read_status(usb->devhdl) == 0)
324 analyzer_configure(usb->devhdl);
326 analyzer_reset(usb->devhdl);
327 analyzer_initialize(usb->devhdl);
329 //analyzer_set_memory_size(MEMORY_SIZE_512K);
330 // analyzer_set_freq(g_freq, g_freq_scale);
331 analyzer_set_trigger_count(1);
332 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
333 // * get_memory_size(g_memory_size)) / 100) >> 2);
336 if (g_double_mode == 1)
337 analyzer_set_compression(COMPRESSION_DOUBLE);
338 else if (g_compression == 1)
339 analyzer_set_compression(COMPRESSION_ENABLE);
342 analyzer_set_compression(COMPRESSION_NONE);
344 if (devc->cur_samplerate == 0) {
345 /* Samplerate hasn't been set. Default to 1MHz. */
346 analyzer_set_freq(1, FREQ_SCALE_MHZ);
347 devc->cur_samplerate = SR_MHZ(1);
350 if (devc->cur_threshold == 0)
351 set_voltage_threshold(devc, 1.5);
356 static int dev_close(struct sr_dev_inst *sdi)
358 struct sr_usb_dev_inst *usb;
365 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
366 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
367 libusb_release_interface(usb->devhdl, USB_INTERFACE);
368 libusb_reset_device(usb->devhdl);
369 libusb_close(usb->devhdl);
371 sdi->status = SR_ST_INACTIVE;
376 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
377 const struct sr_channel_group *cg)
379 struct dev_context *devc;
390 case SR_CONF_SAMPLERATE:
391 *data = g_variant_new_uint64(devc->cur_samplerate);
393 case SR_CONF_CAPTURE_RATIO:
394 *data = g_variant_new_uint64(devc->capture_ratio);
396 case SR_CONF_VOLTAGE_THRESHOLD:
397 range[0] = g_variant_new_double(devc->cur_threshold);
398 range[1] = g_variant_new_double(devc->cur_threshold);
399 *data = g_variant_new_tuple(range, 2);
408 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
409 const struct sr_channel_group *cg)
411 struct dev_context *devc;
416 if (sdi->status != SR_ST_ACTIVE)
417 return SR_ERR_DEV_CLOSED;
419 if (!(devc = sdi->priv)) {
420 sr_err("%s: sdi->priv was NULL", __func__);
425 case SR_CONF_SAMPLERATE:
426 return zp_set_samplerate(devc, g_variant_get_uint64(data));
427 case SR_CONF_LIMIT_SAMPLES:
428 return set_limit_samples(devc, g_variant_get_uint64(data));
429 case SR_CONF_CAPTURE_RATIO:
430 return set_capture_ratio(devc, g_variant_get_uint64(data));
431 case SR_CONF_VOLTAGE_THRESHOLD:
432 g_variant_get(data, "(dd)", &low, &high);
433 return set_voltage_threshold(devc, (low + high) / 2.0);
441 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
442 const struct sr_channel_group *cg)
444 struct dev_context *devc;
445 GVariant *gvar, *grange[2];
453 case SR_CONF_DEVICE_OPTIONS:
454 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
455 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
457 case SR_CONF_SAMPLERATE:
459 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
460 if (devc->prof->max_sampling_freq == 100) {
461 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
462 samplerates_100, ARRAY_SIZE(samplerates_100),
464 } else if (devc->prof->max_sampling_freq == 200) {
465 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
466 samplerates_200, ARRAY_SIZE(samplerates_200),
469 sr_err("Internal error: Unknown max. samplerate: %d.",
470 devc->prof->max_sampling_freq);
473 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
474 *data = g_variant_builder_end(&gvb);
476 case SR_CONF_TRIGGER_MATCH:
477 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
478 trigger_matches, ARRAY_SIZE(trigger_matches),
481 case SR_CONF_VOLTAGE_THRESHOLD:
482 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
483 for (v = -6.0; v <= 6.0; v += 0.1) {
484 range[0] = g_variant_new_double(v);
485 range[1] = g_variant_new_double(v);
486 gvar = g_variant_new_tuple(range, 2);
487 g_variant_builder_add_value(&gvb, gvar);
489 *data = g_variant_builder_end(&gvb);
491 case SR_CONF_LIMIT_SAMPLES:
495 grange[0] = g_variant_new_uint64(0);
496 grange[1] = g_variant_new_uint64(devc->max_sample_depth);
497 *data = g_variant_new_tuple(grange, 2);
506 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
508 struct dev_context *devc;
509 struct sr_usb_dev_inst *usb;
510 struct sr_datafeed_packet packet;
511 struct sr_datafeed_logic logic;
512 unsigned int samples_read;
514 unsigned int packet_num, n;
517 unsigned int stop_address;
518 unsigned int now_address;
519 unsigned int trigger_address;
520 unsigned int trigger_offset;
521 unsigned int triggerbar;
522 unsigned int ramsize_trigger;
523 unsigned int memory_size;
524 unsigned int valid_samples;
525 unsigned int discard;
528 if (sdi->status != SR_ST_ACTIVE)
529 return SR_ERR_DEV_CLOSED;
533 if (analyzer_add_triggers(sdi) != SR_OK) {
534 sr_err("Failed to configure triggers.");
540 set_triggerbar(devc);
542 /* Push configured settings to device. */
543 analyzer_configure(usb->devhdl);
545 analyzer_start(usb->devhdl);
546 sr_info("Waiting for data.");
547 analyzer_wait_data(usb->devhdl);
549 status = analyzer_read_status(usb->devhdl);
550 stop_address = analyzer_get_stop_address(usb->devhdl);
551 now_address = analyzer_get_now_address(usb->devhdl);
552 trigger_address = analyzer_get_trigger_address(usb->devhdl);
554 triggerbar = analyzer_get_triggerbar_address();
555 ramsize_trigger = analyzer_get_ramsize_trigger_address();
557 n = get_memory_size(devc->memory_size);
560 sr_info("Status = 0x%x.", status);
561 sr_info("Stop address = 0x%x.", stop_address);
562 sr_info("Now address = 0x%x.", now_address);
563 sr_info("Trigger address = 0x%x.", trigger_address);
564 sr_info("Triggerbar address = 0x%x.", triggerbar);
565 sr_info("Ramsize trigger = 0x%x.", ramsize_trigger);
566 sr_info("Memory size = 0x%x.", memory_size);
568 std_session_send_df_header(sdi, LOG_PREFIX);
570 /* Check for empty capture */
571 if ((status & STATUS_READY) && !stop_address) {
572 std_session_send_df_end(sdi, LOG_PREFIX);
576 buf = g_malloc(PACKET_SIZE);
578 /* Check if the trigger is in the samples we are throwing away */
579 trigger_now = now_address == trigger_address ||
580 ((now_address + 1) % memory_size) == trigger_address;
583 * STATUS_READY doesn't clear until now_address advances past
584 * addr 0, but for our logic, clear it in that case
587 status &= ~STATUS_READY;
589 analyzer_read_start(usb->devhdl);
591 /* Calculate how much data to discard */
593 if (status & STATUS_READY) {
595 * We haven't wrapped around, we need to throw away data from
596 * our current position to the end of the buffer.
597 * Additionally, the first two samples captured are always
600 discard += memory_size - now_address + 2;
604 /* If we have more samples than we need, discard them */
605 valid_samples = (stop_address - now_address) % memory_size;
606 if (valid_samples > ramsize_trigger + triggerbar) {
607 discard += valid_samples - (ramsize_trigger + triggerbar);
608 now_address += valid_samples - (ramsize_trigger + triggerbar);
611 sr_info("Need to discard %d samples.", discard);
613 /* Calculate how far in the trigger is */
617 trigger_offset = (trigger_address - now_address) % memory_size;
619 /* Recalculate the number of samples available */
620 valid_samples = (stop_address - now_address) % memory_size;
622 /* Send the incoming transfer to the session bus. */
624 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
626 unsigned int buf_offset;
628 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
629 sr_info("Tried to read %d bytes, actually read %d bytes.",
632 if (discard >= PACKET_SIZE / 4) {
633 discard -= PACKET_SIZE / 4;
637 len = PACKET_SIZE - discard * 4;
638 buf_offset = discard * 4;
641 /* Check if we've read all the samples */
642 if (samples_read + len / 4 >= valid_samples)
643 len = (valid_samples - samples_read) * 4;
647 if (samples_read < trigger_offset &&
648 samples_read + len / 4 > trigger_offset) {
649 /* Send out samples remaining before trigger */
650 packet.type = SR_DF_LOGIC;
651 packet.payload = &logic;
652 logic.length = (trigger_offset - samples_read) * 4;
654 logic.data = buf + buf_offset;
655 sr_session_send(sdi, &packet);
657 samples_read += logic.length / 4;
658 buf_offset += logic.length;
661 if (samples_read == trigger_offset) {
662 /* Send out trigger */
663 packet.type = SR_DF_TRIGGER;
664 packet.payload = NULL;
665 sr_session_send(sdi, &packet);
668 /* Send out data (or data after trigger) */
669 packet.type = SR_DF_LOGIC;
670 packet.payload = &logic;
673 logic.data = buf + buf_offset;
674 sr_session_send(sdi, &packet);
675 samples_read += len / 4;
677 analyzer_read_stop(usb->devhdl);
680 std_session_send_df_end(sdi, LOG_PREFIX);
685 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
686 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
688 struct sr_usb_dev_inst *usb;
690 std_session_send_df_end(sdi, LOG_PREFIX);
693 analyzer_reset(usb->devhdl);
694 /* TODO: Need to cancel and free any queued up transfers. */
699 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
700 .name = "zeroplus-logic-cube",
701 .longname = "ZEROPLUS Logic Cube LAP-C series",
704 .cleanup = std_cleanup,
706 .dev_list = dev_list,
708 .config_get = config_get,
709 .config_set = config_set,
710 .config_list = config_list,
711 .dev_open = dev_open,
712 .dev_close = dev_close,
713 .dev_acquisition_start = dev_acquisition_start,
714 .dev_acquisition_stop = dev_acquisition_stop,