Centralise duplicated logging helper defines.

[libsigrok.git] / std.c

diff --git a/std.c b/std.c
index 7dc020b999f736bd36d60628862dbd11f9065475..727ee6e98576e4c9c11b999820ad27f5bc3a3b68 100644 (file)
--- 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.
@@ -129,6 +136,30 @@ 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.
  *
@@ -257,15 +288,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;
-}