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