]> sigrok.org Git - libsigrok.git/blobdiff - src/backend.c
Build: Set local include directories in Makefile.am
[libsigrok.git] / src / backend.c
index e6297f54527e81245bfc2cc9e96c35aabb264795..baf1f8d97fe4c037d2feaa45327c9acbf530483e 100644 (file)
@@ -20,7 +20,7 @@
 
 #include <glib.h>
 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 /** @cond PRIVATE */
  *
  * Initializing and shutting down libsigrok.
  *
- * Before using any of the libsigrok functionality (except
- * sr_log_loglevel_set() and sr_log_opts_set()), sr_init() must
- * be called to initialize the library, which will return a struct sr_context
- * when the initialization was successful.
+ * Before using any of the libsigrok functionality (except for
+ * sr_log_loglevel_set()), sr_init() must be called to initialize the
+ * library, which will return a struct sr_context when the initialization
+ * was successful.
  *
  * When libsigrok functionality is no longer needed, sr_exit() should be
  * called, which will (among other things) free the struct sr_context.
  * @{
  */
 
+static void print_versions(void)
+{
+       GString *s;
+#ifdef HAVE_LIBUSB_1_0
+       const struct libusb_version *lv;
+#endif
+
+       s = g_string_sized_new(200);
+
+       sr_dbg("libsigrok %s/%s (rt: %s/%s).",
+               SR_PACKAGE_VERSION_STRING, SR_LIB_VERSION_STRING,
+               sr_package_version_string_get(), sr_lib_version_string_get());
+
+       g_string_append(s, "Libs: ");
+       g_string_append_printf(s, "glib %d.%d.%d (rt: %d.%d.%d/%d:%d), ",
+               GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
+               glib_major_version, glib_minor_version, glib_micro_version,
+               glib_binary_age, glib_interface_age);
+       g_string_append_printf(s, "libzip %s, ", HAVE_LIBZIP_VER);
+#ifdef HAVE_LIBSERIALPORT
+       g_string_append_printf(s, "libserialport %s/%s (rt: %s/%s), ",
+               SP_PACKAGE_VERSION_STRING, SP_LIB_VERSION_STRING,
+               sp_get_package_version_string(), sp_get_lib_version_string());
+#endif
+#ifdef HAVE_LIBUSB_1_0
+       lv = libusb_get_version();
+       g_string_append_printf(s, "libusb-1.0 %d.%d.%d.%d%s, ",
+               lv->major, lv->minor, lv->micro, lv->nano, lv->rc);
+#endif
+#ifdef HAVE_LIBFTDI
+       g_string_append_printf(s, "libftdi %s, ", HAVE_LIBFTDI_VER);
+#endif
+#ifdef HAVE_LIBGPIB
+       g_string_append_printf(s, "libgpib %s, ", HAVE_LIBGPIB_VER);
+#endif
+#ifdef HAVE_LIBREVISA
+       g_string_append_printf(s, "librevisa %s, ", HAVE_LIBREVISA_VER);
+#endif
+       s->str[s->len - 2] = '.';
+       s->str[s->len - 1] = '\0';
+       sr_dbg("%s", s->str);
+
+       s = g_string_truncate(s, 0);
+       g_string_append_printf(s, "Host: %s, ", HOST);
+#ifdef WORDS_BIGENDIAN
+       g_string_append_printf(s, "big-endian.");
+#else
+       g_string_append_printf(s, "little-endian.");
+#endif
+       sr_dbg("%s", s->str);
+
+       s = g_string_truncate(s, 0);
+       g_string_append_printf(s, "SCPI backends: ");
+
+       g_string_append_printf(s, "TCP, ");
+#if HAVE_RPC
+       g_string_append_printf(s, "RPC, ");
+#endif
+#ifdef HAVE_LIBSERIALPORT
+       g_string_append_printf(s, "serial, ");
+#endif
+#ifdef HAVE_LIBREVISA
+       g_string_append_printf(s, "VISA, ");
+#endif
+#ifdef HAVE_LIBGPIB
+       g_string_append_printf(s, "GPIB, ");
+#endif
+#ifdef HAVE_LIBUSB_1_0
+       g_string_append_printf(s, "USBTMC, ");
+#endif
+       s->str[s->len - 2] = '.';
+       s->str[s->len - 1] = '\0';
+       sr_dbg("%s", s->str);
+
+       g_string_free(s, TRUE);
+}
+
 /**
  * Sanity-check all libsigrok drivers.
  *
+ * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
+ *
  * @retval SR_OK All drivers are OK
  * @retval SR_ERR One or more drivers have issues.
+ * @retval SR_ERR_ARG Invalid argument.
  */
-static int sanity_check_all_drivers(void)
+static int sanity_check_all_drivers(const struct sr_context *ctx)
 {
        int i, errors, ret = SR_OK;
        struct sr_dev_driver **drivers;
        const char *d;
 
+       if (!ctx)
+               return SR_ERR_ARG;
+
        sr_spew("Sanity-checking all drivers.");
 
-       drivers = sr_driver_list();
+       drivers = sr_driver_list(ctx);
        for (i = 0; drivers[i]; i++) {
                errors = 0;
 
@@ -215,7 +298,7 @@ static int sanity_check_all_drivers(void)
 static int sanity_check_all_input_modules(void)
 {
        int i, errors, ret = SR_OK;
-       struct sr_input_module **inputs;
+       const struct sr_input_module **inputs;
        const char *d;
 
        sr_spew("Sanity-checking all input modules.");
@@ -230,20 +313,24 @@ static int sanity_check_all_input_modules(void)
                        sr_err("No ID in module %d ('%s').", i, d);
                        errors++;
                }
-               if (!inputs[i]->description) {
-                       sr_err("No description in module %d ('%s').", i, d);
+               if (!inputs[i]->name) {
+                       sr_err("No name in module %d ('%s').", i, d);
                        errors++;
                }
-               if (!inputs[i]->format_match) {
-                       sr_err("No format_match in module %d ('%s').", i, d);
+               if (!inputs[i]->desc) {
+                       sr_err("No description in module %d ('%s').", i, d);
                        errors++;
                }
                if (!inputs[i]->init) {
                        sr_err("No init in module %d ('%s').", i, d);
                        errors++;
                }
-               if (!inputs[i]->loadfile) {
-                       sr_err("No loadfile in module %d ('%s').", i, d);
+               if (!inputs[i]->receive) {
+                       sr_err("No receive in module %d ('%s').", i, d);
+                       errors++;
+               }
+               if (!inputs[i]->end) {
+                       sr_err("No end in module %d ('%s').", i, d);
                        errors++;
                }
 
@@ -302,6 +389,55 @@ static int sanity_check_all_output_modules(void)
        return ret;
 }
 
+/**
+ * Sanity-check all libsigrok transform modules.
+ *
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules have issues.
+ */
+static int sanity_check_all_transform_modules(void)
+{
+       int i, errors, ret = SR_OK;
+       const struct sr_transform_module **transforms;
+       const char *d;
+
+       sr_spew("Sanity-checking all transform modules.");
+
+       transforms = sr_transform_list();
+       for (i = 0; transforms[i]; i++) {
+               errors = 0;
+
+               d = (transforms[i]->id) ? transforms[i]->id : "NULL";
+
+               if (!transforms[i]->id) {
+                       sr_err("No ID in module %d ('%s').", i, d);
+                       errors++;
+               }
+               if (!transforms[i]->name) {
+                       sr_err("No name in module %d ('%s').", i, d);
+                       errors++;
+               }
+               if (!transforms[i]->desc) {
+                       sr_err("No description in module '%s'.", d);
+                       errors++;
+               }
+               /* Note: options() is optional. */
+               /* Note: init() is optional. */
+               if (!transforms[i]->receive) {
+                       sr_err("No receive in module '%s'.", d);
+                       errors++;
+               }
+               /* Note: cleanup() is optional. */
+
+               if (errors == 0)
+                       continue;
+
+               ret = SR_ERR;
+       }
+
+       return ret;
+}
+
 /**
  * Initialize libsigrok.
  *
@@ -322,13 +458,27 @@ SR_API int sr_init(struct sr_context **ctx)
 {
        int ret = SR_ERR;
        struct sr_context *context;
+       struct sr_dev_driver ***lists, **drivers;
+       GArray *array;
+
+       print_versions();
 
        if (!ctx) {
                sr_err("%s(): libsigrok context was NULL.", __func__);
                return SR_ERR;
        }
 
-       if (sanity_check_all_drivers() < 0) {
+       context = g_malloc0(sizeof(struct sr_context));
+
+       /* Generate ctx->driver_list at runtime. */
+       array = g_array_new(TRUE, FALSE, sizeof(struct sr_dev_driver *));
+       for (lists = drivers_lists; *lists; lists++)
+               for (drivers = *lists; *drivers; drivers++)
+                       g_array_append_val(array, *drivers);
+       context->driver_list = (struct sr_dev_driver **)array->data;
+       g_array_free(array, FALSE);
+
+       if (sanity_check_all_drivers(context) < 0) {
                sr_err("Internal driver error(s), aborting.");
                return ret;
        }
@@ -343,12 +493,9 @@ SR_API int sr_init(struct sr_context **ctx)
                return ret;
        }
 
-       /* + 1 to handle when struct sr_context has no members. */
-       context = g_try_malloc0(sizeof(struct sr_context) + 1);
-
-       if (!context) {
-               ret = SR_ERR_MALLOC;
-               goto done;
+       if (sanity_check_all_transform_modules() < 0) {
+               sr_err("Internal transform module error(s), aborting.");
+               return ret;
        }
 
 #ifdef HAVE_LIBUSB_1_0
@@ -364,9 +511,10 @@ SR_API int sr_init(struct sr_context **ctx)
        context = NULL;
        ret = SR_OK;
 
+#ifdef HAVE_LIBUSB_1_0
 done:
-       if (context)
-               g_free(context);
+#endif
+       g_free(context);
        return ret;
 }
 
@@ -387,12 +535,13 @@ SR_API int sr_exit(struct sr_context *ctx)
                return SR_ERR;
        }
 
-       sr_hw_cleanup_all();
+       sr_hw_cleanup_all(ctx);
 
 #ifdef HAVE_LIBUSB_1_0
        libusb_exit(ctx->libusb_ctx);
 #endif
 
+       g_free(sr_driver_list(ctx));
        g_free(ctx);
 
        return SR_OK;