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/>.
30 #define USB_VENDOR 0x0c12
31 #define USB_VENDOR_NAME "Zeroplus"
32 #define USB_MODEL_NAME "Logic Cube"
33 #define USB_MODEL_VERSION ""
35 #define USB_INTERFACE 0
36 #define USB_CONFIGURATION 1
37 #define NUM_TRIGGER_STAGES 4
38 #define TRIGGER_TYPES "01"
40 #define PACKET_SIZE 2048 // ??
45 unsigned int channels;
46 unsigned int sample_depth; // in Ksamples/channel
47 unsigned int max_sampling_freq;
50 /* Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the same 128K sample depth */
51 model_t zeroplus_models[] = {
52 {0x7009, "LAP-C(16064)", 16, 64, 100},
53 {0x700A, "LAP-C(16128)", 16, 128, 200},
54 {0x700B, "LAP-C(32128)", 32, 128, 200},
55 {0x700C, "LAP-C(321000)", 32, 1024, 200},
56 {0x700D, "LAP-C(322000)", 32, 2048, 200},
57 {0x700E, "LAP-C(16032)", 16, 32, 100},
58 {0x7016, "LAP-C(162000)", 16, 2048, 200},
61 static int capabilities[] = {
66 /* these are really implemented in the driver, not the hardware */
72 /* list of struct sigrok_device_instance, maintained by opendev() and closedev() */
73 static GSList *device_instances = NULL;
75 static libusb_context *usb_context = NULL;
77 /* The hardware supports more samplerates than these, but these are the options
78 hardcoded into the vendor's Windows GUI */
80 // XXX we shouldn't support 150MHz and 200MHz on devices that don't go up that high
81 static uint64_t supported_samplerates[] = {
103 static struct samplerates samplerates = {
105 supported_samplerates
108 /* TODO: all of these should go in a device-specific struct */
109 static uint64_t cur_samplerate = 0;
110 static uint64_t limit_samples = 0;
111 int num_channels = 32; // XXX this is not getting initialized before it is needed :(
112 uint64_t memory_size = 0;
113 static uint8_t probe_mask = 0;
114 static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = {0};
115 static uint8_t trigger_value[NUM_TRIGGER_STAGES] = {0};
116 // static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = {0};
119 static int hw_set_configuration(int device_index, int capability, void *value);
121 static unsigned int get_memory_size(int type)
123 if (type == MEMORY_SIZE_8K)
125 else if (type == MEMORY_SIZE_64K)
127 else if (type == MEMORY_SIZE_128K)
129 else if (type == MEMORY_SIZE_512K)
135 struct sigrok_device_instance *zp_open_device(int device_index)
137 struct sigrok_device_instance *sdi;
138 libusb_device **devlist;
139 struct libusb_device_descriptor des;
143 if(!(sdi = get_sigrok_device_instance(device_instances, device_index)))
146 libusb_get_device_list(usb_context, &devlist);
147 if(sdi->status == ST_INACTIVE) {
148 /* find the device by vendor, product, bus and address */
149 libusb_get_device_list(usb_context, &devlist);
150 for(i = 0; devlist[i]; i++) {
151 if( (err = libusb_get_device_descriptor(devlist[i], &des)) ) {
152 g_warning("failed to get device descriptor: %d", err);
156 if(des.idVendor == USB_VENDOR) {
157 if(libusb_get_bus_number(devlist[i]) == sdi->usb->bus &&
158 libusb_get_device_address(devlist[i]) == sdi->usb->address) {
159 for (j = 0; j < sizeof(zeroplus_models) / sizeof(zeroplus_models[0]); j++) {
160 if (des.idProduct == zeroplus_models[j].pid) {
161 g_message("Found PID=%04X (%s)", des.idProduct, zeroplus_models[j].model_name);
162 num_channels = zeroplus_models[j].channels;
163 memory_size = zeroplus_models[j].sample_depth * 1024;
167 if (num_channels == 0) {
168 g_warning("Unknown ZeroPlus device %04X", des.idProduct);
172 if( !(err = libusb_open(devlist[i], &(sdi->usb->devhdl))) ) {
173 sdi->status = ST_ACTIVE;
174 g_message("opened device %d on %d.%d interface %d", sdi->index,
175 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
178 g_warning("failed to open device: %d", err);
186 /* status must be ST_ACTIVE, i.e. already in use... */
189 libusb_free_device_list(devlist, 1);
191 if(sdi && sdi->status != ST_ACTIVE)
198 static void close_device(struct sigrok_device_instance *sdi)
203 g_message("closing device %d on %d.%d interface %d", sdi->index, sdi->usb->bus,
204 sdi->usb->address, USB_INTERFACE);
205 libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
206 libusb_close(sdi->usb->devhdl);
207 sdi->usb->devhdl = NULL;
208 sdi->status = ST_INACTIVE;
214 static int configure_probes(GSList *probes)
218 int probe_bit, stage, i;
222 for(i = 0; i < NUM_TRIGGER_STAGES; i++)
225 trigger_value[i] = 0;
229 for(l = probes; l; l = l->next)
231 probe = (struct probe *) l->data;
232 if(probe->enabled == FALSE)
234 probe_bit = 1 << (probe->index - 1);
235 probe_mask |= probe_bit;
239 for(tc = probe->trigger; *tc; tc++)
241 trigger_mask[stage] |= probe_bit;
243 trigger_value[stage] |= probe_bit;
245 if(stage > NUM_TRIGGER_STAGES)
260 static int hw_init(char *deviceinfo)
262 struct sigrok_device_instance *sdi;
263 struct libusb_device_descriptor des;
264 libusb_device **devlist;
268 deviceinfo = deviceinfo;
270 if(libusb_init(&usb_context) != 0) {
271 g_warning("Failed to initialize USB.");
275 /* find all ZeroPlus analyzers and add them to device list */
277 libusb_get_device_list(usb_context, &devlist);
278 for(i = 0; devlist[i]; i++) {
279 err = libusb_get_device_descriptor(devlist[i], &des);
281 g_warning("failed to get device descriptor: %d", err);
285 if(des.idVendor == USB_VENDOR) {
286 /* definitely a Zeroplus */
287 /* TODO: any way to detect specific model/version in the zeroplus range? */
288 sdi = sigrok_device_instance_new(devcnt, ST_INACTIVE,
289 USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
292 device_instances = g_slist_append(device_instances, sdi);
293 sdi->usb = usb_device_instance_new(libusb_get_bus_number(devlist[i]),
294 libusb_get_device_address(devlist[i]), NULL);
298 libusb_free_device_list(devlist, 1);
304 static int hw_opendev(int device_index)
306 struct sigrok_device_instance *sdi;
309 if( !(sdi = zp_open_device(device_index)) ) {
310 g_warning("unable to open device");
314 err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
316 g_warning("Unable to claim interface: %d", err);
319 analyzer_reset(sdi->usb->devhdl);
320 analyzer_initialize(sdi->usb->devhdl);
321 analyzer_configure(sdi->usb->devhdl);
323 analyzer_set_memory_size(MEMORY_SIZE_512K);
324 // analyzer_set_freq(g_freq, g_freq_scale);
325 analyzer_set_trigger_count(1);
326 // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger) * get_memory_size(g_memory_size)) / 100) >> 2);
327 analyzer_set_ramsize_trigger_address((100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
329 /* if (g_double_mode == 1)
330 analyzer_set_compression(COMPRESSION_DOUBLE);
331 else if (g_compression == 1)
332 analyzer_set_compression(COMPRESSION_ENABLE);
334 analyzer_set_compression(COMPRESSION_NONE);
336 if(cur_samplerate == 0) {
337 /* sample rate hasn't been set; default to the slowest it has */
338 if(hw_set_configuration(device_index, HWCAP_SAMPLERATE, &samplerates.low) == SIGROK_ERR)
346 static void hw_closedev(int device_index)
348 struct sigrok_device_instance *sdi;
350 if( (sdi = get_sigrok_device_instance(device_instances, device_index)) )
356 static void hw_cleanup(void)
360 /* properly close all devices */
361 for(l = device_instances; l; l = l->next)
362 close_device( (struct sigrok_device_instance *) l->data);
364 /* and free all their memory */
365 for(l = device_instances; l; l = l->next)
367 g_slist_free(device_instances);
368 device_instances = NULL;
371 libusb_exit(usb_context);
377 static void *hw_get_device_info(int device_index, int device_info_id)
379 struct sigrok_device_instance *sdi;
382 if( !(sdi = get_sigrok_device_instance(device_instances, device_index)) )
386 switch(device_info_id)
392 info = GINT_TO_POINTER(num_channels);
397 case DI_TRIGGER_TYPES:
398 info = TRIGGER_TYPES;
400 case DI_CUR_SAMPLERATE:
401 info = &cur_samplerate;
409 static int hw_get_status(int device_index)
411 struct sigrok_device_instance *sdi;
413 sdi = get_sigrok_device_instance(device_instances, device_index);
421 static int *hw_get_capabilities(void)
426 // XXX this will set the same samplerate for all devices
427 static int set_configuration_samplerate(uint64_t samplerate)
429 g_message("%s(%llu)", __FUNCTION__, samplerate);
430 if (samplerate > MHZ(1))
431 analyzer_set_freq(samplerate / MHZ(1), FREQ_SCALE_MHZ);
432 else if (samplerate > KHZ(1))
433 analyzer_set_freq(samplerate / KHZ(1), FREQ_SCALE_KHZ);
435 analyzer_set_freq(samplerate , FREQ_SCALE_HZ);
437 cur_samplerate = samplerate;
442 static int hw_set_configuration(int device_index, int capability, void *value)
444 struct sigrok_device_instance *sdi;
447 if( !(sdi = get_sigrok_device_instance(device_instances, device_index)) )
450 switch (capability) {
451 case HWCAP_SAMPLERATE:
453 return set_configuration_samplerate(*tmp_u64);
455 case HWCAP_PROBECONFIG:
456 return configure_probes( (GSList *) value);
458 case HWCAP_LIMIT_SAMPLES:
459 limit_samples = strtoull(value, NULL, 10);
467 static int hw_start_acquisition(int device_index, gpointer session_device_id)
469 struct sigrok_device_instance *sdi;
470 struct datafeed_packet packet;
471 struct datafeed_header header;
473 unsigned int packet_num;
476 if( !(sdi = get_sigrok_device_instance(device_instances, device_index)))
479 analyzer_start(sdi->usb->devhdl);
480 g_message("Waiting for data");
481 analyzer_wait_data(sdi->usb->devhdl);
483 g_message("Stop address = 0x%x", analyzer_get_stop_address(sdi->usb->devhdl));
484 g_message("Now address = 0x%x", analyzer_get_now_address(sdi->usb->devhdl));
485 g_message("Trigger address = 0x%x", analyzer_get_trigger_address(sdi->usb->devhdl));
487 packet.type = DF_HEADER;
488 packet.length = sizeof(struct datafeed_header);
489 packet.payload = (unsigned char *) &header;
490 header.feed_version = 1;
491 gettimeofday(&header.starttime, NULL);
492 header.samplerate = cur_samplerate;
493 header.protocol_id = PROTO_RAW;
494 header.num_probes = num_channels;
495 session_bus(session_device_id, &packet);
497 buf = g_malloc(PACKET_SIZE);
500 analyzer_read_start(sdi->usb->devhdl);
501 /* send the incoming transfer to the session bus */
502 for(packet_num = 0; packet_num < (memory_size * 4 / PACKET_SIZE); packet_num++) {
503 res = analyzer_read_data(sdi->usb->devhdl, buf, PACKET_SIZE);
504 // g_message("Tried to read %llx bytes, actually read %x bytes", PACKET_SIZE, res);
506 packet.type = DF_LOGIC32;
507 packet.length = PACKET_SIZE;
508 packet.payload = buf;
509 session_bus(session_device_id, &packet);
511 analyzer_read_stop(sdi->usb->devhdl);
514 packet.type = DF_END;
515 session_bus(session_device_id, &packet);
521 /* this stops acquisition on ALL devices, ignoring device_index */
522 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
524 struct datafeed_packet packet;
525 struct sigrok_device_instance *sdi;
527 packet.type = DF_END;
528 session_bus(session_device_id, &packet);
530 if( !(sdi = get_sigrok_device_instance(device_instances, device_index)))
533 analyzer_reset(sdi->usb->devhdl);
534 /* TODO: need to cancel and free any queued up transfers */
539 struct device_plugin zeroplus_logic_cube_plugin_info = {
540 "zeroplus-logic-cube",
550 hw_set_configuration,
551 hw_start_acquisition,