/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <unistd.h>
#include <sys/time.h>
#include <zip.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+
+#define LOG_PREFIX "virtual-session"
/* size of payloads sent across the session bus */
+/** @cond PRIVATE */
#define CHUNKSIZE (512 * 1024)
+/** @endcond */
struct session_vdev {
+ char *sessionfile;
char *capturefile;
struct zip *archive;
struct zip_file *capfile;
int bytes_read;
uint64_t samplerate;
int unitsize;
- int num_probes;
+ int num_channels;
+ int cur_chunk;
+ gboolean finished;
};
-static char *sessionfile = NULL;
static GSList *dev_insts = NULL;
-static int hwcaps[] = {
- SR_HWCAP_CAPTUREFILE,
- SR_HWCAP_CAPTURE_UNITSIZE,
- 0,
+static const int hwcaps[] = {
+ SR_CONF_CAPTUREFILE,
+ SR_CONF_CAPTURE_UNITSIZE,
+ SR_CONF_SAMPLERATE,
};
-/**
- * TODO.
- *
- * @param dev_index TODO.
- */
-static struct session_vdev *get_vdev_by_index(int dev_index)
-{
- struct sr_dev_inst *sdi;
- struct session_vdev *vdev;
-
- /* TODO: Sanity checks on dev_index. */
-
- if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
- sr_err("session driver: %s: device instance with device "
- "index %d was not found", __func__, dev_index);
- return NULL;
- }
-
- /* TODO: Is sdi->priv == NULL valid? */
-
- vdev = sdi->priv;
-
- return vdev;
-}
-
-/**
- * TODO.
- *
- * @param fd TODO.
- * @param revents TODO.
- * @param session_data TODO.
- *
- * @return TODO.
- */
-static int feed_chunk(int fd, int revents, void *session_data)
+static int receive_data(int fd, int revents, void *cb_data)
{
struct sr_dev_inst *sdi;
struct session_vdev *vdev;
struct sr_datafeed_packet packet;
struct sr_datafeed_logic logic;
+ struct zip_stat zs;
GSList *l;
- void *buf;
int ret, got_data;
+ char capturefile[16];
+ void *buf;
- /* Avoid compiler warnings. */
(void)fd;
(void)revents;
- sr_dbg("session_driver: feed chunk");
-
got_data = FALSE;
for (l = dev_insts; l; l = l->next) {
sdi = l->data;
vdev = sdi->priv;
- if (!vdev)
- /* already done with this instance */
+ if (vdev->finished)
+ /* Already done with this instance. */
continue;
+ if (!vdev->capfile) {
+ /* No capture file opened yet, or finished with the last
+ * chunked one. */
+ if (vdev->cur_chunk == 0) {
+ /* capturefile is always the unchunked base name. */
+ if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) != -1) {
+ /* No chunks, just a single capture file. */
+ vdev->cur_chunk = 0;
+ if (!(vdev->capfile = zip_fopen(vdev->archive,
+ vdev->capturefile, 0)))
+ return FALSE;
+ sr_dbg("Opened %s.", vdev->capturefile);
+ } else {
+ /* Try as first chunk filename. */
+ snprintf(capturefile, 15, "%s-1", vdev->capturefile);
+ if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
+ vdev->cur_chunk = 1;
+ if (!(vdev->capfile = zip_fopen(vdev->archive,
+ capturefile, 0)))
+ return FALSE;
+ sr_dbg("Opened %s.", capturefile);
+ } else {
+ sr_err("No capture file '%s' in " "session file '%s'.",
+ vdev->capturefile, vdev->sessionfile);
+ return FALSE;
+ }
+ }
+ } else {
+ /* Capture data is chunked, advance to the next chunk. */
+ vdev->cur_chunk++;
+ snprintf(capturefile, 15, "%s-%d", vdev->capturefile,
+ vdev->cur_chunk);
+ if (zip_stat(vdev->archive, capturefile, 0, &zs) != -1) {
+ if (!(vdev->capfile = zip_fopen(vdev->archive,
+ capturefile, 0)))
+ return FALSE;
+ sr_dbg("Opened %s.", capturefile);
+ } else {
+ /* We got all the chunks, finish up. */
+ vdev->finished = TRUE;
+ continue;
+ }
+ }
+ }
+
if (!(buf = g_try_malloc(CHUNKSIZE))) {
- sr_err("session driver: %s: buf malloc failed",
- __func__);
- return FALSE; /* TODO: SR_ERR_MALLOC */
+ sr_err("%s: buf malloc failed", __func__);
+ return FALSE;
}
- ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
+ ret = zip_fread(vdev->capfile, buf,
+ CHUNKSIZE / vdev->unitsize * vdev->unitsize);
if (ret > 0) {
+ if (ret % vdev->unitsize != 0)
+ sr_warn("Read size %d not a multiple of the"
+ " unit size %d.", ret, vdev->unitsize);
got_data = TRUE;
packet.type = SR_DF_LOGIC;
packet.payload = &logic;
logic.unitsize = vdev->unitsize;
logic.data = buf;
vdev->bytes_read += ret;
- sr_session_bus(session_data, &packet);
+ sr_session_send(cb_data, &packet);
} else {
/* done with this capture file */
zip_fclose(vdev->capfile);
- g_free(vdev->capturefile);
- g_free(vdev);
- sdi->priv = NULL;
+ vdev->capfile = NULL;
+ if (vdev->cur_chunk == 0) {
+ /* It was the only file. */
+ vdev->finished = TRUE;
+ } else {
+ /* There might be more chunks, so don't fall through
+ * to the SR_DF_END here. */
+ g_free(buf);
+ return TRUE;
+ }
}
+ g_free(buf);
}
if (!got_data) {
packet.type = SR_DF_END;
- sr_session_bus(session_data, &packet);
+ sr_session_send(cb_data, &packet);
+ sr_session_source_remove(-1);
}
return TRUE;
}
/* driver callbacks */
-static int hw_cleanup(void);
-/**
- * TODO.
- *
- * @param devinfo TODO.
- *
- * @return TODO.
- */
-static int hw_init(const char *devinfo)
+static int init(struct sr_context *sr_ctx)
{
- sessionfile = g_strdup(devinfo);
+ (void)sr_ctx;
- return 0;
+ return SR_OK;
}
-/**
- * TODO.
- *
- */
-static int hw_cleanup(void)
+static int dev_clear(void)
{
GSList *l;
g_slist_free(dev_insts);
dev_insts = NULL;
- sr_session_source_remove(-1);
-
- g_free(sessionfile);
-
return SR_OK;
}
-static int hw_opendev(int dev_index)
+static int dev_open(struct sr_dev_inst *sdi)
{
- struct sr_dev_inst *sdi;
-
- sdi = sr_dev_inst_new(dev_index, SR_ST_INITIALIZING,
- NULL, NULL, NULL);
- if (!sdi)
- return SR_ERR;
-
- if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
- sr_err("session driver: %s: sdi->priv malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
+ struct session_vdev *vdev;
+ vdev = g_try_malloc0(sizeof(struct session_vdev));
+ sdi->priv = vdev;
dev_insts = g_slist_append(dev_insts, sdi);
return SR_OK;
}
-static void *hw_get_dev_info(int dev_index, int dev_info_id)
+static int dev_close(struct sr_dev_inst *sdi)
{
- struct session_vdev *vdev;
- void *info;
-
- if (dev_info_id != SR_DI_CUR_SAMPLERATE)
- return NULL;
-
- if (!(vdev = get_vdev_by_index(dev_index)))
- return NULL;
+ const struct session_vdev *const vdev = sdi->priv;
+ g_free(vdev->sessionfile);
+ g_free(vdev->capturefile);
- info = &vdev->samplerate;
+ g_free(sdi->priv);
+ sdi->priv = NULL;
- return info;
+ return SR_OK;
}
-static int hw_get_status(int dev_index)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+ const struct sr_channel_group *cg)
{
- /* Avoid compiler warnings. */
- (void)dev_index;
+ struct session_vdev *vdev;
- if (sr_dev_list() != NULL)
- return SR_OK;
- else
- return SR_ERR;
-}
+ (void)cg;
-/**
- * Get the list of hardware capabilities.
- *
- * @return A pointer to the (hardware) capabilities of this virtual session
- * driver. This could be NULL, if no such capabilities exist.
- */
-static int *hw_hwcap_get_all(void)
-{
- return hwcaps;
+ switch (id) {
+ case SR_CONF_SAMPLERATE:
+ if (sdi) {
+ vdev = sdi->priv;
+ *data = g_variant_new_uint64(vdev->samplerate);
+ } else
+ return SR_ERR;
+ break;
+ default:
+ return SR_ERR_NA;
+ }
+
+ return SR_OK;
}
-static int hw_config_set(int dev_index, int hwcap, void *value)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+ const struct sr_channel_group *cg)
{
struct session_vdev *vdev;
- uint64_t *tmp_u64;
- if (!(vdev = get_vdev_by_index(dev_index)))
- return SR_ERR;
+ (void)cg;
- switch (hwcap) {
- case SR_HWCAP_SAMPLERATE:
- tmp_u64 = value;
- vdev->samplerate = *tmp_u64;
- sr_info("session driver: setting samplerate to %" PRIu64,
- vdev->samplerate);
+ vdev = sdi->priv;
+
+ switch (id) {
+ case SR_CONF_SAMPLERATE:
+ vdev->samplerate = g_variant_get_uint64(data);
+ sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
+ break;
+ case SR_CONF_SESSIONFILE:
+ g_free(vdev->sessionfile);
+ vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
+ sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
break;
- case SR_HWCAP_CAPTUREFILE:
- vdev->capturefile = g_strdup(value);
- sr_info("session driver: setting capturefile to %s",
- vdev->capturefile);
+ case SR_CONF_CAPTUREFILE:
+ g_free(vdev->capturefile);
+ vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
+ sr_info("Setting capturefile to '%s'.", vdev->capturefile);
break;
- case SR_HWCAP_CAPTURE_UNITSIZE:
- tmp_u64 = value;
- vdev->unitsize = *tmp_u64;
+ case SR_CONF_CAPTURE_UNITSIZE:
+ vdev->unitsize = g_variant_get_uint64(data);
break;
- case SR_HWCAP_CAPTURE_NUM_PROBES:
- tmp_u64 = value;
- vdev->num_probes = *tmp_u64;
+ case SR_CONF_NUM_LOGIC_CHANNELS:
+ vdev->num_channels = g_variant_get_uint64(data);
break;
default:
- sr_err("session driver: %s: unknown capability %d requested",
- __func__, hwcap);
- return SR_ERR;
+ return SR_ERR_NA;
}
return SR_OK;
}
-static int hw_start_acquisition(int dev_index, gpointer session_dev_id)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+ const struct sr_channel_group *cg)
+{
+ (void)sdi;
+ (void)cg;
+
+ switch (key) {
+ case SR_CONF_DEVICE_OPTIONS:
+ *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+ hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+ break;
+ default:
+ return SR_ERR_NA;
+ }
+
+ return SR_OK;
+}
+
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
- struct zip_stat zs;
struct session_vdev *vdev;
- struct sr_datafeed_header *header;
- struct sr_datafeed_packet *packet;
- int err;
+ int ret;
- /* Avoid compiler warnings. */
- (void)session_dev_id;
+ vdev = sdi->priv;
- if (!(vdev = get_vdev_by_index(dev_index)))
- return SR_ERR;
+ vdev->bytes_read = 0;
+ vdev->cur_chunk = 0;
+ vdev->finished = FALSE;
- sr_info("session_driver: opening archive %s file %s", sessionfile,
+ sr_info("Opening archive %s file %s", vdev->sessionfile,
vdev->capturefile);
- if (!(vdev->archive = zip_open(sessionfile, 0, &err))) {
- sr_err("session driver: Failed to open session file '%s': "
- "zip error %d\n", sessionfile, err);
- return SR_ERR;
- }
-
- if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
- sr_err("session driver: Failed to check capture file '%s' in "
- "session file '%s'.", vdev->capturefile, sessionfile);
+ if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
+ sr_err("Failed to open session file '%s': "
+ "zip error %d.", vdev->sessionfile, ret);
return SR_ERR;
}
- if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
- sr_err("session driver: Failed to open capture file '%s' in "
- "session file '%s'.", vdev->capturefile, sessionfile);
- return SR_ERR;
- }
+ /* Send header packet to the session bus. */
+ std_session_send_df_header(cb_data, LOG_PREFIX);
/* freewheeling source */
- sr_session_source_add(-1, 0, 0, feed_chunk, session_dev_id);
-
- if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
- sr_err("session driver: %s: packet malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
-
- if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
- sr_err("session driver: %s: header malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
-
- /* Send header packet to the session bus. */
- packet->type = SR_DF_HEADER;
- packet->payload = (unsigned char *)header;
- header->feed_version = 1;
- gettimeofday(&header->starttime, NULL);
- header->samplerate = vdev->samplerate;
- header->num_logic_probes = vdev->num_probes;
- sr_session_bus(session_dev_id, packet);
- g_free(header);
- g_free(packet);
+ sr_session_source_add(-1, 0, 0, receive_data, cb_data);
return SR_OK;
}
-SR_PRIV struct sr_dev_plugin session_driver = {
- "session",
- "Session-emulating driver",
- 1,
- hw_init,
- hw_cleanup,
- hw_opendev,
- NULL,
- hw_get_dev_info,
- hw_get_status,
- hw_hwcap_get_all,
- hw_config_set,
- hw_start_acquisition,
- NULL,
+/** @private */
+SR_PRIV struct sr_dev_driver session_driver = {
+ .name = "virtual-session",
+ .longname = "Session-emulating driver",
+ .api_version = 1,
+ .init = init,
+ .cleanup = dev_clear,
+ .scan = NULL,
+ .dev_list = NULL,
+ .dev_clear = dev_clear,
+ .config_get = config_get,
+ .config_set = config_set,
+ .config_list = config_list,
+ .dev_open = dev_open,
+ .dev_close = dev_close,
+ .dev_acquisition_start = dev_acquisition_start,
+ .dev_acquisition_stop = NULL,
+ .priv = NULL,
};
projects / libsigrok.git / blobdiff