2 * This file is part of the sigrok 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 TRIGGER_TYPE "01"
27 #define PACKET_SIZE 2048 /* ?? */
29 //#define ZP_EXPERIMENTAL
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, 0x7009, "LAP-C(16064)", 16, 64, 100},
46 {0x0c12, 0x700a, "LAP-C(16128)", 16, 128, 200},
47 /* TODO: We don't know anything about these.
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},
52 {0x0c12, 0x700e, "LAP-C(16032)", 16, 32, 100},
53 {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
57 static const int hwcaps[] = {
58 SR_CONF_LOGIC_ANALYZER,
60 SR_CONF_CAPTURE_RATIO,
61 SR_CONF_LIMIT_SAMPLES,
66 * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
67 * We currently ignore other untested/unsupported devices here.
69 static const char *probe_names[] = {
70 "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
71 "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
75 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
76 static struct sr_dev_driver *di = &zeroplus_logic_cube_driver_info;
79 * The hardware supports more samplerates than these, but these are the
80 * options hardcoded into the vendor's Windows GUI.
83 static const uint64_t zp_supported_samplerates_100[] = {
103 const uint64_t zp_supported_samplerates_200[] = {
125 static const struct sr_samplerates samplerates_100 = {
129 .list = zp_supported_samplerates_100,
132 static const struct sr_samplerates samplerates_200 = {
136 .list = zp_supported_samplerates_200,
139 static int hw_dev_close(struct sr_dev_inst *sdi);
142 static int configure_probes(const struct sr_dev_inst *sdi)
144 struct dev_context *devc;
145 const struct sr_probe *probe;
147 int probe_bit, stage, i;
150 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
153 devc->probe_mask = 0;
154 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
155 devc->trigger_mask[i] = 0;
156 devc->trigger_value[i] = 0;
160 for (l = sdi->probes; l; l = l->next) {
161 probe = (struct sr_probe *)l->data;
162 if (probe->enabled == FALSE)
164 probe_bit = 1 << (probe->index);
165 devc->probe_mask |= probe_bit;
167 if (probe->trigger) {
169 for (tc = probe->trigger; *tc; tc++) {
170 devc->trigger_mask[stage] |= probe_bit;
172 devc->trigger_value[stage] |= probe_bit;
174 if (stage > NUM_TRIGGER_STAGES)
184 static int configure_probes(const struct sr_dev_inst *sdi)
186 struct dev_context *devc;
188 const struct sr_probe *probe;
192 /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
195 for (l = sdi->probes; l; l = l->next) {
196 probe = (struct sr_probe *)l->data;
197 if (probe->enabled == FALSE)
200 if ((tc = probe->trigger)) {
210 type = TRIGGER_POSEDGE;
213 type = TRIGGER_NEGEDGE;
216 type = TRIGGER_ANYEDGE;
222 analyzer_add_trigger(probe->index, type);
230 static int clear_instances(void)
233 struct sr_dev_inst *sdi;
234 struct drv_context *drvc;
235 struct dev_context *devc;
238 for (l = drvc->instances; l; l = l->next) {
240 if (!(devc = sdi->priv)) {
241 /* Log error, but continue cleaning up the rest. */
242 sr_err("%s: sdi->priv was NULL, continuing", __func__);
245 sr_usb_dev_inst_free(devc->usb);
246 /* Properly close all devices... */
248 /* ...and free all their memory. */
249 sr_dev_inst_free(sdi);
251 g_slist_free(drvc->instances);
252 drvc->instances = NULL;
257 static int hw_init(struct sr_context *sr_ctx)
259 return std_hw_init(sr_ctx, di, "zeroplus: ");
262 static GSList *hw_scan(GSList *options)
264 struct sr_dev_inst *sdi;
265 struct sr_probe *probe;
266 struct drv_context *drvc;
267 struct dev_context *devc;
268 const struct zp_model *prof;
269 struct libusb_device_descriptor des;
270 libusb_device **devlist;
272 int ret, devcnt, i, j;
282 /* Find all ZEROPLUS analyzers and add them to device list. */
284 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
286 for (i = 0; devlist[i]; i++) {
287 ret = libusb_get_device_descriptor(devlist[i], &des);
289 sr_err("Failed to get device descriptor: %s.",
290 libusb_error_name(ret));
295 for (j = 0; j < zeroplus_models[j].vid; j++) {
296 if (des.idVendor == zeroplus_models[j].vid &&
297 des.idProduct == zeroplus_models[j].pid) {
298 prof = &zeroplus_models[j];
301 /* Skip if the device was not found. */
304 sr_info("Found ZEROPLUS %s.", prof->model_name);
306 /* Register the device with libsigrok. */
307 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
308 VENDOR_NAME, prof->model_name, NULL))) {
309 sr_err("%s: sr_dev_inst_new failed", __func__);
314 /* Allocate memory for our private driver context. */
315 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
316 sr_err("Device context malloc failed.");
322 devc->num_channels = prof->channels;
323 #ifdef ZP_EXPERIMENTAL
324 devc->max_memory_size = 128 * 1024;
325 devc->max_samplerate = 200;
327 devc->max_memory_size = prof->sample_depth * 1024;
328 devc->max_samplerate = prof->max_sampling_freq;
330 devc->max_samplerate *= SR_MHZ(1);
331 devc->memory_size = MEMORY_SIZE_8K;
332 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
334 /* Fill in probelist according to this device's profile. */
335 for (j = 0; j < devc->num_channels; j++) {
336 if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
339 sdi->probes = g_slist_append(sdi->probes, probe);
342 devices = g_slist_append(devices, sdi);
343 drvc->instances = g_slist_append(drvc->instances, sdi);
344 devc->usb = sr_usb_dev_inst_new(
345 libusb_get_bus_number(devlist[i]),
346 libusb_get_device_address(devlist[i]), NULL);
350 libusb_free_device_list(devlist, 1);
355 static GSList *hw_dev_list(void)
357 return ((struct drv_context *)(di->priv))->instances;
360 static int hw_dev_open(struct sr_dev_inst *sdi)
362 struct dev_context *devc;
363 struct drv_context *drvc;
364 libusb_device **devlist, *dev;
365 struct libusb_device_descriptor des;
366 int device_count, ret, i;
370 if (!(devc = sdi->priv)) {
371 sr_err("%s: sdi->priv was NULL", __func__);
375 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
377 if (device_count < 0) {
378 sr_err("Failed to retrieve device list.");
383 for (i = 0; i < device_count; i++) {
384 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
385 sr_err("Failed to get device descriptor: %s.",
386 libusb_error_name(ret));
389 if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
390 && libusb_get_device_address(devlist[i]) == devc->usb->address) {
396 sr_err("Device on bus %d address %d disappeared!",
397 devc->usb->bus, devc->usb->address);
401 if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
402 sdi->status = SR_ST_ACTIVE;
403 sr_info("Opened device %d on %d.%d interface %d.",
404 sdi->index, devc->usb->bus,
405 devc->usb->address, USB_INTERFACE);
407 sr_err("Failed to open device: %s.", libusb_error_name(ret));
411 ret = libusb_set_configuration(devc->usb->devhdl, USB_CONFIGURATION);
413 sr_err("Unable to set USB configuration %d: %s.",
414 USB_CONFIGURATION, libusb_error_name(ret));
418 ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
420 sr_err("Unable to claim interface: %s.",
421 libusb_error_name(ret));
425 /* Set default configuration after power on. */
426 if (analyzer_read_status(devc->usb->devhdl) == 0)
427 analyzer_configure(devc->usb->devhdl);
429 analyzer_reset(devc->usb->devhdl);
430 analyzer_initialize(devc->usb->devhdl);
432 //analyzer_set_memory_size(MEMORY_SIZE_512K);
433 // analyzer_set_freq(g_freq, g_freq_scale);
434 analyzer_set_trigger_count(1);
435 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
436 // * get_memory_size(g_memory_size)) / 100) >> 2);
439 if (g_double_mode == 1)
440 analyzer_set_compression(COMPRESSION_DOUBLE);
441 else if (g_compression == 1)
442 analyzer_set_compression(COMPRESSION_ENABLE);
445 analyzer_set_compression(COMPRESSION_NONE);
447 if (devc->cur_samplerate == 0) {
448 /* Samplerate hasn't been set. Default to 1MHz. */
449 analyzer_set_freq(1, FREQ_SCALE_MHZ);
450 devc->cur_samplerate = SR_MHZ(1);
456 static int hw_dev_close(struct sr_dev_inst *sdi)
458 struct dev_context *devc;
462 if (!devc->usb->devhdl)
465 sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
466 devc->usb->bus, devc->usb->address, USB_INTERFACE);
467 libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
468 libusb_reset_device(devc->usb->devhdl);
469 libusb_close(devc->usb->devhdl);
470 devc->usb->devhdl = NULL;
471 sdi->status = SR_ST_INACTIVE;
476 static int hw_cleanup(void)
478 struct drv_context *drvc;
480 if (!(drvc = di->priv))
488 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
490 struct dev_context *devc;
493 case SR_CONF_SAMPLERATE:
496 *data = &devc->cur_samplerate;
497 sr_spew("Returning samplerate: %" PRIu64 "Hz.",
498 devc->cur_samplerate);
509 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
511 struct dev_context *devc;
514 sr_err("%s: sdi was NULL", __func__);
518 if (!(devc = sdi->priv)) {
519 sr_err("%s: sdi->priv was NULL", __func__);
524 case SR_CONF_SAMPLERATE:
525 return zp_set_samplerate(devc, *(const uint64_t *)value);
526 case SR_CONF_LIMIT_SAMPLES:
527 return set_limit_samples(devc, *(const uint64_t *)value);
528 case SR_CONF_CAPTURE_RATIO:
529 return set_capture_ratio(devc, *(const uint64_t *)value);
537 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
539 struct dev_context *devc;
542 case SR_CONF_DEVICE_OPTIONS:
545 case SR_CONF_SAMPLERATE:
547 if (devc->prof->max_sampling_freq == 100) {
548 *data = &samplerates_100;
549 } else if (devc->prof->max_sampling_freq == 200) {
550 *data = &samplerates_200;
552 sr_err("Internal error: Unknown max. samplerate: %d.",
553 devc->prof->max_sampling_freq);
557 case SR_CONF_TRIGGER_TYPE:
558 *data = TRIGGER_TYPE;
567 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
570 struct sr_datafeed_packet packet;
571 struct sr_datafeed_logic logic;
572 //uint64_t samples_read;
574 unsigned int packet_num, n;
576 struct dev_context *devc;
578 if (!(devc = sdi->priv)) {
579 sr_err("%s: sdi->priv was NULL", __func__);
583 if (configure_probes(sdi) != SR_OK) {
584 sr_err("Failed to configure probes.");
588 set_triggerbar(devc);
590 /* Push configured settings to device. */
591 analyzer_configure(devc->usb->devhdl);
593 analyzer_start(devc->usb->devhdl);
594 sr_info("Waiting for data.");
595 analyzer_wait_data(devc->usb->devhdl);
597 sr_info("Stop address = 0x%x.",
598 analyzer_get_stop_address(devc->usb->devhdl));
599 sr_info("Now address = 0x%x.",
600 analyzer_get_now_address(devc->usb->devhdl));
601 sr_info("Trigger address = 0x%x.",
602 analyzer_get_trigger_address(devc->usb->devhdl));
604 /* Send header packet to the session bus. */
605 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
607 if (!(buf = g_try_malloc(PACKET_SIZE))) {
608 sr_err("Packet buffer malloc failed.");
609 return SR_ERR_MALLOC;
613 analyzer_read_start(devc->usb->devhdl);
614 /* Send the incoming transfer to the session bus. */
615 n = get_memory_size(devc->memory_size);
616 if (devc->max_memory_size * 4 < n)
617 n = devc->max_memory_size * 4;
618 for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
619 res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
620 sr_info("Tried to read %d bytes, actually read %d bytes.",
623 packet.type = SR_DF_LOGIC;
624 packet.payload = &logic;
625 logic.length = PACKET_SIZE;
628 sr_session_send(cb_data, &packet);
629 //samples_read += res / 4;
631 analyzer_read_stop(devc->usb->devhdl);
634 packet.type = SR_DF_END;
635 sr_session_send(cb_data, &packet);
640 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
641 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
643 struct sr_datafeed_packet packet;
644 struct dev_context *devc;
646 packet.type = SR_DF_END;
647 sr_session_send(cb_data, &packet);
649 if (!(devc = sdi->priv)) {
650 sr_err("%s: sdi->priv was NULL", __func__);
654 analyzer_reset(devc->usb->devhdl);
655 /* TODO: Need to cancel and free any queued up transfers. */
660 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
661 .name = "zeroplus-logic-cube",
662 .longname = "ZEROPLUS Logic Cube LAP-C series",
665 .cleanup = hw_cleanup,
667 .dev_list = hw_dev_list,
668 .dev_clear = hw_cleanup,
669 .config_get = config_get,
670 .config_set = config_set,
671 .config_list = config_list,
672 .dev_open = hw_dev_open,
673 .dev_close = hw_dev_close,
674 .dev_acquisition_start = hw_dev_acquisition_start,
675 .dev_acquisition_stop = hw_dev_acquisition_stop,