Add helper function for scan completion

[libsigrok.git] / src / std.c

diff --git a/src/std.c b/src/std.c
index aadf8236a790a3f79c38ece2cf6ebd191166991c..4af3c6816266aa91ed097957f1583614c888a7a3 100644 (file)
--- a/src/std.c
+++ b/src/std.c
@@ -39,22 +39,15 @@
  * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and
  * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed.
  *
- * @param sr_ctx The libsigrok context to assign.
  * @param di The driver instance to use.
- * @param[in] prefix A driver-specific prefix string used for log messages.
+ * @param sr_ctx The libsigrok context to assign.
  *
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
-                    const char *prefix)
+SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 {
        struct drv_context *drvc;
 
-       if (!di) {
-               sr_err("%s: Invalid driver, cannot initialize.", prefix);
-               return SR_ERR_ARG;
-       }
-
        drvc = g_malloc0(sizeof(struct drv_context));
        drvc->sr_ctx = sr_ctx;
        drvc->instances = NULL;
@@ -356,3 +349,51 @@ 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.
+ * @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 = di->context;
+       GSList *l;
+
+       for (l = devices; l; l = l->next) {
+               struct sr_dev_inst *sdi = l->data;
+               sdi->driver = di;
+       }
+
+       drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
+
+       return devices;
+}