]> sigrok.org Git - libsigrok.git/blame_incremental - src/session_driver.c
openbench-logic-sniffer: fix acquisition restart with trigger enabled
[libsigrok.git] / src / session_driver.c
... / ...
CommitLineData
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 <sys/types.h>
22#include <sys/stat.h>
23#include <fcntl.h>
24#include <unistd.h>
25#include <sys/time.h>
26#include <zip.h>
27#include <libsigrok/libsigrok.h>
28#include "libsigrok-internal.h"
29
30#define LOG_PREFIX "virtual-session"
31
32/* size of payloads sent across the session bus */
33/** @cond PRIVATE */
34#define CHUNKSIZE (4 * 1024 * 1024)
35/** @endcond */
36
37SR_PRIV struct sr_dev_driver session_driver_info;
38
39struct session_vdev {
40 char *sessionfile;
41 char *capturefile;
42 struct zip *archive;
43 struct zip_file *capfile;
44 int bytes_read;
45 uint64_t samplerate;
46 int unitsize;
47 int num_channels;
48 int num_analog_channels;
49 int cur_analog_channel;
50 GArray *analog_channels;
51 int cur_chunk;
52 gboolean finished;
53};
54
55static const uint32_t devopts[] = {
56 SR_CONF_CAPTUREFILE | SR_CONF_SET,
57 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
58 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
59 SR_CONF_NUM_ANALOG_CHANNELS | SR_CONF_SET,
60 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
61 SR_CONF_SESSIONFILE | SR_CONF_SET,
62};
63
64static gboolean stream_session_data(struct sr_dev_inst *sdi)
65{
66 struct session_vdev *vdev;
67 struct sr_datafeed_packet packet;
68 struct sr_datafeed_logic logic;
69 struct sr_datafeed_analog analog;
70 struct sr_analog_encoding encoding;
71 struct sr_analog_meaning meaning;
72 struct sr_analog_spec spec;
73 struct zip_stat zs;
74 int ret, got_data;
75 char capturefile[16];
76 void *buf;
77
78 got_data = FALSE;
79 vdev = sdi->priv;
80
81 if (!vdev->capfile) {
82 /* No capture file opened yet, or finished with the last
83 * chunked one. */
84 if (vdev->capturefile && (vdev->cur_chunk == 0)) {
85 /* capturefile is always the unchunked base name. */
86 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
87 /* No chunks, just a single capture file. */
88 vdev->cur_chunk = 0;
89 if (!(vdev->capfile = zip_fopen(vdev->archive,
90 vdev->capturefile, 0)))
91 return FALSE;
92 sr_dbg("Opened %s.", vdev->capturefile);
93 } else {
94 /* Try as first chunk filename. */
95 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
96 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
97 vdev->cur_chunk = 1;
98 if (!(vdev->capfile = zip_fopen(vdev->archive,
99 capturefile, 0)))
100 return FALSE;
101 sr_dbg("Opened %s.", capturefile);
102 } else {
103 sr_err("No capture file '%s' in " "session file '%s'.",
104 vdev->capturefile, vdev->sessionfile);
105 return FALSE;
106 }
107 }
108 } else {
109 /* Capture data is chunked, advance to the next chunk. */
110 vdev->cur_chunk++;
111 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
112 vdev->cur_chunk);
113 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
114 if (!(vdev->capfile = zip_fopen(vdev->archive,
115 capturefile, 0)))
116 return FALSE;
117 sr_dbg("Opened %s.", capturefile);
118 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
119 vdev->capturefile = g_strdup_printf("analog-1-%d",
120 vdev->num_channels + vdev->cur_analog_channel + 1);
121 vdev->cur_analog_channel++;
122 vdev->cur_chunk = 0;
123 return TRUE;
124 } else {
125 /* We got all the chunks, finish up. */
126 return FALSE;
127 }
128 }
129 }
130
131 buf = g_malloc(CHUNKSIZE);
132
133 /* unitsize is not defined for purely analog session files. */
134 if (vdev->unitsize)
135 ret = zip_fread(vdev->capfile, buf,
136 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
137 else
138 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
139
140 if (ret > 0) {
141 got_data = TRUE;
142 if (vdev->cur_analog_channel != 0) {
143 packet.type = SR_DF_ANALOG;
144 packet.payload = &analog;
145 /* TODO: Use proper 'digits' value for this device (and its modes). */
146 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
147 analog.meaning->channels = g_slist_prepend(NULL,
148 g_array_index(vdev->analog_channels,
149 struct sr_channel *, vdev->cur_analog_channel - 1));
150 analog.num_samples = ret / sizeof(float);
151 analog.meaning->mq = SR_MQ_VOLTAGE;
152 analog.meaning->unit = SR_UNIT_VOLT;
153 analog.meaning->mqflags = SR_MQFLAG_DC;
154 analog.data = (float *) buf;
155 } else {
156 if (ret % vdev->unitsize != 0)
157 sr_warn("Read size %d not a multiple of the"
158 " unit size %d.", ret, vdev->unitsize);
159 packet.type = SR_DF_LOGIC;
160 packet.payload = &logic;
161 logic.length = ret;
162 logic.unitsize = vdev->unitsize;
163 logic.data = buf;
164 }
165 vdev->bytes_read += ret;
166 sr_session_send(sdi, &packet);
167 } else {
168 /* done with this capture file */
169 zip_fclose(vdev->capfile);
170 vdev->capfile = NULL;
171 if (vdev->cur_chunk != 0) {
172 /* There might be more chunks, so don't fall through
173 * to the SR_DF_END here. */
174 got_data = TRUE;
175 }
176 }
177 g_free(buf);
178
179 return got_data;
180}
181
182static int receive_data(int fd, int revents, void *cb_data)
183{
184 struct sr_dev_inst *sdi;
185 struct session_vdev *vdev;
186
187 (void)fd;
188 (void)revents;
189
190 sdi = cb_data;
191 vdev = sdi->priv;
192
193 if (!vdev->finished && !stream_session_data(sdi))
194 vdev->finished = TRUE;
195 if (!vdev->finished)
196 return G_SOURCE_CONTINUE;
197
198 if (vdev->capfile) {
199 zip_fclose(vdev->capfile);
200 vdev->capfile = NULL;
201 }
202 if (vdev->archive) {
203 zip_discard(vdev->archive);
204 vdev->archive = NULL;
205 }
206
207 std_session_send_df_end(sdi);
208
209 return G_SOURCE_REMOVE;
210}
211
212/* driver callbacks */
213
214static int dev_clear(const struct sr_dev_driver *di)
215{
216 struct drv_context *drvc;
217 GSList *l;
218
219 drvc = di->context;
220 for (l = drvc->instances; l; l = l->next)
221 sr_dev_inst_free(l->data);
222 g_slist_free(drvc->instances);
223 drvc->instances = NULL;
224
225 return SR_OK;
226}
227
228static int dev_open(struct sr_dev_inst *sdi)
229{
230 struct sr_dev_driver *di;
231 struct drv_context *drvc;
232 struct session_vdev *vdev;
233
234 di = sdi->driver;
235 drvc = di->context;
236 vdev = g_malloc0(sizeof(struct session_vdev));
237 sdi->priv = vdev;
238 drvc->instances = g_slist_append(drvc->instances, sdi);
239
240 return SR_OK;
241}
242
243static int dev_close(struct sr_dev_inst *sdi)
244{
245 const struct session_vdev *const vdev = sdi->priv;
246 g_free(vdev->sessionfile);
247 g_free(vdev->capturefile);
248
249 g_free(sdi->priv);
250 sdi->priv = NULL;
251
252 return SR_OK;
253}
254
255static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
256 const struct sr_channel_group *cg)
257{
258 struct session_vdev *vdev;
259
260 (void)cg;
261
262 if (!sdi)
263 return SR_ERR;
264
265 vdev = sdi->priv;
266
267 switch (key) {
268 case SR_CONF_SAMPLERATE:
269 *data = g_variant_new_uint64(vdev->samplerate);
270 break;
271 case SR_CONF_CAPTURE_UNITSIZE:
272 *data = g_variant_new_uint64(vdev->unitsize);
273 break;
274 default:
275 return SR_ERR_NA;
276 }
277
278 return SR_OK;
279}
280
281static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
282 const struct sr_channel_group *cg)
283{
284 struct session_vdev *vdev;
285
286 (void)cg;
287
288 vdev = sdi->priv;
289
290 switch (key) {
291 case SR_CONF_SAMPLERATE:
292 vdev->samplerate = g_variant_get_uint64(data);
293 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
294 break;
295 case SR_CONF_SESSIONFILE:
296 g_free(vdev->sessionfile);
297 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
298 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
299 break;
300 case SR_CONF_CAPTUREFILE:
301 g_free(vdev->capturefile);
302 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
303 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
304 break;
305 case SR_CONF_CAPTURE_UNITSIZE:
306 vdev->unitsize = g_variant_get_uint64(data);
307 break;
308 case SR_CONF_NUM_LOGIC_CHANNELS:
309 vdev->num_channels = g_variant_get_int32(data);
310 break;
311 case SR_CONF_NUM_ANALOG_CHANNELS:
312 vdev->num_analog_channels = g_variant_get_int32(data);
313 break;
314 default:
315 return SR_ERR_NA;
316 }
317
318 return SR_OK;
319}
320
321static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
322 const struct sr_channel_group *cg)
323{
324 (void)sdi;
325 (void)cg;
326
327 switch (key) {
328 case SR_CONF_DEVICE_OPTIONS:
329 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
330 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
331 break;
332 default:
333 return SR_ERR_NA;
334 }
335
336 return SR_OK;
337}
338
339static int dev_acquisition_start(const struct sr_dev_inst *sdi)
340{
341 struct session_vdev *vdev;
342 int ret;
343 GSList *l;
344 struct sr_channel *ch;
345
346 vdev = sdi->priv;
347 vdev->bytes_read = 0;
348 vdev->cur_analog_channel = 0;
349 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
350 sizeof(struct sr_channel *), vdev->num_analog_channels);
351 for (l = sdi->channels; l; l = l->next) {
352 ch = l->data;
353 if (ch->type == SR_CHANNEL_ANALOG)
354 g_array_append_val(vdev->analog_channels, ch);
355 }
356 vdev->cur_chunk = 0;
357 vdev->finished = FALSE;
358
359 sr_info("Opening archive %s file %s", vdev->sessionfile,
360 vdev->capturefile);
361
362 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
363 sr_err("Failed to open session file '%s': "
364 "zip error %d.", vdev->sessionfile, ret);
365 return SR_ERR;
366 }
367
368 std_session_send_df_header(sdi);
369
370 /* freewheeling source */
371 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
372
373 return SR_OK;
374}
375
376static int dev_acquisition_stop(struct sr_dev_inst *sdi)
377{
378 struct session_vdev *vdev;
379
380 vdev = sdi->priv;
381
382 vdev->finished = TRUE;
383
384 return SR_OK;
385}
386
387/** @private */
388SR_PRIV struct sr_dev_driver session_driver = {
389 .name = "virtual-session",
390 .longname = "Session-emulating driver",
391 .api_version = 1,
392 .init = std_init,
393 .cleanup = dev_clear,
394 .scan = NULL,
395 .dev_list = NULL,
396 .dev_clear = dev_clear,
397 .config_get = config_get,
398 .config_set = config_set,
399 .config_list = config_list,
400 .dev_open = dev_open,
401 .dev_close = dev_close,
402 .dev_acquisition_start = dev_acquisition_start,
403 .dev_acquisition_stop = dev_acquisition_stop,
404 .context = NULL,
405};