/*
- * 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"
+
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "virtual-session: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
/* size of payloads sent across the session bus */
+/** @cond PRIVATE */
#define CHUNKSIZE (512 * 1024)
+/** @endcond */
-struct session_vdevice {
+struct session_vdev {
+ char *sessionfile;
char *capturefile;
struct zip *archive;
struct zip_file *capfile;
int bytes_read;
uint64_t samplerate;
+ uint64_t total_samples;
int unitsize;
int num_probes;
};
-static char *sessionfile = NULL;
-static GSList *device_instances = NULL;
-static int capabilities[] = {
- SR_HWCAP_CAPTUREFILE,
- SR_HWCAP_CAPTURE_UNITSIZE,
+static GSList *dev_insts = NULL;
+static const int hwcaps[] = {
+ SR_CONF_CAPTUREFILE,
+ SR_CONF_CAPTURE_UNITSIZE,
0,
};
-/**
- * TODO.
- *
- * @param device_index TODO.
- */
-static struct session_vdevice *get_vdevice_by_index(int device_index)
-{
- struct sr_device_instance *sdi;
- struct session_vdevice *vdevice;
-
- /* TODO: Sanity checks on device_index. */
-
- if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
- sr_err("session driver: %s: device instance with device "
- "index %d was not found", __func__, device_index);
- return NULL;
- }
-
- /* TODO: Is sdi->priv == NULL valid? */
-
- vdevice = sdi->priv;
-
- return vdevice;
-}
-
-/**
- * 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, const struct sr_dev_inst *cb_sdi)
{
- struct sr_device_instance *sdi;
- struct session_vdevice *vdevice;
+ struct sr_dev_inst *sdi;
+ struct session_vdev *vdev;
struct sr_datafeed_packet packet;
struct sr_datafeed_logic logic;
GSList *l;
void *buf;
int ret, got_data;
- /* Avoid compiler warnings. */
(void)fd;
(void)revents;
- sr_dbg("session_driver: feed chunk");
+ sr_dbg("Feed chunk.");
got_data = FALSE;
- for (l = device_instances; l; l = l->next) {
+ for (l = dev_insts; l; l = l->next) {
sdi = l->data;
- vdevice = sdi->priv;
- if (!vdevice)
+ vdev = sdi->priv;
+ if (!vdev)
/* already done with this instance */
continue;
if (!(buf = g_try_malloc(CHUNKSIZE))) {
- sr_err("session: %s: buf malloc failed", __func__);
- return FALSE; /* TODO: SR_ERR_MALLOC */
+ sr_err("%s: buf malloc failed", __func__);
+ return FALSE;
}
- ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
+ ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
if (ret > 0) {
got_data = TRUE;
packet.type = SR_DF_LOGIC;
packet.payload = &logic;
logic.length = ret;
- logic.unitsize = vdevice->unitsize;
+ logic.unitsize = vdev->unitsize;
logic.data = buf;
- vdevice->bytes_read += ret;
- sr_session_bus(session_data, &packet);
+ vdev->bytes_read += ret;
+ sr_session_send(cb_sdi, &packet);
} else {
/* done with this capture file */
- zip_fclose(vdevice->capfile);
- g_free(vdevice->capturefile);
- g_free(vdevice);
+ zip_fclose(vdev->capfile);
+ g_free(vdev->capturefile);
+ g_free(vdev);
sdi->priv = NULL;
}
}
if (!got_data) {
packet.type = SR_DF_END;
- sr_session_bus(session_data, &packet);
+ sr_session_send(cb_sdi, &packet);
+ sr_session_source_remove(-1);
}
return TRUE;
/* driver callbacks */
static int hw_cleanup(void);
-/**
- * TODO.
- *
- * @param deviceinfo TODO.
- *
- * @return TODO.
- */
-static int hw_init(const char *deviceinfo)
+static int hw_init(struct sr_context *sr_ctx)
{
- sessionfile = g_strdup(deviceinfo);
+ (void)sr_ctx;
- return 0;
+ return SR_OK;
}
-/**
- * TODO.
- *
- */
static int hw_cleanup(void)
{
GSList *l;
- /* TODO: Error handling. */
-
- for (l = device_instances; l; l = l->next)
+ for (l = dev_insts; l; l = l->next)
sr_dev_inst_free(l->data);
-
- g_slist_free(device_instances);
- device_instances = NULL;
-
- sr_session_source_remove(-1);
-
- g_free(sessionfile);
+ g_slist_free(dev_insts);
+ dev_insts = NULL;
return SR_OK;
}
-static int hw_opendev(int device_index)
+static int hw_dev_open(struct sr_dev_inst *sdi)
{
- struct sr_device_instance *sdi;
-
- sdi = sr_dev_inst_new(device_index, SR_ST_INITIALIZING,
- NULL, NULL, NULL);
- if (!sdi)
- return SR_ERR;
-
- if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
- sr_err("session: %s: sdi->priv malloc failed", __func__);
+ if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
+ sr_err("%s: sdi->priv malloc failed", __func__);
return SR_ERR_MALLOC;
}
- device_instances = g_slist_append(device_instances, sdi);
+ dev_insts = g_slist_append(dev_insts, sdi);
return SR_OK;
}
-static void *hw_get_device_info(int device_index, int device_info_id)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
{
- struct session_vdevice *vdevice;
- void *info;
-
- if (device_info_id != SR_DI_CUR_SAMPLERATE)
- return NULL;
-
- if (!(vdevice = get_vdevice_by_index(device_index)))
- return NULL;
-
- info = &vdevice->samplerate;
+ struct session_vdev *vdev;
+
+ switch (id) {
+ case SR_CONF_SAMPLERATE:
+ if (sdi) {
+ vdev = sdi->priv;
+ *data = g_variant_new_uint64(vdev->samplerate);
+ } else
+ return SR_ERR;
+ break;
+ case SR_CONF_LIMIT_SAMPLES:
+ if (sdi) {
+ vdev = sdi->priv;
+ *data = g_variant_new_uint64(vdev->total_samples);
+ } else
+ return SR_ERR;
+ break;
+ default:
+ return SR_ERR_ARG;
+ }
- return info;
+ return SR_OK;
}
-static int hw_get_status(int device_index)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
{
- /* Avoid compiler warnings. */
- (void)device_index;
+ struct session_vdev *vdev;
- if (sr_dev_list() != NULL)
- return SR_OK;
- else
+ 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:
+ vdev->sessionfile = g_strdup(g_variant_get_string(data, NULL));
+ sr_info("Setting sessionfile to '%s'.", vdev->sessionfile);
+ break;
+ case SR_CONF_CAPTUREFILE:
+ vdev->capturefile = g_strdup(g_variant_get_string(data, NULL));
+ sr_info("Setting capturefile to '%s'.", vdev->capturefile);
+ break;
+ case SR_CONF_CAPTURE_UNITSIZE:
+ vdev->unitsize = g_variant_get_uint64(data);
+ break;
+ case SR_CONF_LIMIT_SAMPLES:
+ vdev->total_samples = g_variant_get_uint64(data);
+ break;
+ case SR_CONF_CAPTURE_NUM_PROBES:
+ vdev->num_probes = g_variant_get_uint64(data);
+ break;
+ default:
+ sr_err("Unknown capability: %d.", id);
return SR_ERR;
-}
+ }
-/**
- * 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_get_capabilities(void)
-{
- return capabilities;
+ return SR_OK;
}
-static int hw_set_configuration(int device_index, int capability, void *value)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
{
- struct session_vdevice *vdevice;
- uint64_t *tmp_u64;
- if (!(vdevice = get_vdevice_by_index(device_index)))
- return SR_ERR;
+ (void)sdi;
- switch (capability) {
- case SR_HWCAP_SAMPLERATE:
- tmp_u64 = value;
- vdevice->samplerate = *tmp_u64;
- sr_info("session driver: setting samplerate to %" PRIu64,
- vdevice->samplerate);
- break;
- case SR_HWCAP_CAPTUREFILE:
- vdevice->capturefile = g_strdup(value);
- sr_info("session driver: setting capturefile to %s",
- vdevice->capturefile);
- break;
- case SR_HWCAP_CAPTURE_UNITSIZE:
- tmp_u64 = value;
- vdevice->unitsize = *tmp_u64;
- break;
- case SR_HWCAP_CAPTURE_NUM_PROBES:
- tmp_u64 = value;
- vdevice->num_probes = *tmp_u64;
+ switch (key) {
+ case SR_CONF_DEVICE_OPTIONS:
+// *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+// hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+ *data = g_variant_new_from_data(G_VARIANT_TYPE("ai"),
+ hwcaps, ARRAY_SIZE(hwcaps)*sizeof(int32_t), TRUE, NULL, NULL);
break;
default:
- sr_err("session driver: %s: unknown capability %d requested",
- __func__, capability);
- return SR_ERR;
+ return SR_ERR_ARG;
}
return SR_OK;
}
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
+ void *cb_data)
{
struct zip_stat zs;
- struct session_vdevice *vdevice;
- struct sr_datafeed_header *header;
- struct sr_datafeed_packet *packet;
- int err;
+ struct session_vdev *vdev;
+ int ret;
- /* Avoid compiler warnings. */
- (void)session_device_id;
+ vdev = sdi->priv;
- if (!(vdevice = get_vdevice_by_index(device_index)))
- return SR_ERR;
-
- sr_info("session_driver: opening archive %s file %s", sessionfile,
- vdevice->capturefile);
+ sr_info("Opening archive %s file %s", vdev->sessionfile,
+ vdev->capturefile);
- if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
- sr_err("Failed to open session file '%s': zip error %d\n",
- sessionfile, err);
+ if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
+ sr_err("Failed to open session file '%s': "
+ "zip error %d\n", vdev->sessionfile, ret);
return SR_ERR;
}
- if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
- sr_err("Failed to check capture file '%s' in session file "
- "'%s'.", vdevice->capturefile, sessionfile);
+ if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
+ sr_err("Failed to check capture file '%s' in "
+ "session file '%s'.", vdev->capturefile, vdev->sessionfile);
return SR_ERR;
}
- if (!(vdevice->capfile = zip_fopen(vdevice->archive,
- vdevice->capturefile, 0))) {
- sr_err("Failed to open capture file '%s' in session file '%s'.",
- vdevice->capturefile, sessionfile);
+ if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
+ sr_err("Failed to open capture file '%s' in "
+ "session file '%s'.", vdev->capturefile, vdev->sessionfile);
return SR_ERR;
}
- /* freewheeling source */
- sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
-
- if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
- sr_err("session: %s: packet malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
-
- if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
- sr_err("session: %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 = vdevice->samplerate;
- header->num_logic_probes = vdevice->num_probes;
- sr_session_bus(session_device_id, packet);
- g_free(header);
- g_free(packet);
+ std_session_send_df_header(sdi, LOG_PREFIX);
+
+ /* freewheeling source */
+ sr_session_source_add(-1, 0, 0, receive_data, sdi);
return SR_OK;
}
-/* Not static, it's used elsewhere (via 'extern'). */
-struct sr_device_plugin session_driver = {
- "session",
- "Session-emulating driver",
- 1,
- hw_init,
- hw_cleanup,
- hw_opendev,
- NULL,
- hw_get_device_info,
- hw_get_status,
- hw_get_capabilities,
- hw_set_configuration,
- hw_start_acquisition,
- NULL,
+/** @private */
+SR_PRIV struct sr_dev_driver session_driver = {
+ .name = "virtual-session",
+ .longname = "Session-emulating driver",
+ .api_version = 1,
+ .init = hw_init,
+ .cleanup = hw_cleanup,
+ .config_get = config_get,
+ .config_set = config_set,
+ .config_list = config_list,
+ .dev_open = hw_dev_open,
+ .dev_close = NULL,
+ .dev_acquisition_start = hw_dev_acquisition_start,
+ .dev_acquisition_stop = NULL,
};
projects / libsigrok.git / blobdiff