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_old analog;
79 /* No capture file opened yet, or finished with the last
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. */
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);
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++;
122 /* We got all the chunks, finish up. */
128 buf = g_malloc(CHUNKSIZE);
130 ret = zip_fread(vdev->capfile, buf,
131 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
134 if (vdev->cur_analog_channel != 0) {
135 packet.type = SR_DF_ANALOG_OLD;
136 packet.payload = &analog;
137 analog.channels = g_slist_prepend(NULL,
138 g_array_index(vdev->analog_channels,
139 struct sr_channel *, vdev->cur_analog_channel - 1));
140 analog.num_samples = ret / sizeof(float);
141 analog.mq = SR_MQ_VOLTAGE;
142 analog.unit = SR_UNIT_VOLT;
143 analog.mqflags = SR_MQFLAG_DC;
144 analog.data = (float *) buf;
146 if (ret % vdev->unitsize != 0)
147 sr_warn("Read size %d not a multiple of the"
148 " unit size %d.", ret, vdev->unitsize);
149 packet.type = SR_DF_LOGIC;
150 packet.payload = &logic;
152 logic.unitsize = vdev->unitsize;
155 vdev->bytes_read += ret;
156 sr_session_send(sdi, &packet);
158 /* done with this capture file */
159 zip_fclose(vdev->capfile);
160 vdev->capfile = NULL;
161 if (vdev->cur_chunk != 0) {
162 /* There might be more chunks, so don't fall through
163 * to the SR_DF_END here. */
172 static int receive_data(int fd, int revents, void *cb_data)
174 struct sr_dev_inst *sdi;
175 struct session_vdev *vdev;
176 struct sr_datafeed_packet packet;
184 if (!vdev->finished && !stream_session_data(sdi))
185 vdev->finished = TRUE;
187 return G_SOURCE_CONTINUE;
190 zip_fclose(vdev->capfile);
191 vdev->capfile = NULL;
194 zip_discard(vdev->archive);
195 vdev->archive = NULL;
197 packet.type = SR_DF_END;
198 packet.payload = NULL;
199 sr_session_send(sdi, &packet);
201 return G_SOURCE_REMOVE;
204 /* driver callbacks */
206 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
208 return std_init(sr_ctx, di, LOG_PREFIX);
211 static int dev_clear(const struct sr_dev_driver *di)
213 struct drv_context *drvc;
217 for (l = drvc->instances; l; l = l->next)
218 sr_dev_inst_free(l->data);
219 g_slist_free(drvc->instances);
220 drvc->instances = NULL;
225 static int dev_open(struct sr_dev_inst *sdi)
227 struct sr_dev_driver *di;
228 struct drv_context *drvc;
229 struct session_vdev *vdev;
233 vdev = g_malloc0(sizeof(struct session_vdev));
235 drvc->instances = g_slist_append(drvc->instances, sdi);
240 static int dev_close(struct sr_dev_inst *sdi)
242 const struct session_vdev *const vdev = sdi->priv;
243 g_free(vdev->sessionfile);
244 g_free(vdev->capturefile);
252 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
253 const struct sr_channel_group *cg)
255 struct session_vdev *vdev;
265 case SR_CONF_SAMPLERATE:
266 *data = g_variant_new_uint64(vdev->samplerate);
268 case SR_CONF_CAPTURE_UNITSIZE:
269 *data = g_variant_new_uint64(vdev->unitsize);
278 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
279 const struct sr_channel_group *cg)
281 struct session_vdev *vdev;
288 case SR_CONF_SAMPLERATE:
289 vdev->samplerate = g_variant_get_uint64(data);
290 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
292 case SR_CONF_SESSIONFILE:
293 g_free(vdev->sessionfile);
294 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
295 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
297 case SR_CONF_CAPTUREFILE:
298 g_free(vdev->capturefile);
299 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
300 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
302 case SR_CONF_CAPTURE_UNITSIZE:
303 vdev->unitsize = g_variant_get_uint64(data);
305 case SR_CONF_NUM_LOGIC_CHANNELS:
306 vdev->num_channels = g_variant_get_int32(data);
308 case SR_CONF_NUM_ANALOG_CHANNELS:
309 vdev->num_analog_channels = g_variant_get_int32(data);
318 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
319 const struct sr_channel_group *cg)
325 case SR_CONF_DEVICE_OPTIONS:
326 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
327 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
336 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
338 struct session_vdev *vdev;
341 struct sr_channel *ch;
346 vdev->bytes_read = 0;
347 vdev->cur_analog_channel = 0;
348 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
349 sizeof(struct sr_channel *), vdev->num_analog_channels);
350 for (l = sdi->channels; l; l = l->next) {
352 if (ch->type == SR_CHANNEL_ANALOG)
353 g_array_append_val(vdev->analog_channels, ch);
356 vdev->finished = FALSE;
358 sr_info("Opening archive %s file %s", vdev->sessionfile,
361 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
362 sr_err("Failed to open session file '%s': "
363 "zip error %d.", vdev->sessionfile, ret);
367 /* Send header packet to the session bus. */
368 std_session_send_df_header(sdi, LOG_PREFIX);
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, void *cb_data)
378 struct session_vdev *vdev;
383 vdev->finished = TRUE;
389 SR_PRIV struct sr_dev_driver session_driver = {
390 .name = "virtual-session",
391 .longname = "Session-emulating driver",
394 .cleanup = dev_clear,
397 .dev_clear = dev_clear,
398 .config_get = config_get,
399 .config_set = config_set,
400 .config_list = config_list,
401 .dev_open = dev_open,
402 .dev_close = dev_close,
403 .dev_acquisition_start = dev_acquisition_start,
404 .dev_acquisition_stop = dev_acquisition_stop,