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>
27 #include "sigrok-internal.h"
29 /* size of payloads sent across the session bus */
30 #define CHUNKSIZE (512 * 1024)
32 struct session_vdevice {
35 struct zip_file *capfile;
42 static char *sessionfile = NULL;
43 static GSList *device_instances = NULL;
44 static int capabilities[] = {
46 SR_HWCAP_CAPTURE_UNITSIZE,
53 * @param device_index TODO.
55 static struct session_vdevice *get_vdevice_by_index(int device_index)
57 struct sr_device_instance *sdi;
58 struct session_vdevice *vdevice;
60 /* TODO: Sanity checks on device_index. */
62 if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
63 sr_err("session driver: %s: device instance with device "
64 "index %d was not found", __func__, device_index);
68 /* TODO: Is sdi->priv == NULL valid? */
79 * @param revents TODO.
80 * @param session_data TODO.
84 static int feed_chunk(int fd, int revents, void *session_data)
86 struct sr_device_instance *sdi;
87 struct session_vdevice *vdevice;
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 = device_instances; 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(vdevice->capfile, buf, CHUNKSIZE);
117 packet.type = SR_DF_LOGIC;
118 packet.payload = &logic;
120 logic.unitsize = vdevice->unitsize;
122 vdevice->bytes_read += ret;
123 sr_session_bus(session_data, &packet);
125 /* done with this capture file */
126 zip_fclose(vdevice->capfile);
127 g_free(vdevice->capturefile);
134 packet.type = SR_DF_END;
135 sr_session_bus(session_data, &packet);
141 /* driver callbacks */
142 static int hw_cleanup(void);
147 * @param deviceinfo TODO.
151 static int hw_init(const char *deviceinfo)
153 sessionfile = g_strdup(deviceinfo);
162 static int hw_cleanup(void)
166 for (l = device_instances; l; l = l->next)
167 sr_dev_inst_free(l->data);
168 g_slist_free(device_instances);
169 device_instances = NULL;
171 sr_session_source_remove(-1);
178 static int hw_opendev(int device_index)
180 struct sr_device_instance *sdi;
182 sdi = sr_dev_inst_new(device_index, SR_ST_INITIALIZING,
187 if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
188 sr_err("session driver: %s: sdi->priv malloc failed", __func__);
189 return SR_ERR_MALLOC;
192 device_instances = g_slist_append(device_instances, sdi);
197 static void *hw_get_device_info(int device_index, int device_info_id)
199 struct session_vdevice *vdevice;
202 if (device_info_id != SR_DI_CUR_SAMPLERATE)
205 if (!(vdevice = get_vdevice_by_index(device_index)))
208 info = &vdevice->samplerate;
213 static int hw_get_status(int device_index)
215 /* Avoid compiler warnings. */
218 if (sr_dev_list() != NULL)
225 * Get the list of hardware capabilities.
227 * @return A pointer to the (hardware) capabilities of this virtual session
228 * driver. This could be NULL, if no such capabilities exist.
230 static int *hw_get_capabilities(void)
235 static int hw_set_configuration(int device_index, int capability, void *value)
237 struct session_vdevice *vdevice;
240 if (!(vdevice = get_vdevice_by_index(device_index)))
243 switch (capability) {
244 case SR_HWCAP_SAMPLERATE:
246 vdevice->samplerate = *tmp_u64;
247 sr_info("session driver: setting samplerate to %" PRIu64,
248 vdevice->samplerate);
250 case SR_HWCAP_CAPTUREFILE:
251 vdevice->capturefile = g_strdup(value);
252 sr_info("session driver: setting capturefile to %s",
253 vdevice->capturefile);
255 case SR_HWCAP_CAPTURE_UNITSIZE:
257 vdevice->unitsize = *tmp_u64;
259 case SR_HWCAP_CAPTURE_NUM_PROBES:
261 vdevice->num_probes = *tmp_u64;
264 sr_err("session driver: %s: unknown capability %d requested",
265 __func__, capability);
272 static int hw_start_acquisition(int device_index, gpointer session_device_id)
275 struct session_vdevice *vdevice;
276 struct sr_datafeed_header *header;
277 struct sr_datafeed_packet *packet;
280 /* Avoid compiler warnings. */
281 (void)session_device_id;
283 if (!(vdevice = get_vdevice_by_index(device_index)))
286 sr_info("session_driver: opening archive %s file %s", sessionfile,
287 vdevice->capturefile);
289 if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
290 sr_err("session driver: Failed to open session file '%s': "
291 "zip error %d\n", sessionfile, err);
295 if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
296 sr_err("session driver: Failed to check capture file '%s' in "
297 "session file '%s'.", vdevice->capturefile, sessionfile);
301 if (!(vdevice->capfile = zip_fopen(vdevice->archive,
302 vdevice->capturefile, 0))) {
303 sr_err("session driver: Failed to open capture file '%s' in "
304 "session file '%s'.", vdevice->capturefile, sessionfile);
308 /* freewheeling source */
309 sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
311 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
312 sr_err("session driver: %s: packet malloc failed", __func__);
313 return SR_ERR_MALLOC;
316 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
317 sr_err("session driver: %s: header malloc failed", __func__);
318 return SR_ERR_MALLOC;
321 /* Send header packet to the session bus. */
322 packet->type = SR_DF_HEADER;
323 packet->payload = (unsigned char *)header;
324 header->feed_version = 1;
325 gettimeofday(&header->starttime, NULL);
326 header->samplerate = vdevice->samplerate;
327 header->num_logic_probes = vdevice->num_probes;
328 sr_session_bus(session_device_id, packet);
335 SR_PRIV struct sr_device_plugin session_driver = {
337 "Session-emulating driver",
346 hw_set_configuration,
347 hw_start_acquisition,