X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=backend.c;h=f650fe1206edb36bcf0eb0b023b036c84b0902ab;hp=22f65a7c515174a6513c2f7d7c34d2fdb2584c74;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=55a6daf59f85449d99a62b0a3b6010980125d38d diff --git a/backend.c b/backend.c index 22f65a7c..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 * Copyright (C) 2012 Peter Stuge @@ -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,8 +167,13 @@ 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); + /* 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) { @@ -173,14 +184,6 @@ static int sanity_check_all_drivers(void) sr_err("No dev_close in driver %d ('%s').", i, d); errors++; } - if (!drivers[i]->info_get) { - sr_err("No info_get 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); - errors++; - } if (!drivers[i]->dev_acquisition_start) { sr_err("No dev_acquisition_start in driver %d ('%s').", i, d); @@ -203,6 +206,98 @@ 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 '%s'.", d); + errors++; + } + if (!outputs[i]->receive) { + sr_err("No receive in module '%s'.", d); + errors++; + } + + if (errors == 0) + continue; + + ret = SR_ERR; + } + + return ret; +} + /** * Initialize libsigrok. * @@ -216,6 +311,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) { @@ -232,6 +329,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); @@ -243,15 +350,19 @@ 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; } #endif *ctx = context; + context = NULL; ret = SR_OK; done: + if (context) + g_free(context); return ret; } @@ -260,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) {