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 drvopts[] = {
58 SR_CONF_LOGIC_ANALYZER,
61 static const uint32_t devopts[] = {
62 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
63 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
64 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
65 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
66 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
69 static const int32_t trigger_matches[] = {
75 * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
76 * We currently ignore other untested/unsupported devices here.
78 static const char *channel_names[] = {
79 "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
80 "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
81 "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
82 "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
86 * The hardware supports more samplerates than these, but these are the
87 * options hardcoded into the vendor's Windows GUI.
90 static const uint64_t samplerates_100[] = {
109 const uint64_t samplerates_200[] = {
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 GSList *scan(struct sr_dev_driver *di, GSList *options)
159 struct sr_dev_inst *sdi;
160 struct drv_context *drvc;
161 struct dev_context *devc;
162 const struct zp_model *prof;
163 struct libusb_device_descriptor des;
164 struct libusb_device_handle *hdl;
165 libusb_device **devlist;
168 char serial_num[64], connection_id[64];
176 /* Find all ZEROPLUS analyzers and add them to device list. */
177 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
179 for (i = 0; devlist[i]; i++) {
180 libusb_get_device_descriptor(devlist[i], &des);
182 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
185 if (des.iSerialNumber == 0) {
186 serial_num[0] = '\0';
187 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
188 des.iSerialNumber, (unsigned char *) serial_num,
189 sizeof(serial_num))) < 0) {
190 sr_warn("Failed to get serial number string descriptor: %s.",
191 libusb_error_name(ret));
197 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
200 for (j = 0; j < zeroplus_models[j].vid; j++) {
201 if (des.idVendor == zeroplus_models[j].vid &&
202 des.idProduct == zeroplus_models[j].pid) {
203 prof = &zeroplus_models[j];
209 sr_info("Found ZEROPLUS %s.", prof->model_name);
211 sdi = g_malloc0(sizeof(struct sr_dev_inst));
212 sdi->status = SR_ST_INACTIVE;
213 sdi->vendor = g_strdup(VENDOR_NAME);
214 sdi->model = g_strdup(prof->model_name);
215 sdi->serial_num = g_strdup(serial_num);
216 sdi->connection_id = g_strdup(connection_id);
218 devc = g_malloc0(sizeof(struct dev_context));
221 devc->num_channels = prof->channels;
222 #ifdef ZP_EXPERIMENTAL
223 devc->max_sample_depth = 128 * 1024;
224 devc->max_samplerate = 200;
226 devc->max_sample_depth = prof->sample_depth * 1024;
227 devc->max_samplerate = prof->max_sampling_freq;
229 devc->max_samplerate *= SR_MHZ(1);
230 devc->memory_size = MEMORY_SIZE_8K;
231 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
233 for (j = 0; j < devc->num_channels; j++)
234 sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
237 devices = g_slist_append(devices, sdi);
238 sdi->inst_type = SR_INST_USB;
239 sdi->conn = sr_usb_dev_inst_new(
240 libusb_get_bus_number(devlist[i]),
241 libusb_get_device_address(devlist[i]), NULL);
243 libusb_free_device_list(devlist, 1);
245 return std_scan_complete(di, devices);
248 static int dev_open(struct sr_dev_inst *sdi)
250 struct sr_dev_driver *di = sdi->driver;
251 struct dev_context *devc;
252 struct drv_context *drvc;
253 struct sr_usb_dev_inst *usb;
260 ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
264 ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
266 sr_err("Unable to set USB configuration %d: %s.",
267 USB_CONFIGURATION, libusb_error_name(ret));
271 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
273 sr_err("Unable to claim interface: %s.",
274 libusb_error_name(ret));
278 /* Set default configuration after power on. */
279 if (analyzer_read_status(usb->devhdl) == 0)
280 analyzer_configure(usb->devhdl);
282 analyzer_reset(usb->devhdl);
283 analyzer_initialize(usb->devhdl);
285 //analyzer_set_memory_size(MEMORY_SIZE_512K);
286 // analyzer_set_freq(g_freq, g_freq_scale);
287 analyzer_set_trigger_count(1);
288 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
289 // * get_memory_size(g_memory_size)) / 100) >> 2);
292 if (g_double_mode == 1)
293 analyzer_set_compression(COMPRESSION_DOUBLE);
294 else if (g_compression == 1)
295 analyzer_set_compression(COMPRESSION_ENABLE);
298 analyzer_set_compression(COMPRESSION_NONE);
300 if (devc->cur_samplerate == 0) {
301 /* Samplerate hasn't been set. Default to 1MHz. */
302 analyzer_set_freq(1, FREQ_SCALE_MHZ);
303 devc->cur_samplerate = SR_MHZ(1);
306 if (devc->cur_threshold == 0)
307 set_voltage_threshold(devc, 1.5);
312 static int dev_close(struct sr_dev_inst *sdi)
314 struct sr_usb_dev_inst *usb;
321 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
322 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
323 libusb_release_interface(usb->devhdl, USB_INTERFACE);
324 libusb_reset_device(usb->devhdl);
325 libusb_close(usb->devhdl);
331 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
332 const struct sr_channel_group *cg)
334 struct dev_context *devc;
345 case SR_CONF_SAMPLERATE:
346 *data = g_variant_new_uint64(devc->cur_samplerate);
348 case SR_CONF_CAPTURE_RATIO:
349 *data = g_variant_new_uint64(devc->capture_ratio);
351 case SR_CONF_VOLTAGE_THRESHOLD:
352 range[0] = g_variant_new_double(devc->cur_threshold);
353 range[1] = g_variant_new_double(devc->cur_threshold);
354 *data = g_variant_new_tuple(range, 2);
363 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
364 const struct sr_channel_group *cg)
366 struct dev_context *devc;
374 case SR_CONF_SAMPLERATE:
375 return zp_set_samplerate(devc, g_variant_get_uint64(data));
376 case SR_CONF_LIMIT_SAMPLES:
377 return set_limit_samples(devc, g_variant_get_uint64(data));
378 case SR_CONF_CAPTURE_RATIO:
379 return set_capture_ratio(devc, g_variant_get_uint64(data));
380 case SR_CONF_VOLTAGE_THRESHOLD:
381 g_variant_get(data, "(dd)", &low, &high);
382 return set_voltage_threshold(devc, (low + high) / 2.0);
390 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
391 const struct sr_channel_group *cg)
393 struct dev_context *devc;
397 case SR_CONF_DEVICE_OPTIONS:
398 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
399 case SR_CONF_SAMPLERATE:
401 if (devc->prof->max_sampling_freq == 100)
402 *data = std_gvar_samplerates(samplerates_100, ARRAY_SIZE(samplerates_100));
403 else if (devc->prof->max_sampling_freq == 200)
404 *data = std_gvar_samplerates(samplerates_200, ARRAY_SIZE(samplerates_200));
406 sr_err("Internal error: Unknown max. samplerate: %d.",
407 devc->prof->max_sampling_freq);
411 case SR_CONF_TRIGGER_MATCH:
412 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
413 trigger_matches, ARRAY_SIZE(trigger_matches),
416 case SR_CONF_VOLTAGE_THRESHOLD:
417 *data = std_gvar_min_max_step_thresholds(-6.0, 6.0, 0.1);
419 case SR_CONF_LIMIT_SAMPLES:
423 grange[0] = g_variant_new_uint64(0);
424 grange[1] = g_variant_new_uint64(devc->max_sample_depth);
425 *data = g_variant_new_tuple(grange, 2);
434 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
436 struct dev_context *devc;
437 struct sr_usb_dev_inst *usb;
438 struct sr_datafeed_packet packet;
439 struct sr_datafeed_logic logic;
440 unsigned int samples_read;
442 unsigned int packet_num, n;
445 unsigned int stop_address;
446 unsigned int now_address;
447 unsigned int trigger_address;
448 unsigned int trigger_offset;
449 unsigned int triggerbar;
450 unsigned int ramsize_trigger;
451 unsigned int memory_size;
452 unsigned int valid_samples;
453 unsigned int discard;
458 if (analyzer_add_triggers(sdi) != SR_OK) {
459 sr_err("Failed to configure triggers.");
465 set_triggerbar(devc);
467 /* Push configured settings to device. */
468 analyzer_configure(usb->devhdl);
470 analyzer_start(usb->devhdl);
471 sr_info("Waiting for data.");
472 analyzer_wait_data(usb->devhdl);
474 status = analyzer_read_status(usb->devhdl);
475 stop_address = analyzer_get_stop_address(usb->devhdl);
476 now_address = analyzer_get_now_address(usb->devhdl);
477 trigger_address = analyzer_get_trigger_address(usb->devhdl);
479 triggerbar = analyzer_get_triggerbar_address();
480 ramsize_trigger = analyzer_get_ramsize_trigger_address();
482 n = get_memory_size(devc->memory_size);
485 sr_info("Status = 0x%x.", status);
486 sr_info("Stop address = 0x%x.", stop_address);
487 sr_info("Now address = 0x%x.", now_address);
488 sr_info("Trigger address = 0x%x.", trigger_address);
489 sr_info("Triggerbar address = 0x%x.", triggerbar);
490 sr_info("Ramsize trigger = 0x%x.", ramsize_trigger);
491 sr_info("Memory size = 0x%x.", memory_size);
493 std_session_send_df_header(sdi);
495 /* Check for empty capture */
496 if ((status & STATUS_READY) && !stop_address) {
497 std_session_send_df_end(sdi);
501 buf = g_malloc(PACKET_SIZE);
503 /* Check if the trigger is in the samples we are throwing away */
504 trigger_now = now_address == trigger_address ||
505 ((now_address + 1) % memory_size) == trigger_address;
508 * STATUS_READY doesn't clear until now_address advances past
509 * addr 0, but for our logic, clear it in that case
512 status &= ~STATUS_READY;
514 analyzer_read_start(usb->devhdl);
516 /* Calculate how much data to discard */
518 if (status & STATUS_READY) {
520 * We haven't wrapped around, we need to throw away data from
521 * our current position to the end of the buffer.
522 * Additionally, the first two samples captured are always
525 discard += memory_size - now_address + 2;
529 /* If we have more samples than we need, discard them */
530 valid_samples = (stop_address - now_address) % memory_size;
531 if (valid_samples > ramsize_trigger + triggerbar) {
532 discard += valid_samples - (ramsize_trigger + triggerbar);
533 now_address += valid_samples - (ramsize_trigger + triggerbar);
536 sr_info("Need to discard %d samples.", discard);
538 /* Calculate how far in the trigger is */
542 trigger_offset = (trigger_address - now_address) % memory_size;
544 /* Recalculate the number of samples available */
545 valid_samples = (stop_address - now_address) % memory_size;
547 /* Send the incoming transfer to the session bus. */
549 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
551 unsigned int buf_offset;
553 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
554 sr_info("Tried to read %d bytes, actually read %d bytes.",
557 if (discard >= PACKET_SIZE / 4) {
558 discard -= PACKET_SIZE / 4;
562 len = PACKET_SIZE - discard * 4;
563 buf_offset = discard * 4;
566 /* Check if we've read all the samples */
567 if (samples_read + len / 4 >= valid_samples)
568 len = (valid_samples - samples_read) * 4;
572 if (samples_read < trigger_offset &&
573 samples_read + len / 4 > trigger_offset) {
574 /* Send out samples remaining before trigger */
575 packet.type = SR_DF_LOGIC;
576 packet.payload = &logic;
577 logic.length = (trigger_offset - samples_read) * 4;
579 logic.data = buf + buf_offset;
580 sr_session_send(sdi, &packet);
582 samples_read += logic.length / 4;
583 buf_offset += logic.length;
586 if (samples_read == trigger_offset) {
587 /* Send out trigger */
588 packet.type = SR_DF_TRIGGER;
589 packet.payload = NULL;
590 sr_session_send(sdi, &packet);
593 /* Send out data (or data after trigger) */
594 packet.type = SR_DF_LOGIC;
595 packet.payload = &logic;
598 logic.data = buf + buf_offset;
599 sr_session_send(sdi, &packet);
600 samples_read += len / 4;
602 analyzer_read_stop(usb->devhdl);
605 std_session_send_df_end(sdi);
610 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
612 struct sr_usb_dev_inst *usb;
614 std_session_send_df_end(sdi);
617 analyzer_reset(usb->devhdl);
618 /* TODO: Need to cancel and free any queued up transfers. */
623 static struct sr_dev_driver zeroplus_logic_cube_driver_info = {
624 .name = "zeroplus-logic-cube",
625 .longname = "ZEROPLUS Logic Cube LAP-C series",
628 .cleanup = std_cleanup,
630 .dev_list = std_dev_list,
631 .dev_clear = std_dev_clear,
632 .config_get = config_get,
633 .config_set = config_set,
634 .config_list = config_list,
635 .dev_open = dev_open,
636 .dev_close = dev_close,
637 .dev_acquisition_start = dev_acquisition_start,
638 .dev_acquisition_stop = dev_acquisition_stop,
641 SR_REGISTER_DEV_DRIVER(zeroplus_logic_cube_driver_info);