Drop link-mso19/nexus-osciprime in preparation for release.

[libsigrok.git] / backend.c

diff --git a/backend.c b/backend.c
index 22f65a7c515174a6513c2f7d7c34d2fdb2584c74..c29968a4a84cc8d96b5f7431d6866e7a1ac715f0 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  * Copyright (C) 2012 Peter Stuge <peter@stuge.se>
@@ -165,20 +165,21 @@ static int sanity_check_all_drivers(void)
                        sr_err("No dev_clear in driver %d ('%s').", i, d);
                        errors++;
                }
-               if (!drivers[i]->dev_open) {
-                       sr_err("No dev_open in driver %d ('%s').", i, d);
+               /* Note: config_get() is optional. */
+               if (!drivers[i]->config_set) {
+                       sr_err("No config_set in driver %d ('%s').", i, d);
                        errors++;
                }
-               if (!drivers[i]->dev_close) {
-                       sr_err("No dev_close in driver %d ('%s').", i, d);
+               if (!drivers[i]->config_list) {
+                       sr_err("No config_list in driver %d ('%s').", i, d);
                        errors++;
                }
-               if (!drivers[i]->info_get) {
-                       sr_err("No info_get in driver %d ('%s').", i, d);
+               if (!drivers[i]->dev_open) {
+                       sr_err("No dev_open in driver %d ('%s').", i, d);
                        errors++;
                }
-               if (!drivers[i]->dev_config_set) {
-                       sr_err("No dev_config_set in driver %d ('%s').", i, d);
+               if (!drivers[i]->dev_close) {
+                       sr_err("No dev_close in driver %d ('%s').", i, d);
                        errors++;
                }
                if (!drivers[i]->dev_acquisition_start) {
@@ -203,6 +204,108 @@ static int sanity_check_all_drivers(void)
        return ret;
 }
 
+/**
+ * Sanity-check all libsigrok input modules.
+ *
+ * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
+ */
+static int sanity_check_all_input_modules(void)
+{
+       int i, errors, ret = SR_OK;
+       struct sr_input_format **inputs;
+       const char *d;
+
+       sr_spew("Sanity-checking all input modules.");
+
+       inputs = sr_input_list();
+       for (i = 0; inputs[i]; i++) {
+               errors = 0;
+
+               d = (inputs[i]->id) ? inputs[i]->id : "NULL";
+
+               if (!inputs[i]->id) {
+                       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);
+                       errors++;
+               }
+               if (!inputs[i]->format_match) {
+                       sr_err("No format_match 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);
+                       errors++;
+               }
+
+               if (errors == 0)
+                       continue;
+
+               ret = SR_ERR;
+       }
+
+       return ret;
+}
+
+/**
+ * Sanity-check all libsigrok output modules.
+ *
+ * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
+ */
+static int sanity_check_all_output_modules(void)
+{
+       int i, errors, ret = SR_OK;
+       struct sr_output_format **outputs;
+       const char *d;
+
+       sr_spew("Sanity-checking all output modules.");
+
+       outputs = sr_output_list();
+       for (i = 0; outputs[i]; i++) {
+               errors = 0;
+
+               d = (outputs[i]->id) ? outputs[i]->id : "NULL";
+
+               if (!outputs[i]->id) {
+                       sr_err("No ID in module %d ('%s').", i, d);
+                       errors++;
+               }
+               if (!outputs[i]->description) {
+                       sr_err("No description in module %d ('%s').", i, d);
+                       errors++;
+               }
+               if (outputs[i]->df_type < 10000 || outputs[i]->df_type > 10007) {
+                       sr_err("Invalid df_type %d in module %d ('%s').",
+                              outputs[i]->df_type, i, d);
+                       errors++;
+               }
+
+               /* All modules must provide a data or recv API callback. */
+               if (!outputs[i]->data && !outputs[i]->recv) {
+                       sr_err("No data/recv in module %d ('%s').", i, d);
+                       errors++;
+               }
+
+               /*
+                * Currently most API calls are optional (their function
+                * pointers can thus be NULL) in theory: init, event, cleanup.
+                */
+
+               if (errors == 0)
+                       continue;
+
+               ret = SR_ERR;
+       }
+
+       return ret;
+}
+
 /**
  * Initialize libsigrok.
  *
@@ -216,6 +319,8 @@ static int sanity_check_all_drivers(void)
  *         the 'ctx' pointer is undefined and should not be used. Upon success,
  *         the context will be free'd by sr_exit() as part of the libsigrok
  *         shutdown.
+ *
+ * @since 0.1.0 (but the API changed in 0.2.0)
  */
 SR_API int sr_init(struct sr_context **ctx)
 {
@@ -232,6 +337,16 @@ SR_API int sr_init(struct sr_context **ctx)
                return ret;
        }
 
+       if (sanity_check_all_input_modules() < 0) {
+               sr_err("Internal input module error(s), aborting.");
+               return ret;
+       }
+
+       if (sanity_check_all_output_modules() < 0) {
+               sr_err("Internal output module error(s), aborting.");
+               return ret;
+       }
+
        /* + 1 to handle when struct sr_context has no members. */
        context = g_try_malloc0(sizeof(struct sr_context) + 1);
 
@@ -244,14 +359,18 @@ SR_API int sr_init(struct sr_context **ctx)
        ret = libusb_init(&context->libusb_ctx);
        if (LIBUSB_SUCCESS != ret) {
                sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
+               ret = SR_ERR;
                goto done;
        }
 #endif
 
        *ctx = context;
+       context = NULL;
        ret = SR_OK;
 
 done:
+       if (context)
+               g_free(context);
        return ret;
 }
 
@@ -261,6 +380,8 @@ done:
  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
  *
  * @return SR_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0 (but the API changed in 0.2.0)
  */
 SR_API int sr_exit(struct sr_context *ctx)
 {