X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=727ee6e98576e4c9c11b999820ad27f5bc3a3b68;hb=3544f848e0d7f67af8e11ce7ec344b34cd797df3;hp=059bf759013ef5274af32aa6c797a913c55b3da5;hpb=6078d2c99619233173d4536b74258c15e6be73ba;p=libsigrok.git

diff --git a/std.c b/std.c
index 059bf759..727ee6e9 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,13 +39,13 @@
  *
  * @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.
  */
-SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
-			const char *prefix)
+SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
+		     const char *prefix)
 {
 	struct drv_context *drvc;
 
@@ -101,6 +108,58 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 	return SR_OK;
 }
 
+#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 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.
  *
@@ -117,10 +176,12 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  * @param prefix A driver-specific prefix string used for log messages.
  *               Must not be NULL. An empty string is allowed.
  *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
- *         SR_ERR upon other errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
+ * @retval SR_ERR_DEV_CLOSED Device is closed.
+ * @retval SR_ERR Other errors.
  */
-SR_PRIV int std_hw_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)
 {
@@ -134,12 +195,12 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 
 	if (sdi->status != SR_ST_ACTIVE) {
 		sr_err("%sDevice inactive, can't stop acquisition.", prefix);
-		return SR_ERR;
+		return SR_ERR_DEV_CLOSED;
 	}
 
 	sr_dbg("%sStopping acquisition.", prefix);
 
-	if ((ret = sr_source_remove(serial->fd)) < 0) {
+	if ((ret = serial_source_remove(serial)) < 0) {
 		sr_err("%sFailed to remove source: %d.", prefix, ret);
 		return ret;
 	}
@@ -161,6 +222,8 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 	return SR_OK;
 }
 
+#endif
+
 /*
  * Standard driver dev_clear() helper.
  *
@@ -201,12 +264,16 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 			driver->dev_close(sdi);
 
 		if (sdi->conn) {
-			 if (sdi->inst_type == SR_INST_SERIAL)
+#if HAVE_LIBSERIALPORT
+			if (sdi->inst_type == SR_INST_SERIAL)
 				sr_serial_dev_inst_free(sdi->conn);
+#endif
 #if HAVE_LIBUSB_1_0
-			else if (sdi->inst_type == SR_INST_USB)
+			if (sdi->inst_type == SR_INST_USB)
 				sr_usb_dev_inst_free(sdi->conn);
 #endif
+			if (sdi->inst_type == SR_INST_SCPI)
+				sr_scpi_free(sdi->conn);
 		}
 		if (clear_private)
 			clear_private(sdi->priv);
@@ -220,3 +287,4 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 
 	return ret;
 }
+