X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session_driver.c;h=43ad24d6b0b489ddc4763cdaa0f760902863d187;hb=6b7ace4832b3b574399098de2ad4f4bd0f35a14e;hp=ed397a96e466a250020dfd73c2da5a61f00da28b;hpb=40dda2c3a509e9e031078427e32249e2ebc33ec5;p=libsigrok.git

diff --git a/session_driver.c b/session_driver.c
index ed397a96..43ad24d6 100644
--- a/session_driver.c
+++ b/session_driver.c
@@ -26,8 +26,19 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "virtual-session: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
 /* size of payloads sent across the session bus */
+/** @cond PRIVATE */
 #define CHUNKSIZE (512 * 1024)
+/** @endcond */
 
 struct session_vdev {
 	char *sessionfile;
@@ -47,40 +58,6 @@ static const int hwcaps[] = {
 	0,
 };
 
-/**
- * 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 cb_data TODO.
- *
- * @return TODO.
- */
 static int receive_data(int fd, int revents, void *cb_data)
 {
 	struct sr_dev_inst *sdi;
@@ -91,11 +68,10 @@ static int receive_data(int fd, int revents, void *cb_data)
 	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 = dev_insts; l; l = l->next) {
@@ -106,9 +82,8 @@ static int receive_data(int fd, int revents, void *cb_data)
 			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);
@@ -133,6 +108,7 @@ static int receive_data(int fd, int revents, void *cb_data)
 	if (!got_data) {
 		packet.type = SR_DF_END;
 		sr_session_send(cb_data, &packet);
+		sr_session_source_remove(-1);
 	}
 
 	return TRUE;
@@ -141,22 +117,11 @@ static int receive_data(int fd, int revents, void *cb_data)
 /* driver callbacks */
 static int hw_cleanup(void);
 
-/**
- * TODO.
- *
- * @param devinfo TODO.
- *
- * @return TODO.
- */
 static int hw_init(void)
 {
-
-	return 0;
+	return SR_OK;
 }
 
-/**
- * TODO.
- */
 static int hw_cleanup(void)
 {
 	GSList *l;
@@ -166,22 +131,13 @@ static int hw_cleanup(void)
 	g_slist_free(dev_insts);
 	dev_insts = NULL;
 
-	sr_session_source_remove(-1);
-
 	return SR_OK;
 }
 
-static int hw_dev_open(int dev_index)
+static int hw_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__);
+		sr_err("%s: sdi->priv malloc failed", __func__);
 		return SR_ERR_MALLOC;
 	}
 
@@ -190,68 +146,50 @@ static int hw_dev_open(int dev_index)
 	return SR_OK;
 }
 
-static const void *hw_dev_info_get(int dev_index, int dev_info_id)
+static int hw_info_get(int info_id, const void **data,
+       const 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;
-
-	info = &vdev->samplerate;
 
-	return info;
-}
-
-static int hw_dev_status_get(int dev_index)
-{
-	/* Avoid compiler warnings. */
-	(void)dev_index;
-
-	if (sr_dev_list() != NULL)
-		return SR_OK;
-	else
-		return SR_ERR;
-}
+	switch (info_id) {
+	case SR_DI_HWCAPS:
+		*data = hwcaps;
+		break;
+	case SR_DI_CUR_SAMPLERATE:
+		if (sdi) {
+			vdev = sdi->priv;
+			*data = &vdev->samplerate;
+		} else
+			return SR_ERR;
+		break;
+	default:
+		return SR_ERR_ARG;
+	}
 
-/**
- * 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 const int *hw_hwcap_get_all(void)
-{
-	return hwcaps;
+	return SR_OK;
 }
 
-static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
+static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
+		const void *value)
 {
 	struct session_vdev *vdev;
 	const uint64_t *tmp_u64;
 
-	if (!(vdev = get_vdev_by_index(dev_index)))
-		return SR_ERR;
+	vdev = sdi->priv;
 
 	switch (hwcap) {
 	case SR_HWCAP_SAMPLERATE:
 		tmp_u64 = value;
 		vdev->samplerate = *tmp_u64;
-		sr_info("session driver: setting samplerate to %" PRIu64,
-		        vdev->samplerate);
+		sr_info("Setting samplerate to %" PRIu64 ".", vdev->samplerate);
 		break;
 	case SR_HWCAP_SESSIONFILE:
 		vdev->sessionfile = g_strdup(value);
-		sr_info("session driver: setting sessionfile to %s",
-		        vdev->sessionfile);
+		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);
+		sr_info("Setting capturefile to '%s'.", vdev->capturefile);
 		break;
 	case SR_HWCAP_CAPTURE_UNITSIZE:
 		tmp_u64 = value;
@@ -262,15 +200,15 @@ static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
 		vdev->num_probes = *tmp_u64;
 		break;
 	default:
-		sr_err("session driver: %s: unknown capability %d requested",
-		       __func__, hwcap);
+		sr_err("Unknown capability: %d.", hwcap);
 		return SR_ERR;
 	}
 
 	return SR_OK;
 }
 
-static int hw_dev_acquisition_start(int dev_index, void *cb_data)
+static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
+		void *cb_data)
 {
 	struct zip_stat zs;
 	struct session_vdev *vdev;
@@ -279,26 +217,25 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 	struct sr_datafeed_meta_logic meta;
 	int ret;
 
-	if (!(vdev = get_vdev_by_index(dev_index)))
-		return SR_ERR;
+	vdev = sdi->priv;
 
-	sr_info("session_driver: opening archive %s file %s", vdev->sessionfile,
+	sr_info("Opening archive %s file %s", vdev->sessionfile,
 		vdev->capturefile);
 
 	if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
-		sr_err("session driver: Failed to open session file '%s': "
+		sr_err("Failed to open session file '%s': "
 		       "zip error %d\n", vdev->sessionfile, ret);
 		return SR_ERR;
 	}
 
 	if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
-		sr_err("session driver: Failed to check capture file '%s' in "
+		sr_err("Failed to check capture file '%s' in "
 		       "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 		return SR_ERR;
 	}
 
 	if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
-		sr_err("session driver: Failed to open capture file '%s' in "
+		sr_err("Failed to open capture file '%s' in "
 		       "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 		return SR_ERR;
 	}
@@ -307,12 +244,12 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 	sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 
 	if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-		sr_err("session driver: %s: packet malloc failed", __func__);
+		sr_err("%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__);
+		sr_err("%s: header malloc failed", __func__);
 		return SR_ERR_MALLOC;
 	}
 
@@ -336,17 +273,16 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 	return SR_OK;
 }
 
+/** @private */
 SR_PRIV struct sr_dev_driver session_driver = {
-	.name = "session",
+	.name = "virtual-session",
 	.longname = "Session-emulating driver",
 	.api_version = 1,
 	.init = hw_init,
 	.cleanup = hw_cleanup,
 	.dev_open = hw_dev_open,
 	.dev_close = NULL,
-	.dev_info_get = hw_dev_info_get,
-	.dev_status_get = hw_dev_status_get,
-	.hwcap_get_all = hw_hwcap_get_all,
+	.info_get = hw_info_get,
 	.dev_config_set = hw_dev_config_set,
 	.dev_acquisition_start = hw_dev_acquisition_start,
 	.dev_acquisition_stop = NULL,