GPL headers: Use correct project name.

[libsigrok.git] / std.c

diff --git a/std.c b/std.c
index 5eb2e57d8e9808f19c1e13588484f92ead7592d4..03e9db4f9f4a8dccf85445dbd6bcd6fc46dc415d 100644 (file)
--- a/std.c
+++ b/std.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
  *
@@ -159,3 +159,59 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 
        return SR_OK;
 }
+
+/*
+ * Standard driver dev_clear() helper.
+ *
+ * This function can be used to implement the dev_clear() driver API
+ * callback. dev_close() is called before every sr_dev_inst is cleared.
+ *
+ * The only limitation is driver-specific device contexts (sdi->priv).
+ * These are freed, but any dynamic allocation within structs stored
+ * there cannot be freed.
+ *
+ * @param driver The driver which will have its instances released.
+ *
+ * @return SR_OK on success.
+ */
+SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
+               std_dev_clear_t clear_private)
+{
+       struct sr_dev_inst *sdi;
+       struct drv_context *drvc;
+       struct dev_context *devc;
+       GSList *l;
+       int ret;
+
+       drvc = driver->priv;
+       ret = SR_OK;
+       for (l = drvc->instances; l; l = l->next) {
+               /* Log errors, but continue cleaning up the rest. */
+               if (!(sdi = l->data)) {
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               if (!(devc = sdi->priv)) {
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               if (driver->dev_close)
+                       driver->dev_close(sdi);
+
+               if (sdi->conn) {
+                       if (sdi->inst_type == SR_INST_USB)
+                               sr_usb_dev_inst_free(sdi->conn);
+                       else if (sdi->inst_type == SR_INST_SERIAL)
+                               sr_serial_dev_inst_free(sdi->conn);
+               }
+               if (clear_private)
+                       clear_private(sdi->priv);
+               sdi = l->data;
+               sr_dev_inst_free(sdi);
+       }
+
+       g_slist_free(drvc->instances);
+       drvc->instances = NULL;
+
+       return ret;
+}