Improved doxygen docs.

[libsigrok.git] / std.c

diff --git a/std.c b/std.c
index 415d1138b5529a372eb2c2d2b50a49e3444070ed..9fac390d77cd42c68fd18cb3f094fdfa09888b94 100644 (file)
--- a/std.c
+++ b/std.c
@@ -18,6 +18,11 @@
  * 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"
@@ -32,7 +37,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.
@@ -103,6 +108,32 @@ 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
+ * callback in drivers that use a serial port. The port is opened
+ * with the SERIAL_RDWR and SERIAL_NONBLOCK flags.
+ *
+ * If the open succeeded, the status field of the given sdi is set
+ * to SR_ST_ACTIVE.
+ *
+ * @retval SR_OK Success.
+ * @retval SR_ERR Serial port open failed.
+ */
+SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi)
+{
+       struct sr_serial_dev_inst *serial;
+
+       serial = sdi->conn;
+       if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+               return SR_ERR;
+
+       sdi->status = SR_ST_ACTIVE;
+
+       return SR_OK;
+}
+
 /*
  * Standard sr_session_stop() API helper.
  *
@@ -124,7 +155,7 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  * @retval SR_ERR_DEV_CLOSED Device is closed.
  * @retval SR_ERR Other errors.
  */
-SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
+SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
                        void *cb_data, dev_close_t dev_close_fn,
                        struct sr_serial_dev_inst *serial, const char *prefix)
 {
@@ -236,7 +267,7 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
        struct sr_serial_dev_inst *serial;
 
        serial = sdi->conn;
-       if (serial && serial->fd != -1) {
+       if (serial && sdi->status == SR_ST_ACTIVE) {
                serial_close(serial);
                sdi->status = SR_ST_INACTIVE;
        }