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;
78 /* No capture file opened yet, or finished with the last
80 if (vdev->cur_chunk == 0) {
81 /* capturefile is always the unchunked base name. */
82 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
83 /* No chunks, just a single capture file. */
85 if (!(vdev->capfile = zip_fopen(vdev->archive,
86 vdev->capturefile, 0)))
88 sr_dbg("Opened %s.", vdev->capturefile);
90 /* Try as first chunk filename. */
91 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
92 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
94 if (!(vdev->capfile = zip_fopen(vdev->archive,
97 sr_dbg("Opened %s.", capturefile);
99 sr_err("No capture file '%s' in " "session file '%s'.",
100 vdev->capturefile, vdev->sessionfile);
105 /* Capture data is chunked, advance to the next chunk. */
107 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
109 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
110 if (!(vdev->capfile = zip_fopen(vdev->archive,
113 sr_dbg("Opened %s.", capturefile);
114 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
115 vdev->capturefile = g_strdup_printf("analog-1-%d",
116 vdev->cur_analog_channel + 1);
117 vdev->cur_analog_channel++;
121 /* We got all the chunks, finish up. */
127 buf = g_malloc(CHUNKSIZE);
129 ret = zip_fread(vdev->capfile, buf,
130 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
133 if (vdev->cur_analog_channel != 0) {
134 packet.type = SR_DF_ANALOG_OLD;
135 packet.payload = &analog;
136 analog.channels = g_slist_prepend(NULL,
137 g_array_index(vdev->analog_channels,
138 struct sr_channel *, vdev->cur_analog_channel - 1));
139 analog.num_samples = ret / sizeof(float);
140 analog.mq = SR_MQ_VOLTAGE;
141 analog.unit = SR_UNIT_VOLT;
142 analog.mqflags = SR_MQFLAG_DC;
143 analog.data = (float *) buf;
145 if (ret % vdev->unitsize != 0)
146 sr_warn("Read size %d not a multiple of the"
147 " unit size %d.", ret, vdev->unitsize);
148 packet.type = SR_DF_LOGIC;
149 packet.payload = &logic;
151 logic.unitsize = vdev->unitsize;
154 vdev->bytes_read += ret;
155 sr_session_send(sdi, &packet);
157 /* done with this capture file */
158 zip_fclose(vdev->capfile);
159 vdev->capfile = NULL;
160 if (vdev->cur_chunk != 0) {
161 /* There might be more chunks, so don't fall through
162 * to the SR_DF_END here. */
171 static int receive_data(int fd, int revents, void *cb_data)
173 struct sr_dev_inst *sdi;
174 struct session_vdev *vdev;
175 struct sr_datafeed_packet packet;
183 if (!vdev->finished && !stream_session_data(sdi))
184 vdev->finished = TRUE;
186 return G_SOURCE_CONTINUE;
189 zip_fclose(vdev->capfile);
190 vdev->capfile = NULL;
193 zip_discard(vdev->archive);
194 vdev->archive = NULL;
196 packet.type = SR_DF_END;
197 packet.payload = NULL;
198 sr_session_send(sdi, &packet);
200 return G_SOURCE_REMOVE;
203 /* driver callbacks */
205 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
207 return std_init(sr_ctx, di, LOG_PREFIX);
210 static int dev_clear(const struct sr_dev_driver *di)
212 struct drv_context *drvc;
216 for (l = drvc->instances; l; l = l->next)
217 sr_dev_inst_free(l->data);
218 g_slist_free(drvc->instances);
219 drvc->instances = NULL;
224 static int dev_open(struct sr_dev_inst *sdi)
226 struct sr_dev_driver *di;
227 struct drv_context *drvc;
228 struct session_vdev *vdev;
232 vdev = g_malloc0(sizeof(struct session_vdev));
234 drvc->instances = g_slist_append(drvc->instances, sdi);
239 static int dev_close(struct sr_dev_inst *sdi)
241 const struct session_vdev *const vdev = sdi->priv;
242 g_free(vdev->sessionfile);
243 g_free(vdev->capturefile);
251 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
252 const struct sr_channel_group *cg)
254 struct session_vdev *vdev;
264 case SR_CONF_SAMPLERATE:
265 *data = g_variant_new_uint64(vdev->samplerate);
267 case SR_CONF_CAPTURE_UNITSIZE:
268 *data = g_variant_new_uint64(vdev->unitsize);
277 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
278 const struct sr_channel_group *cg)
280 struct session_vdev *vdev;
287 case SR_CONF_SAMPLERATE:
288 vdev->samplerate = g_variant_get_uint64(data);
289 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
291 case SR_CONF_SESSIONFILE:
292 g_free(vdev->sessionfile);
293 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
294 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
296 case SR_CONF_CAPTUREFILE:
297 g_free(vdev->capturefile);
298 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
299 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
301 case SR_CONF_CAPTURE_UNITSIZE:
302 vdev->unitsize = g_variant_get_uint64(data);
304 case SR_CONF_NUM_LOGIC_CHANNELS:
305 vdev->num_channels = g_variant_get_int32(data);
307 case SR_CONF_NUM_ANALOG_CHANNELS:
308 vdev->num_analog_channels = g_variant_get_int32(data);
317 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
318 const struct sr_channel_group *cg)
324 case SR_CONF_DEVICE_OPTIONS:
325 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
326 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
335 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
337 struct session_vdev *vdev;
340 struct sr_channel *ch;
345 vdev->bytes_read = 0;
346 vdev->cur_analog_channel = 0;
347 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
348 sizeof(struct sr_channel *), vdev->num_analog_channels);
349 for (l = sdi->channels; l; l = l->next) {
351 if (ch->type == SR_CHANNEL_ANALOG)
352 g_array_append_val(vdev->analog_channels, ch);
355 vdev->finished = FALSE;
357 sr_info("Opening archive %s file %s", vdev->sessionfile,
360 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
361 sr_err("Failed to open session file '%s': "
362 "zip error %d.", vdev->sessionfile, ret);
366 /* Send header packet to the session bus. */
367 std_session_send_df_header(sdi, LOG_PREFIX);
369 /* freewheeling source */
370 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
375 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
377 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,