]> sigrok.org Git - libsigrok.git/blob - hardware/zeroplus-logic-cube/api.c
probe_groups: API changes required to implement probe groups.
[libsigrok.git] / hardware / zeroplus-logic-cube / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2010-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 "protocol.h"
21
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    /* ?? */
28
29 //#define ZP_EXPERIMENTAL
30
31 struct zp_model {
32         uint16_t vid;
33         uint16_t pid;
34         char *model_name;
35         unsigned int channels;
36         unsigned int sample_depth;      /* In Ksamples/channel */
37         unsigned int max_sampling_freq;
38 };
39
40 /*
41  * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
42  * same 128K sample depth.
43  */
44 static const struct zp_model zeroplus_models[] = {
45         {0x0c12, 0x7002, "LAP-16128U",    16, 128,  200},
46         {0x0c12, 0x7009, "LAP-C(16064)",  16, 64,   100},
47         {0x0c12, 0x700a, "LAP-C(16128)",  16, 128,  200},
48         /* TODO: We don't know anything about these.
49         {0x0c12, 0x700b, "LAP-C(32128)",  32, 128,  200},
50         {0x0c12, 0x700c, "LAP-C(321000)", 32, 1024, 200},
51         {0x0c12, 0x700d, "LAP-C(322000)", 32, 2048, 200},
52         */
53         {0x0c12, 0x700e, "LAP-C(16032)",  16, 32,   100},
54         {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
55         { 0, 0, 0, 0, 0, 0 }
56 };
57
58 static const int32_t hwcaps[] = {
59         SR_CONF_LOGIC_ANALYZER,
60         SR_CONF_SAMPLERATE,
61         SR_CONF_CAPTURE_RATIO,
62         SR_CONF_LIMIT_SAMPLES,
63 };
64
65 /*
66  * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
67  * We currently ignore other untested/unsupported devices here.
68  */
69 static const char *probe_names[] = {
70         "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
71         "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
72         NULL,
73 };
74
75 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
76 static struct sr_dev_driver *di = &zeroplus_logic_cube_driver_info;
77
78 /*
79  * The hardware supports more samplerates than these, but these are the
80  * options hardcoded into the vendor's Windows GUI.
81  */
82
83 static const uint64_t samplerates_100[] = {
84         SR_HZ(100),
85         SR_HZ(500),
86         SR_KHZ(1),
87         SR_KHZ(5),
88         SR_KHZ(25),
89         SR_KHZ(50),
90         SR_KHZ(100),
91         SR_KHZ(200),
92         SR_KHZ(400),
93         SR_KHZ(800),
94         SR_MHZ(1),
95         SR_MHZ(10),
96         SR_MHZ(25),
97         SR_MHZ(50),
98         SR_MHZ(80),
99         SR_MHZ(100),
100 };
101
102 const uint64_t samplerates_200[] = {
103         SR_HZ(100),
104         SR_HZ(500),
105         SR_KHZ(1),
106         SR_KHZ(5),
107         SR_KHZ(25),
108         SR_KHZ(50),
109         SR_KHZ(100),
110         SR_KHZ(200),
111         SR_KHZ(400),
112         SR_KHZ(800),
113         SR_MHZ(1),
114         SR_MHZ(10),
115         SR_MHZ(25),
116         SR_MHZ(50),
117         SR_MHZ(80),
118         SR_MHZ(100),
119         SR_MHZ(150),
120         SR_MHZ(200),
121 };
122
123 static int dev_close(struct sr_dev_inst *sdi);
124
125 #if 0
126 static int configure_probes(const struct sr_dev_inst *sdi)
127 {
128         struct dev_context *devc;
129         const struct sr_probe *probe;
130         const GSList *l;
131         int probe_bit, stage, i;
132         char *tc;
133
134         /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
135         devc = sdi->priv;
136
137         devc->probe_mask = 0;
138         for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
139                 devc->trigger_mask[i] = 0;
140                 devc->trigger_value[i] = 0;
141         }
142
143         stage = -1;
144         for (l = sdi->probes; l; l = l->next) {
145                 probe = (struct sr_probe *)l->data;
146                 if (probe->enabled == FALSE)
147                         continue;
148                 probe_bit = 1 << (probe->index);
149                 devc->probe_mask |= probe_bit;
150
151                 if (probe->trigger) {
152                         stage = 0;
153                         for (tc = probe->trigger; *tc; tc++) {
154                                 devc->trigger_mask[stage] |= probe_bit;
155                                 if (*tc == '1')
156                                         devc->trigger_value[stage] |= probe_bit;
157                                 stage++;
158                                 if (stage > NUM_TRIGGER_STAGES)
159                                         return SR_ERR;
160                         }
161                 }
162         }
163
164         return SR_OK;
165 }
166 #endif
167
168 static int configure_probes(const struct sr_dev_inst *sdi)
169 {
170         struct dev_context *devc;
171         const GSList *l;
172         const struct sr_probe *probe;
173         char *tc;
174         int type;
175
176         /* Note: sdi and sdi->priv are non-NULL, the caller checked this. */
177         devc = sdi->priv;
178
179         for (l = sdi->probes; l; l = l->next) {
180                 probe = (struct sr_probe *)l->data;
181                 if (probe->enabled == FALSE)
182                         continue;
183
184                 if ((tc = probe->trigger)) {
185                         switch (*tc) {
186                         case '1':
187                                 type = TRIGGER_HIGH;
188                                 break;
189                         case '0':
190                                 type = TRIGGER_LOW;
191                                 break;
192 #if 0
193                         case 'r':
194                                 type = TRIGGER_POSEDGE;
195                                 break;
196                         case 'f':
197                                 type = TRIGGER_NEGEDGE;
198                                 break;
199                         case 'c':
200                                 type = TRIGGER_ANYEDGE;
201                                 break;
202 #endif
203                         default:
204                                 return SR_ERR;
205                         }
206                         analyzer_add_trigger(probe->index, type);
207                         devc->trigger = 1;
208                 }
209         }
210
211         return SR_OK;
212 }
213
214 SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
215 {
216         int i;
217
218         for (i = 0; ARRAY_SIZE(samplerates_200); i++)
219                 if (samplerate == samplerates_200[i])
220                         break;
221
222         if (i == ARRAY_SIZE(samplerates_200) || samplerate > devc->max_samplerate) {
223                 sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
224                 return SR_ERR_ARG;
225         }
226
227         sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
228
229         if (samplerate >= SR_MHZ(1))
230                 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
231         else if (samplerate >= SR_KHZ(1))
232                 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
233         else
234                 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
235
236         devc->cur_samplerate = samplerate;
237
238         return SR_OK;
239 }
240
241 static int dev_clear(void)
242 {
243         return std_dev_clear(di, NULL);
244 }
245
246 static int init(struct sr_context *sr_ctx)
247 {
248         return std_init(sr_ctx, di, LOG_PREFIX);
249 }
250
251 static GSList *scan(GSList *options)
252 {
253         struct sr_dev_inst *sdi;
254         struct sr_probe *probe;
255         struct drv_context *drvc;
256         struct dev_context *devc;
257         const struct zp_model *prof;
258         struct libusb_device_descriptor des;
259         libusb_device **devlist;
260         GSList *devices;
261         int ret, devcnt, i, j;
262
263         (void)options;
264
265         drvc = di->priv;
266
267         devices = NULL;
268
269         /* Find all ZEROPLUS analyzers and add them to device list. */
270         devcnt = 0;
271         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
272
273         for (i = 0; devlist[i]; i++) {
274                 ret = libusb_get_device_descriptor(devlist[i], &des);
275                 if (ret != 0) {
276                         sr_err("Failed to get device descriptor: %s.",
277                                libusb_error_name(ret));
278                         continue;
279                 }
280
281                 prof = NULL;
282                 for (j = 0; j < zeroplus_models[j].vid; j++) {
283                         if (des.idVendor == zeroplus_models[j].vid &&
284                                 des.idProduct == zeroplus_models[j].pid) {
285                                 prof = &zeroplus_models[j];
286                         }
287                 }
288                 /* Skip if the device was not found. */
289                 if (!prof)
290                         continue;
291                 sr_info("Found ZEROPLUS %s.", prof->model_name);
292
293                 /* Register the device with libsigrok. */
294                 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
295                                 VENDOR_NAME, prof->model_name, NULL))) {
296                         sr_err("%s: sr_dev_inst_new failed", __func__);
297                         return NULL;
298                 }
299                 sdi->driver = di;
300
301                 /* Allocate memory for our private driver context. */
302                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
303                         sr_err("Device context malloc failed.");
304                         return NULL;
305                 }
306
307                 sdi->priv = devc;
308                 devc->prof = prof;
309                 devc->num_channels = prof->channels;
310 #ifdef ZP_EXPERIMENTAL
311                 devc->max_memory_size = 128 * 1024;
312                 devc->max_samplerate = 200;
313 #else
314                 devc->max_memory_size = prof->sample_depth * 1024;
315                 devc->max_samplerate = prof->max_sampling_freq;
316 #endif
317                 devc->max_samplerate *= SR_MHZ(1);
318                 devc->memory_size = MEMORY_SIZE_8K;
319                 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
320
321                 /* Fill in probelist according to this device's profile. */
322                 for (j = 0; j < devc->num_channels; j++) {
323                         if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
324                                         probe_names[j])))
325                                 return NULL;
326                         sdi->probes = g_slist_append(sdi->probes, probe);
327                 }
328
329                 devices = g_slist_append(devices, sdi);
330                 drvc->instances = g_slist_append(drvc->instances, sdi);
331                 sdi->inst_type = SR_INST_USB;
332                 sdi->conn = sr_usb_dev_inst_new(
333                         libusb_get_bus_number(devlist[i]),
334                         libusb_get_device_address(devlist[i]), NULL);
335                 devcnt++;
336
337         }
338         libusb_free_device_list(devlist, 1);
339
340         return devices;
341 }
342
343 static GSList *dev_list(void)
344 {
345         return ((struct drv_context *)(di->priv))->instances;
346 }
347
348 static int dev_open(struct sr_dev_inst *sdi)
349 {
350         struct dev_context *devc;
351         struct drv_context *drvc;
352         struct sr_usb_dev_inst *usb;
353         libusb_device **devlist, *dev;
354         struct libusb_device_descriptor des;
355         int device_count, ret, i;
356
357         drvc = di->priv;
358         usb = sdi->conn;
359
360         if (!(devc = sdi->priv)) {
361                 sr_err("%s: sdi->priv was NULL", __func__);
362                 return SR_ERR_ARG;
363         }
364
365         device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
366                                               &devlist);
367         if (device_count < 0) {
368                 sr_err("Failed to retrieve device list.");
369                 return SR_ERR;
370         }
371
372         dev = NULL;
373         for (i = 0; i < device_count; i++) {
374                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
375                         sr_err("Failed to get device descriptor: %s.",
376                                libusb_error_name(ret));
377                         continue;
378                 }
379                 if (libusb_get_bus_number(devlist[i]) == usb->bus
380                     && libusb_get_device_address(devlist[i]) == usb->address) {
381                         dev = devlist[i];
382                         break;
383                 }
384         }
385         if (!dev) {
386                 sr_err("Device on bus %d address %d disappeared!",
387                        usb->bus, usb->address);
388                 return SR_ERR;
389         }
390
391         if (!(ret = libusb_open(dev, &(usb->devhdl)))) {
392                 sdi->status = SR_ST_ACTIVE;
393                 sr_info("Opened device %d on %d.%d interface %d.",
394                         sdi->index, usb->bus, usb->address, USB_INTERFACE);
395         } else {
396                 sr_err("Failed to open device: %s.", libusb_error_name(ret));
397                 return SR_ERR;
398         }
399
400         ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
401         if (ret < 0) {
402                 sr_err("Unable to set USB configuration %d: %s.",
403                        USB_CONFIGURATION, libusb_error_name(ret));
404                 return SR_ERR;
405         }
406
407         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
408         if (ret != 0) {
409                 sr_err("Unable to claim interface: %s.",
410                        libusb_error_name(ret));
411                 return SR_ERR;
412         }
413
414         /* Set default configuration after power on. */
415         if (analyzer_read_status(usb->devhdl) == 0)
416                 analyzer_configure(usb->devhdl);
417
418         analyzer_reset(usb->devhdl);
419         analyzer_initialize(usb->devhdl);
420
421         //analyzer_set_memory_size(MEMORY_SIZE_512K);
422         // analyzer_set_freq(g_freq, g_freq_scale);
423         analyzer_set_trigger_count(1);
424         // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
425         // * get_memory_size(g_memory_size)) / 100) >> 2);
426
427 #if 0
428         if (g_double_mode == 1)
429                 analyzer_set_compression(COMPRESSION_DOUBLE);
430         else if (g_compression == 1)
431                 analyzer_set_compression(COMPRESSION_ENABLE);
432         else
433 #endif
434         analyzer_set_compression(COMPRESSION_NONE);
435
436         if (devc->cur_samplerate == 0) {
437                 /* Samplerate hasn't been set. Default to 1MHz. */
438                 analyzer_set_freq(1, FREQ_SCALE_MHZ);
439                 devc->cur_samplerate = SR_MHZ(1);
440         }
441
442         return SR_OK;
443 }
444
445 static int dev_close(struct sr_dev_inst *sdi)
446 {
447         struct sr_usb_dev_inst *usb;
448
449         usb = sdi->conn;
450
451         if (!usb->devhdl)
452                 return SR_ERR;
453
454         sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
455                 usb->bus, usb->address, USB_INTERFACE);
456         libusb_release_interface(usb->devhdl, USB_INTERFACE);
457         libusb_reset_device(usb->devhdl);
458         libusb_close(usb->devhdl);
459         usb->devhdl = NULL;
460         sdi->status = SR_ST_INACTIVE;
461
462         return SR_OK;
463 }
464
465 static int cleanup(void)
466 {
467         return dev_clear();
468 }
469
470 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
471                 const struct sr_probe_group *probe_group)
472 {
473         struct dev_context *devc;
474
475         (void)probe_group;
476
477         switch (id) {
478         case SR_CONF_SAMPLERATE:
479                 if (sdi) {
480                         devc = sdi->priv;
481                         *data = g_variant_new_uint64(devc->cur_samplerate);
482                         sr_spew("Returning samplerate: %" PRIu64 "Hz.",
483                                 devc->cur_samplerate);
484                 } else
485                         return SR_ERR;
486                 break;
487         default:
488                 return SR_ERR_NA;
489         }
490
491         return SR_OK;
492 }
493
494 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
495                 const struct sr_probe_group *probe_group)
496 {
497         struct dev_context *devc;
498
499         (void)probe_group;
500
501         if (sdi->status != SR_ST_ACTIVE)
502                 return SR_ERR_DEV_CLOSED;
503
504         if (!(devc = sdi->priv)) {
505                 sr_err("%s: sdi->priv was NULL", __func__);
506                 return SR_ERR_ARG;
507         }
508
509         switch (id) {
510         case SR_CONF_SAMPLERATE:
511                 return zp_set_samplerate(devc, g_variant_get_uint64(data));
512         case SR_CONF_LIMIT_SAMPLES:
513                 return set_limit_samples(devc, g_variant_get_uint64(data));
514         case SR_CONF_CAPTURE_RATIO:
515                 return set_capture_ratio(devc, g_variant_get_uint64(data));
516         default:
517                 return SR_ERR_NA;
518         }
519
520         return SR_OK;
521 }
522
523 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
524                 const struct sr_probe_group *probe_group)
525 {
526         struct dev_context *devc;
527         GVariant *gvar;
528         GVariantBuilder gvb;
529
530         (void)probe_group;
531
532         switch (key) {
533         case SR_CONF_DEVICE_OPTIONS:
534                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
535                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
536                 break;
537         case SR_CONF_SAMPLERATE:
538                 devc = sdi->priv;
539                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
540                 if (devc->prof->max_sampling_freq == 100) {
541                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
542                                         samplerates_100, ARRAY_SIZE(samplerates_100),
543                                         sizeof(uint64_t));
544                 } else if (devc->prof->max_sampling_freq == 200) {
545                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
546                                         samplerates_200, ARRAY_SIZE(samplerates_200),
547                                         sizeof(uint64_t));
548                 } else {
549                         sr_err("Internal error: Unknown max. samplerate: %d.",
550                                devc->prof->max_sampling_freq);
551                         return SR_ERR_ARG;
552                 }
553                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
554                 *data = g_variant_builder_end(&gvb);
555                 break;
556         case SR_CONF_TRIGGER_TYPE:
557                 *data = g_variant_new_string(TRIGGER_TYPE);
558                 break;
559         default:
560                 return SR_ERR_NA;
561         }
562
563         return SR_OK;
564 }
565
566 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
567                 void *cb_data)
568 {
569         struct dev_context *devc;
570         struct sr_usb_dev_inst *usb;
571         struct sr_datafeed_packet packet;
572         struct sr_datafeed_logic logic;
573         //uint64_t samples_read;
574         int res;
575         unsigned int packet_num, n;
576         unsigned char *buf;
577
578         if (sdi->status != SR_ST_ACTIVE)
579                 return SR_ERR_DEV_CLOSED;
580
581         if (!(devc = sdi->priv)) {
582                 sr_err("%s: sdi->priv was NULL", __func__);
583                 return SR_ERR_ARG;
584         }
585
586         if (configure_probes(sdi) != SR_OK) {
587                 sr_err("Failed to configure probes.");
588                 return SR_ERR;
589         }
590
591         usb = sdi->conn;
592
593         set_triggerbar(devc);
594
595         /* Push configured settings to device. */
596         analyzer_configure(usb->devhdl);
597
598         analyzer_start(usb->devhdl);
599         sr_info("Waiting for data.");
600         analyzer_wait_data(usb->devhdl);
601
602         sr_info("Stop address    = 0x%x.",
603                 analyzer_get_stop_address(usb->devhdl));
604         sr_info("Now address     = 0x%x.",
605                 analyzer_get_now_address(usb->devhdl));
606         sr_info("Trigger address = 0x%x.",
607                 analyzer_get_trigger_address(usb->devhdl));
608
609         /* Send header packet to the session bus. */
610         std_session_send_df_header(cb_data, LOG_PREFIX);
611
612         if (!(buf = g_try_malloc(PACKET_SIZE))) {
613                 sr_err("Packet buffer malloc failed.");
614                 return SR_ERR_MALLOC;
615         }
616
617         //samples_read = 0;
618         analyzer_read_start(usb->devhdl);
619         /* Send the incoming transfer to the session bus. */
620         n = get_memory_size(devc->memory_size);
621         if (devc->max_memory_size * 4 < n)
622                 n = devc->max_memory_size * 4;
623         for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
624                 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
625                 sr_info("Tried to read %d bytes, actually read %d bytes.",
626                         PACKET_SIZE, res);
627
628                 packet.type = SR_DF_LOGIC;
629                 packet.payload = &logic;
630                 logic.length = PACKET_SIZE;
631                 logic.unitsize = 4;
632                 logic.data = buf;
633                 sr_session_send(cb_data, &packet);
634                 //samples_read += res / 4;
635         }
636         analyzer_read_stop(usb->devhdl);
637         g_free(buf);
638
639         packet.type = SR_DF_END;
640         sr_session_send(cb_data, &packet);
641
642         return SR_OK;
643 }
644
645 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
646 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
647 {
648         struct dev_context *devc;
649         struct sr_usb_dev_inst *usb;
650         struct sr_datafeed_packet packet;
651
652         packet.type = SR_DF_END;
653         sr_session_send(cb_data, &packet);
654
655         if (!(devc = sdi->priv)) {
656                 sr_err("%s: sdi->priv was NULL", __func__);
657                 return SR_ERR_BUG;
658         }
659
660         usb = sdi->conn;
661         analyzer_reset(usb->devhdl);
662         /* TODO: Need to cancel and free any queued up transfers. */
663
664         return SR_OK;
665 }
666
667 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
668         .name = "zeroplus-logic-cube",
669         .longname = "ZEROPLUS Logic Cube LAP-C series",
670         .api_version = 1,
671         .init = init,
672         .cleanup = cleanup,
673         .scan = scan,
674         .dev_list = dev_list,
675         .dev_clear = dev_clear,
676         .config_get = config_get,
677         .config_set = config_set,
678         .config_list = config_list,
679         .dev_open = dev_open,
680         .dev_close = dev_close,
681         .dev_acquisition_start = dev_acquisition_start,
682         .dev_acquisition_stop = dev_acquisition_stop,
683         .priv = NULL,
684 };