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 USB_INTERFACE 0
24 #define USB_CONFIGURATION 1
25 #define NUM_TRIGGER_STAGES 4
26 #define PACKET_SIZE 2048 /* ?? */
28 //#define ZP_EXPERIMENTAL
33 const char *model_name;
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, 0x7007, "LAP-16032U", 16, 32, 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, 0x7025, "LAP-C(16128+)", 16, 128, 200},
54 {0x0c12, 0x7064, "Logian-16L", 16, 128, 200},
55 {0x0c12, 0x7100, "AKIP-9101", 16, 256, 200},
59 static const uint32_t drvopts[] = {
60 SR_CONF_LOGIC_ANALYZER,
63 static const uint32_t devopts[] = {
64 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
65 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
66 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
67 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
68 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
71 static const int32_t trigger_matches[] = {
80 * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
81 * We currently ignore other untested/unsupported devices here.
83 static const char *channel_names[] = {
84 "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
85 "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
86 "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
87 "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
91 * The hardware supports more samplerates than these, but these are the
92 * options hardcoded into the vendor's Windows GUI.
95 static const uint64_t samplerates_100[] = {
114 const uint64_t samplerates_200[] = {
135 SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
139 for (i = 0; ARRAY_SIZE(samplerates_200); i++)
140 if (samplerate == samplerates_200[i])
143 if (i == ARRAY_SIZE(samplerates_200) || samplerate > devc->max_samplerate) {
144 sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
148 sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
150 if (samplerate >= SR_MHZ(1))
151 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
152 else if (samplerate >= SR_KHZ(1))
153 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
155 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
157 devc->cur_samplerate = samplerate;
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 const struct zp_model *check;
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);
189 * Check for expected VID:PID first as soon as we got
190 * the descriptor's content. This avoids access to flaky
191 * unrelated devices which trouble the application even
192 * if they are unrelated to measurement purposes.
194 * See https://sigrok.org/bugzilla/show_bug.cgi?id=1115
195 * and https://github.com/sigrokproject/libsigrok/pull/165
199 for (j = 0; zeroplus_models[j].vid; j++) {
200 check = &zeroplus_models[j];
201 if (des.idVendor != check->vid)
203 if (des.idProduct != check->pid)
211 /* Get the device's serial number from USB strings. */
212 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
215 if (des.iSerialNumber == 0) {
216 serial_num[0] = '\0';
217 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
218 des.iSerialNumber, (unsigned char *) serial_num,
219 sizeof(serial_num))) < 0) {
220 sr_warn("Failed to get serial number string descriptor: %s.",
221 libusb_error_name(ret));
227 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
230 sr_info("Found ZEROPLUS %s.", prof->model_name);
232 sdi = g_malloc0(sizeof(struct sr_dev_inst));
233 sdi->status = SR_ST_INACTIVE;
234 sdi->vendor = g_strdup("ZEROPLUS");
235 sdi->model = g_strdup(prof->model_name);
236 sdi->serial_num = g_strdup(serial_num);
237 sdi->connection_id = g_strdup(connection_id);
239 devc = g_malloc0(sizeof(struct dev_context));
242 devc->num_channels = prof->channels;
243 #ifdef ZP_EXPERIMENTAL
244 devc->max_sample_depth = 128 * 1024;
245 devc->max_samplerate = 200;
247 devc->max_sample_depth = prof->sample_depth * 1024;
248 devc->max_samplerate = prof->max_sampling_freq;
250 devc->max_samplerate *= SR_MHZ(1);
251 devc->memory_size = MEMORY_SIZE_8K;
252 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
254 for (j = 0; j < devc->num_channels; j++)
255 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
258 devices = g_slist_append(devices, sdi);
259 sdi->inst_type = SR_INST_USB;
260 sdi->conn = sr_usb_dev_inst_new(
261 libusb_get_bus_number(devlist[i]),
262 libusb_get_device_address(devlist[i]), NULL);
264 libusb_free_device_list(devlist, 1);
266 return std_scan_complete(di, devices);
269 static int dev_open(struct sr_dev_inst *sdi)
271 struct sr_dev_driver *di = sdi->driver;
272 struct dev_context *devc;
273 struct drv_context *drvc;
274 struct sr_usb_dev_inst *usb;
281 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
285 ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
287 sr_err("Unable to set USB configuration %d: %s.",
288 USB_CONFIGURATION, libusb_error_name(ret));
292 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
294 sr_err("Unable to claim interface: %s.",
295 libusb_error_name(ret));
299 /* Set default configuration after power on. */
300 if (analyzer_read_status(usb->devhdl) == 0)
301 analyzer_configure(usb->devhdl);
303 analyzer_reset(usb->devhdl);
304 analyzer_initialize(usb->devhdl);
306 //analyzer_set_memory_size(MEMORY_SIZE_512K);
307 // analyzer_set_freq(g_freq, g_freq_scale);
308 analyzer_set_trigger_count(1);
309 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
310 // * get_memory_size(g_memory_size)) / 100) >> 2);
313 if (g_double_mode == 1)
314 analyzer_set_compression(COMPRESSION_DOUBLE);
315 else if (g_compression == 1)
316 analyzer_set_compression(COMPRESSION_ENABLE);
319 analyzer_set_compression(COMPRESSION_NONE);
321 if (devc->cur_samplerate == 0) {
322 /* Samplerate hasn't been set. Default to 1MHz. */
323 analyzer_set_freq(1, FREQ_SCALE_MHZ);
324 devc->cur_samplerate = SR_MHZ(1);
327 if (devc->cur_threshold == 0)
328 set_voltage_threshold(devc, 1.5);
333 static int dev_close(struct sr_dev_inst *sdi)
335 struct sr_usb_dev_inst *usb;
342 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
343 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
344 libusb_release_interface(usb->devhdl, USB_INTERFACE);
345 libusb_reset_device(usb->devhdl);
346 libusb_close(usb->devhdl);
352 static int config_get(uint32_t key, GVariant **data,
353 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
355 struct dev_context *devc;
365 case SR_CONF_SAMPLERATE:
366 *data = g_variant_new_uint64(devc->cur_samplerate);
368 case SR_CONF_CAPTURE_RATIO:
369 *data = g_variant_new_uint64(devc->capture_ratio);
371 case SR_CONF_VOLTAGE_THRESHOLD:
372 *data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
381 static int config_set(uint32_t key, GVariant *data,
382 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
384 struct dev_context *devc;
392 case SR_CONF_SAMPLERATE:
393 return zp_set_samplerate(devc, g_variant_get_uint64(data));
394 case SR_CONF_LIMIT_SAMPLES:
395 return set_limit_samples(devc, g_variant_get_uint64(data));
396 case SR_CONF_CAPTURE_RATIO:
397 devc->capture_ratio = g_variant_get_uint64(data);
399 case SR_CONF_VOLTAGE_THRESHOLD:
400 g_variant_get(data, "(dd)", &low, &high);
401 return set_voltage_threshold(devc, (low + high) / 2.0);
409 static int config_list(uint32_t key, GVariant **data,
410 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
412 struct dev_context *devc;
415 case SR_CONF_DEVICE_OPTIONS:
416 return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts);
417 case SR_CONF_SAMPLERATE:
419 if (devc->prof->max_sampling_freq == 100)
420 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_100));
421 else if (devc->prof->max_sampling_freq == 200)
422 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_200));
424 sr_err("Internal error: Unknown max. samplerate: %d.",
425 devc->prof->max_sampling_freq);
429 case SR_CONF_TRIGGER_MATCH:
430 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
432 case SR_CONF_VOLTAGE_THRESHOLD:
433 *data = std_gvar_min_max_step_thresholds(-6.0, 6.0, 0.1);
435 case SR_CONF_LIMIT_SAMPLES:
439 *data = std_gvar_tuple_u64(0, devc->max_sample_depth);
448 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
450 struct dev_context *devc;
451 struct sr_usb_dev_inst *usb;
452 struct sr_datafeed_packet packet;
453 struct sr_datafeed_logic logic;
454 unsigned int samples_read;
456 unsigned int packet_num, n;
459 unsigned int stop_address;
460 unsigned int now_address;
461 unsigned int trigger_address;
462 unsigned int trigger_offset;
463 unsigned int triggerbar;
464 unsigned int ramsize_trigger;
465 unsigned int memory_size;
466 unsigned int valid_samples;
467 unsigned int discard;
472 if (analyzer_add_triggers(sdi) != SR_OK) {
473 sr_err("Failed to configure triggers.");
479 set_triggerbar(devc);
481 /* Push configured settings to device. */
482 analyzer_configure(usb->devhdl);
484 analyzer_start(usb->devhdl);
485 sr_info("Waiting for data.");
486 analyzer_wait_data(usb->devhdl);
488 status = analyzer_read_status(usb->devhdl);
489 stop_address = analyzer_get_stop_address(usb->devhdl);
490 now_address = analyzer_get_now_address(usb->devhdl);
491 trigger_address = analyzer_get_trigger_address(usb->devhdl);
493 triggerbar = analyzer_get_triggerbar_address();
494 ramsize_trigger = analyzer_get_ramsize_trigger_address();
496 n = get_memory_size(devc->memory_size);
499 sr_info("Status = 0x%x.", status);
500 sr_info("Stop address = 0x%x.", stop_address);
501 sr_info("Now address = 0x%x.", now_address);
502 sr_info("Trigger address = 0x%x.", trigger_address);
503 sr_info("Triggerbar address = 0x%x.", triggerbar);
504 sr_info("Ramsize trigger = 0x%x.", ramsize_trigger);
505 sr_info("Memory size = 0x%x.", memory_size);
507 std_session_send_df_header(sdi);
509 /* Check for empty capture */
510 if ((status & STATUS_READY) && !stop_address) {
511 std_session_send_df_end(sdi);
515 buf = g_malloc(PACKET_SIZE);
517 /* Check if the trigger is in the samples we are throwing away */
518 trigger_now = now_address == trigger_address ||
519 ((now_address + 1) % memory_size) == trigger_address;
522 * STATUS_READY doesn't clear until now_address advances past
523 * addr 0, but for our logic, clear it in that case
526 status &= ~STATUS_READY;
528 analyzer_read_start(usb->devhdl);
530 /* Calculate how much data to discard */
532 if (status & STATUS_READY) {
534 * We haven't wrapped around, we need to throw away data from
535 * our current position to the end of the buffer.
536 * Additionally, the first two samples captured are always
539 discard += memory_size - now_address + 2;
543 /* If we have more samples than we need, discard them */
544 valid_samples = (stop_address - now_address) % memory_size;
545 if (valid_samples > ramsize_trigger + triggerbar) {
546 discard += valid_samples - (ramsize_trigger + triggerbar);
547 now_address += valid_samples - (ramsize_trigger + triggerbar);
550 sr_info("Need to discard %d samples.", discard);
552 /* Calculate how far in the trigger is */
556 trigger_offset = (trigger_address - now_address) % memory_size;
558 /* Recalculate the number of samples available */
559 valid_samples = (stop_address - now_address) % memory_size;
561 /* Send the incoming transfer to the session bus. */
563 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
565 unsigned int buf_offset;
567 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
568 if (res != PACKET_SIZE)
569 sr_warn("Tried to read %d bytes, actually read %d.",
572 if (discard >= PACKET_SIZE / 4) {
573 discard -= PACKET_SIZE / 4;
577 len = PACKET_SIZE - discard * 4;
578 buf_offset = discard * 4;
581 /* Check if we've read all the samples */
582 if (samples_read + len / 4 >= valid_samples)
583 len = (valid_samples - samples_read) * 4;
587 if (samples_read < trigger_offset &&
588 samples_read + len / 4 > trigger_offset) {
589 /* Send out samples remaining before trigger */
590 packet.type = SR_DF_LOGIC;
591 packet.payload = &logic;
592 logic.length = (trigger_offset - samples_read) * 4;
594 logic.data = buf + buf_offset;
595 sr_session_send(sdi, &packet);
597 samples_read += logic.length / 4;
598 buf_offset += logic.length;
601 if (samples_read == trigger_offset)
602 std_session_send_df_trigger(sdi);
604 /* Send out data (or data after trigger) */
605 packet.type = SR_DF_LOGIC;
606 packet.payload = &logic;
609 logic.data = buf + buf_offset;
610 sr_session_send(sdi, &packet);
611 samples_read += len / 4;
613 analyzer_read_stop(usb->devhdl);
616 std_session_send_df_end(sdi);
621 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
623 struct sr_usb_dev_inst *usb;
625 std_session_send_df_end(sdi);
628 analyzer_reset(usb->devhdl);
629 /* TODO: Need to cancel and free any queued up transfers. */
634 static struct sr_dev_driver zeroplus_logic_cube_driver_info = {
635 .name = "zeroplus-logic-cube",
636 .longname = "ZEROPLUS Logic Cube LAP-C series",
639 .cleanup = std_cleanup,
641 .dev_list = std_dev_list,
642 .dev_clear = std_dev_clear,
643 .config_get = config_get,
644 .config_set = config_set,
645 .config_list = config_list,
646 .dev_open = dev_open,
647 .dev_close = dev_close,
648 .dev_acquisition_start = dev_acquisition_start,
649 .dev_acquisition_stop = dev_acquisition_stop,
652 SR_REGISTER_DEV_DRIVER(zeroplus_logic_cube_driver_info);