X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=backend.c;h=ab668efa800576dacfe8379e64c868b83772dc7c;hb=88b1d4e573480757f08ea4312b15bdccc264d444;hp=0d1b47263f66ba14eb5eff371a1d7773ee9d0eca;hpb=53f05fa80f1f9d7657f1173f24d9d1e2b740a312;p=libsigrok.git diff --git a/backend.c b/backend.c index 0d1b4726..ab668efa 100644 --- a/backend.c +++ b/backend.c @@ -23,6 +23,10 @@ #include "libsigrok.h" #include "libsigrok-internal.h" +/** @cond PRIVATE */ +#define LOG_PREFIX "backend" +/** @endcond */ + extern struct sr_session *session; /** @@ -77,7 +81,8 @@ extern struct sr_session *session; * * 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. * @@ -96,7 +101,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 +109,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 +124,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 +169,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 +211,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 +261,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) { @@ -279,26 +283,14 @@ static int sanity_check_all_output_modules(void) errors++; } if (!outputs[i]->description) { - sr_err("No description in module %d ('%s').", i, d); + sr_err("No description in module '%s'.", 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); + if (!outputs[i]->receive) { + sr_err("No receive in module '%s'.", 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; @@ -360,7 +352,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 +374,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 */