X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=backend.c;h=2f51eedd02a595c6be9039470a1151d1890ae7f3;hb=refs%2Fheads%2Flibsigrok-0.3.x;hp=840b1723df9fea38ee755e2ee4ada1a2a258d48d;hpb=7b870c38e3040fec1165a623ae3986e4fb342218;p=libsigrok.git diff --git a/backend.c b/backend.c index 840b1723..2f51eedd 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 @@ -19,9 +19,16 @@ */ #include +#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ #include "libsigrok.h" #include "libsigrok-internal.h" +/** @cond PRIVATE */ +#define LOG_PREFIX "backend" +/** @endcond */ + +extern struct sr_session *session; + /** * @mainpage libsigrok API * @@ -39,10 +46,14 @@ * input/output * file formats. * - * @section sec_error_handling Error handling + * @section sec_api API reference + * + * See the "Modules" page for an introduction to various libsigrok + * related topics and the detailed API documentation of the respective + * functions. * - * libsigrok functions usually return @ref SR_OK upon success, or a negative - * error code on failure. + * You can also browse the API documentation by file, or review all + * data structures. * * @section sec_mailinglists Mailing lists * @@ -59,14 +70,235 @@ * sigrok.org/wiki/Libsigrok */ +/** + * @file + * + * Initializing and shutting down libsigrok. + */ + /** * @defgroup grp_init Initialization * * Initializing and shutting down libsigrok. * + * Before using any of the libsigrok functionality, sr_init() must + * be called to initialize the library, which will return a struct sr_context + * when the initialization was successful. + * + * When libsigrok functionality is no longer needed, sr_exit() should be + * called, which will (among other things) free the struct sr_context. + * + * Example for a minimal program using libsigrok: + * + * @code{.c} + * #include + * #include + * + * int main(int argc, char **argv) + * { + * int ret; + * struct sr_context *sr_ctx; + * + * if ((ret = sr_init(&sr_ctx)) != SR_OK) { + * 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.\n", + * sr_strerror_name(ret), sr_strerror(ret)); + * return 1; + * } + * + * return 0; + * } + * @endcode + * * @{ */ +/** + * Sanity-check all libsigrok drivers. + * + * @retval SR_OK All drivers are OK + * @retval SR_ERR One or more drivers have issues. + */ +static int sanity_check_all_drivers(void) +{ + int i, errors, ret = SR_OK; + struct sr_dev_driver **drivers; + const char *d; + + sr_spew("Sanity-checking all drivers."); + + drivers = sr_driver_list(); + for (i = 0; drivers[i]; i++) { + errors = 0; + + d = (drivers[i]->name) ? drivers[i]->name : "NULL"; + + if (!drivers[i]->name) { + sr_err("No name in driver %d ('%s').", i, d); + errors++; + } + if (!drivers[i]->longname) { + sr_err("No longname in driver %d ('%s').", i, d); + errors++; + } + if (drivers[i]->api_version < 1) { + sr_err("API version in driver %d ('%s') < 1.", i, d); + errors++; + } + if (!drivers[i]->init) { + sr_err("No init in driver %d ('%s').", i, d); + errors++; + } + if (!drivers[i]->cleanup) { + sr_err("No cleanup in driver %d ('%s').", i, d); + errors++; + } + if (!drivers[i]->scan) { + sr_err("No scan in driver %d ('%s').", i, d); + errors++; + } + if (!drivers[i]->dev_list) { + sr_err("No dev_list 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++; + } + if (!drivers[i]->dev_close) { + sr_err("No dev_close 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); + errors++; + } + if (!drivers[i]->dev_acquisition_stop) { + sr_err("No dev_acquisition_stop in driver %d ('%s').", + i, d); + errors++; + } + + /* Note: 'priv' is allowed to be NULL. */ + + if (errors == 0) + continue; + + ret = SR_ERR; + } + + 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. * @@ -80,6 +312,8 @@ * 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) { @@ -91,6 +325,21 @@ SR_API int sr_init(struct sr_context **ctx) return SR_ERR; } + if (sanity_check_all_drivers() < 0) { + sr_err("Internal driver error(s), aborting."); + 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); @@ -102,15 +351,20 @@ 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; + session = NULL; ret = SR_OK; done: + if (context) + g_free(context); return ret; } @@ -119,7 +373,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) {