libsigrok
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
ols.c
Go to the documentation of this file.
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
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 /*
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
26  */
27 
28 #include <stdlib.h>
29 #include <string.h>
30 #include <glib.h>
31 #include "sigrok.h"
32 #include "sigrok-internal.h"
33 
34 struct context {
35  GString *header;
36  uint64_t num_samples;
37  unsigned int unitsize;
38 };
39 
40 static int init(struct sr_output *o)
41 {
42  struct context *ctx;
43  struct sr_probe *probe;
44  GSList *l;
45  uint64_t samplerate;
46  int num_enabled_probes;
47 
48  if (!(ctx = g_try_malloc(sizeof(struct context)))) {
49  sr_err("ols out: %s: ctx malloc failed", __func__);
50  return SR_ERR_MALLOC;
51  }
52  o->internal = ctx;
53 
54  ctx->num_samples = 0;
55  num_enabled_probes = 0;
56  for (l = o->dev->probes; l; l = l->next) {
57  probe = l->data;
58  if (probe->enabled)
59  num_enabled_probes++;
60  }
61  ctx->unitsize = (num_enabled_probes + 7) / 8;
62 
64  samplerate = *((uint64_t *) o->dev->driver->dev_info_get(
66  else
67  samplerate = 0;
68 
69  ctx->header = g_string_sized_new(512);
70  g_string_append_printf(ctx->header, ";Rate: %"PRIu64"\n", samplerate);
71  g_string_append_printf(ctx->header, ";Channels: %d\n", num_enabled_probes);
72  g_string_append_printf(ctx->header, ";EnabledChannels: -1\n");
73  g_string_append_printf(ctx->header, ";Compressed: true\n");
74  g_string_append_printf(ctx->header, ";CursorEnabled: false\n");
75 
76  return SR_OK;
77 }
78 
79 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
80  uint64_t *length_out)
81 {
82  struct context *ctx;
83 
84  ctx = o->internal;
85 
86  if (ctx && event_type == SR_DF_END) {
87  g_string_free(ctx->header, TRUE);
88  g_free(o->internal);
89  o->internal = NULL;
90  }
91 
92  *data_out = NULL;
93  *length_out = 0;
94 
95  return SR_OK;
96 }
97 
98 static int data(struct sr_output *o, const uint8_t *data_in,
99  uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
100 {
101  GString *out;
102  struct context *ctx;
103  uint64_t sample;
104  unsigned int i;
105 
106  ctx = o->internal;
107  if (ctx->header) {
108  /* first data packet */
109  out = ctx->header;
110  ctx->header = NULL;
111  } else
112  out = g_string_sized_new(512);
113 
114  for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
115  sample = 0;
116  memcpy(&sample, data_in + i, ctx->unitsize);
117  g_string_append_printf(out, "%08x@%"PRIu64"\n",
118  (uint32_t) sample, ctx->num_samples++);
119  }
120  *data_out = (uint8_t *)out->str;
121  *length_out = out->len;
122  g_string_free(out, FALSE);
123 
124  return SR_OK;
125 }
126 
128  .id = "ols",
129  .description = "OpenBench Logic Sniffer",
130  .df_type = SR_DF_LOGIC,
131  .init = init,
132  .data = data,
133  .event = event,
134 };