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