]>
Commit | Line | Data |
---|---|---|
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 | 37 | SR_PRIV struct sr_dev_driver session_driver_info; |
102f1239 | 38 | |
bb7ef793 | 39 | struct 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 | 55 | static 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 | 64 | static 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", | |
e5b280e4 | 120 | vdev->num_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 DE |
125 | /* We got all the chunks, finish up. */ |
126 | return FALSE; | |
f438e0c9 | 127 | } |
7d658874 BV |
128 | } |
129 | } | |
130 | ||
8d4097ff DE |
131 | buf = g_malloc(CHUNKSIZE); |
132 | ||
9cfc695f SA |
133 | /* unitsize is not defined for purely analog session files. */ |
134 | if (vdev->unitsize) | |
135 | ret = zip_fread(vdev->capfile, buf, | |
136 | CHUNKSIZE / vdev->unitsize * vdev->unitsize); | |
137 | else | |
138 | ret = zip_fread(vdev->capfile, buf, CHUNKSIZE); | |
139 | ||
8d4097ff | 140 | if (ret > 0) { |
8d4097ff | 141 | got_data = TRUE; |
2dc40815 | 142 | if (vdev->cur_analog_channel != 0) { |
6cdb1da6 | 143 | packet.type = SR_DF_ANALOG; |
2dc40815 | 144 | packet.payload = &analog; |
6cdb1da6 UH |
145 | sr_analog_init(&analog, &encoding, &meaning, &spec, 0); |
146 | analog.meaning->channels = g_slist_prepend(NULL, | |
2dc40815 ML |
147 | g_array_index(vdev->analog_channels, |
148 | struct sr_channel *, vdev->cur_analog_channel - 1)); | |
149 | analog.num_samples = ret / sizeof(float); | |
6cdb1da6 UH |
150 | analog.meaning->mq = SR_MQ_VOLTAGE; |
151 | analog.meaning->unit = SR_UNIT_VOLT; | |
152 | analog.meaning->mqflags = SR_MQFLAG_DC; | |
2dc40815 ML |
153 | analog.data = (float *) buf; |
154 | } else { | |
155 | if (ret % vdev->unitsize != 0) | |
156 | sr_warn("Read size %d not a multiple of the" | |
157 | " unit size %d.", ret, vdev->unitsize); | |
158 | packet.type = SR_DF_LOGIC; | |
159 | packet.payload = &logic; | |
160 | logic.length = ret; | |
161 | logic.unitsize = vdev->unitsize; | |
162 | logic.data = buf; | |
163 | } | |
8d4097ff | 164 | vdev->bytes_read += ret; |
102f1239 | 165 | sr_session_send(sdi, &packet); |
8d4097ff DE |
166 | } else { |
167 | /* done with this capture file */ | |
168 | zip_fclose(vdev->capfile); | |
169 | vdev->capfile = NULL; | |
170 | if (vdev->cur_chunk != 0) { | |
171 | /* There might be more chunks, so don't fall through | |
172 | * to the SR_DF_END here. */ | |
173 | got_data = TRUE; | |
174 | } | |
7d658874 | 175 | } |
8d4097ff | 176 | g_free(buf); |
7d658874 | 177 | |
8d4097ff DE |
178 | return got_data; |
179 | } | |
180 | ||
181 | static int receive_data(int fd, int revents, void *cb_data) | |
182 | { | |
183 | struct sr_dev_inst *sdi; | |
184 | struct session_vdev *vdev; | |
8d4097ff DE |
185 | |
186 | (void)fd; | |
187 | (void)revents; | |
188 | ||
189 | sdi = cb_data; | |
190 | vdev = sdi->priv; | |
191 | ||
192 | if (!vdev->finished && !stream_session_data(sdi)) | |
193 | vdev->finished = TRUE; | |
194 | if (!vdev->finished) | |
195 | return G_SOURCE_CONTINUE; | |
196 | ||
197 | if (vdev->capfile) { | |
198 | zip_fclose(vdev->capfile); | |
199 | vdev->capfile = NULL; | |
200 | } | |
201 | if (vdev->archive) { | |
202 | zip_discard(vdev->archive); | |
203 | vdev->archive = NULL; | |
204 | } | |
3be42bc2 | 205 | |
bee2b016 | 206 | std_session_send_df_end(sdi); |
8d4097ff DE |
207 | |
208 | return G_SOURCE_REMOVE; | |
7d658874 BV |
209 | } |
210 | ||
211 | /* driver callbacks */ | |
212 | ||
4f840ce9 | 213 | static int dev_clear(const struct sr_dev_driver *di) |
7d658874 | 214 | { |
102f1239 | 215 | struct drv_context *drvc; |
7d658874 BV |
216 | GSList *l; |
217 | ||
41812aca | 218 | drvc = di->context; |
102f1239 | 219 | for (l = drvc->instances; l; l = l->next) |
d3683c42 | 220 | sr_dev_inst_free(l->data); |
102f1239 BV |
221 | g_slist_free(drvc->instances); |
222 | drvc->instances = NULL; | |
805e9640 | 223 | |
57ab7d9f | 224 | return SR_OK; |
7d658874 BV |
225 | } |
226 | ||
6078d2c9 | 227 | static int dev_open(struct sr_dev_inst *sdi) |
7d658874 | 228 | { |
4f840ce9 | 229 | struct sr_dev_driver *di; |
102f1239 | 230 | struct drv_context *drvc; |
aa48adf9 | 231 | struct session_vdev *vdev; |
b53738ba | 232 | |
4f840ce9 | 233 | di = sdi->driver; |
41812aca | 234 | drvc = di->context; |
102f1239 | 235 | vdev = g_malloc0(sizeof(struct session_vdev)); |
aa48adf9 | 236 | sdi->priv = vdev; |
102f1239 | 237 | drvc->instances = g_slist_append(drvc->instances, sdi); |
7d658874 BV |
238 | |
239 | return SR_OK; | |
240 | } | |
241 | ||
aa48adf9 BV |
242 | static int dev_close(struct sr_dev_inst *sdi) |
243 | { | |
8c9d4d67 JH |
244 | const struct session_vdev *const vdev = sdi->priv; |
245 | g_free(vdev->sessionfile); | |
246 | g_free(vdev->capturefile); | |
247 | ||
aa48adf9 BV |
248 | g_free(sdi->priv); |
249 | sdi->priv = NULL; | |
250 | ||
251 | return SR_OK; | |
252 | } | |
253 | ||
584560f1 | 254 | static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, |
53b4680f | 255 | const struct sr_channel_group *cg) |
7d658874 | 256 | { |
bb7ef793 | 257 | struct session_vdev *vdev; |
7d658874 | 258 | |
53b4680f | 259 | (void)cg; |
8f996b89 | 260 | |
3f2cd87f UH |
261 | if (!sdi) |
262 | return SR_ERR; | |
263 | ||
264 | vdev = sdi->priv; | |
265 | ||
584560f1 | 266 | switch (key) { |
123e1313 | 267 | case SR_CONF_SAMPLERATE: |
3f2cd87f UH |
268 | *data = g_variant_new_uint64(vdev->samplerate); |
269 | break; | |
270 | case SR_CONF_CAPTURE_UNITSIZE: | |
271 | *data = g_variant_new_uint64(vdev->unitsize); | |
387014de BV |
272 | break; |
273 | default: | |
96ea73db | 274 | return SR_ERR_NA; |
387014de | 275 | } |
7d658874 | 276 | |
387014de | 277 | return SR_OK; |
7d658874 BV |
278 | } |
279 | ||
584560f1 | 280 | static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, |
53b4680f | 281 | const struct sr_channel_group *cg) |
7d658874 | 282 | { |
bb7ef793 | 283 | struct session_vdev *vdev; |
7d658874 | 284 | |
53b4680f | 285 | (void)cg; |
8f996b89 | 286 | |
6f4b1868 | 287 | vdev = sdi->priv; |
7d658874 | 288 | |
584560f1 | 289 | switch (key) { |
1953564a | 290 | case SR_CONF_SAMPLERATE: |
003595ac | 291 | vdev->samplerate = g_variant_get_uint64(data); |
a885ce3e | 292 | sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate); |
7d658874 | 293 | break; |
1953564a | 294 | case SR_CONF_SESSIONFILE: |
8c9d4d67 | 295 | g_free(vdev->sessionfile); |
003595ac | 296 | vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL)); |
a885ce3e | 297 | sr_info("Setting sessionfile to '%s'.", vdev->sessionfile); |
40dda2c3 | 298 | break; |
1953564a | 299 | case SR_CONF_CAPTUREFILE: |
8c9d4d67 | 300 | g_free(vdev->capturefile); |
003595ac | 301 | vdev->capturefile = g_strdup(g_variant_get_string(data, NULL)); |
a885ce3e | 302 | sr_info("Setting capturefile to '%s'.", vdev->capturefile); |
7d658874 | 303 | break; |
1953564a | 304 | case SR_CONF_CAPTURE_UNITSIZE: |
003595ac | 305 | vdev->unitsize = g_variant_get_uint64(data); |
7d658874 | 306 | break; |
3f239f08 | 307 | case SR_CONF_NUM_LOGIC_CHANNELS: |
2c38a41a | 308 | vdev->num_channels = g_variant_get_int32(data); |
7d658874 | 309 | break; |
b317d1bb ML |
310 | case SR_CONF_NUM_ANALOG_CHANNELS: |
311 | vdev->num_analog_channels = g_variant_get_int32(data); | |
312 | break; | |
7d658874 | 313 | default: |
96ea73db | 314 | return SR_ERR_NA; |
7d658874 BV |
315 | } |
316 | ||
317 | return SR_OK; | |
318 | } | |
319 | ||
584560f1 | 320 | static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, |
53b4680f | 321 | const struct sr_channel_group *cg) |
9a6517d1 | 322 | { |
9a6517d1 | 323 | (void)sdi; |
53b4680f | 324 | (void)cg; |
9a6517d1 BV |
325 | |
326 | switch (key) { | |
327 | case SR_CONF_DEVICE_OPTIONS: | |
584560f1 | 328 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, |
f254bc4b | 329 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); |
9a6517d1 BV |
330 | break; |
331 | default: | |
96ea73db | 332 | return SR_ERR_NA; |
9a6517d1 BV |
333 | } |
334 | ||
335 | return SR_OK; | |
336 | } | |
337 | ||
695dc859 | 338 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
7d658874 | 339 | { |
bb7ef793 | 340 | struct session_vdev *vdev; |
ebc34738 | 341 | int ret; |
2dc40815 ML |
342 | GSList *l; |
343 | struct sr_channel *ch; | |
7d658874 | 344 | |
102f1239 | 345 | vdev = sdi->priv; |
8c9d4d67 | 346 | vdev->bytes_read = 0; |
906921ba | 347 | vdev->cur_analog_channel = 0; |
2dc40815 ML |
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) { | |
351 | ch = l->data; | |
352 | if (ch->type == SR_CHANNEL_ANALOG) | |
353 | g_array_append_val(vdev->analog_channels, ch); | |
354 | } | |
8c9d4d67 JH |
355 | vdev->cur_chunk = 0; |
356 | vdev->finished = FALSE; | |
357 | ||
a885ce3e | 358 | sr_info("Opening archive %s file %s", vdev->sessionfile, |
bb7ef793 | 359 | vdev->capturefile); |
7d658874 | 360 | |
40dda2c3 | 361 | if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) { |
a885ce3e | 362 | sr_err("Failed to open session file '%s': " |
9d122af8 | 363 | "zip error %d.", vdev->sessionfile, ret); |
7d658874 BV |
364 | return SR_ERR; |
365 | } | |
366 | ||
bee2b016 | 367 | std_session_send_df_header(sdi); |
4afdfd46 | 368 | |
7d658874 | 369 | /* freewheeling source */ |
102f1239 | 370 | sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi); |
7d658874 | 371 | |
7d658874 BV |
372 | return SR_OK; |
373 | } | |
374 | ||
695dc859 | 375 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
8d4097ff DE |
376 | { |
377 | struct session_vdev *vdev; | |
378 | ||
8d4097ff DE |
379 | vdev = sdi->priv; |
380 | ||
381 | vdev->finished = TRUE; | |
382 | ||
383 | return SR_OK; | |
384 | } | |
385 | ||
b4bd7088 | 386 | /** @private */ |
c09f0b57 | 387 | SR_PRIV struct sr_dev_driver session_driver = { |
a885ce3e | 388 | .name = "virtual-session", |
5097b0d0 UH |
389 | .longname = "Session-emulating driver", |
390 | .api_version = 1, | |
c2fdcc25 | 391 | .init = std_init, |
824fba03 | 392 | .cleanup = dev_clear, |
96ea73db UH |
393 | .scan = NULL, |
394 | .dev_list = NULL, | |
824fba03 | 395 | .dev_clear = dev_clear, |
035a1078 BV |
396 | .config_get = config_get, |
397 | .config_set = config_set, | |
9a6517d1 | 398 | .config_list = config_list, |
6078d2c9 | 399 | .dev_open = dev_open, |
aa48adf9 | 400 | .dev_close = dev_close, |
6078d2c9 | 401 | .dev_acquisition_start = dev_acquisition_start, |
8d4097ff | 402 | .dev_acquisition_stop = dev_acquisition_stop, |
41812aca | 403 | .context = NULL, |
7d658874 | 404 | }; |