X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=39f47ae70d24a5fbb525729c783aa840e068853a;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=0c21c7caa9fa5f5d5e2c3919d272b221b734f220;hpb=1a081ca67d63a0bd933a3d715792d85afd437296;p=libsigrok.git

diff --git a/session.c b/session.c
index 0c21c7ca..39f47ae7 100644
--- a/session.c
+++ b/session.c
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 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
@@ -25,8 +25,8 @@
 #include "sigrok.h"
 #include "sigrok-internal.h"
 
-/* demo.c */
-extern GIOChannel channels[2];
+/* demo.c. TODO: Should not be global! */
+extern SR_PRIV GIOChannel channels[2];
 
 struct source {
 	int fd;
@@ -47,9 +47,6 @@ static int source_timeout = -1;
 /**
  * Create a new session.
  *
- * TODO.
- *
- * TODO: Should return int?
  * TODO: Should it use the file-global "session" variable or take an argument?
  *       The same question applies to all the other session functions.
  *
@@ -57,7 +54,7 @@ static int source_timeout = -1;
  */
 SR_API struct sr_session *sr_session_new(void)
 {
-	if (!(session = calloc(1, sizeof(struct sr_session)))) {
+	if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
 		sr_err("session: %s: session malloc failed", __func__);
 		return NULL; /* TODO: SR_ERR_MALLOC? */
 	}
@@ -75,7 +72,7 @@ SR_API struct sr_session *sr_session_new(void)
 SR_API int sr_session_destroy(void)
 {
 	if (!session) {
-		sr_warn("session: %s: session was NULL", __func__);
+		sr_err("session: %s: session was NULL", __func__);
 		return SR_ERR_BUG;
 	}
 
@@ -103,7 +100,7 @@ SR_API int sr_session_destroy(void)
 SR_API int sr_session_device_clear(void)
 {
 	if (!session) {
-		sr_warn("session: %s: session was NULL", __func__);
+		sr_err("session: %s: session was NULL", __func__);
 		return SR_ERR_BUG;
 	}
 
@@ -160,8 +157,6 @@ SR_API int sr_session_device_add(struct sr_device *device)
 /**
  * Clear all datafeed callbacks in the current session.
  *
- * TODO.
- *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
 SR_API int sr_session_datafeed_callback_clear(void)
@@ -180,7 +175,8 @@ SR_API int sr_session_datafeed_callback_clear(void)
 /**
  * Add a datafeed callback to the current session.
  *
- * @param callback TODO.
+ * @param callback Function to call when a chunk of data is received.
+ *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
@@ -208,13 +204,11 @@ static int sr_session_run_poll(void)
 
 	fds = NULL;
 	while (session->running) {
-		if (fds)
-			free(fds);
+		/* TODO: Add comment. */
+		g_free(fds);
 
 		/* Construct g_poll()'s array. */
-		/* TODO: Check malloc return value. */
-		fds = malloc(sizeof(GPollFD) * num_sources);
-		if (!fds) {
+		if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) {
 			sr_err("session: %s: fds malloc failed", __func__);
 			return SR_ERR_MALLOC;
 		}
@@ -245,7 +239,7 @@ static int sr_session_run_poll(void)
 			}
 		}
 	}
-	free(fds);
+	g_free(fds);
 
 	return SR_OK;
 }
@@ -253,7 +247,7 @@ static int sr_session_run_poll(void)
 /**
  * Start a session.
  *
- * There can only be one session at a time. TODO
+ * There can only be one session at a time.
  *
  * @return SR_OK upon success, SR_ERR upon errors.
  */
@@ -337,7 +331,8 @@ SR_API int sr_session_run(void)
 /**
  * Halt the current session.
  *
- * TODO.
+ * This requests the current session be stopped as soon as possible, for example
+ * on receiving an SR_DF_END packet.
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
@@ -357,7 +352,8 @@ SR_API int sr_session_halt(void)
 /**
  * Stop the current session.
  *
- * TODO: Difference to halt?
+ * The current session is stopped immediately, with all acquisition sessions
+ * being stopped and hardware plugins cleaned up.
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
@@ -389,24 +385,15 @@ SR_API int sr_session_stop(void)
 }
 
 /**
- * TODO.
+ * Debug helper.
  *
- * TODO: Various error checks.
+ * @param packet The packet to show debugging information for.
  *
- * @param packet TODO.
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-static int datafeed_dump(struct sr_datafeed_packet *packet)
+static void datafeed_dump(struct sr_datafeed_packet *packet)
 {
 	struct sr_datafeed_logic *logic;
 
-	if (!packet) {
-		sr_err("session: %s: packet was NULL", __func__);
-		return SR_ERR_ARG;
-	}
-
-	/* TODO: Validity checks for packet contents. */
-
 	switch (packet->type) {
 	case SR_DF_HEADER:
 		sr_dbg("bus: received SR_DF_HEADER");
@@ -423,22 +410,22 @@ static int datafeed_dump(struct sr_datafeed_packet *packet)
 		sr_dbg("bus: received SR_DF_END");
 		break;
 	default:
-		/* TODO: Abort? */
-		sr_err("bus: received unknown packet type %d", packet->type);
+		sr_dbg("bus: received unknown packet type %d", packet->type);
 		break;
 	}
 
-	return SR_OK;
 }
 
 /**
- * TODO.
+ * Send a packet to whatever is listening on the datafeed bus.
+ *
+ * Hardware drivers use this to send a data packet to the frontend.
  *
  * @param device TODO.
  * @param packet TODO.
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-SR_API int sr_session_bus(struct sr_device *device,
+SR_PRIV int sr_session_bus(struct sr_device *device,
 			  struct sr_datafeed_packet *packet)
 {
 	GSList *l;
@@ -459,14 +446,11 @@ SR_API int sr_session_bus(struct sr_device *device,
 		return SR_ERR_ARG;
 	}
 
-	/*
-	 * TODO: Send packet through PD pipe, and send the output of that to
-	 * the callbacks as well.
-	 */
 	for (l = session->datafeed_callbacks; l; l = l->next) {
+		if (sr_log_loglevel_get() >= SR_LOG_DBG)
+			datafeed_dump(packet);
 		cb = l->data;
 		/* TODO: Check for cb != NULL. */
-		datafeed_dump(packet);
 		cb(device, packet);
 	}
 
@@ -476,7 +460,6 @@ SR_API int sr_session_bus(struct sr_device *device,
 /**
  * TODO.
  *
- * TODO: Switch to g_try_malloc0() / g_free().
  * TODO: More error checks etc.
  *
  * @param fd TODO.
@@ -499,7 +482,7 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
 
 	/* Note: user_data can be NULL, that's not a bug. */
 
-	new_sources = calloc(1, sizeof(struct source) * (num_sources + 1));
+	new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1));
 	if (!new_sources) {
 		sr_err("session: %s: new_sources malloc failed", __func__);
 		return SR_ERR_MALLOC;
@@ -508,7 +491,7 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
 	if (sources) {
 		memcpy(new_sources, sources,
 		       sizeof(struct source) * num_sources);
-		free(sources);
+		g_free(sources);
 	}
 
 	s = &new_sources[num_sources++];
@@ -530,7 +513,6 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
  * Remove the source belonging to the specified file descriptor.
  *
  * TODO: More error checks.
- * TODO: Switch to g_try_malloc0() / g_free().
  *
  * @param fd TODO.
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
@@ -549,7 +531,7 @@ SR_API int sr_session_source_remove(int fd)
 
 	/* TODO: Check if 'fd' valid. */
 
-	new_sources = calloc(1, sizeof(struct source) * num_sources);
+	new_sources = g_try_malloc0(sizeof(struct source) * num_sources);
 	if (!new_sources) {
 		sr_err("session: %s: new_sources malloc failed", __func__);
 		return SR_ERR_MALLOC;
@@ -562,12 +544,12 @@ SR_API int sr_session_source_remove(int fd)
 	}
 
 	if (old != new) {
-		free(sources);
+		g_free(sources);
 		sources = new_sources;
 		num_sources--;
 	} else {
 		/* Target fd was not found. */
-		free(new_sources);
+		g_free(new_sources);
 	}
 
 	return SR_OK;