X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fstd.c;h=218f8f3f2f9490a735801125aecf4ecc97a37739;hb=15f96409dc54fd2ef784c59156daedd9acfa78ed;hp=a03e509c732b4c0693ef6ee69638bffa9acc236a;hpb=c45c32ce47f429099cb0f1cabc1b45b9bcf44855;p=libsigrok.git

diff --git a/src/std.c b/src/std.c
index a03e509c..218f8f3f 100644
--- a/src/std.c
+++ b/src/std.c
@@ -85,24 +85,17 @@ SR_PRIV int std_cleanup(const struct sr_dev_driver *di)
  * dev_acquisition_start() API callback.
  *
  * @param sdi The device instance to use.
- * @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.
  */
-SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
-				       const char *prefix)
+SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi)
 {
+	const char *prefix = sdi->driver->name;
 	int ret;
 	struct sr_datafeed_packet packet;
 	struct sr_datafeed_header header;
 
-	if (!prefix) {
-		sr_err("Invalid prefix.");
-		return SR_ERR_ARG;
-	}
-
 	sr_dbg("%s: Starting acquisition.", prefix);
 
 	/* Send header packet to the session bus. */
@@ -124,19 +117,17 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
  * Standard API helper for sending an SR_DF_END packet.
  *
  * @param sdi The device instance to use. Must not be NULL.
- * @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.
  */
-SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi,
-				    const char *prefix)
+SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi)
 {
+	const char *prefix = sdi->driver->name;
 	int ret;
 	struct sr_datafeed_packet packet;
 
-	if (!sdi || !prefix)
+	if (!sdi)
 		return SR_ERR_ARG;
 
 	sr_dbg("%s: Sending SR_DF_END packet.", prefix);
@@ -215,10 +206,6 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
  * @param cb_data Opaque 'cb_data' pointer. Must not be NULL.
  * @param dev_close_fn Function pointer to the driver's dev_close().
  *               	  Must not be NULL.
- * @param serial The serial device instance (struct serial_dev_inst *).
- *               Must not be NULL.
- * @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.
  * @retval SR_ERR_ARG Invalid arguments.
@@ -226,16 +213,12 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi)
  * @retval SR_ERR Other errors.
  */
 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
-			dev_close_callback dev_close_fn,
-			struct sr_serial_dev_inst *serial, const char *prefix)
+			dev_close_callback dev_close_fn)
 {
+	struct sr_serial_dev_inst *serial = sdi->conn;
+	const char *prefix = sdi->driver->name;
 	int ret;
 
-	if (!prefix) {
-		sr_err("Invalid prefix.");
-		return SR_ERR_ARG;
-	}
-
 	if (sdi->status != SR_ST_ACTIVE) {
 		sr_err("%s: Device inactive, can't stop acquisition.", prefix);
 		return SR_ERR_DEV_CLOSED;
@@ -253,7 +236,7 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 		return ret;
 	}
 
-	std_session_send_df_end(sdi, prefix);
+	std_session_send_df_end(sdi);
 
 	return SR_OK;
 }
@@ -349,3 +332,62 @@ SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di)
 
 	return drvc->instances;
 }
+
+/**
+ * Standard scan() callback API helper.
+ *
+ * This function can be used to perform common tasks required by a driver's
+ * scan() callback. It will initialize the driver for each device on the list
+ * and add the devices on the list to the driver's device instance list.
+ * Usually it should be used as the last step in the scan() callback, right
+ * before returning.
+ *
+ * Note: This function can only be used if std_init() has been called
+ * previously by the driver.
+ *
+ * Example:
+ * @code{c}
+ * static GSList *scan(struct sr_dev_driver *di, GSList *options)
+ * {
+ *     struct GSList *device;
+ *     struct sr_dev_inst *sdi;
+ *
+ *     sdi = g_new0(sr_dev_inst, 1);
+ *     sdi->vendor = ...;
+ *     ...
+ *     devices = g_slist_append(devices, sdi);
+ *     ...
+ *     return std_scan_complete(di, devices);
+ * }
+ * @endcode
+ *
+ * @param di The driver instance to use. Must not be NULL.
+ * @param devices List of newly discovered devices (struct sr_dev_inst).
+ *
+ * @return The @p devices list.
+ */
+SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices)
+{
+	struct drv_context *drvc;
+	GSList *l;
+
+	if (!di) {
+		sr_err("Invalid driver instance (di), cannot complete scan.");
+		return NULL;
+	}
+
+	drvc = di->context;
+
+	for (l = devices; l; l = l->next) {
+		struct sr_dev_inst *sdi = l->data;
+		if (!sdi) {
+			sr_err("Invalid driver instance, cannot complete scan.");
+			return NULL;
+		}
+		sdi->driver = di;
+	}
+
+	drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
+
+	return devices;
+}