]> sigrok.org Git - libsigrok.git/blobdiff - backend.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / backend.c
index 0d1b47263f66ba14eb5eff371a1d7773ee9d0eca..7f1fef889f68b5994c637b4de3f6ca99d145404e 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -23,6 +23,8 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "backend"
+
 extern struct sr_session *session;
 
 /**
@@ -96,7 +98,7 @@ extern struct sr_session *session;
  *     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;
  *     }
@@ -104,7 +106,7 @@ extern struct sr_session *session;
  *     // 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;
  *     }
@@ -119,7 +121,8 @@ extern struct sr_session *session;
 /**
  * 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)
 {
@@ -163,10 +166,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);
@@ -209,7 +208,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)
 {
@@ -258,7 +258,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)
 {
@@ -360,7 +361,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;
        }
@@ -382,7 +383,8 @@ 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
  */