]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
Change type of SR_CONF keys to uint32_t.
[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
20#include <sys/types.h>
21#include <sys/stat.h>
22#include <fcntl.h>
23#include <unistd.h>
24#include <sys/time.h>
25#include <zip.h>
45c59c8b
BV
26#include "libsigrok.h"
27#include "libsigrok-internal.h"
7d658874 28
3544f848 29#define LOG_PREFIX "virtual-session"
a885ce3e 30
7d658874 31/* size of payloads sent across the session bus */
b4bd7088 32/** @cond PRIVATE */
8ff6afc9 33#define CHUNKSIZE (512 * 1024)
b4bd7088 34/** @endcond */
7d658874 35
102f1239
BV
36SR_PRIV struct sr_dev_driver session_driver_info;
37static struct sr_dev_driver *di = &session_driver_info;
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;
f438e0c9 48 int cur_chunk;
aa48adf9 49 gboolean finished;
7d658874
BV
50};
51
584560f1 52static const uint32_t hwcaps[] = {
1953564a
BV
53 SR_CONF_CAPTUREFILE,
54 SR_CONF_CAPTURE_UNITSIZE,
aa48adf9 55 SR_CONF_SAMPLERATE,
7d658874
BV
56};
57
9289e273 58static int receive_data(int fd, int revents, void *cb_data)
7d658874 59{
d68e2d1a 60 struct sr_dev_inst *sdi;
bb7ef793 61 struct session_vdev *vdev;
7d658874 62 struct sr_datafeed_packet packet;
9c939c51 63 struct sr_datafeed_logic logic;
f438e0c9 64 struct zip_stat zs;
7d658874 65 int ret, got_data;
f438e0c9
BV
66 char capturefile[16];
67 void *buf;
7d658874 68
cb93f8a9
UH
69 (void)fd;
70 (void)revents;
7d658874 71
102f1239 72 sdi = cb_data;
7d658874 73 got_data = FALSE;
102f1239
BV
74 vdev = sdi->priv;
75 if (!vdev->finished) {
f438e0c9
BV
76 if (!vdev->capfile) {
77 /* No capture file opened yet, or finished with the last
78 * chunked one. */
79 if (vdev->cur_chunk == 0) {
80 /* capturefile is always the unchunked base name. */
81 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
82 /* No chunks, just a single capture file. */
83 vdev->cur_chunk = 0;
84 if (!(vdev->capfile = zip_fopen(vdev->archive,
85 vdev->capturefile, 0)))
86 return FALSE;
87 sr_dbg("Opened %s.", vdev->capturefile);
88 } else {
89 /* Try as first chunk filename. */
90 snprintf(capturefile, 15, "%s-1", vdev->capturefile);
91 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
92 vdev->cur_chunk = 1;
93 if (!(vdev->capfile = zip_fopen(vdev->archive,
94 capturefile, 0)))
95 return FALSE;
96 sr_dbg("Opened %s.", capturefile);
97 } else {
98 sr_err("No capture file '%s' in " "session file '%s'.",
99 vdev->capturefile, vdev->sessionfile);
100 return FALSE;
101 }
102 }
103 } else {
104 /* Capture data is chunked, advance to the next chunk. */
105 vdev->cur_chunk++;
106 snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
107 vdev->cur_chunk);
108 if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
109 if (!(vdev->capfile = zip_fopen(vdev->archive,
110 capturefile, 0)))
111 return FALSE;
112 sr_dbg("Opened %s.", capturefile);
113 } else {
114 /* We got all the chunks, finish up. */
aa48adf9 115 vdev->finished = TRUE;
102f1239 116 return TRUE;
f438e0c9
BV
117 }
118 }
119 }
120
016f2e00
BV
121 if (!(buf = g_try_malloc(CHUNKSIZE))) {
122 sr_err("%s: buf malloc failed", __func__);
123 return FALSE;
124 }
125
8bbdd364
DE
126 ret = zip_fread(vdev->capfile, buf,
127 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
7d658874 128 if (ret > 0) {
8bbdd364
DE
129 if (ret % vdev->unitsize != 0)
130 sr_warn("Read size %d not a multiple of the"
131 " unit size %d.", ret, vdev->unitsize);
7d658874
BV
132 got_data = TRUE;
133 packet.type = SR_DF_LOGIC;
9c939c51
BV
134 packet.payload = &logic;
135 logic.length = ret;
bb7ef793 136 logic.unitsize = vdev->unitsize;
9c939c51 137 logic.data = buf;
bb7ef793 138 vdev->bytes_read += ret;
102f1239 139 sr_session_send(sdi, &packet);
7d658874
BV
140 } else {
141 /* done with this capture file */
bb7ef793 142 zip_fclose(vdev->capfile);
f438e0c9
BV
143 vdev->capfile = NULL;
144 if (vdev->cur_chunk == 0) {
145 /* It was the only file. */
aa48adf9 146 vdev->finished = TRUE;
f438e0c9
BV
147 } else {
148 /* There might be more chunks, so don't fall through
149 * to the SR_DF_END here. */
016f2e00 150 g_free(buf);
f438e0c9
BV
151 return TRUE;
152 }
7d658874 153 }
016f2e00 154 g_free(buf);
7d658874
BV
155 }
156
157 if (!got_data) {
158 packet.type = SR_DF_END;
102f1239
BV
159 sr_session_send(sdi, &packet);
160 sr_session_source_remove(sdi->session, -1);
7d658874
BV
161 }
162
163 return TRUE;
164}
165
166/* driver callbacks */
167
6078d2c9 168static int init(struct sr_context *sr_ctx)
7d658874 169{
102f1239 170 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
171}
172
824fba03 173static int dev_clear(void)
7d658874 174{
102f1239 175 struct drv_context *drvc;
7d658874
BV
176 GSList *l;
177
102f1239
BV
178 drvc = di->priv;
179 for (l = drvc->instances; l; l = l->next)
d3683c42 180 sr_dev_inst_free(l->data);
102f1239
BV
181 g_slist_free(drvc->instances);
182 drvc->instances = NULL;
805e9640 183
57ab7d9f 184 return SR_OK;
7d658874
BV
185}
186
6078d2c9 187static int dev_open(struct sr_dev_inst *sdi)
7d658874 188{
102f1239 189 struct drv_context *drvc;
aa48adf9 190 struct session_vdev *vdev;
b53738ba 191
102f1239
BV
192 drvc = di->priv;
193 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 194 sdi->priv = vdev;
102f1239 195 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
196
197 return SR_OK;
198}
199
aa48adf9
BV
200static int dev_close(struct sr_dev_inst *sdi)
201{
8c9d4d67
JH
202 const struct session_vdev *const vdev = sdi->priv;
203 g_free(vdev->sessionfile);
204 g_free(vdev->capturefile);
205
aa48adf9
BV
206 g_free(sdi->priv);
207 sdi->priv = NULL;
208
209 return SR_OK;
210}
211
584560f1 212static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 213 const struct sr_channel_group *cg)
7d658874 214{
bb7ef793 215 struct session_vdev *vdev;
7d658874 216
53b4680f 217 (void)cg;
8f996b89 218
584560f1 219 switch (key) {
123e1313 220 case SR_CONF_SAMPLERATE:
387014de
BV
221 if (sdi) {
222 vdev = sdi->priv;
003595ac 223 *data = g_variant_new_uint64(vdev->samplerate);
387014de
BV
224 } else
225 return SR_ERR;
226 break;
227 default:
96ea73db 228 return SR_ERR_NA;
387014de 229 }
7d658874 230
387014de 231 return SR_OK;
7d658874
BV
232}
233
584560f1 234static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 235 const struct sr_channel_group *cg)
7d658874 236{
bb7ef793 237 struct session_vdev *vdev;
7d658874 238
53b4680f 239 (void)cg;
8f996b89 240
6f4b1868 241 vdev = sdi->priv;
7d658874 242
584560f1 243 switch (key) {
1953564a 244 case SR_CONF_SAMPLERATE:
003595ac 245 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 246 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 247 break;
1953564a 248 case SR_CONF_SESSIONFILE:
8c9d4d67 249 g_free(vdev->sessionfile);
003595ac 250 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 251 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 252 break;
1953564a 253 case SR_CONF_CAPTUREFILE:
8c9d4d67 254 g_free(vdev->capturefile);
003595ac 255 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 256 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 257 break;
1953564a 258 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 259 vdev->unitsize = g_variant_get_uint64(data);
7d658874 260 break;
3f239f08 261 case SR_CONF_NUM_LOGIC_CHANNELS:
fca75cbb 262 vdev->num_channels = g_variant_get_uint64(data);
7d658874
BV
263 break;
264 default:
96ea73db 265 return SR_ERR_NA;
7d658874
BV
266 }
267
268 return SR_OK;
269}
270
584560f1 271static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 272 const struct sr_channel_group *cg)
9a6517d1 273{
9a6517d1 274 (void)sdi;
53b4680f 275 (void)cg;
9a6517d1
BV
276
277 switch (key) {
278 case SR_CONF_DEVICE_OPTIONS:
584560f1
BV
279 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
280 hwcaps, ARRAY_SIZE(hwcaps), sizeof(uint32_t));
9a6517d1
BV
281 break;
282 default:
96ea73db 283 return SR_ERR_NA;
9a6517d1
BV
284 }
285
286 return SR_OK;
287}
288
6078d2c9 289static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 290{
bb7ef793 291 struct session_vdev *vdev;
ebc34738 292 int ret;
7d658874 293
102f1239 294 (void)cb_data;
7d658874 295
102f1239 296 vdev = sdi->priv;
8c9d4d67
JH
297 vdev->bytes_read = 0;
298 vdev->cur_chunk = 0;
299 vdev->finished = FALSE;
300
a885ce3e 301 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 302 vdev->capturefile);
7d658874 303
40dda2c3 304 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 305 sr_err("Failed to open session file '%s': "
9d122af8 306 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
307 return SR_ERR;
308 }
309
4afdfd46 310 /* Send header packet to the session bus. */
102f1239 311 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 312
7d658874 313 /* freewheeling source */
102f1239 314 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 315
7d658874
BV
316 return SR_OK;
317}
318
b4bd7088 319/** @private */
c09f0b57 320SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 321 .name = "virtual-session",
5097b0d0
UH
322 .longname = "Session-emulating driver",
323 .api_version = 1,
6078d2c9 324 .init = init,
824fba03 325 .cleanup = dev_clear,
96ea73db
UH
326 .scan = NULL,
327 .dev_list = NULL,
824fba03 328 .dev_clear = dev_clear,
035a1078
BV
329 .config_get = config_get,
330 .config_set = config_set,
9a6517d1 331 .config_list = config_list,
6078d2c9 332 .dev_open = dev_open,
aa48adf9 333 .dev_close = dev_close,
6078d2c9 334 .dev_acquisition_start = dev_acquisition_start,
69040b7c 335 .dev_acquisition_stop = NULL,
96ea73db 336 .priv = NULL,
7d658874 337};