2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 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/>.
28 #include <sigrok-internal.h>
31 #define USB_VENDOR 0x0c12
32 #define USB_VENDOR_NAME "Zeroplus"
33 #define USB_MODEL_NAME "Logic Cube"
34 #define USB_MODEL_VERSION ""
36 #define USB_INTERFACE 0
37 #define USB_CONFIGURATION 1
38 #define NUM_TRIGGER_STAGES 4
39 #define TRIGGER_TYPES "01"
41 #define PACKET_SIZE 2048 /* ?? */
46 unsigned int channels;
47 unsigned int sample_depth; /* In Ksamples/channel */
48 unsigned int max_sampling_freq;
52 * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
53 * same 128K sample depth.
55 static model_t zeroplus_models[] = {
56 {0x7009, "LAP-C(16064)", 16, 64, 100},
57 {0x700A, "LAP-C(16128)", 16, 128, 200},
58 {0x700B, "LAP-C(32128)", 32, 128, 200},
59 {0x700C, "LAP-C(321000)", 32, 1024, 200},
60 {0x700D, "LAP-C(322000)", 32, 2048, 200},
61 {0x700E, "LAP-C(16032)", 16, 32, 100},
62 {0x7016, "LAP-C(162000)", 16, 2048, 200},
65 static int capabilities[] = {
66 SR_HWCAP_LOGIC_ANALYZER,
69 SR_HWCAP_CAPTURE_RATIO,
71 /* These are really implemented in the driver, not the hardware. */
72 SR_HWCAP_LIMIT_SAMPLES,
76 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
77 static GSList *device_instances = NULL;
79 static libusb_context *usb_context = NULL;
82 * The hardware supports more samplerates than these, but these are the
83 * options hardcoded into the vendor's Windows GUI.
87 * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
90 static uint64_t supported_samplerates[] = {
112 static struct sr_samplerates samplerates = {
116 supported_samplerates,
119 /* TODO: All of these should go in a device-specific struct. */
120 static uint64_t cur_samplerate = 0;
121 static uint64_t period_ps = 0;
122 static uint64_t limit_samples = 0;
123 static int num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
124 static uint64_t memory_size = 0;
125 static uint8_t probe_mask = 0;
126 static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
127 static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
129 // static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
131 static int hw_set_configuration(int device_index, int capability, void *value);
133 static unsigned int get_memory_size(int type)
135 if (type == MEMORY_SIZE_8K)
137 else if (type == MEMORY_SIZE_64K)
139 else if (type == MEMORY_SIZE_128K)
141 else if (type == MEMORY_SIZE_512K)
147 static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
148 struct libusb_device_descriptor *des)
153 if ((err = libusb_get_device_descriptor(dev, des))) {
154 sr_warn("failed to get device descriptor: %d", err);
158 if (des->idVendor != USB_VENDOR)
161 if (libusb_get_bus_number(dev) == (*sdi)->usb->bus
162 && libusb_get_device_address(dev) == (*sdi)->usb->address) {
164 for (i = 0; i < ARRAY_SIZE(zeroplus_models); i++) {
165 if (!(des->idProduct == zeroplus_models[i].pid))
168 sr_info("Found PID=%04X (%s)", des->idProduct,
169 zeroplus_models[i].model_name);
170 num_channels = zeroplus_models[i].channels;
171 memory_size = zeroplus_models[i].sample_depth * 1024;
175 if (num_channels == 0) {
176 sr_warn("Unknown ZeroPlus device %04X", des->idProduct);
181 if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
182 (*sdi)->status = SR_ST_ACTIVE;
183 sr_info("opened device %d on %d.%d interface %d",
184 (*sdi)->index, (*sdi)->usb->bus,
185 (*sdi)->usb->address, USB_INTERFACE);
187 sr_warn("failed to open device: %d", err);
195 static struct sr_device_instance *zp_open_device(int device_index)
197 struct sr_device_instance *sdi;
198 libusb_device **devlist;
199 struct libusb_device_descriptor des;
202 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
205 libusb_get_device_list(usb_context, &devlist);
206 if (sdi->status == SR_ST_INACTIVE) {
207 /* Find the device by vendor, product, bus and address. */
208 libusb_get_device_list(usb_context, &devlist);
209 for (i = 0; devlist[i]; i++) {
210 /* TODO: Error handling. */
211 err = opendev4(&sdi, devlist[i], &des);
214 /* Status must be SR_ST_ACTIVE, i.e. already in use... */
217 libusb_free_device_list(devlist, 1);
219 if (sdi && sdi->status != SR_ST_ACTIVE)
225 static void close_device(struct sr_device_instance *sdi)
227 if (!sdi->usb->devhdl)
230 sr_info("closing device %d on %d.%d interface %d", sdi->index,
231 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
232 libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
233 libusb_close(sdi->usb->devhdl);
234 sdi->usb->devhdl = NULL;
235 sdi->status = SR_ST_INACTIVE;
238 static int configure_probes(GSList *probes)
240 struct sr_probe *probe;
242 int probe_bit, stage, i;
246 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
248 trigger_value[i] = 0;
252 for (l = probes; l; l = l->next) {
253 probe = (struct sr_probe *)l->data;
254 if (probe->enabled == FALSE)
256 probe_bit = 1 << (probe->index - 1);
257 probe_mask |= probe_bit;
259 if (probe->trigger) {
261 for (tc = probe->trigger; *tc; tc++) {
262 trigger_mask[stage] |= probe_bit;
264 trigger_value[stage] |= probe_bit;
266 if (stage > NUM_TRIGGER_STAGES)
279 static int hw_init(const char *deviceinfo)
281 struct sr_device_instance *sdi;
282 struct libusb_device_descriptor des;
283 libusb_device **devlist;
286 /* Avoid compiler warnings. */
289 if (libusb_init(&usb_context) != 0) {
290 sr_warn("Failed to initialize USB.");
294 /* Find all ZeroPlus analyzers and add them to device list. */
296 libusb_get_device_list(usb_context, &devlist);
298 for (i = 0; devlist[i]; i++) {
299 err = libusb_get_device_descriptor(devlist[i], &des);
301 sr_warn("failed to get device descriptor: %d", err);
305 if (des.idVendor == USB_VENDOR) {
307 * Definitely a Zeroplus.
308 * TODO: Any way to detect specific model/version in
309 * the zeroplus range?
311 sdi = sr_device_instance_new(devcnt,
312 SR_ST_INACTIVE, USB_VENDOR_NAME,
313 USB_MODEL_NAME, USB_MODEL_VERSION);
317 g_slist_append(device_instances, sdi);
318 sdi->usb = sr_usb_device_instance_new(
319 libusb_get_bus_number(devlist[i]),
320 libusb_get_device_address(devlist[i]), NULL);
324 libusb_free_device_list(devlist, 1);
329 static int hw_opendev(int device_index)
331 struct sr_device_instance *sdi;
334 if (!(sdi = zp_open_device(device_index))) {
335 sr_warn("unable to open device");
339 err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
341 sr_warn("Unable to claim interface: %d", err);
344 analyzer_reset(sdi->usb->devhdl);
345 analyzer_initialize(sdi->usb->devhdl);
347 analyzer_set_memory_size(MEMORY_SIZE_512K);
348 // analyzer_set_freq(g_freq, g_freq_scale);
349 analyzer_set_trigger_count(1);
350 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
351 // * get_memory_size(g_memory_size)) / 100) >> 2);
352 analyzer_set_ramsize_trigger_address(
353 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
356 if (g_double_mode == 1)
357 analyzer_set_compression(COMPRESSION_DOUBLE);
358 else if (g_compression == 1)
359 analyzer_set_compression(COMPRESSION_ENABLE);
362 analyzer_set_compression(COMPRESSION_NONE);
364 if (cur_samplerate == 0) {
365 /* Samplerate hasn't been set. Default to the slowest one. */
366 if (hw_set_configuration(device_index, SR_HWCAP_SAMPLERATE,
367 &samplerates.low) == SR_ERR)
374 static int hw_closedev(int device_index)
376 struct sr_device_instance *sdi;
378 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
379 sr_err("lap-c: %s: sdi was NULL", __func__);
380 return SR_ERR; /* TODO: SR_ERR_ARG? */
389 static void hw_cleanup(void)
393 /* Properly close all devices... */
394 for (l = device_instances; l; l = l->next)
395 close_device((struct sr_device_instance *)l->data);
397 /* ...and free all their memory. */
398 for (l = device_instances; l; l = l->next)
400 g_slist_free(device_instances);
401 device_instances = NULL;
404 libusb_exit(usb_context);
408 static void *hw_get_device_info(int device_index, int device_info_id)
410 struct sr_device_instance *sdi;
413 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
416 switch (device_info_id) {
420 case SR_DI_NUM_PROBES:
421 info = GINT_TO_POINTER(num_channels);
423 case SR_DI_SAMPLERATES:
426 case SR_DI_TRIGGER_TYPES:
427 info = TRIGGER_TYPES;
429 case SR_DI_CUR_SAMPLERATE:
430 info = &cur_samplerate;
437 static int hw_get_status(int device_index)
439 struct sr_device_instance *sdi;
441 sdi = sr_get_device_instance(device_instances, device_index);
445 return SR_ST_NOT_FOUND;
448 static int *hw_get_capabilities(void)
453 /* TODO: This will set the same samplerate for all devices. */
454 static int set_configuration_samplerate(uint64_t samplerate)
456 sr_info("%s(%" PRIu64 ")", __func__, samplerate);
457 if (samplerate > SR_MHZ(1))
458 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
459 else if (samplerate > SR_KHZ(1))
460 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
462 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
464 cur_samplerate = samplerate;
465 period_ps = 1000000000000 / samplerate;
470 static int hw_set_configuration(int device_index, int capability, void *value)
472 struct sr_device_instance *sdi;
475 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
478 switch (capability) {
479 case SR_HWCAP_SAMPLERATE:
481 return set_configuration_samplerate(*tmp_u64);
482 case SR_HWCAP_PROBECONFIG:
483 return configure_probes((GSList *) value);
484 case SR_HWCAP_LIMIT_SAMPLES:
486 limit_samples = *tmp_u64;
493 static int hw_start_acquisition(int device_index, gpointer session_data)
495 struct sr_device_instance *sdi;
496 struct sr_datafeed_packet packet;
497 struct sr_datafeed_logic logic;
498 struct sr_datafeed_header header;
499 uint64_t samples_read;
501 unsigned int packet_num;
504 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
507 /* push configured settings to device */
508 analyzer_configure(sdi->usb->devhdl);
510 analyzer_start(sdi->usb->devhdl);
511 sr_info("Waiting for data");
512 analyzer_wait_data(sdi->usb->devhdl);
514 sr_info("Stop address = 0x%x", analyzer_get_stop_address(sdi->usb->devhdl));
515 sr_info("Now address = 0x%x", analyzer_get_now_address(sdi->usb->devhdl));
516 sr_info("Trigger address = 0x%x", analyzer_get_trigger_address(sdi->usb->devhdl));
518 packet.type = SR_DF_HEADER;
519 packet.payload = &header;
520 header.feed_version = 1;
521 gettimeofday(&header.starttime, NULL);
522 header.samplerate = cur_samplerate;
523 header.num_logic_probes = num_channels;
524 header.num_analog_probes = 0;
525 sr_session_bus(session_data, &packet);
527 if (!(buf = g_try_malloc(PACKET_SIZE))) {
528 sr_err("lap-c: %s: buf malloc failed", __func__);
529 return SR_ERR_MALLOC;
533 analyzer_read_start(sdi->usb->devhdl);
534 /* Send the incoming transfer to the session bus. */
535 for (packet_num = 0; packet_num < (memory_size * 4 / PACKET_SIZE);
537 res = analyzer_read_data(sdi->usb->devhdl, buf, PACKET_SIZE);
538 sr_info("Tried to read %llx bytes, actually read %x bytes",
541 packet.type = SR_DF_LOGIC;
542 packet.timeoffset = samples_read * period_ps;
543 packet.duration = res / 4 * period_ps;
544 packet.payload = &logic;
545 logic.length = PACKET_SIZE;
548 sr_session_bus(session_data, &packet);
549 samples_read += res / 4;
551 analyzer_read_stop(sdi->usb->devhdl);
554 packet.type = SR_DF_END;
555 sr_session_bus(session_data, &packet);
560 /* This stops acquisition on ALL devices, ignoring device_index. */
561 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
563 struct sr_datafeed_packet packet;
564 struct sr_device_instance *sdi;
566 packet.type = SR_DF_END;
567 sr_session_bus(session_device_id, &packet);
569 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
570 return; /* TODO: Cry? */
572 analyzer_reset(sdi->usb->devhdl);
573 /* TODO: Need to cancel and free any queued up transfers. */
576 struct sr_device_plugin zeroplus_logic_cube_plugin_info = {
577 .name = "zeroplus-logic-cube",
578 .longname = "Zeroplus Logic Cube LAP-C series",
581 .cleanup = hw_cleanup,
582 .opendev = hw_opendev,
583 .closedev = hw_closedev,
584 .get_device_info = hw_get_device_info,
585 .get_status = hw_get_status,
586 .get_capabilities = hw_get_capabilities,
587 .set_configuration = hw_set_configuration,
588 .start_acquisition = hw_start_acquisition,
589 .stop_acquisition = hw_stop_acquisition,