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