]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
drivers: Add and use STD_CONFIG_LIST().
[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 */
df3e608a 34#define CHUNKSIZE (4 * 1024 * 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;
6fb5570b 47 int num_logic_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;
6cdb1da6
UH
69 struct sr_datafeed_analog analog;
70 struct sr_analog_encoding encoding;
71 struct sr_analog_meaning meaning;
72 struct sr_analog_spec spec;
f438e0c9 73 struct zip_stat zs;
7d658874 74 int ret, got_data;
f438e0c9
BV
75 char capturefile[16];
76 void *buf;
7d658874 77
7d658874 78 got_data = FALSE;
102f1239 79 vdev = sdi->priv;
7c69b528 80
8d4097ff
DE
81 if (!vdev->capfile) {
82 /* No capture file opened yet, or finished with the last
83 * chunked one. */
7c69b528 84 if (vdev->capturefile && (vdev->cur_chunk == 0)) {
8d4097ff
DE
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. */
88 vdev->cur_chunk = 0;
89 if (!(vdev->capfile = zip_fopen(vdev->archive,
90 vdev->capturefile, 0)))
91 return FALSE;
92 sr_dbg("Opened %s.", vdev->capturefile);
f438e0c9 93 } else {
8d4097ff
DE
94 /* Try as first chunk filename. */
95 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
f438e0c9 96 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
8d4097ff 97 vdev->cur_chunk = 1;
f438e0c9
BV
98 if (!(vdev->capfile = zip_fopen(vdev->archive,
99 capturefile, 0)))
100 return FALSE;
101 sr_dbg("Opened %s.", capturefile);
102 } else {
8d4097ff
DE
103 sr_err("No capture file '%s' in " "session file '%s'.",
104 vdev->capturefile, vdev->sessionfile);
105 return FALSE;
f438e0c9
BV
106 }
107 }
7d658874 108 } else {
8d4097ff
DE
109 /* Capture data is chunked, advance to the next chunk. */
110 vdev->cur_chunk++;
111 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
112 vdev->cur_chunk);
113 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
114 if (!(vdev->capfile = zip_fopen(vdev->archive,
115 capturefile, 0)))
116 return FALSE;
117 sr_dbg("Opened %s.", capturefile);
906921ba
ML
118 } else if (vdev->cur_analog_channel < vdev->num_analog_channels) {
119 vdev->capturefile = g_strdup_printf("analog-1-%d",
6fb5570b 120 vdev->num_logic_channels + vdev->cur_analog_channel + 1);
906921ba
ML
121 vdev->cur_analog_channel++;
122 vdev->cur_chunk = 0;
123 return TRUE;
f438e0c9 124 } else {
8d4097ff 125 /* We got all the chunks, finish up. */
b7939d7c 126 g_free(vdev->capturefile);
16a1d50a
SA
127
128 /* If the file has logic channels, the initial value for
129 * capturefile is set by stream_session_data() - however only
130 * once. In order to not mess this mechanism up, we simulate
131 * this here if needed. For purely analog files, capturefile
132 * is not set.
133 */
134 if (vdev->num_logic_channels)
135 vdev->capturefile = g_strdup("logic-1");
136 else
137 vdev->capturefile = NULL;
8d4097ff 138 return FALSE;
f438e0c9 139 }
7d658874
BV
140 }
141 }
142
8d4097ff
DE
143 buf = g_malloc(CHUNKSIZE);
144
9cfc695f
SA
145 /* unitsize is not defined for purely analog session files. */
146 if (vdev->unitsize)
147 ret = zip_fread(vdev->capfile, buf,
148 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
149 else
150 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
151
8d4097ff 152 if (ret > 0) {
8d4097ff 153 got_data = TRUE;
2dc40815 154 if (vdev->cur_analog_channel != 0) {
6cdb1da6 155 packet.type = SR_DF_ANALOG;
2dc40815 156 packet.payload = &analog;
7dcaddd3
UH
157 /* TODO: Use proper 'digits' value for this device (and its modes). */
158 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
6cdb1da6 159 analog.meaning->channels = g_slist_prepend(NULL,
2dc40815
ML
160 g_array_index(vdev->analog_channels,
161 struct sr_channel *, vdev->cur_analog_channel - 1));
162 analog.num_samples = ret / sizeof(float);
6cdb1da6
UH
163 analog.meaning->mq = SR_MQ_VOLTAGE;
164 analog.meaning->unit = SR_UNIT_VOLT;
165 analog.meaning->mqflags = SR_MQFLAG_DC;
2dc40815
ML
166 analog.data = (float *) buf;
167 } else {
168 if (ret % vdev->unitsize != 0)
169 sr_warn("Read size %d not a multiple of the"
170 " unit size %d.", ret, vdev->unitsize);
171 packet.type = SR_DF_LOGIC;
172 packet.payload = &logic;
173 logic.length = ret;
174 logic.unitsize = vdev->unitsize;
175 logic.data = buf;
176 }
8d4097ff 177 vdev->bytes_read += ret;
102f1239 178 sr_session_send(sdi, &packet);
8d4097ff
DE
179 } else {
180 /* done with this capture file */
181 zip_fclose(vdev->capfile);
182 vdev->capfile = NULL;
183 if (vdev->cur_chunk != 0) {
184 /* There might be more chunks, so don't fall through
185 * to the SR_DF_END here. */
186 got_data = TRUE;
187 }
7d658874 188 }
8d4097ff 189 g_free(buf);
7d658874 190
8d4097ff
DE
191 return got_data;
192}
193
194static int receive_data(int fd, int revents, void *cb_data)
195{
196 struct sr_dev_inst *sdi;
197 struct session_vdev *vdev;
8d4097ff
DE
198
199 (void)fd;
200 (void)revents;
201
202 sdi = cb_data;
203 vdev = sdi->priv;
204
205 if (!vdev->finished && !stream_session_data(sdi))
206 vdev->finished = TRUE;
207 if (!vdev->finished)
208 return G_SOURCE_CONTINUE;
209
210 if (vdev->capfile) {
211 zip_fclose(vdev->capfile);
212 vdev->capfile = NULL;
213 }
214 if (vdev->archive) {
215 zip_discard(vdev->archive);
216 vdev->archive = NULL;
217 }
3be42bc2 218
bee2b016 219 std_session_send_df_end(sdi);
8d4097ff
DE
220
221 return G_SOURCE_REMOVE;
7d658874
BV
222}
223
224/* driver callbacks */
225
6078d2c9 226static int dev_open(struct sr_dev_inst *sdi)
7d658874 227{
4f840ce9 228 struct sr_dev_driver *di;
102f1239 229 struct drv_context *drvc;
aa48adf9 230 struct session_vdev *vdev;
b53738ba 231
4f840ce9 232 di = sdi->driver;
41812aca 233 drvc = di->context;
102f1239 234 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 235 sdi->priv = vdev;
102f1239 236 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
237
238 return SR_OK;
239}
240
aa48adf9
BV
241static int dev_close(struct sr_dev_inst *sdi)
242{
8c9d4d67
JH
243 const struct session_vdev *const vdev = sdi->priv;
244 g_free(vdev->sessionfile);
245 g_free(vdev->capturefile);
246
aa48adf9
BV
247 g_free(sdi->priv);
248 sdi->priv = NULL;
249
250 return SR_OK;
251}
252
584560f1 253static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 254 const struct sr_channel_group *cg)
7d658874 255{
bb7ef793 256 struct session_vdev *vdev;
7d658874 257
53b4680f 258 (void)cg;
8f996b89 259
3f2cd87f
UH
260 if (!sdi)
261 return SR_ERR;
262
263 vdev = sdi->priv;
264
584560f1 265 switch (key) {
123e1313 266 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
267 *data = g_variant_new_uint64(vdev->samplerate);
268 break;
269 case SR_CONF_CAPTURE_UNITSIZE:
270 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
271 break;
272 default:
96ea73db 273 return SR_ERR_NA;
387014de 274 }
7d658874 275
387014de 276 return SR_OK;
7d658874
BV
277}
278
584560f1 279static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 280 const struct sr_channel_group *cg)
7d658874 281{
bb7ef793 282 struct session_vdev *vdev;
7d658874 283
53b4680f 284 (void)cg;
8f996b89 285
6f4b1868 286 vdev = sdi->priv;
7d658874 287
584560f1 288 switch (key) {
1953564a 289 case SR_CONF_SAMPLERATE:
003595ac 290 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 291 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 292 break;
1953564a 293 case SR_CONF_SESSIONFILE:
8c9d4d67 294 g_free(vdev->sessionfile);
003595ac 295 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 296 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 297 break;
1953564a 298 case SR_CONF_CAPTUREFILE:
8c9d4d67 299 g_free(vdev->capturefile);
003595ac 300 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 301 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 302 break;
1953564a 303 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 304 vdev->unitsize = g_variant_get_uint64(data);
7d658874 305 break;
3f239f08 306 case SR_CONF_NUM_LOGIC_CHANNELS:
6fb5570b 307 vdev->num_logic_channels = g_variant_get_int32(data);
7d658874 308 break;
b317d1bb
ML
309 case SR_CONF_NUM_ANALOG_CHANNELS:
310 vdev->num_analog_channels = g_variant_get_int32(data);
311 break;
7d658874 312 default:
96ea73db 313 return SR_ERR_NA;
7d658874
BV
314 }
315
316 return SR_OK;
317}
318
584560f1 319static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 320 const struct sr_channel_group *cg)
9a6517d1 321{
e66d1892 322 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, NULL, devopts);
9a6517d1
BV
323}
324
695dc859 325static int dev_acquisition_start(const struct sr_dev_inst *sdi)
7d658874 326{
bb7ef793 327 struct session_vdev *vdev;
ebc34738 328 int ret;
2dc40815
ML
329 GSList *l;
330 struct sr_channel *ch;
7d658874 331
102f1239 332 vdev = sdi->priv;
8c9d4d67 333 vdev->bytes_read = 0;
906921ba 334 vdev->cur_analog_channel = 0;
2dc40815
ML
335 vdev->analog_channels = g_array_sized_new(FALSE, FALSE,
336 sizeof(struct sr_channel *), vdev->num_analog_channels);
337 for (l = sdi->channels; l; l = l->next) {
338 ch = l->data;
339 if (ch->type == SR_CHANNEL_ANALOG)
340 g_array_append_val(vdev->analog_channels, ch);
341 }
8c9d4d67
JH
342 vdev->cur_chunk = 0;
343 vdev->finished = FALSE;
344
a885ce3e 345 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 346 vdev->capturefile);
7d658874 347
40dda2c3 348 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 349 sr_err("Failed to open session file '%s': "
9d122af8 350 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
351 return SR_ERR;
352 }
353
bee2b016 354 std_session_send_df_header(sdi);
4afdfd46 355
7d658874 356 /* freewheeling source */
102f1239 357 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 358
7d658874
BV
359 return SR_OK;
360}
361
695dc859 362static int dev_acquisition_stop(struct sr_dev_inst *sdi)
8d4097ff
DE
363{
364 struct session_vdev *vdev;
365
8d4097ff
DE
366 vdev = sdi->priv;
367
368 vdev->finished = TRUE;
369
370 return SR_OK;
371}
372
b4bd7088 373/** @private */
c09f0b57 374SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 375 .name = "virtual-session",
5097b0d0
UH
376 .longname = "Session-emulating driver",
377 .api_version = 1,
c2fdcc25 378 .init = std_init,
b4fde527 379 .cleanup = std_cleanup,
96ea73db
UH
380 .scan = NULL,
381 .dev_list = NULL,
029b2042 382 .dev_clear = std_dev_clear,
035a1078
BV
383 .config_get = config_get,
384 .config_set = config_set,
9a6517d1 385 .config_list = config_list,
6078d2c9 386 .dev_open = dev_open,
aa48adf9 387 .dev_close = dev_close,
6078d2c9 388 .dev_acquisition_start = dev_acquisition_start,
8d4097ff 389 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 390 .context = NULL,
7d658874 391};