X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=1a65b039ab3b0abf9600cbb9dc7e59d6cdb9a8af;hb=c90beca7801b16e46ffd4d74c9dd21b02a045ab5;hp=7dc020b999f736bd36d60628862dbd11f9065475;hpb=23dc6661667b05a91b01ab6a6fa425aa57af6daf;p=libsigrok.git

diff --git a/std.c b/std.c
index 7dc020b9..1a65b039 100644
--- a/std.c
+++ b/std.c
@@ -18,10 +18,17 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+/** @file
+  * Standard API helper functions.
+  * @internal
+  */
+
 #include <glib.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "std"
+
 /**
  * Standard sr_driver_init() API helper.
  *
@@ -32,7 +39,7 @@
  *
  * @param sr_ctx The libsigrok context to assign.
  * @param di The driver instance to use.
- * @param prefix A driver-specific prefix string used for log messages.
+ * @param[in] prefix A driver-specific prefix string used for log messages.
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors.
@@ -43,12 +50,12 @@ SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 	struct drv_context *drvc;
 
 	if (!di) {
-		sr_err("%sInvalid driver, cannot initialize.", prefix);
+		sr_err("%s: Invalid driver, cannot initialize.", prefix);
 		return SR_ERR_ARG;
 	}
 
 	if (!(drvc = g_try_malloc(sizeof(struct drv_context)))) {
-		sr_err("%sDriver context malloc failed.", prefix);
+		sr_err("%s: Driver context malloc failed.", prefix);
 		return SR_ERR_MALLOC;
 	}
 
@@ -84,17 +91,17 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 		return SR_ERR_ARG;
 	}
 
-	sr_dbg("%sStarting acquisition.", prefix);
+	sr_dbg("%s: Starting acquisition.", prefix);
 
 	/* Send header packet to the session bus. */
-	sr_dbg("%sSending SR_DF_HEADER packet.", prefix);
+	sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix);
 	packet.type = SR_DF_HEADER;
 	packet.payload = (uint8_t *)&header;
 	header.feed_version = 1;
 	gettimeofday(&header.starttime, NULL);
 
 	if ((ret = sr_session_send(sdi, &packet)) < 0) {
-		sr_err("%sFailed to send header packet: %d.", prefix, ret);
+		sr_err("%s: Failed to send header packet: %d.", prefix, ret);
 		return ret;
 	}
 
@@ -103,7 +110,7 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 
 #ifdef HAVE_LIBSERIALPORT
 
-/*
+/**
  * Standard serial driver dev_open() helper.
  *
  * This function can be used to implement the dev_open() driver API
@@ -129,7 +136,31 @@ SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
 	return SR_OK;
 }
 
-/*
+/**
+ * Standard serial driver dev_close() helper.
+ *
+ * This function can be used to implement the dev_close() driver API
+ * callback in drivers that use a serial port.
+ *
+ * After closing the port, the status field of the given sdi is set
+ * to SR_ST_INACTIVE.
+ *
+ * @retval SR_OK Success.
+ */
+SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
+{
+	struct sr_serial_dev_inst *serial;
+
+	serial = sdi->conn;
+	if (serial && sdi->status == SR_ST_ACTIVE) {
+		serial_close(serial);
+		sdi->status = SR_ST_INACTIVE;
+	}
+
+	return SR_OK;
+}
+
+/**
  * Standard sr_session_stop() API helper.
  *
  * This function can be used to simplify most (serial port based) driver's
@@ -142,7 +173,7 @@ SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
  *               	  Must not be NULL.
  * @param serial The serial device instance (struct serial_dev_inst *).
  *               Must not be NULL.
- * @param prefix A driver-specific prefix string used for log messages.
+ * @param[in] prefix A driver-specific prefix string used for log messages.
  *               Must not be NULL. An empty string is allowed.
  *
  * @retval SR_OK Success.
@@ -163,28 +194,28 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 	}
 
 	if (sdi->status != SR_ST_ACTIVE) {
-		sr_err("%sDevice inactive, can't stop acquisition.", prefix);
+		sr_err("%s: Device inactive, can't stop acquisition.", prefix);
 		return SR_ERR_DEV_CLOSED;
 	}
 
-	sr_dbg("%sStopping acquisition.", prefix);
+	sr_dbg("%s: Stopping acquisition.", prefix);
 
 	if ((ret = serial_source_remove(serial)) < 0) {
-		sr_err("%sFailed to remove source: %d.", prefix, ret);
+		sr_err("%s: Failed to remove source: %d.", prefix, ret);
 		return ret;
 	}
 
 	if ((ret = dev_close_fn(sdi)) < 0) {
-		sr_err("%sFailed to close device: %d.", prefix, ret);
+		sr_err("%s: Failed to close device: %d.", prefix, ret);
 		return ret;
 	}
 
 	/* Send SR_DF_END packet to the session bus. */
-	sr_dbg("%sSending SR_DF_END packet.", prefix);
+	sr_dbg("%s: Sending SR_DF_END packet.", prefix);
 	packet.type = SR_DF_END;
 	packet.payload = NULL;
 	if ((ret = sr_session_send(cb_data, &packet)) < 0) {
-		sr_err("%sFailed to send SR_DF_END packet: %d.", prefix, ret);
+		sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret);
 		return ret;
 	}
 
@@ -193,9 +224,11 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 
 #endif
 
-/*
+/**
  * Standard driver dev_clear() helper.
  *
+ * Clear driver, this means, close all instances.
+ *
  * This function can be used to implement the dev_clear() driver API
  * callback. dev_close() is called before every sr_dev_inst is cleared.
  *
@@ -233,11 +266,11 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 			driver->dev_close(sdi);
 
 		if (sdi->conn) {
-#if HAVE_LIBSERIALPORT
+#ifdef HAVE_LIBSERIALPORT
 			if (sdi->inst_type == SR_INST_SERIAL)
 				sr_serial_dev_inst_free(sdi->conn);
 #endif
-#if HAVE_LIBUSB_1_0
+#ifdef HAVE_LIBUSB_1_0
 			if (sdi->inst_type == SR_INST_USB)
 				sr_usb_dev_inst_free(sdi->conn);
 #endif
@@ -256,16 +289,3 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 
 	return ret;
 }
-
-SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
-{
-	struct sr_serial_dev_inst *serial;
-
-	serial = sdi->conn;
-	if (serial && sdi->status == SR_ST_ACTIVE) {
-		serial_close(serial);
-		sdi->status = SR_ST_INACTIVE;
-	}
-
-	return SR_OK;
-}