]> sigrok.org Git - libsigrok.git/blame_incremental - src/session_driver.c
Drop unneeded std_session_send_df_header() comments.
[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 (512 * 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_old analog;
70 struct zip_stat zs;
71 int ret, got_data;
72 char capturefile[16];
73 void *buf;
74
75 got_data = FALSE;
76 vdev = sdi->priv;
77
78 if (!vdev->capfile) {
79 /* No capture file opened yet, or finished with the last
80 * chunked one. */
81 if (vdev->capturefile && (vdev->cur_chunk == 0)) {
82 /* capturefile is always the unchunked base name. */
83 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
84 /* No chunks, just a single capture file. */
85 vdev->cur_chunk = 0;
86 if (!(vdev->capfile = zip_fopen(vdev->archive,
87 vdev->capturefile, 0)))
88 return FALSE;
89 sr_dbg("Opened %s.", vdev->capturefile);
90 } else {
91 /* Try as first chunk filename. */
92 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
93 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
94 vdev->cur_chunk = 1;
95 if (!(vdev->capfile = zip_fopen(vdev->archive,
96 capturefile, 0)))
97 return FALSE;
98 sr_dbg("Opened %s.", capturefile);
99 } else {
100 sr_err("No capture file '%s' in " "session file '%s'.",
101 vdev->capturefile, vdev->sessionfile);
102 return FALSE;
103 }
104 }
105 } else {
106 /* Capture data is chunked, advance to the next chunk. */
107 vdev->cur_chunk++;
108 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
109 vdev->cur_chunk);
110 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
111 if (!(vdev->capfile = zip_fopen(vdev->archive,
112 capturefile, 0)))
113 return FALSE;
114 sr_dbg("Opened %s.", capturefile);
115 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
116 vdev->capturefile = g_strdup_printf("analog-1-%d",
117 vdev->num_channels + vdev->cur_analog_channel + 1);
118 vdev->cur_analog_channel++;
119 vdev->cur_chunk = 0;
120 return TRUE;
121 } else {
122 /* We got all the chunks, finish up. */
123 return FALSE;
124 }
125 }
126 }
127
128 buf = g_malloc(CHUNKSIZE);
129
130 /* unitsize is not defined for purely analog session files. */
131 if (vdev->unitsize)
132 ret = zip_fread(vdev->capfile, buf,
133 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
134 else
135 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
136
137 if (ret > 0) {
138 got_data = TRUE;
139 if (vdev->cur_analog_channel != 0) {
140 packet.type = SR_DF_ANALOG_OLD;
141 packet.payload = &analog;
142 analog.channels = g_slist_prepend(NULL,
143 g_array_index(vdev->analog_channels,
144 struct sr_channel *, vdev->cur_analog_channel - 1));
145 analog.num_samples = ret / sizeof(float);
146 analog.mq = SR_MQ_VOLTAGE;
147 analog.unit = SR_UNIT_VOLT;
148 analog.mqflags = SR_MQFLAG_DC;
149 analog.data = (float *) buf;
150 } else {
151 if (ret % vdev->unitsize != 0)
152 sr_warn("Read size %d not a multiple of the"
153 " unit size %d.", ret, vdev->unitsize);
154 packet.type = SR_DF_LOGIC;
155 packet.payload = &logic;
156 logic.length = ret;
157 logic.unitsize = vdev->unitsize;
158 logic.data = buf;
159 }
160 vdev->bytes_read += ret;
161 sr_session_send(sdi, &packet);
162 } else {
163 /* done with this capture file */
164 zip_fclose(vdev->capfile);
165 vdev->capfile = NULL;
166 if (vdev->cur_chunk != 0) {
167 /* There might be more chunks, so don't fall through
168 * to the SR_DF_END here. */
169 got_data = TRUE;
170 }
171 }
172 g_free(buf);
173
174 return got_data;
175}
176
177static int receive_data(int fd, int revents, void *cb_data)
178{
179 struct sr_dev_inst *sdi;
180 struct session_vdev *vdev;
181
182 (void)fd;
183 (void)revents;
184
185 sdi = cb_data;
186 vdev = sdi->priv;
187
188 if (!vdev->finished && !stream_session_data(sdi))
189 vdev->finished = TRUE;
190 if (!vdev->finished)
191 return G_SOURCE_CONTINUE;
192
193 if (vdev->capfile) {
194 zip_fclose(vdev->capfile);
195 vdev->capfile = NULL;
196 }
197 if (vdev->archive) {
198 zip_discard(vdev->archive);
199 vdev->archive = NULL;
200 }
201
202 std_session_send_df_end(sdi, LOG_PREFIX);
203
204 return G_SOURCE_REMOVE;
205}
206
207/* driver callbacks */
208
209static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
210{
211 return std_init(sr_ctx, di, LOG_PREFIX);
212}
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, void *cb_data)
340{
341 struct session_vdev *vdev;
342 int ret;
343 GSList *l;
344 struct sr_channel *ch;
345
346 (void)cb_data;
347
348 vdev = sdi->priv;
349 vdev->bytes_read = 0;
350 vdev->cur_analog_channel = 0;
351 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
352 sizeof(struct sr_channel *), vdev->num_analog_channels);
353 for (l = sdi->channels; l; l = l->next) {
354 ch = l->data;
355 if (ch->type == SR_CHANNEL_ANALOG)
356 g_array_append_val(vdev->analog_channels, ch);
357 }
358 vdev->cur_chunk = 0;
359 vdev->finished = FALSE;
360
361 sr_info("Opening archive %s file %s", vdev->sessionfile,
362 vdev->capturefile);
363
364 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
365 sr_err("Failed to open session file '%s': "
366 "zip error %d.", vdev->sessionfile, ret);
367 return SR_ERR;
368 }
369
370 std_session_send_df_header(sdi, LOG_PREFIX);
371
372 /* freewheeling source */
373 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
374
375 return SR_OK;
376}
377
378static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
379{
380 struct session_vdev *vdev;
381
382 (void)cb_data;
383 vdev = sdi->priv;
384
385 vdev->finished = TRUE;
386
387 return SR_OK;
388}
389
390/** @private */
391SR_PRIV struct sr_dev_driver session_driver = {
392 .name = "virtual-session",
393 .longname = "Session-emulating driver",
394 .api_version = 1,
395 .init = init,
396 .cleanup = dev_clear,
397 .scan = NULL,
398 .dev_list = NULL,
399 .dev_clear = dev_clear,
400 .config_get = config_get,
401 .config_set = config_set,
402 .config_list = config_list,
403 .dev_open = dev_open,
404 .dev_close = dev_close,
405 .dev_acquisition_start = dev_acquisition_start,
406 .dev_acquisition_stop = dev_acquisition_stop,
407 .context = NULL,
408};