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