]> sigrok.org Git - libsigrok.git/blob - src/hardware/zeroplus-logic-cube/api.c
drivers: Factor out std_gvar_samplerates{,_steps}().
[libsigrok.git] / src / 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 <config.h>
21 #include "protocol.h"
22
23 #define VENDOR_NAME                     "ZEROPLUS"
24 #define USB_INTERFACE                   0
25 #define USB_CONFIGURATION               1
26 #define NUM_TRIGGER_STAGES              4
27 #define PACKET_SIZE                     2048    /* ?? */
28
29 //#define ZP_EXPERIMENTAL
30
31 struct zp_model {
32         uint16_t vid;
33         uint16_t pid;
34         const 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         {0x0c12, 0x700b, "LAP-C(32128)",  32, 128,  200},
49         {0x0c12, 0x700c, "LAP-C(321000)", 32, 1024, 200},
50         {0x0c12, 0x700d, "LAP-C(322000)", 32, 2048, 200},
51         {0x0c12, 0x700e, "LAP-C(16032)",  16, 32,   100},
52         {0x0c12, 0x7016, "LAP-C(162000)", 16, 2048, 200},
53         {0x0c12, 0x7100, "AKIP-9101", 16, 256, 200},
54         ALL_ZERO
55 };
56
57 static const uint32_t drvopts[] = {
58         SR_CONF_LOGIC_ANALYZER,
59 };
60
61 static const uint32_t devopts[] = {
62         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
63         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
64         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
65         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
66         SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
67 };
68
69 static const int32_t trigger_matches[] = {
70         SR_TRIGGER_ZERO,
71         SR_TRIGGER_ONE,
72 };
73
74 /*
75  * ZEROPLUS LAP-C (16032) numbers the 16 channels A0-A7 and B0-B7.
76  * We currently ignore other untested/unsupported devices here.
77  */
78 static const char *channel_names[] = {
79         "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
80         "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
81         "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7",
82         "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
83 };
84
85 /*
86  * The hardware supports more samplerates than these, but these are the
87  * options hardcoded into the vendor's Windows GUI.
88  */
89
90 static const uint64_t samplerates_100[] = {
91         SR_HZ(100),
92         SR_HZ(500),
93         SR_KHZ(1),
94         SR_KHZ(5),
95         SR_KHZ(25),
96         SR_KHZ(50),
97         SR_KHZ(100),
98         SR_KHZ(200),
99         SR_KHZ(400),
100         SR_KHZ(800),
101         SR_MHZ(1),
102         SR_MHZ(10),
103         SR_MHZ(25),
104         SR_MHZ(50),
105         SR_MHZ(80),
106         SR_MHZ(100),
107 };
108
109 const uint64_t samplerates_200[] = {
110         SR_HZ(100),
111         SR_HZ(500),
112         SR_KHZ(1),
113         SR_KHZ(5),
114         SR_KHZ(25),
115         SR_KHZ(50),
116         SR_KHZ(100),
117         SR_KHZ(200),
118         SR_KHZ(400),
119         SR_KHZ(800),
120         SR_MHZ(1),
121         SR_MHZ(10),
122         SR_MHZ(25),
123         SR_MHZ(50),
124         SR_MHZ(80),
125         SR_MHZ(100),
126         SR_MHZ(150),
127         SR_MHZ(200),
128 };
129
130 SR_PRIV int zp_set_samplerate(struct dev_context *devc, uint64_t samplerate)
131 {
132         int i;
133
134         for (i = 0; ARRAY_SIZE(samplerates_200); i++)
135                 if (samplerate == samplerates_200[i])
136                         break;
137
138         if (i == ARRAY_SIZE(samplerates_200) || samplerate > devc->max_samplerate) {
139                 sr_err("Unsupported samplerate: %" PRIu64 "Hz.", samplerate);
140                 return SR_ERR_ARG;
141         }
142
143         sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
144
145         if (samplerate >= SR_MHZ(1))
146                 analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
147         else if (samplerate >= SR_KHZ(1))
148                 analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
149         else
150                 analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
151
152         devc->cur_samplerate = samplerate;
153
154         return SR_OK;
155 }
156
157 static GSList *scan(struct sr_dev_driver *di, GSList *options)
158 {
159         struct sr_dev_inst *sdi;
160         struct drv_context *drvc;
161         struct dev_context *devc;
162         const struct zp_model *prof;
163         struct libusb_device_descriptor des;
164         struct libusb_device_handle *hdl;
165         libusb_device **devlist;
166         GSList *devices;
167         int ret, i, j;
168         char serial_num[64], connection_id[64];
169
170         (void)options;
171
172         drvc = di->context;
173
174         devices = NULL;
175
176         /* Find all ZEROPLUS analyzers and add them to device list. */
177         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
178
179         for (i = 0; devlist[i]; i++) {
180                 libusb_get_device_descriptor(devlist[i], &des);
181
182                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
183                         continue;
184
185                 if (des.iSerialNumber == 0) {
186                         serial_num[0] = '\0';
187                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
188                                 des.iSerialNumber, (unsigned char *) serial_num,
189                                 sizeof(serial_num))) < 0) {
190                         sr_warn("Failed to get serial number string descriptor: %s.",
191                                 libusb_error_name(ret));
192                         continue;
193                 }
194
195                 libusb_close(hdl);
196
197                 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
198
199                 prof = NULL;
200                 for (j = 0; j < zeroplus_models[j].vid; j++) {
201                         if (des.idVendor == zeroplus_models[j].vid &&
202                                 des.idProduct == zeroplus_models[j].pid) {
203                                 prof = &zeroplus_models[j];
204                         }
205                 }
206
207                 if (!prof)
208                         continue;
209                 sr_info("Found ZEROPLUS %s.", prof->model_name);
210
211                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
212                 sdi->status = SR_ST_INACTIVE;
213                 sdi->vendor = g_strdup(VENDOR_NAME);
214                 sdi->model = g_strdup(prof->model_name);
215                 sdi->serial_num = g_strdup(serial_num);
216                 sdi->connection_id = g_strdup(connection_id);
217
218                 devc = g_malloc0(sizeof(struct dev_context));
219                 sdi->priv = devc;
220                 devc->prof = prof;
221                 devc->num_channels = prof->channels;
222 #ifdef ZP_EXPERIMENTAL
223                 devc->max_sample_depth = 128 * 1024;
224                 devc->max_samplerate = 200;
225 #else
226                 devc->max_sample_depth = prof->sample_depth * 1024;
227                 devc->max_samplerate = prof->max_sampling_freq;
228 #endif
229                 devc->max_samplerate *= SR_MHZ(1);
230                 devc->memory_size = MEMORY_SIZE_8K;
231                 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
232
233                 for (j = 0; j < devc->num_channels; j++)
234                         sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
235                                         channel_names[j]);
236
237                 devices = g_slist_append(devices, sdi);
238                 sdi->inst_type = SR_INST_USB;
239                 sdi->conn = sr_usb_dev_inst_new(
240                         libusb_get_bus_number(devlist[i]),
241                         libusb_get_device_address(devlist[i]), NULL);
242         }
243         libusb_free_device_list(devlist, 1);
244
245         return std_scan_complete(di, devices);
246 }
247
248 static int dev_open(struct sr_dev_inst *sdi)
249 {
250         struct sr_dev_driver *di = sdi->driver;
251         struct dev_context *devc;
252         struct drv_context *drvc;
253         struct sr_usb_dev_inst *usb;
254         int ret;
255
256         drvc = di->context;
257         usb = sdi->conn;
258         devc = sdi->priv;
259
260         ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
261         if (ret != SR_OK)
262                 return ret;
263
264         ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
265         if (ret < 0) {
266                 sr_err("Unable to set USB configuration %d: %s.",
267                        USB_CONFIGURATION, libusb_error_name(ret));
268                 return SR_ERR;
269         }
270
271         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
272         if (ret != 0) {
273                 sr_err("Unable to claim interface: %s.",
274                        libusb_error_name(ret));
275                 return SR_ERR;
276         }
277
278         /* Set default configuration after power on. */
279         if (analyzer_read_status(usb->devhdl) == 0)
280                 analyzer_configure(usb->devhdl);
281
282         analyzer_reset(usb->devhdl);
283         analyzer_initialize(usb->devhdl);
284
285         //analyzer_set_memory_size(MEMORY_SIZE_512K);
286         // analyzer_set_freq(g_freq, g_freq_scale);
287         analyzer_set_trigger_count(1);
288         // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
289         // * get_memory_size(g_memory_size)) / 100) >> 2);
290
291 #if 0
292         if (g_double_mode == 1)
293                 analyzer_set_compression(COMPRESSION_DOUBLE);
294         else if (g_compression == 1)
295                 analyzer_set_compression(COMPRESSION_ENABLE);
296         else
297 #endif
298         analyzer_set_compression(COMPRESSION_NONE);
299
300         if (devc->cur_samplerate == 0) {
301                 /* Samplerate hasn't been set. Default to 1MHz. */
302                 analyzer_set_freq(1, FREQ_SCALE_MHZ);
303                 devc->cur_samplerate = SR_MHZ(1);
304         }
305
306         if (devc->cur_threshold == 0)
307                 set_voltage_threshold(devc, 1.5);
308
309         return SR_OK;
310 }
311
312 static int dev_close(struct sr_dev_inst *sdi)
313 {
314         struct sr_usb_dev_inst *usb;
315
316         usb = sdi->conn;
317
318         if (!usb->devhdl)
319                 return SR_ERR_BUG;
320
321         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
322                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
323         libusb_release_interface(usb->devhdl, USB_INTERFACE);
324         libusb_reset_device(usb->devhdl);
325         libusb_close(usb->devhdl);
326         usb->devhdl = NULL;
327
328         return SR_OK;
329 }
330
331 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
332                 const struct sr_channel_group *cg)
333 {
334         struct dev_context *devc;
335         GVariant *range[2];
336
337         (void)cg;
338
339         if (!sdi)
340                 return SR_ERR_ARG;
341
342         devc = sdi->priv;
343
344         switch (key) {
345         case SR_CONF_SAMPLERATE:
346                 *data = g_variant_new_uint64(devc->cur_samplerate);
347                 break;
348         case SR_CONF_CAPTURE_RATIO:
349                 *data = g_variant_new_uint64(devc->capture_ratio);
350                 break;
351         case SR_CONF_VOLTAGE_THRESHOLD:
352                 range[0] = g_variant_new_double(devc->cur_threshold);
353                 range[1] = g_variant_new_double(devc->cur_threshold);
354                 *data = g_variant_new_tuple(range, 2);
355                 break;
356         default:
357                 return SR_ERR_NA;
358         }
359
360         return SR_OK;
361 }
362
363 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
364                 const struct sr_channel_group *cg)
365 {
366         struct dev_context *devc;
367         gdouble low, high;
368
369         (void)cg;
370
371         devc = sdi->priv;
372
373         switch (key) {
374         case SR_CONF_SAMPLERATE:
375                 return zp_set_samplerate(devc, g_variant_get_uint64(data));
376         case SR_CONF_LIMIT_SAMPLES:
377                 return set_limit_samples(devc, g_variant_get_uint64(data));
378         case SR_CONF_CAPTURE_RATIO:
379                 return set_capture_ratio(devc, g_variant_get_uint64(data));
380         case SR_CONF_VOLTAGE_THRESHOLD:
381                 g_variant_get(data, "(dd)", &low, &high);
382                 return set_voltage_threshold(devc, (low + high) / 2.0);
383         default:
384                 return SR_ERR_NA;
385         }
386
387         return SR_OK;
388 }
389
390 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
391                 const struct sr_channel_group *cg)
392 {
393         struct dev_context *devc;
394         GVariant *gvar, *grange[2];
395         GVariantBuilder gvb;
396         double v;
397         GVariant *range[2];
398
399         switch (key) {
400         case SR_CONF_DEVICE_OPTIONS:
401                 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
402         case SR_CONF_SAMPLERATE:
403                 devc = sdi->priv;
404                 if (devc->prof->max_sampling_freq == 100)
405                         *data = std_gvar_samplerates(samplerates_100, ARRAY_SIZE(samplerates_100));
406                 else if (devc->prof->max_sampling_freq == 200)
407                         *data = std_gvar_samplerates(samplerates_200, ARRAY_SIZE(samplerates_200));
408                 else {
409                         sr_err("Internal error: Unknown max. samplerate: %d.",
410                                devc->prof->max_sampling_freq);
411                         return SR_ERR_ARG;
412                 }
413                 break;
414         case SR_CONF_TRIGGER_MATCH:
415                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
416                                 trigger_matches, ARRAY_SIZE(trigger_matches),
417                                 sizeof(int32_t));
418                 break;
419         case SR_CONF_VOLTAGE_THRESHOLD:
420                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
421                 for (v = -6.0; v <= 6.0; v += 0.1) {
422                         range[0] = g_variant_new_double(v);
423                         range[1] = g_variant_new_double(v);
424                         gvar = g_variant_new_tuple(range, 2);
425                         g_variant_builder_add_value(&gvb, gvar);
426                 }
427                 *data = g_variant_builder_end(&gvb);
428                 break;
429         case SR_CONF_LIMIT_SAMPLES:
430                 if (!sdi)
431                         return SR_ERR_ARG;
432                 devc = sdi->priv;
433                 grange[0] = g_variant_new_uint64(0);
434                 grange[1] = g_variant_new_uint64(devc->max_sample_depth);
435                 *data = g_variant_new_tuple(grange, 2);
436                 break;
437         default:
438                 return SR_ERR_NA;
439         }
440
441         return SR_OK;
442 }
443
444 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
445 {
446         struct dev_context *devc;
447         struct sr_usb_dev_inst *usb;
448         struct sr_datafeed_packet packet;
449         struct sr_datafeed_logic logic;
450         unsigned int samples_read;
451         int res;
452         unsigned int packet_num, n;
453         unsigned char *buf;
454         unsigned int status;
455         unsigned int stop_address;
456         unsigned int now_address;
457         unsigned int trigger_address;
458         unsigned int trigger_offset;
459         unsigned int triggerbar;
460         unsigned int ramsize_trigger;
461         unsigned int memory_size;
462         unsigned int valid_samples;
463         unsigned int discard;
464         int trigger_now;
465
466         devc = sdi->priv;
467
468         if (analyzer_add_triggers(sdi) != SR_OK) {
469                 sr_err("Failed to configure triggers.");
470                 return SR_ERR;
471         }
472
473         usb = sdi->conn;
474
475         set_triggerbar(devc);
476
477         /* Push configured settings to device. */
478         analyzer_configure(usb->devhdl);
479
480         analyzer_start(usb->devhdl);
481         sr_info("Waiting for data.");
482         analyzer_wait_data(usb->devhdl);
483
484         status = analyzer_read_status(usb->devhdl);
485         stop_address = analyzer_get_stop_address(usb->devhdl);
486         now_address = analyzer_get_now_address(usb->devhdl);
487         trigger_address = analyzer_get_trigger_address(usb->devhdl);
488
489         triggerbar = analyzer_get_triggerbar_address();
490         ramsize_trigger = analyzer_get_ramsize_trigger_address();
491
492         n = get_memory_size(devc->memory_size);
493         memory_size = n / 4;
494
495         sr_info("Status = 0x%x.", status);
496         sr_info("Stop address       = 0x%x.", stop_address);
497         sr_info("Now address        = 0x%x.", now_address);
498         sr_info("Trigger address    = 0x%x.", trigger_address);
499         sr_info("Triggerbar address = 0x%x.", triggerbar);
500         sr_info("Ramsize trigger    = 0x%x.", ramsize_trigger);
501         sr_info("Memory size        = 0x%x.", memory_size);
502
503         std_session_send_df_header(sdi);
504
505         /* Check for empty capture */
506         if ((status & STATUS_READY) && !stop_address) {
507                 std_session_send_df_end(sdi);
508                 return SR_OK;
509         }
510
511         buf = g_malloc(PACKET_SIZE);
512
513         /* Check if the trigger is in the samples we are throwing away */
514         trigger_now = now_address == trigger_address ||
515                 ((now_address + 1) % memory_size) == trigger_address;
516
517         /*
518          * STATUS_READY doesn't clear until now_address advances past
519          * addr 0, but for our logic, clear it in that case
520          */
521         if (!now_address)
522                 status &= ~STATUS_READY;
523
524         analyzer_read_start(usb->devhdl);
525
526         /* Calculate how much data to discard */
527         discard = 0;
528         if (status & STATUS_READY) {
529                 /*
530                  * We haven't wrapped around, we need to throw away data from
531                  * our current position to the end of the buffer.
532                  * Additionally, the first two samples captured are always
533                  * bogus.
534                  */
535                 discard += memory_size - now_address + 2;
536                 now_address = 2;
537         }
538
539         /* If we have more samples than we need, discard them */
540         valid_samples = (stop_address - now_address) % memory_size;
541         if (valid_samples > ramsize_trigger + triggerbar) {
542                 discard += valid_samples - (ramsize_trigger + triggerbar);
543                 now_address += valid_samples - (ramsize_trigger + triggerbar);
544         }
545
546         sr_info("Need to discard %d samples.", discard);
547
548         /* Calculate how far in the trigger is */
549         if (trigger_now)
550                 trigger_offset = 0;
551         else
552                 trigger_offset = (trigger_address - now_address) % memory_size;
553
554         /* Recalculate the number of samples available */
555         valid_samples = (stop_address - now_address) % memory_size;
556
557         /* Send the incoming transfer to the session bus. */
558         samples_read = 0;
559         for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
560                 unsigned int len;
561                 unsigned int buf_offset;
562
563                 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
564                 sr_info("Tried to read %d bytes, actually read %d bytes.",
565                         PACKET_SIZE, res);
566
567                 if (discard >= PACKET_SIZE / 4) {
568                         discard -= PACKET_SIZE / 4;
569                         continue;
570                 }
571
572                 len = PACKET_SIZE - discard * 4;
573                 buf_offset = discard * 4;
574                 discard = 0;
575
576                 /* Check if we've read all the samples */
577                 if (samples_read + len / 4 >= valid_samples)
578                         len = (valid_samples - samples_read) * 4;
579                 if (!len)
580                         break;
581
582                 if (samples_read < trigger_offset &&
583                     samples_read + len / 4 > trigger_offset) {
584                         /* Send out samples remaining before trigger */
585                         packet.type = SR_DF_LOGIC;
586                         packet.payload = &logic;
587                         logic.length = (trigger_offset - samples_read) * 4;
588                         logic.unitsize = 4;
589                         logic.data = buf + buf_offset;
590                         sr_session_send(sdi, &packet);
591                         len -= logic.length;
592                         samples_read += logic.length / 4;
593                         buf_offset += logic.length;
594                 }
595
596                 if (samples_read == trigger_offset) {
597                         /* Send out trigger */
598                         packet.type = SR_DF_TRIGGER;
599                         packet.payload = NULL;
600                         sr_session_send(sdi, &packet);
601                 }
602
603                 /* Send out data (or data after trigger) */
604                 packet.type = SR_DF_LOGIC;
605                 packet.payload = &logic;
606                 logic.length = len;
607                 logic.unitsize = 4;
608                 logic.data = buf + buf_offset;
609                 sr_session_send(sdi, &packet);
610                 samples_read += len / 4;
611         }
612         analyzer_read_stop(usb->devhdl);
613         g_free(buf);
614
615         std_session_send_df_end(sdi);
616
617         return SR_OK;
618 }
619
620 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
621 {
622         struct sr_usb_dev_inst *usb;
623
624         std_session_send_df_end(sdi);
625
626         usb = sdi->conn;
627         analyzer_reset(usb->devhdl);
628         /* TODO: Need to cancel and free any queued up transfers. */
629
630         return SR_OK;
631 }
632
633 static struct sr_dev_driver zeroplus_logic_cube_driver_info = {
634         .name = "zeroplus-logic-cube",
635         .longname = "ZEROPLUS Logic Cube LAP-C series",
636         .api_version = 1,
637         .init = std_init,
638         .cleanup = std_cleanup,
639         .scan = scan,
640         .dev_list = std_dev_list,
641         .dev_clear = std_dev_clear,
642         .config_get = config_get,
643         .config_set = config_set,
644         .config_list = config_list,
645         .dev_open = dev_open,
646         .dev_close = dev_close,
647         .dev_acquisition_start = dev_acquisition_start,
648         .dev_acquisition_stop = dev_acquisition_stop,
649         .context = NULL,
650 };
651 SR_REGISTER_DEV_DRIVER(zeroplus_logic_cube_driver_info);