X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=backend.c;h=f650fe1206edb36bcf0eb0b023b036c84b0902ab;hb=3337e9a1c9e853a57beed80084d1f5ca93e0a3db;hp=eeaea2451c9ca8b15ddb5c415b361c841bfa4ab3;hpb=218e629fa48e2efb970b018d8d2ff8ccfa2d9a2c;p=libsigrok.git

diff --git a/backend.c b/backend.c
index eeaea245..f650fe12 100644
--- 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>
@@ -23,6 +23,10 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
+#define LOG_PREFIX "backend"
+/** @endcond */
+
 /**
  * @mainpage libsigrok API
  *
@@ -75,7 +79,8 @@
  *
  * Initializing and shutting down libsigrok.
  *
- * Before using any of the libsigrok functionality, sr_init() must
+ * 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.
  *
@@ -94,7 +99,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;
  *   	}
@@ -102,7 +107,7 @@
  *   	// 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;
  *   	}
@@ -117,7 +122,8 @@
 /**
  * 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)
 {
@@ -161,10 +167,6 @@ static int sanity_check_all_drivers(void)
 			sr_err("No dev_list in driver %d ('%s').", i, d);
 			errors++;
 		}
-		if (!drivers[i]->dev_clear) {
-			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);
@@ -207,7 +209,8 @@ static int sanity_check_all_drivers(void)
 /**
  * Sanity-check all libsigrok input modules.
  *
- * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules have issues.
  */
 static int sanity_check_all_input_modules(void)
 {
@@ -256,7 +259,8 @@ static int sanity_check_all_input_modules(void)
 /**
  * Sanity-check all libsigrok output modules.
  *
- * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules have issues.
  */
 static int sanity_check_all_output_modules(void)
 {
@@ -277,26 +281,14 @@ static int sanity_check_all_output_modules(void)
 			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);
+			sr_err("No description in module '%s'.", 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);
+		if (!outputs[i]->receive) {
+			sr_err("No receive in module '%s'.", d);
 			errors++;
 		}
 
-		/*
-		 * Currently most API calls are optional (their function
-		 * pointers can thus be NULL) in theory: init, event, cleanup.
-		 */
-
 		if (errors == 0)
 			continue;
 
@@ -319,6 +311,8 @@ static int sanity_check_all_output_modules(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)
 {
@@ -356,7 +350,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;
 	}
@@ -377,7 +371,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)
 {