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 /* unitsize is not defined for purely analog session files. */
132 ret = zip_fread(vdev->capfile, buf,
133 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
135 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
139 if (vdev->cur_analog_channel != 0) {
140 packet.type = SR_DF_ANALOG_OLD;
141 packet.payload = &analog;
142 analog.channels = g_slist_prepend(NULL,
143 g_array_index(vdev->analog_channels,
144 struct sr_channel *, vdev->cur_analog_channel - 1));
145 analog.num_samples = ret / sizeof(float);
146 analog.mq = SR_MQ_VOLTAGE;
147 analog.unit = SR_UNIT_VOLT;
148 analog.mqflags = SR_MQFLAG_DC;
149 analog.data = (float *) buf;
151 if (ret % vdev->unitsize != 0)
152 sr_warn("Read size %d not a multiple of the"
153 " unit size %d.", ret, vdev->unitsize);
154 packet.type = SR_DF_LOGIC;
155 packet.payload = &logic;
157 logic.unitsize = vdev->unitsize;
160 vdev->bytes_read += ret;
161 sr_session_send(sdi, &packet);
163 /* done with this capture file */
164 zip_fclose(vdev->capfile);
165 vdev->capfile = NULL;
166 if (vdev->cur_chunk != 0) {
167 /* There might be more chunks, so don't fall through
168 * to the SR_DF_END here. */
177 static int receive_data(int fd, int revents, void *cb_data)
179 struct sr_dev_inst *sdi;
180 struct session_vdev *vdev;
181 struct sr_datafeed_packet packet;
189 if (!vdev->finished && !stream_session_data(sdi))
190 vdev->finished = TRUE;
192 return G_SOURCE_CONTINUE;
195 zip_fclose(vdev->capfile);
196 vdev->capfile = NULL;
199 zip_discard(vdev->archive);
200 vdev->archive = NULL;
202 packet.type = SR_DF_END;
203 packet.payload = NULL;
204 sr_session_send(sdi, &packet);
206 return G_SOURCE_REMOVE;
209 /* driver callbacks */
211 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
213 return std_init(sr_ctx, di, LOG_PREFIX);
216 static int dev_clear(const struct sr_dev_driver *di)
218 struct drv_context *drvc;
222 for (l = drvc->instances; l; l = l->next)
223 sr_dev_inst_free(l->data);
224 g_slist_free(drvc->instances);
225 drvc->instances = NULL;
230 static int dev_open(struct sr_dev_inst *sdi)
232 struct sr_dev_driver *di;
233 struct drv_context *drvc;
234 struct session_vdev *vdev;
238 vdev = g_malloc0(sizeof(struct session_vdev));
240 drvc->instances = g_slist_append(drvc->instances, sdi);
245 static int dev_close(struct sr_dev_inst *sdi)
247 const struct session_vdev *const vdev = sdi->priv;
248 g_free(vdev->sessionfile);
249 g_free(vdev->capturefile);
257 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
258 const struct sr_channel_group *cg)
260 struct session_vdev *vdev;
270 case SR_CONF_SAMPLERATE:
271 *data = g_variant_new_uint64(vdev->samplerate);
273 case SR_CONF_CAPTURE_UNITSIZE:
274 *data = g_variant_new_uint64(vdev->unitsize);
283 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
284 const struct sr_channel_group *cg)
286 struct session_vdev *vdev;
293 case SR_CONF_SAMPLERATE:
294 vdev->samplerate = g_variant_get_uint64(data);
295 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
297 case SR_CONF_SESSIONFILE:
298 g_free(vdev->sessionfile);
299 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
300 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
302 case SR_CONF_CAPTUREFILE:
303 g_free(vdev->capturefile);
304 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
305 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
307 case SR_CONF_CAPTURE_UNITSIZE:
308 vdev->unitsize = g_variant_get_uint64(data);
310 case SR_CONF_NUM_LOGIC_CHANNELS:
311 vdev->num_channels = g_variant_get_int32(data);
313 case SR_CONF_NUM_ANALOG_CHANNELS:
314 vdev->num_analog_channels = g_variant_get_int32(data);
323 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
324 const struct sr_channel_group *cg)
330 case SR_CONF_DEVICE_OPTIONS:
331 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
332 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
341 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
343 struct session_vdev *vdev;
346 struct sr_channel *ch;
351 vdev->bytes_read = 0;
352 vdev->cur_analog_channel = 0;
353 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
354 sizeof(struct sr_channel *), vdev->num_analog_channels);
355 for (l = sdi->channels; l; l = l->next) {
357 if (ch->type == SR_CHANNEL_ANALOG)
358 g_array_append_val(vdev->analog_channels, ch);
361 vdev->finished = FALSE;
363 sr_info("Opening archive %s file %s", vdev->sessionfile,
366 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
367 sr_err("Failed to open session file '%s': "
368 "zip error %d.", vdev->sessionfile, ret);
372 /* Send header packet to the session bus. */
373 std_session_send_df_header(sdi, LOG_PREFIX);
375 /* freewheeling source */
376 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
381 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
383 struct session_vdev *vdev;
388 vdev->finished = TRUE;
394 SR_PRIV struct sr_dev_driver session_driver = {
395 .name = "virtual-session",
396 .longname = "Session-emulating driver",
399 .cleanup = dev_clear,
402 .dev_clear = dev_clear,
403 .config_get = config_get,
404 .config_set = config_set,
405 .config_list = config_list,
406 .dev_open = dev_open,
407 .dev_close = dev_close,
408 .dev_acquisition_start = dev_acquisition_start,
409 .dev_acquisition_stop = dev_acquisition_stop,