]> sigrok.org Git - libsigrok.git/blob - src/hardware/openbench-logic-sniffer/api.c
ols: Clear "disabled groups" flags before setting them
[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 scanopts[] = {
26         SR_CONF_CONN,
27         SR_CONF_SERIALCOMM,
28 };
29
30 static const uint32_t drvopts[] = {
31         SR_CONF_LOGIC_ANALYZER,
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 (20 * 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 num_read;
95         unsigned int i;
96         const char *conn, *serialcomm;
97         char buf[4] = { 0, 0, 0, 0 };
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 (serial_has_receive_data(serial) == 0) {
139                 sr_dbg("Didn't get any ID reply.");
140                 return NULL;
141         }
142
143         num_read = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
144         if (num_read < 0) {
145                 sr_err("Getting ID reply failed (%d).", num_read);
146                 return NULL;
147         }
148
149         if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
150                 GString *id = sr_hexdump_new((uint8_t *)buf, num_read);
151
152                 sr_err("Invalid ID reply (got %s).", id->str);
153
154                 sr_hexdump_free(id);
155                 return NULL;
156         }
157
158         /* Definitely using the OLS protocol, check if it supports
159          * the metadata command.
160          */
161         send_shortcommand(serial, CMD_METADATA);
162
163         g_usleep(RESPONSE_DELAY_US);
164
165         if (serial_has_receive_data(serial) != 0) {
166                 /* Got metadata. */
167                 sdi = get_metadata(serial);
168         } else {
169                 /* Not an OLS -- some other board that uses the sump protocol. */
170                 sr_info("Device does not support metadata.");
171                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
172                 sdi->status = SR_ST_INACTIVE;
173                 sdi->vendor = g_strdup("Sump");
174                 sdi->model = g_strdup("Logic Analyzer");
175                 sdi->version = g_strdup("v1.0");
176                 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
177                         sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
178                                         ols_channel_names[i]);
179                 sdi->priv = ols_dev_new();
180         }
181         /* Configure samplerate and divider. */
182         if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
183                 sr_dbg("Failed to set default samplerate (%"PRIu64").",
184                                 DEFAULT_SAMPLERATE);
185         sdi->inst_type = SR_INST_SERIAL;
186         sdi->conn = serial;
187
188         serial_close(serial);
189
190         return std_scan_complete(di, g_slist_append(NULL, sdi));
191 }
192
193 static int config_get(uint32_t key, GVariant **data,
194         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
195 {
196         struct dev_context *devc;
197
198         (void)cg;
199
200         if (!sdi)
201                 return SR_ERR_ARG;
202
203         devc = sdi->priv;
204
205         switch (key) {
206         case SR_CONF_SAMPLERATE:
207                 *data = g_variant_new_uint64(devc->cur_samplerate);
208                 break;
209         case SR_CONF_CAPTURE_RATIO:
210                 *data = g_variant_new_uint64(devc->capture_ratio);
211                 break;
212         case SR_CONF_LIMIT_SAMPLES:
213                 *data = g_variant_new_uint64(devc->limit_samples);
214                 break;
215         case SR_CONF_PATTERN_MODE:
216                 if (devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE)
217                         *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
218                 else if (devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE)
219                         *data = g_variant_new_string(STR_PATTERN_INTERNAL);
220                 else
221                         *data = g_variant_new_string(STR_PATTERN_NONE);
222                 break;
223         case SR_CONF_RLE:
224                 *data = g_variant_new_boolean(devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
225                 break;
226         default:
227                 return SR_ERR_NA;
228         }
229
230         return SR_OK;
231 }
232
233 static int config_set(uint32_t key, GVariant *data,
234         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
235 {
236         struct dev_context *devc;
237         uint16_t flag;
238         uint64_t tmp_u64;
239         const char *stropt;
240
241         (void)cg;
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                 return ols_set_samplerate(sdi, g_variant_get_uint64(data));
251         case SR_CONF_LIMIT_SAMPLES:
252                 tmp_u64 = g_variant_get_uint64(data);
253                 if (tmp_u64 < MIN_NUM_SAMPLES)
254                         return SR_ERR;
255                 devc->limit_samples = tmp_u64;
256                 break;
257         case SR_CONF_CAPTURE_RATIO:
258                 devc->capture_ratio = g_variant_get_uint64(data);
259                 break;
260         case SR_CONF_EXTERNAL_CLOCK:
261                 if (g_variant_get_boolean(data)) {
262                         sr_info("Enabling external clock.");
263                         devc->capture_flags |= CAPTURE_FLAG_CLOCK_EXTERNAL;
264                 } else {
265                         sr_info("Disabled external clock.");
266                         devc->capture_flags &= ~CAPTURE_FLAG_CLOCK_EXTERNAL;
267                 }
268                 break;
269         case SR_CONF_PATTERN_MODE:
270                 stropt = g_variant_get_string(data, NULL);
271                 if (!strcmp(stropt, STR_PATTERN_NONE)) {
272                         sr_info("Disabling test modes.");
273                         flag = 0x0000;
274                 } else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
275                         sr_info("Enabling internal test mode.");
276                         flag = CAPTURE_FLAG_INTERNAL_TEST_MODE;
277                 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
278                         sr_info("Enabling external test mode.");
279                         flag = CAPTURE_FLAG_EXTERNAL_TEST_MODE;
280                 } else {
281                         return SR_ERR;
282                 }
283                 devc->capture_flags &= ~CAPTURE_FLAG_INTERNAL_TEST_MODE;
284                 devc->capture_flags &= ~CAPTURE_FLAG_EXTERNAL_TEST_MODE;
285                 devc->capture_flags |= flag;
286                 break;
287         case SR_CONF_SWAP:
288                 if (g_variant_get_boolean(data)) {
289                         sr_info("Enabling channel swapping.");
290                         devc->capture_flags |= CAPTURE_FLAG_SWAP_CHANNELS;
291                 } else {
292                         sr_info("Disabling channel swapping.");
293                         devc->capture_flags &= ~CAPTURE_FLAG_SWAP_CHANNELS;
294                 }
295                 break;
296         case SR_CONF_RLE:
297                 if (g_variant_get_boolean(data)) {
298                         sr_info("Enabling RLE.");
299                         devc->capture_flags |= CAPTURE_FLAG_RLE;
300                 } else {
301                         sr_info("Disabling RLE.");
302                         devc->capture_flags &= ~CAPTURE_FLAG_RLE;
303                 }
304                 break;
305         default:
306                 return SR_ERR_NA;
307         }
308
309         return SR_OK;
310 }
311
312 static int config_list(uint32_t key, GVariant **data,
313         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
314 {
315         struct dev_context *devc;
316         int num_ols_changrp, i;
317
318         switch (key) {
319         case SR_CONF_SCAN_OPTIONS:
320         case SR_CONF_DEVICE_OPTIONS:
321                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
322         case SR_CONF_SAMPLERATE:
323                 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
324                 break;
325         case SR_CONF_TRIGGER_MATCH:
326                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
327                 break;
328         case SR_CONF_PATTERN_MODE:
329                 *data = g_variant_new_strv(ARRAY_AND_SIZE(patterns));
330                 break;
331         case SR_CONF_LIMIT_SAMPLES:
332                 if (!sdi)
333                         return SR_ERR_ARG;
334                 devc = sdi->priv;
335                 if (devc->capture_flags & CAPTURE_FLAG_RLE)
336                         return SR_ERR_NA;
337                 if (devc->max_samples == 0)
338                         /* Device didn't specify sample memory size in metadata. */
339                         return SR_ERR_NA;
340                 /*
341                  * Channel groups are turned off if no channels in that group are
342                  * enabled, making more room for samples for the enabled group.
343                 */
344                 ols_channel_mask(sdi);
345                 num_ols_changrp = 0;
346                 for (i = 0; i < 4; i++) {
347                         if (devc->channel_mask & (0xff << (i * 8)))
348                                 num_ols_changrp++;
349                 }
350
351                 *data = std_gvar_tuple_u64(MIN_NUM_SAMPLES,
352                         (num_ols_changrp) ? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
353                 break;
354         default:
355                 return SR_ERR_NA;
356         }
357
358         return SR_OK;
359 }
360
361 static int set_basic_trigger(const struct sr_dev_inst *sdi, int stage)
362 {
363         struct dev_context *devc;
364         struct sr_serial_dev_inst *serial;
365         uint8_t cmd, arg[4];
366
367         devc = sdi->priv;
368         serial = sdi->conn;
369
370         cmd = CMD_SET_BASIC_TRIGGER_MASK0 + stage * 4;
371         arg[0] = devc->trigger_mask[stage] & 0xff;
372         arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
373         arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
374         arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
375         if (send_longcommand(serial, cmd, arg) != SR_OK)
376                 return SR_ERR;
377
378         cmd = CMD_SET_BASIC_TRIGGER_VALUE0 + stage * 4;
379         arg[0] = devc->trigger_value[stage] & 0xff;
380         arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
381         arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
382         arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
383         if (send_longcommand(serial, cmd, arg) != SR_OK)
384                 return SR_ERR;
385
386         cmd = CMD_SET_BASIC_TRIGGER_CONFIG0 + stage * 4;
387         arg[0] = arg[1] = arg[3] = 0x00;
388         arg[2] = stage;
389         if (stage == devc->num_stages)
390                 /* Last stage, fire when this one matches. */
391                 arg[3] |= TRIGGER_START;
392         if (send_longcommand(serial, cmd, arg) != SR_OK)
393                 return SR_ERR;
394
395         return SR_OK;
396 }
397
398 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
399 {
400         struct dev_context *devc;
401         struct sr_serial_dev_inst *serial;
402         uint32_t samplecount, readcount, delaycount;
403         uint8_t ols_changrp_mask, arg[4];
404         int num_ols_changrp;
405         int ret, i;
406
407         devc = sdi->priv;
408         serial = sdi->conn;
409
410         ols_channel_mask(sdi);
411
412         num_ols_changrp = 0;
413         ols_changrp_mask = 0;
414         for (i = 0; i < 4; i++) {
415                 if (devc->channel_mask & (0xff << (i * 8))) {
416                         ols_changrp_mask |= (1 << i);
417                         num_ols_changrp++;
418                 }
419         }
420
421         /*
422          * Limit readcount to prevent reading past the end of the hardware
423          * buffer. Rather read too many samples than too few.
424          */
425         samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
426         readcount = (samplecount + 3) / 4;
427
428         /* Basic triggers. */
429         if (ols_convert_trigger(sdi) != SR_OK) {
430                 sr_err("Failed to configure channels.");
431                 return SR_ERR;
432         }
433         if (devc->num_stages > 0) {
434                 /*
435                  * According to http://mygizmos.org/ols/Logic-Sniffer-FPGA-Spec.pdf
436                  * reset command must be send prior each arm command
437                  */
438                 sr_dbg("Send reset command before trigger configure");
439                 if (ols_send_reset(serial) != SR_OK)
440                         return SR_ERR;
441
442                 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
443                 devc->trigger_at_smpl = (readcount - delaycount) * 4 - devc->num_stages;
444                 for (i = 0; i <= devc->num_stages; i++) {
445                         sr_dbg("Setting OLS stage %d trigger.", i);
446                         if ((ret = set_basic_trigger(sdi, i)) != SR_OK)
447                                 return ret;
448                 }
449         } else {
450                 /* No triggers configured, force trigger on first stage. */
451                 sr_dbg("Forcing trigger at stage 0.");
452                 if ((ret = set_basic_trigger(sdi, 0)) != SR_OK)
453                         return ret;
454                 delaycount = readcount;
455         }
456
457         /* Samplerate. */
458         sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
459                         devc->cur_samplerate, devc->cur_samplerate_divider);
460         arg[0] = devc->cur_samplerate_divider & 0xff;
461         arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
462         arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
463         arg[3] = 0x00;
464         if (send_longcommand(serial, CMD_SET_DIVIDER, arg) != SR_OK)
465                 return SR_ERR;
466
467         /* Send sample limit and pre/post-trigger capture ratio. */
468         sr_dbg("Setting sample limit %d, trigger point at %d",
469                         (readcount - 1) * 4, (delaycount - 1) * 4);
470
471         if (devc->max_samples > 256 * 1024) {
472                 arg[0] = ((readcount - 1) & 0xff);
473                 arg[1] = ((readcount - 1) & 0xff00) >> 8;
474                 arg[2] = ((readcount - 1) & 0xff0000) >> 16;
475                 arg[3] = ((readcount - 1) & 0xff000000) >> 24;
476                 if (send_longcommand(serial, CMD_CAPTURE_READCOUNT, arg) != SR_OK)
477                         return SR_ERR;
478                 arg[0] = ((delaycount - 1) & 0xff);
479                 arg[1] = ((delaycount - 1) & 0xff00) >> 8;
480                 arg[2] = ((delaycount - 1) & 0xff0000) >> 16;
481                 arg[3] = ((delaycount - 1) & 0xff000000) >> 24;
482                 if (send_longcommand(serial, CMD_CAPTURE_DELAYCOUNT, arg) != SR_OK)
483                         return SR_ERR;
484         } else {
485                 arg[0] = ((readcount - 1) & 0xff);
486                 arg[1] = ((readcount - 1) & 0xff00) >> 8;
487                 arg[2] = ((delaycount - 1) & 0xff);
488                 arg[3] = ((delaycount - 1) & 0xff00) >> 8;
489                 if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
490                         return SR_ERR;
491         }
492
493         /* Flag register. */
494         sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
495                         devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE ? "on": "off",
496                         devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE ? "on": "off",
497                         devc->capture_flags & CAPTURE_FLAG_RLE ? "on" : "off",
498                         devc->capture_flags & CAPTURE_FLAG_NOISE_FILTER ? "on": "off",
499                         devc->capture_flags & CAPTURE_FLAG_DEMUX ? "on" : "off");
500
501         /*
502          * Enable/disable OLS channel groups in the flag register according
503          * to the channel mask. 1 means "disable channel".
504          */
505         devc->capture_flags &= ~0x3c;
506         devc->capture_flags |= ~(ols_changrp_mask << 2) & 0x3c;
507
508         /* RLE mode is always zero, for now. */
509
510         arg[0] = devc->capture_flags & 0xff;
511         arg[1] = devc->capture_flags >> 8;
512         arg[2] = arg[3] = 0x00;
513         if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
514                 return SR_ERR;
515
516         /* Start acquisition on the device. */
517         if (send_shortcommand(serial, CMD_ARM_BASIC_TRIGGER) != SR_OK)
518                 return SR_ERR;
519
520         /* Reset all operational states. */
521         devc->rle_count = devc->num_transfers = 0;
522         devc->num_samples = devc->num_bytes = 0;
523         devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
524         memset(devc->sample, 0, 4);
525
526         std_session_send_df_header(sdi);
527
528         /* If the device stops sending for longer than it takes to send a byte,
529          * that means it's finished. But wait at least 100 ms to be safe.
530          */
531         serial_source_add(sdi->session, serial, G_IO_IN, 100,
532                         ols_receive_data, (struct sr_dev_inst *)sdi);
533
534         return SR_OK;
535 }
536
537 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
538 {
539         abort_acquisition(sdi);
540
541         return SR_OK;
542 }
543
544 static struct sr_dev_driver ols_driver_info = {
545         .name = "ols",
546         .longname = "Openbench Logic Sniffer & SUMP compatibles",
547         .api_version = 1,
548         .init = std_init,
549         .cleanup = std_cleanup,
550         .scan = scan,
551         .dev_list = std_dev_list,
552         .dev_clear = std_dev_clear,
553         .config_get = config_get,
554         .config_set = config_set,
555         .config_list = config_list,
556         .dev_open = std_serial_dev_open,
557         .dev_close = std_serial_dev_close,
558         .dev_acquisition_start = dev_acquisition_start,
559         .dev_acquisition_stop = dev_acquisition_stop,
560         .context = NULL,
561 };
562 SR_REGISTER_DEV_DRIVER(ols_driver_info);