2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 #include <sys/types.h>
26 #include "libsigrok.h"
27 #include "libsigrok-internal.h"
29 /* size of payloads sent across the session bus */
30 #define CHUNKSIZE (512 * 1024)
36 struct zip_file *capfile;
43 static GSList *dev_insts = NULL;
44 static const int hwcaps[] = {
46 SR_HWCAP_CAPTURE_UNITSIZE,
53 * @param dev_index TODO.
55 static struct session_vdev *get_vdev_by_index(int dev_index)
57 struct sr_dev_inst *sdi;
58 struct session_vdev *vdev;
60 /* TODO: Sanity checks on dev_index. */
62 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
63 sr_err("session driver: %s: device instance with device "
64 "index %d was not found", __func__, dev_index);
68 /* TODO: Is sdi->priv == NULL valid? */
79 * @param revents TODO.
80 * @param cb_data TODO.
84 static int receive_data(int fd, int revents, void *cb_data)
86 struct sr_dev_inst *sdi;
87 struct session_vdev *vdev;
88 struct sr_datafeed_packet packet;
89 struct sr_datafeed_logic logic;
94 /* Avoid compiler warnings. */
98 sr_dbg("session_driver: feed chunk");
101 for (l = dev_insts; l; l = l->next) {
105 /* already done with this instance */
108 if (!(buf = g_try_malloc(CHUNKSIZE))) {
109 sr_err("session driver: %s: buf malloc failed",
111 return FALSE; /* TODO: SR_ERR_MALLOC */
114 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
117 packet.type = SR_DF_LOGIC;
118 packet.payload = &logic;
120 logic.unitsize = vdev->unitsize;
122 vdev->bytes_read += ret;
123 sr_session_send(cb_data, &packet);
125 /* done with this capture file */
126 zip_fclose(vdev->capfile);
127 g_free(vdev->capturefile);
134 packet.type = SR_DF_END;
135 sr_session_send(cb_data, &packet);
141 /* driver callbacks */
142 static int hw_cleanup(void);
147 * @param devinfo TODO.
151 static int hw_init(void)
160 static int hw_cleanup(void)
164 for (l = dev_insts; l; l = l->next)
165 sr_dev_inst_free(l->data);
166 g_slist_free(dev_insts);
169 sr_session_source_remove(-1);
174 static int hw_dev_open(int dev_index)
176 struct sr_dev_inst *sdi;
178 sdi = sr_dev_inst_new(dev_index, SR_ST_INITIALIZING,
183 if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
184 sr_err("session driver: %s: sdi->priv malloc failed", __func__);
185 return SR_ERR_MALLOC;
188 dev_insts = g_slist_append(dev_insts, sdi);
193 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
195 struct session_vdev *vdev;
198 if (dev_info_id != SR_DI_CUR_SAMPLERATE)
201 if (!(vdev = get_vdev_by_index(dev_index)))
204 info = &vdev->samplerate;
209 static int hw_dev_status_get(int dev_index)
211 /* Avoid compiler warnings. */
214 if (sr_dev_list() != NULL)
221 * Get the list of hardware capabilities.
223 * @return A pointer to the (hardware) capabilities of this virtual session
224 * driver. This could be NULL, if no such capabilities exist.
226 static const int *hw_hwcap_get_all(void)
231 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
233 struct session_vdev *vdev;
234 const uint64_t *tmp_u64;
236 if (!(vdev = get_vdev_by_index(dev_index)))
240 case SR_HWCAP_SAMPLERATE:
242 vdev->samplerate = *tmp_u64;
243 sr_info("session driver: setting samplerate to %" PRIu64,
246 case SR_HWCAP_SESSIONFILE:
247 vdev->sessionfile = g_strdup(value);
248 sr_info("session driver: setting sessionfile to %s",
251 case SR_HWCAP_CAPTUREFILE:
252 vdev->capturefile = g_strdup(value);
253 sr_info("session driver: setting capturefile to %s",
256 case SR_HWCAP_CAPTURE_UNITSIZE:
258 vdev->unitsize = *tmp_u64;
260 case SR_HWCAP_CAPTURE_NUM_PROBES:
262 vdev->num_probes = *tmp_u64;
265 sr_err("session driver: %s: unknown capability %d requested",
273 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
276 struct session_vdev *vdev;
277 struct sr_datafeed_header *header;
278 struct sr_datafeed_packet *packet;
279 struct sr_datafeed_meta_logic meta;
282 if (!(vdev = get_vdev_by_index(dev_index)))
285 sr_info("session_driver: opening archive %s file %s", vdev->sessionfile,
288 if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
289 sr_err("session driver: Failed to open session file '%s': "
290 "zip error %d\n", vdev->sessionfile, ret);
294 if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
295 sr_err("session driver: Failed to check capture file '%s' in "
296 "session file '%s'.", vdev->capturefile, vdev->sessionfile);
300 if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
301 sr_err("session driver: Failed to open capture file '%s' in "
302 "session file '%s'.", vdev->capturefile, vdev->sessionfile);
306 /* freewheeling source */
307 sr_session_source_add(-1, 0, 0, receive_data, cb_data);
309 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
310 sr_err("session driver: %s: packet malloc failed", __func__);
311 return SR_ERR_MALLOC;
314 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
315 sr_err("session driver: %s: header malloc failed", __func__);
316 return SR_ERR_MALLOC;
319 /* Send header packet to the session bus. */
320 packet->type = SR_DF_HEADER;
321 packet->payload = (unsigned char *)header;
322 header->feed_version = 1;
323 gettimeofday(&header->starttime, NULL);
324 sr_session_send(cb_data, packet);
326 /* Send metadata about the SR_DF_LOGIC packets to come. */
327 packet->type = SR_DF_META_LOGIC;
328 packet->payload = &meta;
329 meta.samplerate = vdev->samplerate;
330 meta.num_probes = vdev->num_probes;
331 sr_session_send(cb_data, packet);
339 SR_PRIV struct sr_dev_driver session_driver = {
341 .longname = "Session-emulating driver",
344 .cleanup = hw_cleanup,
345 .dev_open = hw_dev_open,
347 .dev_info_get = hw_dev_info_get,
348 .dev_status_get = hw_dev_status_get,
349 .hwcap_get_all = hw_hwcap_get_all,
350 .dev_config_set = hw_dev_config_set,
351 .dev_acquisition_start = hw_dev_acquisition_start,
352 .dev_acquisition_stop = NULL,