2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include <sys/types.h>
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "virtual-session"
32 /* size of payloads sent across the session bus */
34 #define CHUNKSIZE (512 * 1024)
37 SR_PRIV struct sr_dev_driver session_driver_info;
43 struct zip_file *capfile;
52 static const uint32_t devopts[] = {
53 SR_CONF_CAPTUREFILE | SR_CONF_SET,
54 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
55 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
56 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
57 SR_CONF_SESSIONFILE | SR_CONF_SET,
60 static gboolean stream_session_data(struct sr_dev_inst *sdi)
62 struct session_vdev *vdev;
63 struct sr_datafeed_packet packet;
64 struct sr_datafeed_logic logic;
73 /* No capture file opened yet, or finished with the last
75 if (vdev->cur_chunk == 0) {
76 /* capturefile is always the unchunked base name. */
77 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
78 /* No chunks, just a single capture file. */
80 if (!(vdev->capfile = zip_fopen(vdev->archive,
81 vdev->capturefile, 0)))
83 sr_dbg("Opened %s.", vdev->capturefile);
85 /* Try as first chunk filename. */
86 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
87 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
89 if (!(vdev->capfile = zip_fopen(vdev->archive,
92 sr_dbg("Opened %s.", capturefile);
94 sr_err("No capture file '%s' in " "session file '%s'.",
95 vdev->capturefile, vdev->sessionfile);
100 /* Capture data is chunked, advance to the next chunk. */
102 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
104 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
105 if (!(vdev->capfile = zip_fopen(vdev->archive,
108 sr_dbg("Opened %s.", capturefile);
110 /* We got all the chunks, finish up. */
116 buf = g_malloc(CHUNKSIZE);
118 ret = zip_fread(vdev->capfile, buf,
119 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
121 if (ret % vdev->unitsize != 0)
122 sr_warn("Read size %d not a multiple of the"
123 " unit size %d.", ret, vdev->unitsize);
125 packet.type = SR_DF_LOGIC;
126 packet.payload = &logic;
128 logic.unitsize = vdev->unitsize;
130 vdev->bytes_read += ret;
131 sr_session_send(sdi, &packet);
133 /* done with this capture file */
134 zip_fclose(vdev->capfile);
135 vdev->capfile = NULL;
136 if (vdev->cur_chunk != 0) {
137 /* There might be more chunks, so don't fall through
138 * to the SR_DF_END here. */
147 static int receive_data(int fd, int revents, void *cb_data)
149 struct sr_dev_inst *sdi;
150 struct session_vdev *vdev;
151 struct sr_datafeed_packet packet;
159 if (!vdev->finished && !stream_session_data(sdi))
160 vdev->finished = TRUE;
162 return G_SOURCE_CONTINUE;
165 zip_fclose(vdev->capfile);
166 vdev->capfile = NULL;
169 zip_discard(vdev->archive);
170 vdev->archive = NULL;
172 packet.type = SR_DF_END;
173 packet.payload = NULL;
174 sr_session_send(sdi, &packet);
176 return G_SOURCE_REMOVE;
179 /* driver callbacks */
181 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
183 return std_init(sr_ctx, di, LOG_PREFIX);
186 static int dev_clear(const struct sr_dev_driver *di)
188 struct drv_context *drvc;
192 for (l = drvc->instances; l; l = l->next)
193 sr_dev_inst_free(l->data);
194 g_slist_free(drvc->instances);
195 drvc->instances = NULL;
200 static int dev_open(struct sr_dev_inst *sdi)
202 struct sr_dev_driver *di;
203 struct drv_context *drvc;
204 struct session_vdev *vdev;
208 vdev = g_malloc0(sizeof(struct session_vdev));
210 drvc->instances = g_slist_append(drvc->instances, sdi);
215 static int dev_close(struct sr_dev_inst *sdi)
217 const struct session_vdev *const vdev = sdi->priv;
218 g_free(vdev->sessionfile);
219 g_free(vdev->capturefile);
227 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
228 const struct sr_channel_group *cg)
230 struct session_vdev *vdev;
240 case SR_CONF_SAMPLERATE:
241 *data = g_variant_new_uint64(vdev->samplerate);
243 case SR_CONF_CAPTURE_UNITSIZE:
244 *data = g_variant_new_uint64(vdev->unitsize);
253 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
254 const struct sr_channel_group *cg)
256 struct session_vdev *vdev;
263 case SR_CONF_SAMPLERATE:
264 vdev->samplerate = g_variant_get_uint64(data);
265 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
267 case SR_CONF_SESSIONFILE:
268 g_free(vdev->sessionfile);
269 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
270 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
272 case SR_CONF_CAPTUREFILE:
273 g_free(vdev->capturefile);
274 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
275 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
277 case SR_CONF_CAPTURE_UNITSIZE:
278 vdev->unitsize = g_variant_get_uint64(data);
280 case SR_CONF_NUM_LOGIC_CHANNELS:
281 vdev->num_channels = g_variant_get_int32(data);
290 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
291 const struct sr_channel_group *cg)
297 case SR_CONF_DEVICE_OPTIONS:
298 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
299 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
308 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
310 struct session_vdev *vdev;
316 vdev->bytes_read = 0;
318 vdev->finished = FALSE;
320 sr_info("Opening archive %s file %s", vdev->sessionfile,
323 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
324 sr_err("Failed to open session file '%s': "
325 "zip error %d.", vdev->sessionfile, ret);
329 /* Send header packet to the session bus. */
330 std_session_send_df_header(sdi, LOG_PREFIX);
332 /* freewheeling source */
333 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
338 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
340 struct session_vdev *vdev;
345 vdev->finished = TRUE;
351 SR_PRIV struct sr_dev_driver session_driver = {
352 .name = "virtual-session",
353 .longname = "Session-emulating driver",
356 .cleanup = dev_clear,
359 .dev_clear = dev_clear,
360 .config_get = config_get,
361 .config_set = config_set,
362 .config_list = config_list,
363 .dev_open = dev_open,
364 .dev_close = dev_close,
365 .dev_acquisition_start = dev_acquisition_start,
366 .dev_acquisition_stop = dev_acquisition_stop,