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;
48 int num_analog_channels;
49 int cur_analog_channel;
50 GArray *analog_channels;
55 static 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,
64 static gboolean stream_session_data(struct sr_dev_inst *sdi)
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;
82 /* No capture file opened yet, or finished with the last
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. */
89 if (!(vdev->capfile = zip_fopen(vdev->archive,
90 vdev->capturefile, 0)))
92 sr_dbg("Opened %s.", vdev->capturefile);
94 /* Try as first chunk filename. */
95 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
96 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
98 if (!(vdev->capfile = zip_fopen(vdev->archive,
101 sr_dbg("Opened %s.", capturefile);
103 sr_err("No capture file '%s' in " "session file '%s'.",
104 vdev->capturefile, vdev->sessionfile);
109 /* Capture data is chunked, advance to the next chunk. */
111 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
113 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
114 if (!(vdev->capfile = zip_fopen(vdev->archive,
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++;
125 /* We got all the chunks, finish up. */
131 buf = g_malloc(CHUNKSIZE);
133 /* unitsize is not defined for purely analog session files. */
135 ret = zip_fread(vdev->capfile, buf,
136 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
138 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
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;
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;
162 logic.unitsize = vdev->unitsize;
165 vdev->bytes_read += ret;
166 sr_session_send(sdi, &packet);
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. */
182 static int receive_data(int fd, int revents, void *cb_data)
184 struct sr_dev_inst *sdi;
185 struct session_vdev *vdev;
193 if (!vdev->finished && !stream_session_data(sdi))
194 vdev->finished = TRUE;
196 return G_SOURCE_CONTINUE;
199 zip_fclose(vdev->capfile);
200 vdev->capfile = NULL;
203 zip_discard(vdev->archive);
204 vdev->archive = NULL;
207 std_session_send_df_end(sdi);
209 return G_SOURCE_REMOVE;
212 /* driver callbacks */
214 static int dev_clear(const struct sr_dev_driver *di)
216 struct drv_context *drvc;
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;
228 static int dev_open(struct sr_dev_inst *sdi)
230 struct sr_dev_driver *di;
231 struct drv_context *drvc;
232 struct session_vdev *vdev;
236 vdev = g_malloc0(sizeof(struct session_vdev));
238 drvc->instances = g_slist_append(drvc->instances, sdi);
243 static int dev_close(struct sr_dev_inst *sdi)
245 const struct session_vdev *const vdev = sdi->priv;
246 g_free(vdev->sessionfile);
247 g_free(vdev->capturefile);
255 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
256 const struct sr_channel_group *cg)
258 struct session_vdev *vdev;
268 case SR_CONF_SAMPLERATE:
269 *data = g_variant_new_uint64(vdev->samplerate);
271 case SR_CONF_CAPTURE_UNITSIZE:
272 *data = g_variant_new_uint64(vdev->unitsize);
281 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
282 const struct sr_channel_group *cg)
284 struct session_vdev *vdev;
291 case SR_CONF_SAMPLERATE:
292 vdev->samplerate = g_variant_get_uint64(data);
293 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
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);
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);
305 case SR_CONF_CAPTURE_UNITSIZE:
306 vdev->unitsize = g_variant_get_uint64(data);
308 case SR_CONF_NUM_LOGIC_CHANNELS:
309 vdev->num_channels = g_variant_get_int32(data);
311 case SR_CONF_NUM_ANALOG_CHANNELS:
312 vdev->num_analog_channels = g_variant_get_int32(data);
321 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
322 const struct sr_channel_group *cg)
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));
339 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
341 struct session_vdev *vdev;
344 struct sr_channel *ch;
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) {
353 if (ch->type == SR_CHANNEL_ANALOG)
354 g_array_append_val(vdev->analog_channels, ch);
357 vdev->finished = FALSE;
359 sr_info("Opening archive %s file %s", vdev->sessionfile,
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);
368 std_session_send_df_header(sdi);
370 /* freewheeling source */
371 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
376 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
378 struct session_vdev *vdev;
382 vdev->finished = TRUE;
388 SR_PRIV struct sr_dev_driver session_driver = {
389 .name = "virtual-session",
390 .longname = "Session-emulating driver",
393 .cleanup = dev_clear,
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,