]> sigrok.org Git - libsigrok.git/blame - src/session_driver.c
No need to check return value of libusb_get_device_descriptor().
[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;
f438e0c9 48 int cur_chunk;
aa48adf9 49 gboolean finished;
7d658874
BV
50};
51
f254bc4b 52static const uint32_t devopts[] = {
68ac991d
BV
53 SR_CONF_CAPTUREFILE | SR_CONF_SET,
54 SR_CONF_CAPTURE_UNITSIZE | SR_CONF_GET | SR_CONF_SET,
55 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET,
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
a95f142e 121 buf = g_malloc(CHUNKSIZE);
016f2e00 122
8bbdd364
DE
123 ret = zip_fread(vdev->capfile, buf,
124 CHUNKSIZE / vdev->unitsize * vdev->unitsize);
7d658874 125 if (ret > 0) {
8bbdd364
DE
126 if (ret % vdev->unitsize != 0)
127 sr_warn("Read size %d not a multiple of the"
128 " unit size %d.", ret, vdev->unitsize);
7d658874
BV
129 got_data = TRUE;
130 packet.type = SR_DF_LOGIC;
9c939c51
BV
131 packet.payload = &logic;
132 logic.length = ret;
bb7ef793 133 logic.unitsize = vdev->unitsize;
9c939c51 134 logic.data = buf;
bb7ef793 135 vdev->bytes_read += ret;
102f1239 136 sr_session_send(sdi, &packet);
7d658874
BV
137 } else {
138 /* done with this capture file */
bb7ef793 139 zip_fclose(vdev->capfile);
f438e0c9
BV
140 vdev->capfile = NULL;
141 if (vdev->cur_chunk == 0) {
142 /* It was the only file. */
aa48adf9 143 vdev->finished = TRUE;
f438e0c9
BV
144 } else {
145 /* There might be more chunks, so don't fall through
146 * to the SR_DF_END here. */
016f2e00 147 g_free(buf);
f438e0c9
BV
148 return TRUE;
149 }
7d658874 150 }
016f2e00 151 g_free(buf);
7d658874
BV
152 }
153
154 if (!got_data) {
155 packet.type = SR_DF_END;
102f1239
BV
156 sr_session_send(sdi, &packet);
157 sr_session_source_remove(sdi->session, -1);
7d658874
BV
158 }
159
160 return TRUE;
161}
162
163/* driver callbacks */
164
4f840ce9 165static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
7d658874 166{
102f1239 167 return std_init(sr_ctx, di, LOG_PREFIX);
7d658874
BV
168}
169
4f840ce9 170static int dev_clear(const struct sr_dev_driver *di)
7d658874 171{
102f1239 172 struct drv_context *drvc;
7d658874
BV
173 GSList *l;
174
41812aca 175 drvc = di->context;
102f1239 176 for (l = drvc->instances; l; l = l->next)
d3683c42 177 sr_dev_inst_free(l->data);
102f1239
BV
178 g_slist_free(drvc->instances);
179 drvc->instances = NULL;
805e9640 180
57ab7d9f 181 return SR_OK;
7d658874
BV
182}
183
6078d2c9 184static int dev_open(struct sr_dev_inst *sdi)
7d658874 185{
4f840ce9 186 struct sr_dev_driver *di;
102f1239 187 struct drv_context *drvc;
aa48adf9 188 struct session_vdev *vdev;
b53738ba 189
4f840ce9 190 di = sdi->driver;
41812aca 191 drvc = di->context;
102f1239 192 vdev = g_malloc0(sizeof(struct session_vdev));
aa48adf9 193 sdi->priv = vdev;
102f1239 194 drvc->instances = g_slist_append(drvc->instances, sdi);
7d658874
BV
195
196 return SR_OK;
197}
198
aa48adf9
BV
199static int dev_close(struct sr_dev_inst *sdi)
200{
8c9d4d67
JH
201 const struct session_vdev *const vdev = sdi->priv;
202 g_free(vdev->sessionfile);
203 g_free(vdev->capturefile);
204
aa48adf9
BV
205 g_free(sdi->priv);
206 sdi->priv = NULL;
207
208 return SR_OK;
209}
210
584560f1 211static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 212 const struct sr_channel_group *cg)
7d658874 213{
bb7ef793 214 struct session_vdev *vdev;
7d658874 215
53b4680f 216 (void)cg;
8f996b89 217
3f2cd87f
UH
218 if (!sdi)
219 return SR_ERR;
220
221 vdev = sdi->priv;
222
584560f1 223 switch (key) {
123e1313 224 case SR_CONF_SAMPLERATE:
3f2cd87f
UH
225 *data = g_variant_new_uint64(vdev->samplerate);
226 break;
227 case SR_CONF_CAPTURE_UNITSIZE:
228 *data = g_variant_new_uint64(vdev->unitsize);
387014de
BV
229 break;
230 default:
96ea73db 231 return SR_ERR_NA;
387014de 232 }
7d658874 233
387014de 234 return SR_OK;
7d658874
BV
235}
236
584560f1 237static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 238 const struct sr_channel_group *cg)
7d658874 239{
bb7ef793 240 struct session_vdev *vdev;
7d658874 241
53b4680f 242 (void)cg;
8f996b89 243
6f4b1868 244 vdev = sdi->priv;
7d658874 245
584560f1 246 switch (key) {
1953564a 247 case SR_CONF_SAMPLERATE:
003595ac 248 vdev->samplerate = g_variant_get_uint64(data);
a885ce3e 249 sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
7d658874 250 break;
1953564a 251 case SR_CONF_SESSIONFILE:
8c9d4d67 252 g_free(vdev->sessionfile);
003595ac 253 vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 254 sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
40dda2c3 255 break;
1953564a 256 case SR_CONF_CAPTUREFILE:
8c9d4d67 257 g_free(vdev->capturefile);
003595ac 258 vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
a885ce3e 259 sr_info("Setting capturefile to '%s'.", vdev->capturefile);
7d658874 260 break;
1953564a 261 case SR_CONF_CAPTURE_UNITSIZE:
003595ac 262 vdev->unitsize = g_variant_get_uint64(data);
7d658874 263 break;
3f239f08 264 case SR_CONF_NUM_LOGIC_CHANNELS:
fca75cbb 265 vdev->num_channels = g_variant_get_uint64(data);
7d658874
BV
266 break;
267 default:
96ea73db 268 return SR_ERR_NA;
7d658874
BV
269 }
270
271 return SR_OK;
272}
273
584560f1 274static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 275 const struct sr_channel_group *cg)
9a6517d1 276{
9a6517d1 277 (void)sdi;
53b4680f 278 (void)cg;
9a6517d1
BV
279
280 switch (key) {
281 case SR_CONF_DEVICE_OPTIONS:
584560f1 282 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 283 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1
BV
284 break;
285 default:
96ea73db 286 return SR_ERR_NA;
9a6517d1
BV
287 }
288
289 return SR_OK;
290}
291
6078d2c9 292static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
7d658874 293{
bb7ef793 294 struct session_vdev *vdev;
ebc34738 295 int ret;
7d658874 296
102f1239 297 (void)cb_data;
7d658874 298
102f1239 299 vdev = sdi->priv;
8c9d4d67
JH
300 vdev->bytes_read = 0;
301 vdev->cur_chunk = 0;
302 vdev->finished = FALSE;
303
a885ce3e 304 sr_info("Opening archive %s file %s", vdev->sessionfile,
bb7ef793 305 vdev->capturefile);
7d658874 306
40dda2c3 307 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
a885ce3e 308 sr_err("Failed to open session file '%s': "
9d122af8 309 "zip error %d.", vdev->sessionfile, ret);
7d658874
BV
310 return SR_ERR;
311 }
312
4afdfd46 313 /* Send header packet to the session bus. */
102f1239 314 std_session_send_df_header(sdi, LOG_PREFIX);
4afdfd46 315
7d658874 316 /* freewheeling source */
102f1239 317 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
7d658874 318
7d658874
BV
319 return SR_OK;
320}
321
b4bd7088 322/** @private */
c09f0b57 323SR_PRIV struct sr_dev_driver session_driver = {
a885ce3e 324 .name = "virtual-session",
5097b0d0
UH
325 .longname = "Session-emulating driver",
326 .api_version = 1,
6078d2c9 327 .init = init,
824fba03 328 .cleanup = dev_clear,
96ea73db
UH
329 .scan = NULL,
330 .dev_list = NULL,
824fba03 331 .dev_clear = dev_clear,
035a1078
BV
332 .config_get = config_get,
333 .config_set = config_set,
9a6517d1 334 .config_list = config_list,
6078d2c9 335 .dev_open = dev_open,
aa48adf9 336 .dev_close = dev_close,
6078d2c9 337 .dev_acquisition_start = dev_acquisition_start,
69040b7c 338 .dev_acquisition_stop = NULL,
41812aca 339 .context = NULL,
7d658874 340};