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