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/>.
20 #include <sys/types.h>
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "virtual-session"
31 /* size of payloads sent across the session bus */
33 #define CHUNKSIZE (512 * 1024)
36 SR_PRIV struct sr_dev_driver session_driver_info;
42 struct zip_file *capfile;
51 static const uint32_t devopts[] = {
52 SR_CONF_CAPTUREFILE | SR_CONF_SET,
53 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
54 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
57 static int receive_data(int fd, int revents, void *cb_data)
59 struct sr_dev_inst *sdi;
60 struct session_vdev *vdev;
61 struct sr_datafeed_packet packet;
62 struct sr_datafeed_logic logic;
74 if (!vdev->finished) {
76 /* No capture file opened yet, or finished with the last
78 if (vdev->cur_chunk == 0) {
79 /* capturefile is always the unchunked base name. */
80 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
81 /* No chunks, just a single capture file. */
83 if (!(vdev->capfile = zip_fopen(vdev->archive,
84 vdev->capturefile, 0)))
86 sr_dbg("Opened %s.", vdev->capturefile);
88 /* Try as first chunk filename. */
89 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
90 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
92 if (!(vdev->capfile = zip_fopen(vdev->archive,
95 sr_dbg("Opened %s.", capturefile);
97 sr_err("No capture file '%s' in " "session file '%s'.",
98 vdev->capturefile, vdev->sessionfile);
103 /* Capture data is chunked, advance to the next chunk. */
105 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
107 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
108 if (!(vdev->capfile = zip_fopen(vdev->archive,
111 sr_dbg("Opened %s.", capturefile);
113 /* We got all the chunks, finish up. */
114 vdev->finished = TRUE;
120 buf = g_malloc(CHUNKSIZE);
122 ret = zip_fread(vdev->capfile, buf,
123 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
125 if (ret % vdev->unitsize != 0)
126 sr_warn("Read size %d not a multiple of the"
127 " unit size %d.", ret, vdev->unitsize);
129 packet.type = SR_DF_LOGIC;
130 packet.payload = &logic;
132 logic.unitsize = vdev->unitsize;
134 vdev->bytes_read += ret;
135 sr_session_send(sdi, &packet);
137 /* done with this capture file */
138 zip_fclose(vdev->capfile);
139 vdev->capfile = NULL;
140 if (vdev->cur_chunk == 0) {
141 /* It was the only file. */
142 vdev->finished = TRUE;
144 /* There might be more chunks, so don't fall through
145 * to the SR_DF_END here. */
154 packet.type = SR_DF_END;
155 sr_session_send(sdi, &packet);
156 sr_session_source_remove(sdi->session, -1);
162 /* driver callbacks */
164 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
166 return std_init(sr_ctx, di, LOG_PREFIX);
169 static int dev_clear(const struct sr_dev_driver *di)
171 struct drv_context *drvc;
175 for (l = drvc->instances; l; l = l->next)
176 sr_dev_inst_free(l->data);
177 g_slist_free(drvc->instances);
178 drvc->instances = NULL;
183 static int dev_open(struct sr_dev_inst *sdi)
185 struct sr_dev_driver *di;
186 struct drv_context *drvc;
187 struct session_vdev *vdev;
191 vdev = g_malloc0(sizeof(struct session_vdev));
193 drvc->instances = g_slist_append(drvc->instances, sdi);
198 static int dev_close(struct sr_dev_inst *sdi)
200 const struct session_vdev *const vdev = sdi->priv;
201 g_free(vdev->sessionfile);
202 g_free(vdev->capturefile);
210 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
211 const struct sr_channel_group *cg)
213 struct session_vdev *vdev;
223 case SR_CONF_SAMPLERATE:
224 *data = g_variant_new_uint64(vdev->samplerate);
226 case SR_CONF_CAPTURE_UNITSIZE:
227 *data = g_variant_new_uint64(vdev->unitsize);
236 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
237 const struct sr_channel_group *cg)
239 struct session_vdev *vdev;
246 case SR_CONF_SAMPLERATE:
247 vdev->samplerate = g_variant_get_uint64(data);
248 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
250 case SR_CONF_SESSIONFILE:
251 g_free(vdev->sessionfile);
252 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
253 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
255 case SR_CONF_CAPTUREFILE:
256 g_free(vdev->capturefile);
257 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
258 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
260 case SR_CONF_CAPTURE_UNITSIZE:
261 vdev->unitsize = g_variant_get_uint64(data);
263 case SR_CONF_NUM_LOGIC_CHANNELS:
264 vdev->num_channels = g_variant_get_uint64(data);
273 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
274 const struct sr_channel_group *cg)
280 case SR_CONF_DEVICE_OPTIONS:
281 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
282 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
291 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
293 struct session_vdev *vdev;
299 vdev->bytes_read = 0;
301 vdev->finished = FALSE;
303 sr_info("Opening archive %s file %s", vdev->sessionfile,
306 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
307 sr_err("Failed to open session file '%s': "
308 "zip error %d.", vdev->sessionfile, ret);
312 /* Send header packet to the session bus. */
313 std_session_send_df_header(sdi, LOG_PREFIX);
315 /* freewheeling source */
316 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
322 SR_PRIV struct sr_dev_driver session_driver = {
323 .name = "virtual-session",
324 .longname = "Session-emulating driver",
327 .cleanup = dev_clear,
330 .dev_clear = dev_clear,
331 .config_get = config_get,
332 .config_set = config_set,
333 .config_list = config_list,
334 .dev_open = dev_open,
335 .dev_close = dev_close,
336 .dev_acquisition_start = dev_acquisition_start,
337 .dev_acquisition_stop = NULL,