]> sigrok.org Git - libsigrok.git/blob - src/hardware/openbench-logic-sniffer/api.c
Add sr_dev_acquisition_start(), factor out SR_ERR_DEV_CLOSED check.
[libsigrok.git] / src / hardware / openbench-logic-sniffer / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 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 SERIALCOMM "115200/8n1"
24
25 static const uint32_t drvopts[] = {
26         SR_CONF_LOGIC_ANALYZER,
27 };
28
29 static const uint32_t scanopts[] = {
30         SR_CONF_CONN,
31         SR_CONF_SERIALCOMM,
32 };
33
34 static const uint32_t devopts[] = {
35         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
37         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
38         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
39         SR_CONF_EXTERNAL_CLOCK | SR_CONF_SET,
40         SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41         SR_CONF_SWAP | SR_CONF_SET,
42         SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
43 };
44
45 static const int32_t trigger_matches[] = {
46         SR_TRIGGER_ZERO,
47         SR_TRIGGER_ONE,
48 };
49
50 #define STR_PATTERN_NONE     "None"
51 #define STR_PATTERN_EXTERNAL "External"
52 #define STR_PATTERN_INTERNAL "Internal"
53
54 /* Supported methods of test pattern outputs */
55 enum {
56         /**
57          * Capture pins 31:16 (unbuffered wing) output a test pattern
58          * that can captured on pins 0:15.
59          */
60         PATTERN_EXTERNAL,
61
62         /** Route test pattern internally to capture buffer. */
63         PATTERN_INTERNAL,
64 };
65
66 static const char *patterns[] = {
67         STR_PATTERN_NONE,
68         STR_PATTERN_EXTERNAL,
69         STR_PATTERN_INTERNAL,
70 };
71
72 /* Channels are numbered 0-31 (on the PCB silkscreen). */
73 SR_PRIV const char *ols_channel_names[] = {
74         "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
75         "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
76         "24", "25", "26", "27", "28", "29", "30", "31",
77 };
78
79 /* Default supported samplerates, can be overridden by device metadata. */
80 static const uint64_t samplerates[] = {
81         SR_HZ(10),
82         SR_MHZ(200),
83         SR_HZ(1),
84 };
85
86 #define RESPONSE_DELAY_US (10 * 1000)
87
88 static GSList *scan(struct sr_dev_driver *di, GSList *options)
89 {
90         struct sr_config *src;
91         struct sr_dev_inst *sdi;
92         struct sr_serial_dev_inst *serial;
93         GSList *l;
94         int ret;
95         unsigned int i;
96         const char *conn, *serialcomm;
97         char buf[8];
98
99         conn = serialcomm = NULL;
100         for (l = options; l; l = l->next) {
101                 src = l->data;
102                 switch (src->key) {
103                 case SR_CONF_CONN:
104                         conn = g_variant_get_string(src->data, NULL);
105                         break;
106                 case SR_CONF_SERIALCOMM:
107                         serialcomm = g_variant_get_string(src->data, NULL);
108                         break;
109                 }
110         }
111         if (!conn)
112                 return NULL;
113
114         if (!serialcomm)
115                 serialcomm = SERIALCOMM;
116
117         serial = sr_serial_dev_inst_new(conn, serialcomm);
118
119         /* The discovery procedure is like this: first send the Reset
120          * command (0x00) 5 times, since the device could be anywhere
121          * in a 5-byte command. Then send the ID command (0x02).
122          * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
123          * have a match.
124          */
125         sr_info("Probing %s.", conn);
126         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
127                 return NULL;
128
129         if (ols_send_reset(serial) != SR_OK) {
130                 serial_close(serial);
131                 sr_err("Could not use port %s. Quitting.", conn);
132                 return NULL;
133         }
134         send_shortcommand(serial, CMD_ID);
135
136         g_usleep(RESPONSE_DELAY_US);
137
138         if (sp_input_waiting(serial->data) == 0) {
139                 sr_dbg("Didn't get any reply.");
140                 return NULL;
141         }
142
143         ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
144         if (ret != 4) {
145                 sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
146                 return NULL;
147         }
148
149         if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
150                 sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
151                        "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
152                 return NULL;
153         }
154
155         /* Definitely using the OLS protocol, check if it supports
156          * the metadata command.
157          */
158         send_shortcommand(serial, CMD_METADATA);
159
160         g_usleep(RESPONSE_DELAY_US);
161
162         if (sp_input_waiting(serial->data) != 0) {
163                 /* Got metadata. */
164                 sdi = get_metadata(serial);
165         } else {
166                 /* Not an OLS -- some other board that uses the sump protocol. */
167                 sr_info("Device does not support metadata.");
168                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
169                 sdi->status = SR_ST_INACTIVE;
170                 sdi->vendor = g_strdup("Sump");
171                 sdi->model = g_strdup("Logic Analyzer");
172                 sdi->version = g_strdup("v1.0");
173                 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
174                         sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
175                                         ols_channel_names[i]);
176                 sdi->priv = ols_dev_new();
177         }
178         /* Configure samplerate and divider. */
179         if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
180                 sr_dbg("Failed to set default samplerate (%"PRIu64").",
181                                 DEFAULT_SAMPLERATE);
182         sdi->inst_type = SR_INST_SERIAL;
183         sdi->conn = serial;
184
185         serial_close(serial);
186
187         return std_scan_complete(di, g_slist_append(NULL, sdi));
188 }
189
190 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
191                 const struct sr_channel_group *cg)
192 {
193         struct dev_context *devc;
194
195         (void)cg;
196
197         if (!sdi)
198                 return SR_ERR_ARG;
199
200         devc = sdi->priv;
201         switch (key) {
202         case SR_CONF_SAMPLERATE:
203                 *data = g_variant_new_uint64(devc->cur_samplerate);
204                 break;
205         case SR_CONF_CAPTURE_RATIO:
206                 *data = g_variant_new_uint64(devc->capture_ratio);
207                 break;
208         case SR_CONF_LIMIT_SAMPLES:
209                 *data = g_variant_new_uint64(devc->limit_samples);
210                 break;
211         case SR_CONF_PATTERN_MODE:
212                 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
213                         *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
214                 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
215                         *data = g_variant_new_string(STR_PATTERN_INTERNAL);
216                 else
217                         *data = g_variant_new_string(STR_PATTERN_NONE);
218                 break;
219         case SR_CONF_RLE:
220                 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
221                 break;
222         default:
223                 return SR_ERR_NA;
224         }
225
226         return SR_OK;
227 }
228
229 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
230                 const struct sr_channel_group *cg)
231 {
232         struct dev_context *devc;
233         uint16_t flag;
234         uint64_t tmp_u64;
235         int ret;
236         const char *stropt;
237
238         (void)cg;
239
240         if (sdi->status != SR_ST_ACTIVE)
241                 return SR_ERR_DEV_CLOSED;
242
243         devc = sdi->priv;
244
245         switch (key) {
246         case SR_CONF_SAMPLERATE:
247                 tmp_u64 = g_variant_get_uint64(data);
248                 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
249                         return SR_ERR_SAMPLERATE;
250                 ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
251                 break;
252         case SR_CONF_LIMIT_SAMPLES:
253                 tmp_u64 = g_variant_get_uint64(data);
254                 if (tmp_u64 < MIN_NUM_SAMPLES)
255                         return SR_ERR;
256                 devc->limit_samples = tmp_u64;
257                 ret = SR_OK;
258                 break;
259         case SR_CONF_CAPTURE_RATIO:
260                 devc->capture_ratio = g_variant_get_uint64(data);
261                 if (devc->capture_ratio < 0 || devc->capture_ratio > 100)
262                         ret = SR_ERR;
263                 else
264                         ret = SR_OK;
265                 break;
266         case SR_CONF_EXTERNAL_CLOCK:
267                 if (g_variant_get_boolean(data)) {
268                         sr_info("Enabling external clock.");
269                         devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
270                 } else {
271                         sr_info("Disabled external clock.");
272                         devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
273                 }
274                 ret = SR_OK;
275                 break;
276         case SR_CONF_PATTERN_MODE:
277                 stropt = g_variant_get_string(data, NULL);
278                 ret = SR_OK;
279                 flag = 0xffff;
280                 if (!strcmp(stropt, STR_PATTERN_NONE)) {
281                         sr_info("Disabling test modes.");
282                         flag = 0x0000;
283                 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
284                         sr_info("Enabling internal test mode.");
285                         flag = FLAG_INTERNAL_TEST_MODE;
286                 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
287                         sr_info("Enabling external test mode.");
288                         flag = FLAG_EXTERNAL_TEST_MODE;
289                 } else {
290                         ret = SR_ERR;
291                 }
292                 if (flag != 0xffff) {
293                         devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
294                         devc->flag_reg |= flag;
295                 }
296                 break;
297         case SR_CONF_SWAP:
298                 if (g_variant_get_boolean(data)) {
299                         sr_info("Enabling channel swapping.");
300                         devc->flag_reg |= FLAG_SWAP_CHANNELS;
301                 } else {
302                         sr_info("Disabling channel swapping.");
303                         devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
304                 }
305                 ret = SR_OK;
306                 break;
307
308         case SR_CONF_RLE:
309                 if (g_variant_get_boolean(data)) {
310                         sr_info("Enabling RLE.");
311                         devc->flag_reg |= FLAG_RLE;
312                 } else {
313                         sr_info("Disabling RLE.");
314                         devc->flag_reg &= ~FLAG_RLE;
315                 }
316                 ret = SR_OK;
317                 break;
318         default:
319                 ret = SR_ERR_NA;
320         }
321
322         return ret;
323 }
324
325 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
326                 const struct sr_channel_group *cg)
327 {
328         struct dev_context *devc;
329         GVariant *gvar, *grange[2];
330         GVariantBuilder gvb;
331         int num_ols_changrp, i;
332
333         (void)cg;
334
335         switch (key) {
336         case SR_CONF_SCAN_OPTIONS:
337                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
338                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
339                 break;
340         case SR_CONF_DEVICE_OPTIONS:
341                 if (!sdi)
342                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
343                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
344                 else
345                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
346                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
347                 break;
348         case SR_CONF_SAMPLERATE:
349                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
350                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
351                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
352                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
353                 *data = g_variant_builder_end(&gvb);
354                 break;
355         case SR_CONF_TRIGGER_MATCH:
356                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
357                                 trigger_matches, ARRAY_SIZE(trigger_matches),
358                                 sizeof(int32_t));
359                 break;
360         case SR_CONF_PATTERN_MODE:
361                 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
362                 break;
363         case SR_CONF_LIMIT_SAMPLES:
364                 if (!sdi)
365                         return SR_ERR_ARG;
366                 devc = sdi->priv;
367                 if (devc->flag_reg & FLAG_RLE)
368                         return SR_ERR_NA;
369                 if (devc->max_samples == 0)
370                         /* Device didn't specify sample memory size in metadata. */
371                         return SR_ERR_NA;
372                 /*
373                  * Channel groups are turned off if no channels in that group are
374                  * enabled, making more room for samples for the enabled group.
375                 */
376                 ols_channel_mask(sdi);
377                 num_ols_changrp = 0;
378                 for (i = 0; i < 4; i++) {
379                         if (devc->channel_mask & (0xff << (i * 8)))
380                                 num_ols_changrp++;
381                 }
382                 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
383                 if (num_ols_changrp)
384                         grange[1] = g_variant_new_uint64(devc->max_samples / num_ols_changrp);
385                 else
386                         grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
387                 *data = g_variant_new_tuple(grange, 2);
388                 break;
389         default:
390                 return SR_ERR_NA;
391         }
392
393         return SR_OK;
394 }
395
396 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
397 {
398         struct dev_context *devc;
399         struct sr_serial_dev_inst *serial;
400         uint8_t cmd, arg[4];
401
402         devc = sdi->priv;
403         serial = sdi->conn;
404
405         cmd = CMD_SET_TRIGGER_MASK + stage * 4;
406         arg[0] = devc->trigger_mask[stage] & 0xff;
407         arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
408         arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
409         arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
410         if (send_longcommand(serial, cmd, arg) != SR_OK)
411                 return SR_ERR;
412
413         cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
414         arg[0] = devc->trigger_value[stage] & 0xff;
415         arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
416         arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
417         arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
418         if (send_longcommand(serial, cmd, arg) != SR_OK)
419                 return SR_ERR;
420
421         cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
422         arg[0] = arg[1] = arg[3] = 0x00;
423         arg[2] = stage;
424         if (stage == devc->num_stages)
425                 /* Last stage, fire when this one matches. */
426                 arg[3] |= TRIGGER_START;
427         if (send_longcommand(serial, cmd, arg) != SR_OK)
428                 return SR_ERR;
429
430         return SR_OK;
431 }
432
433 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
434 {
435         struct dev_context *devc;
436         struct sr_serial_dev_inst *serial;
437         uint16_t samplecount, readcount, delaycount;
438         uint8_t ols_changrp_mask, arg[4];
439         int num_ols_changrp;
440         int ret, i;
441
442         devc = sdi->priv;
443         serial = sdi->conn;
444
445         ols_channel_mask(sdi);
446
447         num_ols_changrp = 0;
448         ols_changrp_mask = 0;
449         for (i = 0; i < 4; i++) {
450                 if (devc->channel_mask & (0xff << (i * 8))) {
451                         ols_changrp_mask |= (1 << i);
452                         num_ols_changrp++;
453                 }
454         }
455
456         /*
457          * Limit readcount to prevent reading past the end of the hardware
458          * buffer.
459          */
460         samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
461         readcount = samplecount / 4;
462
463         /* Rather read too many samples than too few. */
464         if (samplecount % 4 != 0)
465                 readcount++;
466
467         /* Basic triggers. */
468         if (ols_convert_trigger(sdi) != SR_OK) {
469                 sr_err("Failed to configure channels.");
470                 return SR_ERR;
471         }
472         if (devc->num_stages > 0) {
473                 /*
474                  * According to http://mygizmos.org/ols/Logic-Sniffer-FPGA-Spec.pdf
475                  * reset command must be send prior each arm command
476                  */
477                 sr_dbg("Send reset command before trigger configure");
478                 if (ols_send_reset(serial) != SR_OK)
479                         return SR_ERR;
480
481                 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
482                 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
483                 for (i = 0; i <= devc->num_stages; i++) {
484                         sr_dbg("Setting OLS stage %d trigger.", i);
485                         if ((ret = set_trigger(sdi, i)) != SR_OK)
486                                 return ret;
487                 }
488         } else {
489                 /* No triggers configured, force trigger on first stage. */
490                 sr_dbg("Forcing trigger at stage 0.");
491                 if ((ret = set_trigger(sdi, 0)) != SR_OK)
492                         return ret;
493                 delaycount = readcount;
494         }
495
496         /* Samplerate. */
497         sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
498                         devc->cur_samplerate, devc->cur_samplerate_divider);
499         arg[0] = devc->cur_samplerate_divider & 0xff;
500         arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
501         arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
502         arg[3] = 0x00;
503         if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
504                 return SR_ERR;
505
506         /* Send sample limit and pre/post-trigger capture ratio. */
507         sr_dbg("Setting sample limit %d, trigger point at %d",
508                         (readcount - 1) * 4, (delaycount - 1) * 4);
509         arg[0] = ((readcount - 1) & 0xff);
510         arg[1] = ((readcount - 1) & 0xff00) >> 8;
511         arg[2] = ((delaycount - 1) & 0xff);
512         arg[3] = ((delaycount - 1) & 0xff00) >> 8;
513         if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
514                 return SR_ERR;
515
516         /* Flag register. */
517         sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
518                         devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
519                         devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
520                         devc->flag_reg & FLAG_RLE ? "on" : "off",
521                         devc->flag_reg & FLAG_FILTER ? "on": "off",
522                         devc->flag_reg & FLAG_DEMUX ? "on" : "off");
523         /*
524          * Enable/disable OLS channel groups in the flag register according
525          * to the channel mask. 1 means "disable channel".
526          */
527         devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
528         arg[0] = devc->flag_reg & 0xff;
529         arg[1] = devc->flag_reg >> 8;
530         arg[2] = arg[3] = 0x00;
531         if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
532                 return SR_ERR;
533
534         /* Start acquisition on the device. */
535         if (send_shortcommand(serial, CMD_RUN) != SR_OK)
536                 return SR_ERR;
537
538         /* Reset all operational states. */
539         devc->rle_count = devc->num_transfers = 0;
540         devc->num_samples = devc->num_bytes = 0;
541         devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
542         memset(devc->sample, 0, 4);
543
544         std_session_send_df_header(sdi);
545
546         /* If the device stops sending for longer than it takes to send a byte,
547          * that means it's finished. But wait at least 100 ms to be safe.
548          */
549         serial_source_add(sdi->session, serial, G_IO_IN, 100,
550                         ols_receive_data, (struct sr_dev_inst *)sdi);
551
552         return SR_OK;
553 }
554
555 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
556 {
557         abort_acquisition(sdi);
558
559         return SR_OK;
560 }
561
562 static struct sr_dev_driver ols_driver_info = {
563         .name = "ols",
564         .longname = "Openbench Logic Sniffer",
565         .api_version = 1,
566         .init = std_init,
567         .cleanup = std_cleanup,
568         .scan = scan,
569         .dev_list = std_dev_list,
570         .dev_clear = NULL,
571         .config_get = config_get,
572         .config_set = config_set,
573         .config_list = config_list,
574         .dev_open = std_serial_dev_open,
575         .dev_close = std_serial_dev_close,
576         .dev_acquisition_start = dev_acquisition_start,
577         .dev_acquisition_stop = dev_acquisition_stop,
578         .context = NULL,
579 };
580 SR_REGISTER_DEV_DRIVER(ols_driver_info);