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