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 = {
114 supported_samplerates,
117 /* TODO: All of these should go in a device-specific struct. */
118 static uint64_t cur_samplerate = 0;
119 static uint64_t limit_samples = 0;
120 static int num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
121 static uint64_t memory_size = 0;
122 static uint8_t probe_mask = 0;
123 static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
124 static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
126 // static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
128 static int hw_set_configuration(int device_index, int capability, void *value);
130 static unsigned int get_memory_size(int type)
132 if (type == MEMORY_SIZE_8K)
134 else if (type == MEMORY_SIZE_64K)
136 else if (type == MEMORY_SIZE_128K)
138 else if (type == MEMORY_SIZE_512K)
144 static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
145 struct libusb_device_descriptor *des)
150 if ((err = libusb_get_device_descriptor(dev, des))) {
151 g_warning("failed to get device descriptor: %d", err);
155 if (des->idVendor != USB_VENDOR)
158 if (libusb_get_bus_number(dev) == (*sdi)->usb->bus
159 && libusb_get_device_address(dev) == (*sdi)->usb->address) {
161 for (i = 0; i < ARRAY_SIZE(zeroplus_models); i++) {
162 if (!(des->idProduct == zeroplus_models[i].pid))
165 g_message("Found PID=%04X (%s)", des->idProduct,
166 zeroplus_models[i].model_name);
167 num_channels = zeroplus_models[i].channels;
168 memory_size = zeroplus_models[i].sample_depth * 1024;
172 if (num_channels == 0) {
173 g_warning("Unknown ZeroPlus device %04X",
179 if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
180 (*sdi)->status = SR_ST_ACTIVE;
181 g_message("opened device %d on %d.%d interface %d",
182 (*sdi)->index, (*sdi)->usb->bus,
183 (*sdi)->usb->address, USB_INTERFACE);
185 g_warning("failed to open device: %d", err);
193 static struct sr_device_instance *zp_open_device(int device_index)
195 struct sr_device_instance *sdi;
196 libusb_device **devlist;
197 struct libusb_device_descriptor des;
200 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
203 libusb_get_device_list(usb_context, &devlist);
204 if (sdi->status == SR_ST_INACTIVE) {
205 /* Find the device by vendor, product, bus and address. */
206 libusb_get_device_list(usb_context, &devlist);
207 for (i = 0; devlist[i]; i++) {
208 /* TODO: Error handling. */
209 err = opendev4(&sdi, devlist[i], &des);
212 /* Status must be SR_ST_ACTIVE, i.e. already in use... */
215 libusb_free_device_list(devlist, 1);
217 if (sdi && sdi->status != SR_ST_ACTIVE)
223 static void close_device(struct sr_device_instance *sdi)
225 if (!sdi->usb->devhdl)
228 g_message("closing device %d on %d.%d interface %d", sdi->index,
229 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
230 libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
231 libusb_close(sdi->usb->devhdl);
232 sdi->usb->devhdl = NULL;
233 sdi->status = SR_ST_INACTIVE;
236 static int configure_probes(GSList *probes)
238 struct sr_probe *probe;
240 int probe_bit, stage, i;
244 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
246 trigger_value[i] = 0;
250 for (l = probes; l; l = l->next) {
251 probe = (struct sr_probe *)l->data;
252 if (probe->enabled == FALSE)
254 probe_bit = 1 << (probe->index - 1);
255 probe_mask |= probe_bit;
257 if (probe->trigger) {
259 for (tc = probe->trigger; *tc; tc++) {
260 trigger_mask[stage] |= probe_bit;
262 trigger_value[stage] |= probe_bit;
264 if (stage > NUM_TRIGGER_STAGES)
277 static int hw_init(const char *deviceinfo)
279 struct sr_device_instance *sdi;
280 struct libusb_device_descriptor des;
281 libusb_device **devlist;
284 /* Avoid compiler warnings. */
285 deviceinfo = deviceinfo;
287 if (libusb_init(&usb_context) != 0) {
288 g_warning("Failed to initialize USB.");
292 /* Find all ZeroPlus analyzers and add them to device list. */
294 libusb_get_device_list(usb_context, &devlist);
296 for (i = 0; devlist[i]; i++) {
297 err = libusb_get_device_descriptor(devlist[i], &des);
299 g_warning("failed to get device descriptor: %d", err);
303 if (des.idVendor == USB_VENDOR) {
305 * Definitely a Zeroplus.
306 * TODO: Any way to detect specific model/version in
307 * the zeroplus range?
309 sdi = sr_device_instance_new(devcnt,
310 SR_ST_INACTIVE, USB_VENDOR_NAME,
311 USB_MODEL_NAME, USB_MODEL_VERSION);
315 g_slist_append(device_instances, sdi);
316 sdi->usb = sr_usb_device_instance_new(
317 libusb_get_bus_number(devlist[i]),
318 libusb_get_device_address(devlist[i]), NULL);
322 libusb_free_device_list(devlist, 1);
327 static int hw_opendev(int device_index)
329 struct sr_device_instance *sdi;
332 if (!(sdi = zp_open_device(device_index))) {
333 g_warning("unable to open device");
337 err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
339 g_warning("Unable to claim interface: %d", err);
342 analyzer_reset(sdi->usb->devhdl);
343 analyzer_initialize(sdi->usb->devhdl);
345 analyzer_set_memory_size(MEMORY_SIZE_512K);
346 // analyzer_set_freq(g_freq, g_freq_scale);
347 analyzer_set_trigger_count(1);
348 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
349 // * get_memory_size(g_memory_size)) / 100) >> 2);
350 analyzer_set_ramsize_trigger_address(
351 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
354 if (g_double_mode == 1)
355 analyzer_set_compression(COMPRESSION_DOUBLE);
356 else if (g_compression == 1)
357 analyzer_set_compression(COMPRESSION_ENABLE);
360 analyzer_set_compression(COMPRESSION_NONE);
362 if (cur_samplerate == 0) {
363 /* Samplerate hasn't been set. Default to the slowest one. */
364 if (hw_set_configuration(device_index, SR_HWCAP_SAMPLERATE,
365 &samplerates.low) == SR_ERR)
372 static void hw_closedev(int device_index)
374 struct sr_device_instance *sdi;
376 if ((sdi = sr_get_device_instance(device_instances, device_index)))
380 static void hw_cleanup(void)
384 /* Properly close all devices... */
385 for (l = device_instances; l; l = l->next)
386 close_device((struct sr_device_instance *)l->data);
388 /* ...and free all their memory. */
389 for (l = device_instances; l; l = l->next)
391 g_slist_free(device_instances);
392 device_instances = NULL;
395 libusb_exit(usb_context);
399 static void *hw_get_device_info(int device_index, int device_info_id)
401 struct sr_device_instance *sdi;
404 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
407 switch (device_info_id) {
411 case SR_DI_NUM_PROBES:
412 info = GINT_TO_POINTER(num_channels);
414 case SR_DI_SAMPLERATES:
417 case SR_DI_TRIGGER_TYPES:
418 info = TRIGGER_TYPES;
420 case SR_DI_CUR_SAMPLERATE:
421 info = &cur_samplerate;
428 static int hw_get_status(int device_index)
430 struct sr_device_instance *sdi;
432 sdi = sr_get_device_instance(device_instances, device_index);
436 return SR_ST_NOT_FOUND;
439 static int *hw_get_capabilities(void)
444 /* TODO: This will set the same samplerate for all devices. */
445 static int set_configuration_samplerate(uint64_t samplerate)
447 g_message("%s(%" PRIu64 ")", __FUNCTION__, samplerate);
448 if (samplerate > SR_MHZ(1))
449 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
450 else if (samplerate > SR_KHZ(1))
451 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
453 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
455 cur_samplerate = samplerate;
460 static int hw_set_configuration(int device_index, int capability, void *value)
462 struct sr_device_instance *sdi;
465 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
468 switch (capability) {
469 case SR_HWCAP_SAMPLERATE:
471 return set_configuration_samplerate(*tmp_u64);
472 case SR_HWCAP_PROBECONFIG:
473 return configure_probes((GSList *) value);
474 case SR_HWCAP_LIMIT_SAMPLES:
476 limit_samples = *tmp_u64;
483 static int hw_start_acquisition(int device_index, gpointer session_device_id)
485 struct sr_device_instance *sdi;
486 struct sr_datafeed_packet packet;
487 struct sr_datafeed_header header;
489 unsigned int packet_num;
492 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
495 /* push configured settings to device */
496 analyzer_configure(sdi->usb->devhdl);
498 analyzer_start(sdi->usb->devhdl);
499 g_message("Waiting for data");
500 analyzer_wait_data(sdi->usb->devhdl);
502 g_message("Stop address = 0x%x",
503 analyzer_get_stop_address(sdi->usb->devhdl));
504 g_message("Now address = 0x%x",
505 analyzer_get_now_address(sdi->usb->devhdl));
506 g_message("Trigger address = 0x%x",
507 analyzer_get_trigger_address(sdi->usb->devhdl));
509 packet.type = SR_DF_HEADER;
510 packet.length = sizeof(struct sr_datafeed_header);
511 packet.payload = (unsigned char *)&header;
512 header.feed_version = 1;
513 gettimeofday(&header.starttime, NULL);
514 header.samplerate = cur_samplerate;
515 header.protocol_id = SR_PROTO_RAW;
516 header.num_logic_probes = num_channels;
517 header.num_analog_probes = 0;
518 sr_session_bus(session_device_id, &packet);
520 buf = g_malloc(PACKET_SIZE);
523 analyzer_read_start(sdi->usb->devhdl);
524 /* Send the incoming transfer to the session bus. */
525 for (packet_num = 0; packet_num < (memory_size * 4 / PACKET_SIZE);
527 res = analyzer_read_data(sdi->usb->devhdl, buf, PACKET_SIZE);
529 g_message("Tried to read %llx bytes, actually read %x bytes",
533 packet.type = SR_DF_LOGIC;
534 packet.length = PACKET_SIZE;
536 packet.payload = buf;
537 sr_session_bus(session_device_id, &packet);
539 analyzer_read_stop(sdi->usb->devhdl);
542 packet.type = SR_DF_END;
543 sr_session_bus(session_device_id, &packet);
548 /* This stops acquisition on ALL devices, ignoring device_index. */
549 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
551 struct sr_datafeed_packet packet;
552 struct sr_device_instance *sdi;
554 packet.type = SR_DF_END;
555 sr_session_bus(session_device_id, &packet);
557 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
558 return; /* TODO: Cry? */
560 analyzer_reset(sdi->usb->devhdl);
561 /* TODO: Need to cancel and free any queued up transfers. */
564 struct sr_device_plugin zeroplus_logic_cube_plugin_info = {
565 "zeroplus-logic-cube",
566 "Zeroplus Logic Cube LAP-C series",
575 hw_set_configuration,
576 hw_start_acquisition,