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 int receive_data(int fd, int revents, void *cb_data)
62 struct sr_dev_inst *sdi;
63 struct session_vdev *vdev;
64 struct sr_datafeed_packet packet;
65 struct sr_datafeed_logic logic;
77 if (!vdev->finished) {
79 /* No capture file opened yet, or finished with the last
81 if (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. */
86 if (!(vdev->capfile = zip_fopen(vdev->archive,
87 vdev->capturefile, 0)))
89 sr_dbg("Opened %s.", vdev->capturefile);
91 /* Try as first chunk filename. */
92 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
93 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
95 if (!(vdev->capfile = zip_fopen(vdev->archive,
98 sr_dbg("Opened %s.", capturefile);
100 sr_err("No capture file '%s' in " "session file '%s'.",
101 vdev->capturefile, vdev->sessionfile);
106 /* Capture data is chunked, advance to the next chunk. */
108 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
110 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
111 if (!(vdev->capfile = zip_fopen(vdev->archive,
114 sr_dbg("Opened %s.", capturefile);
116 /* We got all the chunks, finish up. */
117 vdev->finished = TRUE;
123 buf = g_malloc(CHUNKSIZE);
125 ret = zip_fread(vdev->capfile, buf,
126 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
128 if (ret % vdev->unitsize != 0)
129 sr_warn("Read size %d not a multiple of the"
130 " unit size %d.", ret, vdev->unitsize);
132 packet.type = SR_DF_LOGIC;
133 packet.payload = &logic;
135 logic.unitsize = vdev->unitsize;
137 vdev->bytes_read += ret;
138 sr_session_send(sdi, &packet);
140 /* done with this capture file */
141 zip_fclose(vdev->capfile);
142 vdev->capfile = NULL;
143 if (vdev->cur_chunk == 0) {
144 /* It was the only file. */
145 vdev->finished = TRUE;
147 /* There might be more chunks, so don't fall through
148 * to the SR_DF_END here. */
157 packet.type = SR_DF_END;
158 sr_session_send(sdi, &packet);
159 sr_session_source_remove(sdi->session, -1);
165 /* driver callbacks */
167 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
169 return std_init(sr_ctx, di, LOG_PREFIX);
172 static int dev_clear(const struct sr_dev_driver *di)
174 struct drv_context *drvc;
178 for (l = drvc->instances; l; l = l->next)
179 sr_dev_inst_free(l->data);
180 g_slist_free(drvc->instances);
181 drvc->instances = NULL;
186 static int dev_open(struct sr_dev_inst *sdi)
188 struct sr_dev_driver *di;
189 struct drv_context *drvc;
190 struct session_vdev *vdev;
194 vdev = g_malloc0(sizeof(struct session_vdev));
196 drvc->instances = g_slist_append(drvc->instances, sdi);
201 static int dev_close(struct sr_dev_inst *sdi)
203 const struct session_vdev *const vdev = sdi->priv;
204 g_free(vdev->sessionfile);
205 g_free(vdev->capturefile);
213 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
214 const struct sr_channel_group *cg)
216 struct session_vdev *vdev;
226 case SR_CONF_SAMPLERATE:
227 *data = g_variant_new_uint64(vdev->samplerate);
229 case SR_CONF_CAPTURE_UNITSIZE:
230 *data = g_variant_new_uint64(vdev->unitsize);
239 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
240 const struct sr_channel_group *cg)
242 struct session_vdev *vdev;
249 case SR_CONF_SAMPLERATE:
250 vdev->samplerate = g_variant_get_uint64(data);
251 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
253 case SR_CONF_SESSIONFILE:
254 g_free(vdev->sessionfile);
255 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
256 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
258 case SR_CONF_CAPTUREFILE:
259 g_free(vdev->capturefile);
260 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
261 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
263 case SR_CONF_CAPTURE_UNITSIZE:
264 vdev->unitsize = g_variant_get_uint64(data);
266 case SR_CONF_NUM_LOGIC_CHANNELS:
267 vdev->num_channels = g_variant_get_uint64(data);
276 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
277 const struct sr_channel_group *cg)
283 case SR_CONF_DEVICE_OPTIONS:
284 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
285 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
294 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
296 struct session_vdev *vdev;
302 vdev->bytes_read = 0;
304 vdev->finished = FALSE;
306 sr_info("Opening archive %s file %s", vdev->sessionfile,
309 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
310 sr_err("Failed to open session file '%s': "
311 "zip error %d.", vdev->sessionfile, ret);
315 /* Send header packet to the session bus. */
316 std_session_send_df_header(sdi, LOG_PREFIX);
318 /* freewheeling source */
319 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
325 SR_PRIV struct sr_dev_driver session_driver = {
326 .name = "virtual-session",
327 .longname = "Session-emulating driver",
330 .cleanup = dev_clear,
333 .dev_clear = dev_clear,
334 .config_get = config_get,
335 .config_set = config_set,
336 .config_list = config_list,
337 .dev_open = dev_open,
338 .dev_close = dev_close,
339 .dev_acquisition_start = dev_acquisition_start,
340 .dev_acquisition_stop = NULL,