X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=session.c;h=75a2cb353ba5a06b9dd6b1e4f87fae7ab612dd14;hb=44dae539254e324e0330e194f9c775be3d761503;hp=ed8cadc53bbe5505b2c6585ee100dc2935aaf27e;hpb=133a37bfba1a7e1423716b2b872d3bb82a2e64d9;p=libsigrok.git

diff --git a/session.c b/session.c
index ed8cadc5..75a2cb35 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
@@ -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.
  *
@@ -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)
@@ -251,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.
  */
@@ -335,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.
  */
@@ -355,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.
  */
@@ -387,24 +385,14 @@ SR_API int sr_session_stop(void)
 }
 
 /**
- * TODO.
- *
- * TODO: Various error checks.
+ * Debug helper.
  *
- * @param packet TODO.
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ * @param packet The packet to show debugging information for.
  */
-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");
@@ -421,23 +409,23 @@ 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,
-			  struct sr_datafeed_packet *packet)
+SR_PRIV int sr_session_bus(struct sr_device *device,
+			   struct sr_datafeed_packet *packet)
 {
 	GSList *l;
 	sr_datafeed_callback cb;
@@ -457,14 +445,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);
 	}
 
@@ -481,6 +466,7 @@ SR_API int sr_session_bus(struct sr_device *device,
  * @param timeout TODO.
  * @param callback TODO.
  * @param user_data TODO.
+ *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors.
  */
@@ -529,6 +515,7 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
  * TODO: More error checks.
  *
  * @param fd TODO.
+ *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
  *         internal errors.