backend.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Peter Stuge <peter@stuge.se>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <glib.h>
  22 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25
  26 #define LOG_PREFIX "backend"
  27
  28 extern struct sr_session *session;
  29
  30 /**
  31  * @mainpage libsigrok API
  32  *
  33  * @section sec_intro Introduction
  34  *
  35  * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
  36  * portable, cross-platform, Free/Libre/Open-Source signal analysis software
  37  * suite that supports various device types (such as logic analyzers,
  38  * oscilloscopes, multimeters, and more).
  39  *
  40  * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
  41  * library written in C which provides the basic API for talking to
  42  * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
  43  * and reading/writing the acquired data into various
  44  * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
  45  * file formats</a>.
  46  *
  47  * @section sec_api API reference
  48  *
  49  * See the "Modules" page for an introduction to various libsigrok
  50  * related topics and the detailed API documentation of the respective
  51  * functions.
  52  *
  53  * You can also browse the API documentation by file, or review all
  54  * data structures.
  55  *
  56  * @section sec_mailinglists Mailing lists
  57  *
  58  * There are two mailing lists for sigrok/libsigrok: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
  59  *
  60  * @section sec_irc IRC
  61  *
  62  * You can find the sigrok developers in the
  63  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
  64  * IRC channel on Freenode.
  65  *
  66  * @section sec_website Website
  67  *
  68  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
  69  */
  70
  71 /**
  72  * @file
  73  *
  74  * Initializing and shutting down libsigrok.
  75  */
  76
  77 /**
  78  * @defgroup grp_init Initialization
  79  *
  80  * Initializing and shutting down libsigrok.
  81  *
  82  * Before using any of the libsigrok functionality, sr_init() must
  83  * be called to initialize the library, which will return a struct sr_context
  84  * when the initialization was successful.
  85  *
  86  * When libsigrok functionality is no longer needed, sr_exit() should be
  87  * called, which will (among other things) free the struct sr_context.
  88  *
  89  * Example for a minimal program using libsigrok:
  90  *
  91  * @code{.c}
  92  *   #include <stdio.h>
  93  *   #include <libsigrok/libsigrok.h>
  94  *
  95  *   int main(int argc, char **argv)
  96  *   {
  97  *      int ret;
  98  *      struct sr_context *sr_ctx;
  99  *
 100  *      if ((ret = sr_init(&sr_ctx)) != SR_OK) {
 101  *              printf("Error initializing libsigrok (%s): %s.\n",
 102  *                     sr_strerror_name(ret), sr_strerror(ret));
 103  *              return 1;
 104  *      }
 105  *
 106  *      // Use libsigrok functions here...
 107  *
 108  *      if ((ret = sr_exit(sr_ctx)) != SR_OK) {
 109  *              printf("Error shutting down libsigrok (%s): %s.\n",
 110  *                     sr_strerror_name(ret), sr_strerror(ret));
 111  *              return 1;
 112  *      }
 113  *
 114  *      return 0;
 115  *   }
 116  * @endcode
 117  *
 118  * @{
 119  */
 120
 121 /**
 122  * Sanity-check all libsigrok drivers.
 123  *
 124  * @retval SR_OK All drivers are OK
 125  * @retval SR_ERR One or more drivers have issues.
 126  */
 127 static int sanity_check_all_drivers(void)
 128 {
 129         int i, errors, ret = SR_OK;
 130         struct sr_dev_driver **drivers;
 131         const char *d;
 132
 133         sr_spew("Sanity-checking all drivers.");
 134
 135         drivers = sr_driver_list();
 136         for (i = 0; drivers[i]; i++) {
 137                 errors = 0;
 138
 139                 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
 140
 141                 if (!drivers[i]->name) {
 142                         sr_err("No name in driver %d ('%s').", i, d);
 143                         errors++;
 144                 }
 145                 if (!drivers[i]->longname) {
 146                         sr_err("No longname in driver %d ('%s').", i, d);
 147                         errors++;
 148                 }
 149                 if (drivers[i]->api_version < 1) {
 150                         sr_err("API version in driver %d ('%s') < 1.", i, d);
 151                         errors++;
 152                 }
 153                 if (!drivers[i]->init) {
 154                         sr_err("No init in driver %d ('%s').", i, d);
 155                         errors++;
 156                 }
 157                 if (!drivers[i]->cleanup) {
 158                         sr_err("No cleanup in driver %d ('%s').", i, d);
 159                         errors++;
 160                 }
 161                 if (!drivers[i]->scan) {
 162                         sr_err("No scan in driver %d ('%s').", i, d);
 163                         errors++;
 164                 }
 165                 if (!drivers[i]->dev_list) {
 166                         sr_err("No dev_list in driver %d ('%s').", i, d);
 167                         errors++;
 168                 }
 169                 if (!drivers[i]->dev_clear) {
 170                         sr_err("No dev_clear in driver %d ('%s').", i, d);
 171                         errors++;
 172                 }
 173                 /* Note: config_get() is optional. */
 174                 if (!drivers[i]->config_set) {
 175                         sr_err("No config_set in driver %d ('%s').", i, d);
 176                         errors++;
 177                 }
 178                 if (!drivers[i]->config_list) {
 179                         sr_err("No config_list in driver %d ('%s').", i, d);
 180                         errors++;
 181                 }
 182                 if (!drivers[i]->dev_open) {
 183                         sr_err("No dev_open in driver %d ('%s').", i, d);
 184                         errors++;
 185                 }
 186                 if (!drivers[i]->dev_close) {
 187                         sr_err("No dev_close in driver %d ('%s').", i, d);
 188                         errors++;
 189                 }
 190                 if (!drivers[i]->dev_acquisition_start) {
 191                         sr_err("No dev_acquisition_start in driver %d ('%s').",
 192                                i, d);
 193                         errors++;
 194                 }
 195                 if (!drivers[i]->dev_acquisition_stop) {
 196                         sr_err("No dev_acquisition_stop in driver %d ('%s').",
 197                                i, d);
 198                         errors++;
 199                 }
 200
 201                 /* Note: 'priv' is allowed to be NULL. */
 202
 203                 if (errors == 0)
 204                         continue;
 205
 206                 ret = SR_ERR;
 207         }
 208
 209         return ret;
 210 }
 211
 212 /**
 213  * Sanity-check all libsigrok input modules.
 214  *
 215  * @retval SR_OK All modules are OK
 216  * @retval SR_ERR One or more modules have issues.
 217  */
 218 static int sanity_check_all_input_modules(void)
 219 {
 220         int i, errors, ret = SR_OK;
 221         struct sr_input_format **inputs;
 222         const char *d;
 223
 224         sr_spew("Sanity-checking all input modules.");
 225
 226         inputs = sr_input_list();
 227         for (i = 0; inputs[i]; i++) {
 228                 errors = 0;
 229
 230                 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
 231
 232                 if (!inputs[i]->id) {
 233                         sr_err("No ID in module %d ('%s').", i, d);
 234                         errors++;
 235                 }
 236                 if (!inputs[i]->description) {
 237                         sr_err("No description in module %d ('%s').", i, d);
 238                         errors++;
 239                 }
 240                 if (!inputs[i]->format_match) {
 241                         sr_err("No format_match in module %d ('%s').", i, d);
 242                         errors++;
 243                 }
 244                 if (!inputs[i]->init) {
 245                         sr_err("No init in module %d ('%s').", i, d);
 246                         errors++;
 247                 }
 248                 if (!inputs[i]->loadfile) {
 249                         sr_err("No loadfile in module %d ('%s').", i, d);
 250                         errors++;
 251                 }
 252
 253                 if (errors == 0)
 254                         continue;
 255
 256                 ret = SR_ERR;
 257         }
 258
 259         return ret;
 260 }
 261
 262 /**
 263  * Sanity-check all libsigrok output modules.
 264  *
 265  * @retval SR_OK All modules are OK
 266  * @retval SR_ERR One or more modules have issues.
 267  */
 268 static int sanity_check_all_output_modules(void)
 269 {
 270         int i, errors, ret = SR_OK;
 271         struct sr_output_format **outputs;
 272         const char *d;
 273
 274         sr_spew("Sanity-checking all output modules.");
 275
 276         outputs = sr_output_list();
 277         for (i = 0; outputs[i]; i++) {
 278                 errors = 0;
 279
 280                 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
 281
 282                 if (!outputs[i]->id) {
 283                         sr_err("No ID in module %d ('%s').", i, d);
 284                         errors++;
 285                 }
 286                 if (!outputs[i]->description) {
 287                         sr_err("No description in module %d ('%s').", i, d);
 288                         errors++;
 289                 }
 290                 if (outputs[i]->df_type < 10000 || outputs[i]->df_type > 10007) {
 291                         sr_err("Invalid df_type %d in module %d ('%s').",
 292                                outputs[i]->df_type, i, d);
 293                         errors++;
 294                 }
 295
 296                 /* All modules must provide a data or recv API callback. */
 297                 if (!outputs[i]->data && !outputs[i]->receive) {
 298                         sr_err("No data/receive in module %d ('%s').", i, d);
 299                         errors++;
 300                 }
 301
 302                 /*
 303                  * Currently most API calls are optional (their function
 304                  * pointers can thus be NULL) in theory: init, event, cleanup.
 305                  */
 306
 307                 if (errors == 0)
 308                         continue;
 309
 310                 ret = SR_ERR;
 311         }
 312
 313         return ret;
 314 }
 315
 316 /**
 317  * Initialize libsigrok.
 318  *
 319  * This function must be called before any other libsigrok function.
 320  *
 321  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
 322  *            This will be a pointer to a newly allocated libsigrok context
 323  *            object upon success, and is undefined upon errors.
 324  *
 325  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
 326  *         the 'ctx' pointer is undefined and should not be used. Upon success,
 327  *         the context will be free'd by sr_exit() as part of the libsigrok
 328  *         shutdown.
 329  *
 330  * @since 0.2.0
 331  */
 332 SR_API int sr_init(struct sr_context **ctx)
 333 {
 334         int ret = SR_ERR;
 335         struct sr_context *context;
 336
 337         if (!ctx) {
 338                 sr_err("%s(): libsigrok context was NULL.", __func__);
 339                 return SR_ERR;
 340         }
 341
 342         if (sanity_check_all_drivers() < 0) {
 343                 sr_err("Internal driver error(s), aborting.");
 344                 return ret;
 345         }
 346
 347         if (sanity_check_all_input_modules() < 0) {
 348                 sr_err("Internal input module error(s), aborting.");
 349                 return ret;
 350         }
 351
 352         if (sanity_check_all_output_modules() < 0) {
 353                 sr_err("Internal output module error(s), aborting.");
 354                 return ret;
 355         }
 356
 357         /* + 1 to handle when struct sr_context has no members. */
 358         context = g_try_malloc0(sizeof(struct sr_context) + 1);
 359
 360         if (!context) {
 361                 ret = SR_ERR_MALLOC;
 362                 goto done;
 363         }
 364
 365 #ifdef HAVE_LIBUSB_1_0
 366         ret = libusb_init(&context->libusb_ctx);
 367         if (LIBUSB_SUCCESS != ret) {
 368                 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
 369                 ret = SR_ERR;
 370                 goto done;
 371         }
 372 #endif
 373
 374         *ctx = context;
 375         context = NULL;
 376         session = NULL;
 377         ret = SR_OK;
 378
 379 done:
 380         if (context)
 381                 g_free(context);
 382         return ret;
 383 }
 384
 385 /**
 386  * Shutdown libsigrok.
 387  *
 388  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
 389  *
 390  * @retval SR_OK Success
 391  * @retval other Error code SR_ERR, ...
 392  *
 393  * @since 0.2.0
 394  */
 395 SR_API int sr_exit(struct sr_context *ctx)
 396 {
 397         if (!ctx) {
 398                 sr_err("%s(): libsigrok context was NULL.", __func__);
 399                 return SR_ERR;
 400         }
 401
 402         sr_hw_cleanup_all();
 403
 404 #ifdef HAVE_LIBUSB_1_0
 405         libusb_exit(ctx->libusb_ctx);
 406 #endif
 407
 408         g_free(ctx);
 409
 410         return SR_OK;
 411 }
 412
 413 /** @} */