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