gmc-mh-1x-2x: Added new driver gmc-mh-2x-bd232.

[libsigrok.git] / std.c

diff --git a/std.c b/std.c
index ca9c25e1833e749f4405ade5cd430939f14171e1..1a65b039ab3b0abf9600cbb9dc7e59d6cdb9a8af 100644 (file)
--- a/std.c
+++ b/std.c
@@ -18,7 +18,7 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-/** \file
+/** @file
   * Standard API helper functions.
   * @internal
   */
@@ -27,6 +27,8 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "std"
+
 /**
  * Standard sr_driver_init() API helper.
  *
@@ -48,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;
        }
 
@@ -89,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;
        }
 
@@ -108,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
@@ -134,7 +136,7 @@ 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
@@ -158,7 +160,7 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-/*
+/**
  * Standard sr_session_stop() API helper.
  *
  * This function can be used to simplify most (serial port based) driver's
@@ -171,7 +173,7 @@ SR_PRIV int std_serial_dev_close(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.
@@ -192,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;
        }
 
@@ -222,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.
  *
@@ -262,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
@@ -285,4 +289,3 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 
        return ret;
 }
-