]> sigrok.org Git - libsigrok.git/blob - src/hardware/zeroplus-logic-cube/api.c
zeroplus-logic-cube: move USB VID:PID check in scan before device access
[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, i, j;
173         const struct zp_model *check;
174         char serial_num[64], connection_id[64];
175
176         (void)options;
177
178         drvc = di->context;
179
180         devices = NULL;
181
182         /* Find all ZEROPLUS analyzers and add them to device list. */
183         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
184
185         for (i = 0; devlist[i]; i++) {
186                 libusb_get_device_descriptor(devlist[i], &des);
187
188                 /*
189                  * Check for expected VID:PID first as soon as we got
190                  * the descriptor's content. This avoids access to flaky
191                  * unrelated devices which trouble the application even
192                  * if they are unrelated to measurement purposes.
193                  *
194                  * See https://sigrok.org/bugzilla/show_bug.cgi?id=1115
195                  * and https://github.com/sigrokproject/libsigrok/pull/165
196                  * for a discussion.
197                  */
198                 prof = NULL;
199                 for (j = 0; zeroplus_models[j].vid; j++) {
200                         check = &zeroplus_models[j];
201                         if (des.idVendor != check->vid)
202                                 continue;
203                         if (des.idProduct != check->pid)
204                                 continue;
205                         prof = check;
206                         break;
207                 }
208                 if (!prof)
209                         continue;
210
211                 /* Get the device's serial number from USB strings. */
212                 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
213                         continue;
214
215                 if (des.iSerialNumber == 0) {
216                         serial_num[0] = '\0';
217                 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
218                                 des.iSerialNumber, (unsigned char *) serial_num,
219                                 sizeof(serial_num))) < 0) {
220                         sr_warn("Failed to get serial number string descriptor: %s.",
221                                 libusb_error_name(ret));
222                         continue;
223                 }
224
225                 libusb_close(hdl);
226
227                 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
228                         continue;
229
230                 sr_info("Found ZEROPLUS %s.", prof->model_name);
231
232                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
233                 sdi->status = SR_ST_INACTIVE;
234                 sdi->vendor = g_strdup("ZEROPLUS");
235                 sdi->model = g_strdup(prof->model_name);
236                 sdi->serial_num = g_strdup(serial_num);
237                 sdi->connection_id = g_strdup(connection_id);
238
239                 devc = g_malloc0(sizeof(struct dev_context));
240                 sdi->priv = devc;
241                 devc->prof = prof;
242                 devc->num_channels = prof->channels;
243 #ifdef ZP_EXPERIMENTAL
244                 devc->max_sample_depth = 128 * 1024;
245                 devc->max_samplerate = 200;
246 #else
247                 devc->max_sample_depth = prof->sample_depth * 1024;
248                 devc->max_samplerate = prof->max_sampling_freq;
249 #endif
250                 devc->max_samplerate *= SR_MHZ(1);
251                 devc->memory_size = MEMORY_SIZE_8K;
252                 // memset(devc->trigger_buffer, 0, NUM_TRIGGER_STAGES);
253
254                 for (j = 0; j < devc->num_channels; j++)
255                         sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
256                                         channel_names[j]);
257
258                 devices = g_slist_append(devices, sdi);
259                 sdi->inst_type = SR_INST_USB;
260                 sdi->conn = sr_usb_dev_inst_new(
261                         libusb_get_bus_number(devlist[i]),
262                         libusb_get_device_address(devlist[i]), NULL);
263         }
264         libusb_free_device_list(devlist, 1);
265
266         return std_scan_complete(di, devices);
267 }
268
269 static int dev_open(struct sr_dev_inst *sdi)
270 {
271         struct sr_dev_driver *di = sdi->driver;
272         struct dev_context *devc;
273         struct drv_context *drvc;
274         struct sr_usb_dev_inst *usb;
275         int ret;
276
277         drvc = di->context;
278         usb = sdi->conn;
279         devc = sdi->priv;
280
281         ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
282         if (ret != SR_OK)
283                 return ret;
284
285         ret = libusb_set_configuration(usb->devhdl, USB_CONFIGURATION);
286         if (ret < 0) {
287                 sr_err("Unable to set USB configuration %d: %s.",
288                        USB_CONFIGURATION, libusb_error_name(ret));
289                 return SR_ERR;
290         }
291
292         ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
293         if (ret != 0) {
294                 sr_err("Unable to claim interface: %s.",
295                        libusb_error_name(ret));
296                 return SR_ERR;
297         }
298
299         /* Set default configuration after power on. */
300         if (analyzer_read_status(usb->devhdl) == 0)
301                 analyzer_configure(usb->devhdl);
302
303         analyzer_reset(usb->devhdl);
304         analyzer_initialize(usb->devhdl);
305
306         //analyzer_set_memory_size(MEMORY_SIZE_512K);
307         // analyzer_set_freq(g_freq, g_freq_scale);
308         analyzer_set_trigger_count(1);
309         // analyzer_set_ramsize_trigger_address((((100 - g_pre_trigger)
310         // * get_memory_size(g_memory_size)) / 100) >> 2);
311
312 #if 0
313         if (g_double_mode == 1)
314                 analyzer_set_compression(COMPRESSION_DOUBLE);
315         else if (g_compression == 1)
316                 analyzer_set_compression(COMPRESSION_ENABLE);
317         else
318 #endif
319         analyzer_set_compression(COMPRESSION_NONE);
320
321         if (devc->cur_samplerate == 0) {
322                 /* Samplerate hasn't been set. Default to 1MHz. */
323                 analyzer_set_freq(1, FREQ_SCALE_MHZ);
324                 devc->cur_samplerate = SR_MHZ(1);
325         }
326
327         if (devc->cur_threshold == 0)
328                 set_voltage_threshold(devc, 1.5);
329
330         return SR_OK;
331 }
332
333 static int dev_close(struct sr_dev_inst *sdi)
334 {
335         struct sr_usb_dev_inst *usb;
336
337         usb = sdi->conn;
338
339         if (!usb->devhdl)
340                 return SR_ERR_BUG;
341
342         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
343                 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
344         libusb_release_interface(usb->devhdl, USB_INTERFACE);
345         libusb_reset_device(usb->devhdl);
346         libusb_close(usb->devhdl);
347         usb->devhdl = NULL;
348
349         return SR_OK;
350 }
351
352 static int config_get(uint32_t key, GVariant **data,
353         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
354 {
355         struct dev_context *devc;
356
357         (void)cg;
358
359         if (!sdi)
360                 return SR_ERR_ARG;
361
362         devc = sdi->priv;
363
364         switch (key) {
365         case SR_CONF_SAMPLERATE:
366                 *data = g_variant_new_uint64(devc->cur_samplerate);
367                 break;
368         case SR_CONF_CAPTURE_RATIO:
369                 *data = g_variant_new_uint64(devc->capture_ratio);
370                 break;
371         case SR_CONF_VOLTAGE_THRESHOLD:
372                 *data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
373                 break;
374         default:
375                 return SR_ERR_NA;
376         }
377
378         return SR_OK;
379 }
380
381 static int config_set(uint32_t key, GVariant *data,
382         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
383 {
384         struct dev_context *devc;
385         gdouble low, high;
386
387         (void)cg;
388
389         devc = sdi->priv;
390
391         switch (key) {
392         case SR_CONF_SAMPLERATE:
393                 return zp_set_samplerate(devc, g_variant_get_uint64(data));
394         case SR_CONF_LIMIT_SAMPLES:
395                 return set_limit_samples(devc, g_variant_get_uint64(data));
396         case SR_CONF_CAPTURE_RATIO:
397                 devc->capture_ratio = g_variant_get_uint64(data);
398                 break;
399         case SR_CONF_VOLTAGE_THRESHOLD:
400                 g_variant_get(data, "(dd)", &low, &high);
401                 return set_voltage_threshold(devc, (low + high) / 2.0);
402         default:
403                 return SR_ERR_NA;
404         }
405
406         return SR_OK;
407 }
408
409 static int config_list(uint32_t key, GVariant **data,
410         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
411 {
412         struct dev_context *devc;
413
414         switch (key) {
415         case SR_CONF_DEVICE_OPTIONS:
416                 return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts);
417         case SR_CONF_SAMPLERATE:
418                 devc = sdi->priv;
419                 if (devc->prof->max_sampling_freq == 100)
420                         *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_100));
421                 else if (devc->prof->max_sampling_freq == 200)
422                         *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_200));
423                 else {
424                         sr_err("Internal error: Unknown max. samplerate: %d.",
425                                devc->prof->max_sampling_freq);
426                         return SR_ERR_ARG;
427                 }
428                 break;
429         case SR_CONF_TRIGGER_MATCH:
430                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
431                 break;
432         case SR_CONF_VOLTAGE_THRESHOLD:
433                 *data = std_gvar_min_max_step_thresholds(-6.0, 6.0, 0.1);
434                 break;
435         case SR_CONF_LIMIT_SAMPLES:
436                 if (!sdi)
437                         return SR_ERR_ARG;
438                 devc = sdi->priv;
439                 *data = std_gvar_tuple_u64(0, devc->max_sample_depth);
440                 break;
441         default:
442                 return SR_ERR_NA;
443         }
444
445         return SR_OK;
446 }
447
448 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
449 {
450         struct dev_context *devc;
451         struct sr_usb_dev_inst *usb;
452         struct sr_datafeed_packet packet;
453         struct sr_datafeed_logic logic;
454         unsigned int samples_read;
455         int res;
456         unsigned int packet_num, n;
457         unsigned char *buf;
458         unsigned int status;
459         unsigned int stop_address;
460         unsigned int now_address;
461         unsigned int trigger_address;
462         unsigned int trigger_offset;
463         unsigned int triggerbar;
464         unsigned int ramsize_trigger;
465         unsigned int memory_size;
466         unsigned int valid_samples;
467         unsigned int discard;
468         int trigger_now;
469
470         devc = sdi->priv;
471
472         if (analyzer_add_triggers(sdi) != SR_OK) {
473                 sr_err("Failed to configure triggers.");
474                 return SR_ERR;
475         }
476
477         usb = sdi->conn;
478
479         set_triggerbar(devc);
480
481         /* Push configured settings to device. */
482         analyzer_configure(usb->devhdl);
483
484         analyzer_start(usb->devhdl);
485         sr_info("Waiting for data.");
486         analyzer_wait_data(usb->devhdl);
487
488         status = analyzer_read_status(usb->devhdl);
489         stop_address = analyzer_get_stop_address(usb->devhdl);
490         now_address = analyzer_get_now_address(usb->devhdl);
491         trigger_address = analyzer_get_trigger_address(usb->devhdl);
492
493         triggerbar = analyzer_get_triggerbar_address();
494         ramsize_trigger = analyzer_get_ramsize_trigger_address();
495
496         n = get_memory_size(devc->memory_size);
497         memory_size = n / 4;
498
499         sr_info("Status = 0x%x.", status);
500         sr_info("Stop address       = 0x%x.", stop_address);
501         sr_info("Now address        = 0x%x.", now_address);
502         sr_info("Trigger address    = 0x%x.", trigger_address);
503         sr_info("Triggerbar address = 0x%x.", triggerbar);
504         sr_info("Ramsize trigger    = 0x%x.", ramsize_trigger);
505         sr_info("Memory size        = 0x%x.", memory_size);
506
507         std_session_send_df_header(sdi);
508
509         /* Check for empty capture */
510         if ((status & STATUS_READY) && !stop_address) {
511                 std_session_send_df_end(sdi);
512                 return SR_OK;
513         }
514
515         buf = g_malloc(PACKET_SIZE);
516
517         /* Check if the trigger is in the samples we are throwing away */
518         trigger_now = now_address == trigger_address ||
519                 ((now_address + 1) % memory_size) == trigger_address;
520
521         /*
522          * STATUS_READY doesn't clear until now_address advances past
523          * addr 0, but for our logic, clear it in that case
524          */
525         if (!now_address)
526                 status &= ~STATUS_READY;
527
528         analyzer_read_start(usb->devhdl);
529
530         /* Calculate how much data to discard */
531         discard = 0;
532         if (status & STATUS_READY) {
533                 /*
534                  * We haven't wrapped around, we need to throw away data from
535                  * our current position to the end of the buffer.
536                  * Additionally, the first two samples captured are always
537                  * bogus.
538                  */
539                 discard += memory_size - now_address + 2;
540                 now_address = 2;
541         }
542
543         /* If we have more samples than we need, discard them */
544         valid_samples = (stop_address - now_address) % memory_size;
545         if (valid_samples > ramsize_trigger + triggerbar) {
546                 discard += valid_samples - (ramsize_trigger + triggerbar);
547                 now_address += valid_samples - (ramsize_trigger + triggerbar);
548         }
549
550         sr_info("Need to discard %d samples.", discard);
551
552         /* Calculate how far in the trigger is */
553         if (trigger_now)
554                 trigger_offset = 0;
555         else
556                 trigger_offset = (trigger_address - now_address) % memory_size;
557
558         /* Recalculate the number of samples available */
559         valid_samples = (stop_address - now_address) % memory_size;
560
561         /* Send the incoming transfer to the session bus. */
562         samples_read = 0;
563         for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
564                 unsigned int len;
565                 unsigned int buf_offset;
566
567                 res = analyzer_read_data(usb->devhdl, buf, PACKET_SIZE);
568                 if (res != PACKET_SIZE)
569                         sr_warn("Tried to read %d bytes, actually read %d.",
570                                 PACKET_SIZE, res);
571
572                 if (discard >= PACKET_SIZE / 4) {
573                         discard -= PACKET_SIZE / 4;
574                         continue;
575                 }
576
577                 len = PACKET_SIZE - discard * 4;
578                 buf_offset = discard * 4;
579                 discard = 0;
580
581                 /* Check if we've read all the samples */
582                 if (samples_read + len / 4 >= valid_samples)
583                         len = (valid_samples - samples_read) * 4;
584                 if (!len)
585                         break;
586
587                 if (samples_read < trigger_offset &&
588                     samples_read + len / 4 > trigger_offset) {
589                         /* Send out samples remaining before trigger */
590                         packet.type = SR_DF_LOGIC;
591                         packet.payload = &logic;
592                         logic.length = (trigger_offset - samples_read) * 4;
593                         logic.unitsize = 4;
594                         logic.data = buf + buf_offset;
595                         sr_session_send(sdi, &packet);
596                         len -= logic.length;
597                         samples_read += logic.length / 4;
598                         buf_offset += logic.length;
599                 }
600
601                 if (samples_read == trigger_offset)
602                         std_session_send_df_trigger(sdi);
603
604                 /* Send out data (or data after trigger) */
605                 packet.type = SR_DF_LOGIC;
606                 packet.payload = &logic;
607                 logic.length = len;
608                 logic.unitsize = 4;
609                 logic.data = buf + buf_offset;
610                 sr_session_send(sdi, &packet);
611                 samples_read += len / 4;
612         }
613         analyzer_read_stop(usb->devhdl);
614         g_free(buf);
615
616         std_session_send_df_end(sdi);
617
618         return SR_OK;
619 }
620
621 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
622 {
623         struct sr_usb_dev_inst *usb;
624
625         std_session_send_df_end(sdi);
626
627         usb = sdi->conn;
628         analyzer_reset(usb->devhdl);
629         /* TODO: Need to cancel and free any queued up transfers. */
630
631         return SR_OK;
632 }
633
634 static struct sr_dev_driver zeroplus_logic_cube_driver_info = {
635         .name = "zeroplus-logic-cube",
636         .longname = "ZEROPLUS Logic Cube LAP-C series",
637         .api_version = 1,
638         .init = std_init,
639         .cleanup = std_cleanup,
640         .scan = scan,
641         .dev_list = std_dev_list,
642         .dev_clear = std_dev_clear,
643         .config_get = config_get,
644         .config_set = config_set,
645         .config_list = config_list,
646         .dev_open = dev_open,
647         .dev_close = dev_close,
648         .dev_acquisition_start = dev_acquisition_start,
649         .dev_acquisition_stop = dev_acquisition_stop,
650         .context = NULL,
651 };
652 SR_REGISTER_DEV_DRIVER(zeroplus_logic_cube_driver_info);