]>
Commit | Line | Data |
---|---|---|
ab224f7b | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
ab224f7b UH |
3 | * |
4 | * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de> | |
13d8e03c | 5 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> |
ab224f7b UH |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | */ | |
21 | ||
22 | /* | |
305bde4d BV |
23 | * This implements version 1.3 of the output format for the OpenBench Logic |
24 | * Sniffer "Alternative" Java client. Details: | |
25 | * https://github.com/jawi/ols/wiki/OLS-data-file-format | |
ab224f7b UH |
26 | */ |
27 | ||
28 | #include <stdlib.h> | |
29 | #include <string.h> | |
30 | #include <glib.h> | |
45c59c8b BV |
31 | #include "libsigrok.h" |
32 | #include "libsigrok-internal.h" | |
ab224f7b | 33 | |
3544f848 | 34 | #define LOG_PREFIX "output/ols" |
a944a84b | 35 | |
ab224f7b | 36 | struct context { |
17f63de6 | 37 | uint64_t samplerate; |
6e738600 | 38 | uint64_t num_samples; |
ab224f7b UH |
39 | }; |
40 | ||
6e738600 BV |
41 | static int init(struct sr_output *o) |
42 | { | |
43 | struct context *ctx; | |
ab224f7b | 44 | |
b53738ba | 45 | if (!(ctx = g_try_malloc(sizeof(struct context)))) { |
a944a84b | 46 | sr_err("%s: ctx malloc failed", __func__); |
6e738600 | 47 | return SR_ERR_MALLOC; |
b53738ba | 48 | } |
6e738600 | 49 | o->internal = ctx; |
305bde4d | 50 | |
17f63de6 | 51 | ctx->samplerate = 0; |
6e738600 | 52 | ctx->num_samples = 0; |
3292535c BV |
53 | |
54 | return SR_OK; | |
55 | } | |
56 | ||
57 | static GString *gen_header(const struct sr_dev_inst *sdi, struct context *ctx) | |
58 | { | |
ba7dd8bb | 59 | struct sr_channel *ch; |
3292535c BV |
60 | GSList *l; |
61 | GString *s; | |
62 | GVariant *gvar; | |
ba7dd8bb | 63 | int num_enabled_channels; |
3292535c | 64 | |
8f996b89 ML |
65 | if (!ctx->samplerate && sr_config_get(sdi->driver, sdi, NULL, |
66 | SR_CONF_SAMPLERATE, &gvar) == SR_OK) { | |
3292535c BV |
67 | ctx->samplerate = g_variant_get_uint64(gvar); |
68 | g_variant_unref(gvar); | |
69 | } | |
70 | ||
ba7dd8bb UH |
71 | num_enabled_channels = 0; |
72 | for (l = sdi->channels; l; l = l->next) { | |
73 | ch = l->data; | |
3f239f08 | 74 | if (ch->type != SR_CHANNEL_LOGIC) |
3699a8a1 | 75 | continue; |
ba7dd8bb | 76 | if (!ch->enabled) |
3699a8a1 | 77 | continue; |
ba7dd8bb | 78 | num_enabled_channels++; |
ab224f7b UH |
79 | } |
80 | ||
3292535c BV |
81 | s = g_string_sized_new(512); |
82 | g_string_append_printf(s, ";Rate: %"PRIu64"\n", ctx->samplerate); | |
ba7dd8bb | 83 | g_string_append_printf(s, ";Channels: %d\n", num_enabled_channels); |
3292535c BV |
84 | g_string_append_printf(s, ";EnabledChannels: -1\n"); |
85 | g_string_append_printf(s, ";Compressed: true\n"); | |
86 | g_string_append_printf(s, ";CursorEnabled: false\n"); | |
305bde4d | 87 | |
3292535c | 88 | return s; |
ab224f7b UH |
89 | } |
90 | ||
17f63de6 BV |
91 | static int receive(struct sr_output *o, const struct sr_dev_inst *sdi, |
92 | const struct sr_datafeed_packet *packet, GString **out) | |
ab224f7b UH |
93 | { |
94 | struct context *ctx; | |
3292535c BV |
95 | const struct sr_datafeed_meta *meta; |
96 | const struct sr_datafeed_logic *logic; | |
97 | const struct sr_config *src; | |
98 | GSList *l; | |
3292535c BV |
99 | unsigned int i, j; |
100 | uint8_t c; | |
ab224f7b | 101 | |
17f63de6 | 102 | *out = NULL; |
3292535c | 103 | if (!o || !o->sdi) |
17f63de6 | 104 | return SR_ERR_ARG; |
ab224f7b | 105 | ctx = o->internal; |
6e738600 | 106 | |
3292535c | 107 | switch (packet->type) { |
17f63de6 | 108 | case SR_DF_META: |
3292535c BV |
109 | meta = packet->payload; |
110 | for (l = meta->config; l; l = l->next) { | |
111 | src = l->data; | |
112 | if (src->key == SR_CONF_SAMPLERATE) | |
113 | ctx->samplerate = g_variant_get_uint64(src->data); | |
114 | } | |
17f63de6 BV |
115 | break; |
116 | case SR_DF_LOGIC: | |
3292535c BV |
117 | logic = packet->payload; |
118 | if (ctx->num_samples == 0) { | |
119 | /* First logic packet in the feed. */ | |
17f63de6 | 120 | *out = gen_header(sdi, ctx); |
3292535c | 121 | } else |
17f63de6 | 122 | *out = g_string_sized_new(512); |
3292535c BV |
123 | for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) { |
124 | for (j = 0; j < logic->unitsize; j++) { | |
125 | /* The OLS format wants the samples presented MSB first. */ | |
126 | c = *((uint8_t *)logic->data + i + logic->unitsize - 1 - j); | |
17f63de6 | 127 | g_string_append_printf(*out, "%02x", c); |
3292535c | 128 | } |
17f63de6 | 129 | g_string_append_printf(*out, "@%"PRIu64"\n", ctx->num_samples++); |
3292535c BV |
130 | } |
131 | break; | |
ab224f7b UH |
132 | } |
133 | ||
17f63de6 | 134 | return SR_OK; |
ab224f7b UH |
135 | } |
136 | ||
3292535c | 137 | static int cleanup(struct sr_output *o) |
ab224f7b UH |
138 | { |
139 | struct context *ctx; | |
3292535c BV |
140 | |
141 | if (!o || !o->sdi) | |
142 | return SR_ERR_ARG; | |
ab224f7b UH |
143 | |
144 | ctx = o->internal; | |
17f63de6 BV |
145 | g_free(ctx); |
146 | o->internal = NULL; | |
ab224f7b | 147 | |
e46b8fb1 | 148 | return SR_OK; |
ab224f7b UH |
149 | } |
150 | ||
7c1d391c | 151 | SR_PRIV struct sr_output_format output_ols = { |
cdb3573c | 152 | .id = "ols", |
d494a4aa UH |
153 | .description = "OpenBench Logic Sniffer", |
154 | .df_type = SR_DF_LOGIC, | |
155 | .init = init, | |
17f63de6 | 156 | .receive = receive, |
3292535c | 157 | .cleanup = cleanup |
ab224f7b | 158 | }; |