]> sigrok.org Git - libsigrok.git/blob - hardware/zeroplus-logic-cube/zeroplus.c
sr: remove unused time/duration fields from datafeed packets
[libsigrok.git] / hardware / zeroplus-logic-cube / zeroplus.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <sys/time.h>
24 #include <inttypes.h>
25 #include <glib.h>
26 #include <libusb.h>
27 #include "config.h"
28 #include "sigrok.h"
29 #include "sigrok-internal.h"
30 #include "analyzer.h"
31
32 #define USB_VENDOR                      0x0c12
33 #define USB_VENDOR_NAME                 "Zeroplus"
34 #define USB_MODEL_NAME                  "Logic Cube"
35 #define USB_MODEL_VERSION               ""
36
37 #define USB_INTERFACE                   0
38 #define USB_CONFIGURATION               1
39 #define NUM_TRIGGER_STAGES              4
40 #define TRIGGER_TYPES                   "01"
41
42 #define PACKET_SIZE                     2048    /* ?? */
43
44 typedef struct {
45         unsigned short pid;
46         char model_name[64];
47         unsigned int channels;
48         unsigned int sample_depth;      /* In Ksamples/channel */
49         unsigned int max_sampling_freq;
50 } model_t;
51
52 /*
53  * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
54  * same 128K sample depth.
55  */
56 static model_t zeroplus_models[] = {
57         {0x7009, "LAP-C(16064)",  16, 64,   100},
58         {0x700A, "LAP-C(16128)",  16, 128,  200},
59         {0x700B, "LAP-C(32128)",  32, 128,  200},
60         {0x700C, "LAP-C(321000)", 32, 1024, 200},
61         {0x700D, "LAP-C(322000)", 32, 2048, 200},
62         {0x700E, "LAP-C(16032)",  16, 32,   100},
63         {0x7016, "LAP-C(162000)", 16, 2048, 200},
64 };
65
66 static int capabilities[] = {
67         SR_HWCAP_LOGIC_ANALYZER,
68         SR_HWCAP_SAMPLERATE,
69         SR_HWCAP_PROBECONFIG,
70         SR_HWCAP_CAPTURE_RATIO,
71
72         /* These are really implemented in the driver, not the hardware. */
73         SR_HWCAP_LIMIT_SAMPLES,
74         0,
75 };
76
77 static const char *probe_names[] = {
78         "0",
79         "1",
80         "2",
81         "3",
82         "4",
83         "5",
84         "6",
85         "7",
86         "8",
87         "9",
88         "10",
89         "11",
90         "12",
91         "13",
92         "14",
93         "15",
94         "16",
95         "17",
96         "18",
97         "19",
98         "20",
99         "21",
100         "22",
101         "23",
102         "24",
103         "25",
104         "26",
105         "27",
106         "28",
107         "29",
108         "30",
109         "31",
110         NULL,
111 };
112
113 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
114 static GSList *device_instances = NULL;
115
116 static libusb_context *usb_context = NULL;
117
118 /*
119  * The hardware supports more samplerates than these, but these are the
120  * options hardcoded into the vendor's Windows GUI.
121  */
122
123 /*
124  * TODO: We shouldn't support 150MHz and 200MHz on devices that don't go up
125  * that high.
126  */
127 static uint64_t supported_samplerates[] = {
128         SR_HZ(100),
129         SR_HZ(500),
130         SR_KHZ(1),
131         SR_KHZ(5),
132         SR_KHZ(25),
133         SR_KHZ(50),
134         SR_KHZ(100),
135         SR_KHZ(200),
136         SR_KHZ(400),
137         SR_KHZ(800),
138         SR_MHZ(1),
139         SR_MHZ(10),
140         SR_MHZ(25),
141         SR_MHZ(50),
142         SR_MHZ(80),
143         SR_MHZ(100),
144         SR_MHZ(150),
145         SR_MHZ(200),
146         0,
147 };
148
149 static struct sr_samplerates samplerates = {
150         SR_HZ(0),
151         SR_HZ(0),
152         SR_HZ(0),
153         supported_samplerates,
154 };
155
156 struct zp {
157         uint64_t cur_samplerate;
158         uint64_t limit_samples;
159         int num_channels; /* TODO: This isn't initialized before it's needed :( */
160         uint64_t memory_size;
161         uint8_t probe_mask;
162         uint8_t trigger_mask[NUM_TRIGGER_STAGES];
163         uint8_t trigger_value[NUM_TRIGGER_STAGES];
164         // uint8_t trigger_buffer[NUM_TRIGGER_STAGES];
165
166         struct sr_usb_device_instance *usb;
167 };
168
169 static int hw_set_configuration(int device_index, int capability, void *value);
170
171 static unsigned int get_memory_size(int type)
172 {
173         if (type == MEMORY_SIZE_8K)
174                 return 8 * 1024;
175         else if (type == MEMORY_SIZE_64K)
176                 return 64 * 1024;
177         else if (type == MEMORY_SIZE_128K)
178                 return 128 * 1024;
179         else if (type == MEMORY_SIZE_512K)
180                 return 512 * 1024;
181         else
182                 return 0;
183 }
184
185 static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
186                     struct libusb_device_descriptor *des)
187 {
188         struct zp *zp;
189         unsigned int i;
190         int err;
191
192         /* Note: sdi is non-NULL, the caller already checked this. */
193
194         if (!(zp = (*sdi)->priv)) {
195                 sr_err("zp: %s: (*sdi)->priv was NULL", __func__);
196                 return -1;
197         }
198
199         if ((err = libusb_get_device_descriptor(dev, des))) {
200                 sr_warn("failed to get device descriptor: %d", err);
201                 return -1;
202         }
203
204         if (des->idVendor != USB_VENDOR)
205                 return 0;
206
207         if (libusb_get_bus_number(dev) == zp->usb->bus
208             && libusb_get_device_address(dev) == zp->usb->address) {
209
210                 for (i = 0; i < ARRAY_SIZE(zeroplus_models); i++) {
211                         if (!(des->idProduct == zeroplus_models[i].pid))
212                                 continue;
213
214                         sr_info("Found PID=%04X (%s)", des->idProduct,
215                                 zeroplus_models[i].model_name);
216                         zp->num_channels = zeroplus_models[i].channels;
217                         zp->memory_size = zeroplus_models[i].sample_depth * 1024;
218                         break;
219                 }
220
221                 if (zp->num_channels == 0) {
222                         sr_warn("Unknown ZeroPlus device %04X", des->idProduct);
223                         return -2;
224                 }
225
226                 /* Found it. */
227                 if (!(err = libusb_open(dev, &(zp->usb->devhdl)))) {
228                         (*sdi)->status = SR_ST_ACTIVE;
229                         sr_info("opened device %d on %d.%d interface %d",
230                                 (*sdi)->index, zp->usb->bus,
231                                 zp->usb->address, USB_INTERFACE);
232                 } else {
233                         sr_warn("failed to open device: %d", err);
234                         *sdi = NULL;
235                 }
236         }
237
238         return 0;
239 }
240
241 static struct sr_device_instance *zp_open_device(int device_index)
242 {
243         struct sr_device_instance *sdi;
244         libusb_device **devlist;
245         struct libusb_device_descriptor des;
246         int err, i;
247
248         if (!(sdi = sr_get_device_instance(device_instances, device_index)))
249                 return NULL;
250
251         libusb_get_device_list(usb_context, &devlist);
252         if (sdi->status == SR_ST_INACTIVE) {
253                 /* Find the device by vendor, product, bus and address. */
254                 libusb_get_device_list(usb_context, &devlist);
255                 for (i = 0; devlist[i]; i++) {
256                         /* TODO: Error handling. */
257                         err = opendev4(&sdi, devlist[i], &des);
258                 }
259         } else {
260                 /* Status must be SR_ST_ACTIVE, i.e. already in use... */
261                 sdi = NULL;
262         }
263         libusb_free_device_list(devlist, 1);
264
265         if (sdi && sdi->status != SR_ST_ACTIVE)
266                 sdi = NULL;
267
268         return sdi;
269 }
270
271 static void close_device(struct sr_device_instance *sdi)
272 {
273         struct zp *zp;
274
275         if (!(zp = sdi->priv)) {
276                 sr_err("zp: %s: sdi->priv was NULL", __func__);
277                 return; /* FIXME */
278         }
279
280         if (!zp->usb->devhdl)
281                 return;
282
283         sr_info("closing device %d on %d.%d interface %d", sdi->index,
284                 zp->usb->bus, zp->usb->address, USB_INTERFACE);
285         libusb_release_interface(zp->usb->devhdl, USB_INTERFACE);
286         libusb_close(zp->usb->devhdl);
287         zp->usb->devhdl = NULL;
288         sdi->status = SR_ST_INACTIVE;
289 }
290
291 static int configure_probes(struct sr_device_instance *sdi, GSList *probes)
292 {
293         struct zp *zp;
294         struct sr_probe *probe;
295         GSList *l;
296         int probe_bit, stage, i;
297         char *tc;
298
299         /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
300         zp = sdi->priv;
301
302         zp->probe_mask = 0;
303         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
304                 zp->trigger_mask[i] = 0;
305                 zp->trigger_value[i] = 0;
306         }
307
308         stage = -1;
309         for (l = probes; l; l = l->next) {
310                 probe = (struct sr_probe *)l->data;
311                 if (probe->enabled == FALSE)
312                         continue;
313                 probe_bit = 1 << (probe->index - 1);
314                 zp->probe_mask |= probe_bit;
315
316                 if (probe->trigger) {
317                         stage = 0;
318                         for (tc = probe->trigger; *tc; tc++) {
319                                 zp->trigger_mask[stage] |= probe_bit;
320                                 if (*tc == '1')
321                                         zp->trigger_value[stage] |= probe_bit;
322                                 stage++;
323                                 if (stage > NUM_TRIGGER_STAGES)
324                                         return SR_ERR;
325                         }
326                 }
327         }
328
329         return SR_OK;
330 }
331
332 /*
333  * API callbacks
334  */
335
336 static int hw_init(const char *deviceinfo)
337 {
338         struct sr_device_instance *sdi;
339         struct libusb_device_descriptor des;
340         libusb_device **devlist;
341         int err, devcnt, i;
342         struct zp *zp;
343
344         /* Avoid compiler warnings. */
345         (void)deviceinfo;
346
347         /* Allocate memory for our private driver context. */
348         if (!(zp = g_try_malloc(sizeof(struct zp)))) {
349                 sr_err("zp: %s: struct zp malloc failed", __func__);
350                 return 0;
351         }
352
353         /* Set some sane defaults. */
354         zp->cur_samplerate = 0;
355         zp->limit_samples = 0;
356         zp->num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
357         zp->memory_size = 0;
358         zp->probe_mask = 0;
359         memset(zp->trigger_mask, 0, NUM_TRIGGER_STAGES);
360         memset(zp->trigger_value, 0, NUM_TRIGGER_STAGES);
361         // memset(zp->trigger_buffer, 0, NUM_TRIGGER_STAGES);
362
363         if (libusb_init(&usb_context) != 0) {
364                 sr_warn("Failed to initialize USB.");
365                 return 0;
366         }
367
368         /* Find all ZeroPlus analyzers and add them to device list. */
369         devcnt = 0;
370         libusb_get_device_list(usb_context, &devlist);
371
372         for (i = 0; devlist[i]; i++) {
373                 err = libusb_get_device_descriptor(devlist[i], &des);
374                 if (err != 0) {
375                         sr_warn("failed to get device descriptor: %d", err);
376                         continue;
377                 }
378
379                 if (des.idVendor == USB_VENDOR) {
380                         /*
381                          * Definitely a Zeroplus.
382                          * TODO: Any way to detect specific model/version in
383                          * the zeroplus range?
384                          */
385                         /* Register the device with libsigrok. */
386                         sdi = sr_device_instance_new(devcnt,
387                                         SR_ST_INACTIVE, USB_VENDOR_NAME,
388                                         USB_MODEL_NAME, USB_MODEL_VERSION);
389                         if (!sdi) {
390                                 sr_err("zp: %s: sr_device_instance_new failed",
391                                        __func__);
392                                 return 0;
393                         }
394
395                         sdi->priv = zp;
396
397                         device_instances =
398                             g_slist_append(device_instances, sdi);
399                         zp->usb = sr_usb_device_instance_new(
400                                 libusb_get_bus_number(devlist[i]),
401                                 libusb_get_device_address(devlist[i]), NULL);
402                         devcnt++;
403                 }
404         }
405         libusb_free_device_list(devlist, 1);
406
407         return devcnt;
408 }
409
410 static int hw_opendev(int device_index)
411 {
412         struct sr_device_instance *sdi;
413         struct zp *zp;
414         int err;
415
416         if (!(sdi = zp_open_device(device_index))) {
417                 sr_warn("unable to open device");
418                 return SR_ERR;
419         }
420
421         /* TODO: Note: sdi is retrieved in zp_open_device(). */
422
423         if (!(zp = sdi->priv)) {
424                 sr_err("zp: %s: sdi->priv was NULL", __func__);
425                 return SR_ERR_ARG;
426         }
427
428         err = libusb_claim_interface(zp->usb->devhdl, USB_INTERFACE);
429         if (err != 0) {
430                 sr_warn("Unable to claim interface: %d", err);
431                 return SR_ERR;
432         }
433         analyzer_reset(zp->usb->devhdl);
434         analyzer_initialize(zp->usb->devhdl);
435
436         analyzer_set_memory_size(MEMORY_SIZE_512K);
437         // analyzer_set_freq(g_freq, g_freq_scale);
438         analyzer_set_trigger_count(1);
439         // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
440         // * get_memory_size(g_memory_size)) / 100) >> 2);
441         analyzer_set_ramsize_trigger_address(
442                 (100 * get_memory_size(MEMORY_SIZE_512K) / 100) >> 2);
443
444 #if 0
445         if (g_double_mode == 1)
446                 analyzer_set_compression(COMPRESSION_DOUBLE);
447         else if (g_compression == 1)
448                 analyzer_set_compression(COMPRESSION_ENABLE);
449         else
450 #endif
451         analyzer_set_compression(COMPRESSION_NONE);
452
453         if (zp->cur_samplerate == 0) {
454                 /* Samplerate hasn't been set. Default to the slowest one. */
455                 if (hw_set_configuration(device_index, SR_HWCAP_SAMPLERATE,
456                      &samplerates.list[0]) == SR_ERR)
457                         return SR_ERR;
458         }
459
460         return SR_OK;
461 }
462
463 static int hw_closedev(int device_index)
464 {
465         struct sr_device_instance *sdi;
466
467         if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
468                 sr_err("zp: %s: sdi was NULL", __func__);
469                 return SR_ERR; /* TODO: SR_ERR_ARG? */
470         }
471
472         /* TODO */
473         close_device(sdi);
474
475         return SR_OK;
476 }
477
478 static void hw_cleanup(void)
479 {
480         GSList *l;
481
482         /* Properly close all devices... */
483         for (l = device_instances; l; l = l->next)
484                 close_device((struct sr_device_instance *)l->data);
485
486         /* ...and free all their memory. */
487         for (l = device_instances; l; l = l->next)
488                 g_free(l->data);
489         g_slist_free(device_instances);
490         device_instances = NULL;
491
492         if (usb_context)
493                 libusb_exit(usb_context);
494         usb_context = NULL;
495 }
496
497 static void *hw_get_device_info(int device_index, int device_info_id)
498 {
499         struct sr_device_instance *sdi;
500         struct zp *zp;
501         void *info;
502
503         if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
504                 sr_err("zp: %s: sdi was NULL", __func__);
505                 return NULL;
506         }
507
508         if (!(zp = sdi->priv)) {
509                 sr_err("zp: %s: sdi->priv was NULL", __func__);
510                 return NULL;
511         }
512
513         switch (device_info_id) {
514         case SR_DI_INSTANCE:
515                 info = sdi;
516                 break;
517         case SR_DI_NUM_PROBES:
518                 info = GINT_TO_POINTER(zp->num_channels);
519                 break;
520         case SR_DI_PROBE_NAMES:
521                 info = probe_names;
522                 break;
523         case SR_DI_SAMPLERATES:
524                 info = &samplerates;
525                 break;
526         case SR_DI_TRIGGER_TYPES:
527                 info = TRIGGER_TYPES;
528                 break;
529         case SR_DI_CUR_SAMPLERATE:
530                 info = &zp->cur_samplerate;
531                 break;
532         default:
533                 /* Unknown device info ID, return NULL. */
534                 sr_err("zp: %s: Unknown device info ID", __func__);
535                 info = NULL;
536                 break;
537         }
538
539         return info;
540 }
541
542 static int hw_get_status(int device_index)
543 {
544         struct sr_device_instance *sdi;
545
546         sdi = sr_get_device_instance(device_instances, device_index);
547         if (sdi)
548                 return sdi->status;
549         else
550                 return SR_ST_NOT_FOUND;
551 }
552
553 static int *hw_get_capabilities(void)
554 {
555         return capabilities;
556 }
557
558 static int set_configuration_samplerate(struct sr_device_instance *sdi,
559                                         uint64_t samplerate)
560 {
561         struct zp *zp;
562
563         if (!sdi) {
564                 sr_err("zp: %s: sdi was NULL", __func__);
565                 return SR_ERR_ARG;
566         }
567
568         if (!(zp = sdi->priv)) {
569                 sr_err("zp: %s: sdi->priv was NULL", __func__);
570                 return SR_ERR_ARG;
571         }
572
573         sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
574
575         if (samplerate > SR_MHZ(1))
576                 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
577         else if (samplerate > SR_KHZ(1))
578                 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
579         else
580                 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
581
582         zp->cur_samplerate = samplerate;
583
584         return SR_OK;
585 }
586
587 static int hw_set_configuration(int device_index, int capability, void *value)
588 {
589         struct sr_device_instance *sdi;
590         uint64_t *tmp_u64;
591         struct zp *zp;
592
593         if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
594                 sr_err("zp: %s: sdi was NULL", __func__);
595                 return SR_ERR;
596         }
597
598         if (!(zp = sdi->priv)) {
599                 sr_err("zp: %s: sdi->priv was NULL", __func__);
600                 return SR_ERR_ARG;
601         }
602
603         switch (capability) {
604         case SR_HWCAP_SAMPLERATE:
605                 tmp_u64 = value;
606                 return set_configuration_samplerate(sdi, *tmp_u64);
607         case SR_HWCAP_PROBECONFIG:
608                 return configure_probes(sdi, (GSList *)value);
609         case SR_HWCAP_LIMIT_SAMPLES:
610                 tmp_u64 = value;
611                 zp->limit_samples = *tmp_u64;
612                 return SR_OK;
613         default:
614                 return SR_ERR;
615         }
616 }
617
618 static int hw_start_acquisition(int device_index, gpointer session_data)
619 {
620         struct sr_device_instance *sdi;
621         struct sr_datafeed_packet packet;
622         struct sr_datafeed_logic logic;
623         struct sr_datafeed_header header;
624         uint64_t samples_read;
625         int res;
626         unsigned int packet_num;
627         unsigned char *buf;
628         struct zp *zp;
629
630         if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
631                 sr_err("zp: %s: sdi was NULL", __func__);
632                 return SR_ERR;
633         }
634
635         if (!(zp = sdi->priv)) {
636                 sr_err("zp: %s: sdi->priv was NULL", __func__);
637                 return SR_ERR_ARG;
638         }
639
640         /* push configured settings to device */
641         analyzer_configure(zp->usb->devhdl);
642
643         analyzer_start(zp->usb->devhdl);
644         sr_info("Waiting for data");
645         analyzer_wait_data(zp->usb->devhdl);
646
647         sr_info("Stop address    = 0x%x", analyzer_get_stop_address(zp->usb->devhdl));
648         sr_info("Now address     = 0x%x", analyzer_get_now_address(zp->usb->devhdl));
649         sr_info("Trigger address = 0x%x", analyzer_get_trigger_address(zp->usb->devhdl));
650
651         packet.type = SR_DF_HEADER;
652         packet.payload = &header;
653         header.feed_version = 1;
654         gettimeofday(&header.starttime, NULL);
655         header.samplerate = zp->cur_samplerate;
656         header.num_logic_probes = zp->num_channels;
657         header.num_analog_probes = 0;
658         sr_session_bus(session_data, &packet);
659
660         if (!(buf = g_try_malloc(PACKET_SIZE))) {
661                 sr_err("zp: %s: buf malloc failed", __func__);
662                 return SR_ERR_MALLOC;
663         }
664
665         samples_read = 0;
666         analyzer_read_start(zp->usb->devhdl);
667         /* Send the incoming transfer to the session bus. */
668         for (packet_num = 0; packet_num < (zp->memory_size * 4 / PACKET_SIZE);
669              packet_num++) {
670                 res = analyzer_read_data(zp->usb->devhdl, buf, PACKET_SIZE);
671                 sr_info("Tried to read %llx bytes, actually read %x bytes",
672                         PACKET_SIZE, res);
673
674                 packet.type = SR_DF_LOGIC;
675                 packet.payload = &logic;
676                 logic.length = PACKET_SIZE;
677                 logic.unitsize = 4;
678                 logic.data = buf;
679                 sr_session_bus(session_data, &packet);
680                 samples_read += res / 4;
681         }
682         analyzer_read_stop(zp->usb->devhdl);
683         g_free(buf);
684
685         packet.type = SR_DF_END;
686         sr_session_bus(session_data, &packet);
687
688         return SR_OK;
689 }
690
691 /* This stops acquisition on ALL devices, ignoring device_index. */
692 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
693 {
694         struct sr_datafeed_packet packet;
695         struct sr_device_instance *sdi;
696         struct zp *zp;
697
698         packet.type = SR_DF_END;
699         sr_session_bus(session_device_id, &packet);
700
701         if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
702                 sr_err("zp: %s: sdi was NULL", __func__);
703                 return; /* FIXME */
704         }
705
706         if (!(zp = sdi->priv)) {
707                 sr_err("zp: %s: sdi->priv was NULL", __func__);
708                 return; /* FIXME */
709         }
710
711         analyzer_reset(zp->usb->devhdl);
712         /* TODO: Need to cancel and free any queued up transfers. */
713 }
714
715 struct sr_device_plugin zeroplus_logic_cube_plugin_info = {
716         .name = "zeroplus-logic-cube",
717         .longname = "Zeroplus Logic Cube LAP-C series",
718         .api_version = 1,
719         .init = hw_init,
720         .cleanup = hw_cleanup,
721         .opendev = hw_opendev,
722         .closedev = hw_closedev,
723         .get_device_info = hw_get_device_info,
724         .get_status = hw_get_status,
725         .get_capabilities = hw_get_capabilities,
726         .set_configuration = hw_set_configuration,
727         .start_acquisition = hw_start_acquisition,
728         .stop_acquisition = hw_stop_acquisition,
729 };