]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
Drop unneeded std_session_send_df_header() comments.
[libsigrok.git] / src / session_driver.c
CommitLineData
7d658874 1/*
50985c20 2 * This file is part of the libsigrok project.
7d658874 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7d658874
BV
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
6ec6c43b 20#include <config.h>
7d658874
BV
21#include <sys/types.h>
22#include <sys/stat.h>
23#include <fcntl.h>
24#include <unistd.h>
25#include <sys/time.h>
26#include <zip.h>
c1aae900 27#include <libsigrok/libsigrok.h>
45c59c8b 28#include "libsigrok-internal.h"
7d658874 29
3544f848 30#define LOG_PREFIX "virtual-session"
a885ce3e 31
7d658874 32/* size of payloads sent across the session bus */
b4bd7088 33/** @cond PRIVATE */
8ff6afc9 34#define CHUNKSIZE (512 * 1024)
b4bd7088 35/** @endcond */
7d658874 36
102f1239 37SR_PRIV struct sr_dev_driver session_driver_info;
102f1239 38
bb7ef793 39struct session_vdev {
40dda2c3 40 char *sessionfile;
7d658874
BV
41 char *capturefile;
42 struct zip *archive;
43 struct zip_file *capfile;
cb1e389c 44 int bytes_read;
7d658874
BV
45 uint64_t samplerate;
46 int unitsize;
fca75cbb 47 int num_channels;
b317d1bb 48 int num_analog_channels;
906921ba 49 int cur_analog_channel;
2dc40815 50 GArray *analog_channels;
f438e0c9 51 int cur_chunk;
aa48adf9 52 gboolean finished;
7d658874
BV
53};
54
f254bc4b 55static const uint32_t devopts[] = {
68ac991d
BV
56 SR_CONF_CAPTUREFILE | SR_CONF_SET,
57 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 58 SR_CONF_NUM_LOGIC_CHANNELS | SR_CONF_SET,
b317d1bb 59 SR_CONF_NUM_ANALOG_CHANNELS | SR_CONF_SET,
68ac991d 60 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
02e49ae5 61 SR_CONF_SESSIONFILE | SR_CONF_SET,
7d658874
BV
62};
63
8d4097ff 64static gboolean stream_session_data(struct sr_dev_inst *sdi)
7d658874 65{
bb7ef793 66 struct session_vdev *vdev;
7d658874 67 struct sr_datafeed_packet packet;
9c939c51 68 struct sr_datafeed_logic logic;
2dc40815 69 struct sr_datafeed_analog_old analog;
f438e0c9 70 struct zip_stat zs;
7d658874 71 int ret, got_data;
f438e0c9
BV
72 char capturefile[16];
73 void *buf;
7d658874 74
7d658874 75 got_data = FALSE;
102f1239 76 vdev = sdi->priv;
7c69b528 77
8d4097ff
DE
78 if (!vdev->capfile) {
79 /* No capture file opened yet, or finished with the last
80 * chunked one. */
7c69b528 81 if (vdev->capturefile && (vdev->cur_chunk == 0)) {
8d4097ff
DE
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. */
85 vdev->cur_chunk = 0;
86 if (!(vdev->capfile = zip_fopen(vdev->archive,
87 vdev->capturefile, 0)))
88 return FALSE;
89 sr_dbg("Opened %s.", vdev->capturefile);
f438e0c9 90 } else {
8d4097ff
DE
91 /* Try as first chunk filename. */
92 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
f438e0c9 93 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
8d4097ff 94 vdev->cur_chunk = 1;
f438e0c9
BV
95 if (!(vdev->capfile = zip_fopen(vdev->archive,
96 capturefile, 0)))
97 return FALSE;
98 sr_dbg("Opened %s.", capturefile);
99 } else {
8d4097ff
DE
100 sr_err("No capture file '%s' in " "session file '%s'.",
101 vdev->capturefile, vdev->sessionfile);
102 return FALSE;
f438e0c9
BV
103 }
104 }
7d658874 105 } else {
8d4097ff
DE
106 /* Capture data is chunked, advance to the next chunk. */
107 vdev->cur_chunk++;
108 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
109 vdev->cur_chunk);
110 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
111 if (!(vdev->capfile = zip_fopen(vdev->archive,
112 capturefile, 0)))
113 return FALSE;
114 sr_dbg("Opened %s.", capturefile);
906921ba
ML
115 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
116 vdev->capturefile = g_strdup_printf("analog-1-%d",
e5b280e4 117 vdev->num_channels + vdev->cur_analog_channel + 1);
906921ba
ML
118 vdev->cur_analog_channel++;
119 vdev->cur_chunk = 0;
120 return TRUE;
f438e0c9 121 } else {
8d4097ff
DE
122 /* We got all the chunks, finish up. */
123 return FALSE;
f438e0c9 124 }
7d658874
BV
125 }
126 }
127
8d4097ff
DE
128 buf = g_malloc(CHUNKSIZE);
129
9cfc695f
SA
130 /* unitsize is not defined for purely analog session files. */
131 if (vdev->unitsize)
132 ret = zip_fread(vdev->capfile, buf,
133 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
134 else
135 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
136
8d4097ff 137 if (ret > 0) {
8d4097ff 138 got_data = TRUE;
2dc40815
ML
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;
150 } else {
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;
156 logic.length = ret;
157 logic.unitsize = vdev->unitsize;
158 logic.data = buf;
159 }
8d4097ff 160 vdev->bytes_read += ret;
102f1239 161 sr_session_send(sdi, &packet);
8d4097ff
DE
162 } else {
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. */
169 got_data = TRUE;
170 }
7d658874 171 }
8d4097ff 172 g_free(buf);
7d658874 173
8d4097ff
DE
174 return got_data;
175}
176
177static int receive_data(int fd, int revents, void *cb_data)
178{
179 struct sr_dev_inst *sdi;
180 struct session_vdev *vdev;
8d4097ff
DE
181
182 (void)fd;
183 (void)revents;
184
185 sdi = cb_data;
186 vdev = sdi->priv;
187
188 if (!vdev->finished && !stream_session_data(sdi))
189 vdev->finished = TRUE;
190 if (!vdev->finished)
191 return G_SOURCE_CONTINUE;
192
193 if (vdev->capfile) {
194 zip_fclose(vdev->capfile);
195 vdev->capfile = NULL;
196 }
197 if (vdev->archive) {
198 zip_discard(vdev->archive);
199 vdev->archive = NULL;
200 }
3be42bc2
UH
201
202 std_session_send_df_end(sdi, LOG_PREFIX);
8d4097ff
DE
203
204 return G_SOURCE_REMOVE;
7d658874
BV
205}
206
207/* driver callbacks */
208
4f840ce9 209static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
7d658874 210{
102f1239 211 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
212}
213
4f840ce9 214static int dev_clear(const struct sr_dev_driver *di)
7d658874 215{
102f1239 216 struct drv_context *drvc;
7d658874
BV
217 GSList *l;
218
41812aca 219 drvc = di->context;
102f1239 220 for (l = drvc->instances; l; l = l->next)
d3683c42 221 sr_dev_inst_free(l->data);
102f1239
BV
222 g_slist_free(drvc->instances);
223 drvc->instances = NULL;
805e9640 224
57ab7d9f 225 return SR_OK;
7d658874
BV
226}
227
6078d2c9 228static int dev_open(struct sr_dev_inst *sdi)
7d658874 229{
4f840ce9 230 struct sr_dev_driver *di;
102f1239 231 struct drv_context *drvc;
aa48adf9 232 struct session_vdev *vdev;
b53738ba 233
4f840ce9 234 di = sdi->driver;
41812aca 235 drvc = di->context;
102f1239 236 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 237 sdi->priv = vdev;
102f1239 238 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
239
240 return SR_OK;
241}
242
aa48adf9
BV
243static int dev_close(struct sr_dev_inst *sdi)
244{
8c9d4d67
JH
245 const struct session_vdev *const vdev = sdi->priv;
246 g_free(vdev->sessionfile);
247 g_free(vdev->capturefile);
248
aa48adf9
BV
249 g_free(sdi->priv);
250 sdi->priv = NULL;
251
252 return SR_OK;
253}
254
584560f1 255static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 256 const struct sr_channel_group *cg)
7d658874 257{
bb7ef793 258 struct session_vdev *vdev;
7d658874 259
53b4680f 260 (void)cg;
8f996b89 261
3f2cd87f
UH
262 if (!sdi)
263 return SR_ERR;
264
265 vdev = sdi->priv;
266
584560f1 267 switch (key) {
123e1313 268 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
269 *data = g_variant_new_uint64(vdev->samplerate);
270 break;
271 case SR_CONF_CAPTURE_UNITSIZE:
272 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
273 break;
274 default:
96ea73db 275 return SR_ERR_NA;
387014de 276 }
7d658874 277
387014de 278 return SR_OK;
7d658874
BV
279}
280
584560f1 281static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 282 const struct sr_channel_group *cg)
7d658874 283{
bb7ef793 284 struct session_vdev *vdev;
7d658874 285
53b4680f 286 (void)cg;
8f996b89 287
6f4b1868 288 vdev = sdi->priv;
7d658874 289
584560f1 290 switch (key) {
1953564a 291 case SR_CONF_SAMPLERATE:
003595ac 292 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 293 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 294 break;
1953564a 295 case SR_CONF_SESSIONFILE:
8c9d4d67 296 g_free(vdev->sessionfile);
003595ac 297 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 298 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 299 break;
1953564a 300 case SR_CONF_CAPTUREFILE:
8c9d4d67 301 g_free(vdev->capturefile);
003595ac 302 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 303 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 304 break;
1953564a 305 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 306 vdev->unitsize = g_variant_get_uint64(data);
7d658874 307 break;
3f239f08 308 case SR_CONF_NUM_LOGIC_CHANNELS:
2c38a41a 309 vdev->num_channels = g_variant_get_int32(data);
7d658874 310 break;
b317d1bb
ML
311 case SR_CONF_NUM_ANALOG_CHANNELS:
312 vdev->num_analog_channels = g_variant_get_int32(data);
313 break;
7d658874 314 default:
96ea73db 315 return SR_ERR_NA;
7d658874
BV
316 }
317
318 return SR_OK;
319}
320
584560f1 321static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 322 const struct sr_channel_group *cg)
9a6517d1 323{
9a6517d1 324 (void)sdi;
53b4680f 325 (void)cg;
9a6517d1
BV
326
327 switch (key) {
328 case SR_CONF_DEVICE_OPTIONS:
584560f1 329 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 330 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1
BV
331 break;
332 default:
96ea73db 333 return SR_ERR_NA;
9a6517d1
BV
334 }
335
336 return SR_OK;
337}
338
6078d2c9 339static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 340{
bb7ef793 341 struct session_vdev *vdev;
ebc34738 342 int ret;
2dc40815
ML
343 GSList *l;
344 struct sr_channel *ch;
7d658874 345
102f1239 346 (void)cb_data;
7d658874 347
102f1239 348 vdev = sdi->priv;
8c9d4d67 349 vdev->bytes_read = 0;
906921ba 350 vdev->cur_analog_channel = 0;
2dc40815
ML
351 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
352 sizeof(struct sr_channel *), vdev->num_analog_channels);
353 for (l = sdi->channels; l; l = l->next) {
354 ch = l->data;
355 if (ch->type == SR_CHANNEL_ANALOG)
356 g_array_append_val(vdev->analog_channels, ch);
357 }
8c9d4d67
JH
358 vdev->cur_chunk = 0;
359 vdev->finished = FALSE;
360
a885ce3e 361 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 362 vdev->capturefile);
7d658874 363
40dda2c3 364 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 365 sr_err("Failed to open session file '%s': "
9d122af8 366 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
367 return SR_ERR;
368 }
369
102f1239 370 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 371
7d658874 372 /* freewheeling source */
102f1239 373 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 374
7d658874
BV
375 return SR_OK;
376}
377
8d4097ff
DE
378static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
379{
380 struct session_vdev *vdev;
381
382 (void)cb_data;
383 vdev = sdi->priv;
384
385 vdev->finished = TRUE;
386
387 return SR_OK;
388}
389
b4bd7088 390/** @private */
c09f0b57 391SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 392 .name = "virtual-session",
5097b0d0
UH
393 .longname = "Session-emulating driver",
394 .api_version = 1,
6078d2c9 395 .init = init,
824fba03 396 .cleanup = dev_clear,
96ea73db
UH
397 .scan = NULL,
398 .dev_list = NULL,
824fba03 399 .dev_clear = dev_clear,
035a1078
BV
400 .config_get = config_get,
401 .config_set = config_set,
9a6517d1 402 .config_list = config_list,
6078d2c9 403 .dev_open = dev_open,
aa48adf9 404 .dev_close = dev_close,
6078d2c9 405 .dev_acquisition_start = dev_acquisition_start,
8d4097ff 406 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 407 .context = NULL,
7d658874 408};