]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
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 | ||
20 | #include <config.h> | |
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> | |
27 | #include <libsigrok/libsigrok.h> | |
28 | #include "libsigrok-internal.h" | |
29 | ||
30 | #define LOG_PREFIX "virtual-session" | |
31 | ||
32 | /* size of payloads sent across the session bus */ | |
33 | /** @cond PRIVATE */ | |
34 | #define CHUNKSIZE (4 * 1024 * 1024) | |
35 | /** @endcond */ | |
36 | ||
37 | SR_PRIV struct sr_dev_driver session_driver_info; | |
38 | ||
39 | struct session_vdev { | |
40 | char *sessionfile; | |
41 | char *capturefile; | |
42 | struct zip *archive; | |
43 | struct zip_file *capfile; | |
44 | int bytes_read; | |
45 | uint64_t samplerate; | |
46 | int unitsize; | |
47 | int num_logic_channels; | |
48 | int num_analog_channels; | |
49 | int cur_analog_channel; | |
50 | GArray *analog_channels; | |
51 | int cur_chunk; | |
52 | gboolean finished; | |
53 | }; | |
54 | ||
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, | |
62 | }; | |
63 | ||
64 | static gboolean stream_session_data(struct sr_dev_inst *sdi) | |
65 | { | |
66 | struct session_vdev *vdev; | |
67 | struct sr_datafeed_packet packet; | |
68 | struct sr_datafeed_logic logic; | |
69 | struct sr_datafeed_analog analog; | |
70 | struct sr_analog_encoding encoding; | |
71 | struct sr_analog_meaning meaning; | |
72 | struct sr_analog_spec spec; | |
73 | struct zip_stat zs; | |
74 | int ret, got_data; | |
75 | char capturefile[128]; | |
76 | void *buf; | |
77 | ||
78 | got_data = FALSE; | |
79 | vdev = sdi->priv; | |
80 | ||
81 | if (!vdev->capfile) { | |
82 | /* No capture file opened yet, or finished with the last | |
83 | * chunked one. */ | |
84 | if (vdev->capturefile && (vdev->cur_chunk == 0)) { | |
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); | |
93 | } else { | |
94 | /* Try as first chunk filename. */ | |
95 | snprintf(capturefile, sizeof(capturefile) - 1, "%s-1", vdev->capturefile); | |
96 | if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) { | |
97 | vdev->cur_chunk = 1; | |
98 | if (!(vdev->capfile = zip_fopen(vdev->archive, | |
99 | capturefile, 0))) | |
100 | return FALSE; | |
101 | sr_dbg("Opened %s.", capturefile); | |
102 | } else { | |
103 | sr_err("No capture file '%s' in " "session file '%s'.", | |
104 | vdev->capturefile, vdev->sessionfile); | |
105 | return FALSE; | |
106 | } | |
107 | } | |
108 | } else { | |
109 | /* Capture data is chunked, advance to the next chunk. */ | |
110 | vdev->cur_chunk++; | |
111 | snprintf(capturefile, sizeof(capturefile) - 1, "%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); | |
118 | } else if (vdev->cur_analog_channel < vdev->num_analog_channels) { | |
119 | vdev->capturefile = g_strdup_printf("analog-1-%d", | |
120 | vdev->num_logic_channels + vdev->cur_analog_channel + 1); | |
121 | vdev->cur_analog_channel++; | |
122 | vdev->cur_chunk = 0; | |
123 | return TRUE; | |
124 | } else { | |
125 | /* We got all the chunks, finish up. */ | |
126 | g_free(vdev->capturefile); | |
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; | |
138 | return FALSE; | |
139 | } | |
140 | } | |
141 | } | |
142 | ||
143 | buf = g_malloc(CHUNKSIZE); | |
144 | ||
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 | ||
152 | if (ret > 0) { | |
153 | if (vdev->cur_analog_channel != 0) { | |
154 | got_data = TRUE; | |
155 | packet.type = SR_DF_ANALOG; | |
156 | packet.payload = &analog; | |
157 | /* TODO: Use proper 'digits' value for this device (and its modes). */ | |
158 | sr_analog_init(&analog, &encoding, &meaning, &spec, 2); | |
159 | analog.meaning->channels = g_slist_prepend(NULL, | |
160 | g_array_index(vdev->analog_channels, | |
161 | struct sr_channel *, vdev->cur_analog_channel - 1)); | |
162 | analog.num_samples = ret / sizeof(float); | |
163 | analog.meaning->mq = SR_MQ_VOLTAGE; | |
164 | analog.meaning->unit = SR_UNIT_VOLT; | |
165 | analog.meaning->mqflags = SR_MQFLAG_DC; | |
166 | analog.data = (float *) buf; | |
167 | } else if (vdev->unitsize) { | |
168 | got_data = TRUE; | |
169 | if (ret % vdev->unitsize != 0) | |
170 | sr_warn("Read size %d not a multiple of the" | |
171 | " unit size %d.", ret, vdev->unitsize); | |
172 | packet.type = SR_DF_LOGIC; | |
173 | packet.payload = &logic; | |
174 | logic.length = ret; | |
175 | logic.unitsize = vdev->unitsize; | |
176 | logic.data = buf; | |
177 | } else { | |
178 | /* | |
179 | * Neither analog data, nor logic which has | |
180 | * unitsize, must be an unexpected API use. | |
181 | */ | |
182 | sr_warn("Neither analog nor logic data. Ignoring."); | |
183 | } | |
184 | if (got_data) { | |
185 | vdev->bytes_read += ret; | |
186 | sr_session_send(sdi, &packet); | |
187 | } | |
188 | } else { | |
189 | /* done with this capture file */ | |
190 | zip_fclose(vdev->capfile); | |
191 | vdev->capfile = NULL; | |
192 | if (vdev->cur_chunk != 0) { | |
193 | /* There might be more chunks, so don't fall through | |
194 | * to the SR_DF_END here. */ | |
195 | got_data = TRUE; | |
196 | } | |
197 | } | |
198 | g_free(buf); | |
199 | ||
200 | return got_data; | |
201 | } | |
202 | ||
203 | static int receive_data(int fd, int revents, void *cb_data) | |
204 | { | |
205 | struct sr_dev_inst *sdi; | |
206 | struct session_vdev *vdev; | |
207 | ||
208 | (void)fd; | |
209 | (void)revents; | |
210 | ||
211 | sdi = cb_data; | |
212 | vdev = sdi->priv; | |
213 | ||
214 | if (!vdev->finished && !stream_session_data(sdi)) | |
215 | vdev->finished = TRUE; | |
216 | if (!vdev->finished) | |
217 | return G_SOURCE_CONTINUE; | |
218 | ||
219 | if (vdev->capfile) { | |
220 | zip_fclose(vdev->capfile); | |
221 | vdev->capfile = NULL; | |
222 | } | |
223 | if (vdev->archive) { | |
224 | zip_discard(vdev->archive); | |
225 | vdev->archive = NULL; | |
226 | } | |
227 | ||
228 | std_session_send_df_end(sdi); | |
229 | ||
230 | return G_SOURCE_REMOVE; | |
231 | } | |
232 | ||
233 | /* driver callbacks */ | |
234 | ||
235 | static int dev_open(struct sr_dev_inst *sdi) | |
236 | { | |
237 | struct sr_dev_driver *di; | |
238 | struct drv_context *drvc; | |
239 | struct session_vdev *vdev; | |
240 | ||
241 | di = sdi->driver; | |
242 | drvc = di->context; | |
243 | vdev = g_malloc0(sizeof(struct session_vdev)); | |
244 | sdi->priv = vdev; | |
245 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
246 | ||
247 | return SR_OK; | |
248 | } | |
249 | ||
250 | static int dev_close(struct sr_dev_inst *sdi) | |
251 | { | |
252 | const struct session_vdev *const vdev = sdi->priv; | |
253 | g_free(vdev->sessionfile); | |
254 | g_free(vdev->capturefile); | |
255 | ||
256 | g_free(sdi->priv); | |
257 | sdi->priv = NULL; | |
258 | ||
259 | return SR_OK; | |
260 | } | |
261 | ||
262 | static int config_get(uint32_t key, GVariant **data, | |
263 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
264 | { | |
265 | struct session_vdev *vdev; | |
266 | ||
267 | (void)cg; | |
268 | ||
269 | if (!sdi) | |
270 | return SR_ERR; | |
271 | ||
272 | vdev = sdi->priv; | |
273 | ||
274 | switch (key) { | |
275 | case SR_CONF_SAMPLERATE: | |
276 | *data = g_variant_new_uint64(vdev->samplerate); | |
277 | break; | |
278 | case SR_CONF_CAPTURE_UNITSIZE: | |
279 | *data = g_variant_new_uint64(vdev->unitsize); | |
280 | break; | |
281 | default: | |
282 | return SR_ERR_NA; | |
283 | } | |
284 | ||
285 | return SR_OK; | |
286 | } | |
287 | ||
288 | static int config_set(uint32_t key, GVariant *data, | |
289 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
290 | { | |
291 | struct session_vdev *vdev; | |
292 | ||
293 | (void)cg; | |
294 | ||
295 | vdev = sdi->priv; | |
296 | ||
297 | switch (key) { | |
298 | case SR_CONF_SAMPLERATE: | |
299 | vdev->samplerate = g_variant_get_uint64(data); | |
300 | sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate); | |
301 | break; | |
302 | case SR_CONF_SESSIONFILE: | |
303 | g_free(vdev->sessionfile); | |
304 | vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL)); | |
305 | sr_info("Setting sessionfile to '%s'.", vdev->sessionfile); | |
306 | break; | |
307 | case SR_CONF_CAPTUREFILE: | |
308 | g_free(vdev->capturefile); | |
309 | vdev->capturefile = g_strdup(g_variant_get_string(data, NULL)); | |
310 | sr_info("Setting capturefile to '%s'.", vdev->capturefile); | |
311 | break; | |
312 | case SR_CONF_CAPTURE_UNITSIZE: | |
313 | vdev->unitsize = g_variant_get_uint64(data); | |
314 | break; | |
315 | case SR_CONF_NUM_LOGIC_CHANNELS: | |
316 | vdev->num_logic_channels = g_variant_get_int32(data); | |
317 | break; | |
318 | case SR_CONF_NUM_ANALOG_CHANNELS: | |
319 | vdev->num_analog_channels = g_variant_get_int32(data); | |
320 | break; | |
321 | default: | |
322 | return SR_ERR_NA; | |
323 | } | |
324 | ||
325 | return SR_OK; | |
326 | } | |
327 | ||
328 | static int config_list(uint32_t key, GVariant **data, | |
329 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
330 | { | |
331 | return STD_CONFIG_LIST(key, data, sdi, cg, NULL, NULL, devopts); | |
332 | } | |
333 | ||
334 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
335 | { | |
336 | struct session_vdev *vdev; | |
337 | int ret; | |
338 | GSList *l; | |
339 | struct sr_channel *ch; | |
340 | ||
341 | vdev = sdi->priv; | |
342 | vdev->bytes_read = 0; | |
343 | vdev->cur_analog_channel = 0; | |
344 | vdev->analog_channels = g_array_sized_new(FALSE, FALSE, | |
345 | sizeof(struct sr_channel *), vdev->num_analog_channels); | |
346 | for (l = sdi->channels; l; l = l->next) { | |
347 | ch = l->data; | |
348 | if (ch->type == SR_CHANNEL_ANALOG) | |
349 | g_array_append_val(vdev->analog_channels, ch); | |
350 | } | |
351 | vdev->cur_chunk = 0; | |
352 | vdev->finished = FALSE; | |
353 | ||
354 | sr_info("Opening archive %s file %s", vdev->sessionfile, | |
355 | vdev->capturefile); | |
356 | ||
357 | if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) { | |
358 | sr_err("Failed to open session file '%s': " | |
359 | "zip error %d.", vdev->sessionfile, ret); | |
360 | return SR_ERR; | |
361 | } | |
362 | ||
363 | std_session_send_df_header(sdi); | |
364 | ||
365 | /* freewheeling source */ | |
366 | sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi); | |
367 | ||
368 | return SR_OK; | |
369 | } | |
370 | ||
371 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) | |
372 | { | |
373 | struct session_vdev *vdev; | |
374 | ||
375 | vdev = sdi->priv; | |
376 | ||
377 | vdev->finished = TRUE; | |
378 | ||
379 | return SR_OK; | |
380 | } | |
381 | ||
382 | /** @private */ | |
383 | SR_PRIV struct sr_dev_driver session_driver = { | |
384 | .name = "virtual-session", | |
385 | .longname = "Session-emulating driver", | |
386 | .api_version = 1, | |
387 | .init = std_init, | |
388 | .cleanup = std_cleanup, | |
389 | .scan = NULL, | |
390 | .dev_list = NULL, | |
391 | .dev_clear = std_dev_clear, | |
392 | .config_get = config_get, | |
393 | .config_set = config_set, | |
394 | .config_list = config_list, | |
395 | .dev_open = dev_open, | |
396 | .dev_close = dev_close, | |
397 | .dev_acquisition_start = dev_acquisition_start, | |
398 | .dev_acquisition_stop = dev_acquisition_stop, | |
399 | .context = NULL, | |
400 | }; |