]> sigrok.org Git - libsigrok.git/blobdiff - backend.c
gmc-mh-1x-2x: Support for interface SI232-II with driver gmc-mh-2x-bd232.
[libsigrok.git] / backend.c
index 0dab1eeab93f42d938a1b5c0c9df94e9e7636d28..0ed16a58f47fc894cf126dc73180055f3e41f520 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>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "backend"
+
+extern struct sr_session *session;
+
 /**
  * @mainpage libsigrok API
  *
@@ -94,7 +98,7 @@
  *     struct sr_context *sr_ctx;
  *
  *     if ((ret = sr_init(&sr_ctx)) != SR_OK) {
- *             printf("Error initializing libsigrok (%s): %s.",
+ *             printf("Error initializing libsigrok (%s): %s.\n",
  *                    sr_strerror_name(ret), sr_strerror(ret));
  *             return 1;
  *     }
  *     // Use libsigrok functions here...
  *
  *     if ((ret = sr_exit(sr_ctx)) != SR_OK) {
- *             printf("Error shutting down libsigrok (%s): %s.",
+ *             printf("Error shutting down libsigrok (%s): %s.\n",
  *                    sr_strerror_name(ret), sr_strerror(ret));
  *             return 1;
  *     }
 /**
  * Sanity-check all libsigrok drivers.
  *
- * @return SR_OK if all drivers are OK, SR_ERR if one or more have issues.
+ * @retval SR_OK All drivers are OK
+ * @retval SR_ERR One or more drivers have issues.
  */
 static int sanity_check_all_drivers(void)
 {
@@ -165,6 +170,15 @@ static int sanity_check_all_drivers(void)
                        sr_err("No dev_clear in driver %d ('%s').", i, d);
                        errors++;
                }
+               /* 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]->config_list) {
+                       sr_err("No config_list in driver %d ('%s').", i, d);
+                       errors++;
+               }
                if (!drivers[i]->dev_open) {
                        sr_err("No dev_open in driver %d ('%s').", i, d);
                        errors++;
@@ -195,6 +209,110 @@ static int sanity_check_all_drivers(void)
        return ret;
 }
 
+/**
+ * Sanity-check all libsigrok input modules.
+ *
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules 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.
+ *
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules 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]->receive) {
+                       sr_err("No data/receive 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.
  *
@@ -208,6 +326,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.2.0
  */
 SR_API int sr_init(struct sr_context **ctx)
 {
@@ -224,6 +344,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);
 
@@ -235,7 +365,7 @@ SR_API int sr_init(struct sr_context **ctx)
 #ifdef HAVE_LIBUSB_1_0
        ret = libusb_init(&context->libusb_ctx);
        if (LIBUSB_SUCCESS != ret) {
-               sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
+               sr_err("libusb_init() returned %s.", libusb_error_name(ret));
                ret = SR_ERR;
                goto done;
        }
@@ -243,6 +373,7 @@ SR_API int sr_init(struct sr_context **ctx)
 
        *ctx = context;
        context = NULL;
+       session = NULL;
        ret = SR_OK;
 
 done:
@@ -256,7 +387,10 @@ done:
  *
  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
  *
- * @return SR_OK upon success, a (negative) error code otherwise.
+ * @retval SR_OK Success
+ * @retval other Error code SR_ERR, ...
+ *
+ * @since 0.2.0
  */
 SR_API int sr_exit(struct sr_context *ctx)
 {