src/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 <config.h>
  22 #include <glib.h>
  23 #ifdef _WIN32
  24 #include <winsock2.h>
  25 #endif
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28
  29 /** @cond PRIVATE */
  30 #define LOG_PREFIX "backend"
  31 /** @endcond */
  32
  33 /**
  34  * @mainpage libsigrok API
  35  *
  36  * @section sec_intro Introduction
  37  *
  38  * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
  39  * portable, cross-platform, Free/Libre/Open-Source signal analysis software
  40  * suite that supports various device types (such as logic analyzers,
  41  * oscilloscopes, multimeters, and more).
  42  *
  43  * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
  44  * library written in C which provides the basic API for talking to
  45  * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
  46  * and reading/writing the acquired data into various
  47  * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
  48  * file formats</a>.
  49  *
  50  * @section sec_api API reference
  51  *
  52  * See the "Modules" page for an introduction to various libsigrok
  53  * related topics and the detailed API documentation of the respective
  54  * functions.
  55  *
  56  * You can also browse the API documentation by file, or review all
  57  * data structures.
  58  *
  59  * @section sec_mailinglists Mailing lists
  60  *
  61  * There is one mailing list for sigrok/libsigrok: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a>.
  62  *
  63  * @section sec_irc IRC
  64  *
  65  * You can find the sigrok developers in the
  66  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
  67  * IRC channel on Freenode.
  68  *
  69  * @section sec_website Website
  70  *
  71  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
  72  */
  73
  74 /**
  75  * @file
  76  *
  77  * Initializing and shutting down libsigrok.
  78  */
  79
  80 /**
  81  * @defgroup grp_init Initialization
  82  *
  83  * Initializing and shutting down libsigrok.
  84  *
  85  * Before using any of the libsigrok functionality (except for
  86  * sr_log_loglevel_set()), sr_init() must be called to initialize the
  87  * library, which will return a struct sr_context when the initialization
  88  * was successful.
  89  *
  90  * When libsigrok functionality is no longer needed, sr_exit() should be
  91  * called, which will (among other things) free the struct sr_context.
  92  *
  93  * Example for a minimal program using libsigrok:
  94  *
  95  * @code{.c}
  96  *   #include <stdio.h>
  97  *   #include <libsigrok/libsigrok.h>
  98  *
  99  *   int main(int argc, char **argv)
 100  *   {
 101  *      int ret;
 102  *      struct sr_context *sr_ctx;
 103  *
 104  *      if ((ret = sr_init(&sr_ctx)) != SR_OK) {
 105  *              printf("Error initializing libsigrok (%s): %s.\n",
 106  *                     sr_strerror_name(ret), sr_strerror(ret));
 107  *              return 1;
 108  *      }
 109  *
 110  *      // Use libsigrok functions here...
 111  *
 112  *      if ((ret = sr_exit(sr_ctx)) != SR_OK) {
 113  *              printf("Error shutting down libsigrok (%s): %s.\n",
 114  *                     sr_strerror_name(ret), sr_strerror(ret));
 115  *              return 1;
 116  *      }
 117  *
 118  *      return 0;
 119  *   }
 120  * @endcode
 121  *
 122  * @{
 123  */
 124
 125 SR_API GSList *sr_buildinfo_libs_get(void)
 126 {
 127         GSList *l = NULL, *m = NULL;
 128 #if defined(HAVE_LIBUSB_1_0) && !defined(__FreeBSD__)
 129         const struct libusb_version *lv;
 130 #endif
 131
 132         m = g_slist_append(NULL, g_strdup("glib"));
 133         m = g_slist_append(m, g_strdup_printf("%d.%d.%d (rt: %d.%d.%d/%d:%d)",
 134                 GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
 135                 glib_major_version, glib_minor_version, glib_micro_version,
 136                 glib_binary_age, glib_interface_age));
 137         l = g_slist_append(l, m);
 138
 139         m = g_slist_append(NULL, g_strdup("libzip"));
 140         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBZIP_VERSION));
 141         l = g_slist_append(l, m);
 142
 143 #ifdef HAVE_LIBSERIALPORT
 144         m = g_slist_append(NULL, g_strdup("libserialport"));
 145         m = g_slist_append(m, g_strdup_printf("%s/%s (rt: %s/%s)",
 146                 SP_PACKAGE_VERSION_STRING, SP_LIB_VERSION_STRING,
 147                 sp_get_package_version_string(), sp_get_lib_version_string()));
 148         l = g_slist_append(l, m);
 149 #endif
 150 #ifdef HAVE_LIBUSB_1_0
 151         m = g_slist_append(NULL, g_strdup("libusb-1.0"));
 152 #ifdef __FreeBSD__
 153         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBUSB_1_0_VERSION));
 154 #else
 155         lv = libusb_get_version();
 156         m = g_slist_append(m, g_strdup_printf("%d.%d.%d.%d%s",
 157                 lv->major, lv->minor, lv->micro, lv->nano, lv->rc));
 158 #endif
 159         l = g_slist_append(l, m);
 160 #endif
 161 #ifdef HAVE_LIBFTDI
 162         m = g_slist_append(NULL, g_strdup("libftdi"));
 163         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBFTDI_VERSION));
 164         l = g_slist_append(l, m);
 165 #endif
 166 #ifdef HAVE_LIBGPIB
 167         m = g_slist_append(NULL, g_strdup("libgpib"));
 168         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBGPIB_VERSION));
 169         l = g_slist_append(l, m);
 170 #endif
 171 #ifdef HAVE_LIBREVISA
 172         m = g_slist_append(NULL, g_strdup("librevisa"));
 173         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBREVISA_VERSION));
 174         l = g_slist_append(l, m);
 175 #endif
 176
 177         return l;
 178 }
 179
 180 SR_API char *sr_buildinfo_host_get(void)
 181 {
 182         return g_strdup_printf("%s, %s-endian", CONF_HOST,
 183 #ifdef WORDS_BIGENDIAN
 184         "big"
 185 #else
 186         "little"
 187 #endif
 188         );
 189 }
 190
 191 SR_API char *sr_buildinfo_scpi_backends_get(void)
 192 {
 193         GString *s;
 194         char *str;
 195
 196         s = g_string_sized_new(200);
 197
 198         g_string_append_printf(s, "TCP, ");
 199 #if HAVE_RPC
 200         g_string_append_printf(s, "RPC, ");
 201 #endif
 202 #ifdef HAVE_LIBSERIALPORT
 203         g_string_append_printf(s, "serial, ");
 204 #endif
 205 #ifdef HAVE_LIBREVISA
 206         g_string_append_printf(s, "VISA, ");
 207 #endif
 208 #ifdef HAVE_LIBGPIB
 209         g_string_append_printf(s, "GPIB, ");
 210 #endif
 211 #ifdef HAVE_LIBUSB_1_0
 212         g_string_append_printf(s, "USBTMC, ");
 213 #endif
 214         s->str[s->len - 2] = '\0';
 215
 216         str = g_strdup(s->str);
 217         g_string_free(s, TRUE);
 218
 219         return str;
 220 }
 221
 222 static void print_versions(void)
 223 {
 224         GString *s;
 225         GSList *l, *l_orig, *m;
 226         char *str;
 227         const char *lib, *version;
 228
 229         sr_dbg("libsigrok %s/%s (rt: %s/%s).",
 230                 SR_PACKAGE_VERSION_STRING, SR_LIB_VERSION_STRING,
 231                 sr_package_version_string_get(), sr_lib_version_string_get());
 232
 233         s = g_string_sized_new(200);
 234         g_string_append(s, "Libs: ");
 235         l_orig = sr_buildinfo_libs_get();
 236         for (l = l_orig; l; l = l->next) {
 237                 m = l->data;
 238                 lib = m->data;
 239                 version = m->next->data;
 240                 g_string_append_printf(s, "%s %s, ", lib, version);
 241                 g_slist_free_full(m, g_free);
 242         }
 243         g_slist_free(l_orig);
 244         s->str[s->len - 2] = '.';
 245         s->str[s->len - 1] = '\0';
 246         sr_dbg("%s", s->str);
 247         g_string_free(s, TRUE);
 248
 249         str = sr_buildinfo_host_get();
 250         sr_dbg("Host: %s.", str);
 251         g_free(str);
 252
 253         str = sr_buildinfo_scpi_backends_get();
 254         sr_dbg("SCPI backends: %s.", str);
 255         g_free(str);
 256 }
 257
 258 static void print_resourcepaths(void)
 259 {
 260         GSList *l, *l_orig;
 261
 262         sr_dbg("Firmware search paths:");
 263         l_orig = sr_resourcepaths_get(SR_RESOURCE_FIRMWARE);
 264         for (l = l_orig; l; l = l->next)
 265                 sr_dbg(" - %s", (const char *)l->data);
 266         g_slist_free_full(l_orig, g_free);
 267 }
 268
 269 /**
 270  * Sanity-check all libsigrok drivers.
 271  *
 272  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 273  *
 274  * @retval SR_OK All drivers are OK
 275  * @retval SR_ERR One or more drivers have issues.
 276  * @retval SR_ERR_ARG Invalid argument.
 277  */
 278 static int sanity_check_all_drivers(const struct sr_context *ctx)
 279 {
 280         int i, errors, ret = SR_OK;
 281         struct sr_dev_driver **drivers;
 282         const char *d;
 283
 284         if (!ctx)
 285                 return SR_ERR_ARG;
 286
 287         sr_spew("Sanity-checking all drivers.");
 288
 289         drivers = sr_driver_list(ctx);
 290         for (i = 0; drivers[i]; i++) {
 291                 errors = 0;
 292
 293                 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
 294
 295                 if (!drivers[i]->name) {
 296                         sr_err("No name in driver %d ('%s').", i, d);
 297                         errors++;
 298                 }
 299                 if (!drivers[i]->longname) {
 300                         sr_err("No longname in driver %d ('%s').", i, d);
 301                         errors++;
 302                 }
 303                 if (drivers[i]->api_version < 1) {
 304                         sr_err("API version in driver %d ('%s') < 1.", i, d);
 305                         errors++;
 306                 }
 307                 if (!drivers[i]->init) {
 308                         sr_err("No init in driver %d ('%s').", i, d);
 309                         errors++;
 310                 }
 311                 if (!drivers[i]->cleanup) {
 312                         sr_err("No cleanup in driver %d ('%s').", i, d);
 313                         errors++;
 314                 }
 315                 if (!drivers[i]->scan) {
 316                         sr_err("No scan in driver %d ('%s').", i, d);
 317                         errors++;
 318                 }
 319                 if (!drivers[i]->dev_list) {
 320                         sr_err("No dev_list in driver %d ('%s').", i, d);
 321                         errors++;
 322                 }
 323                 if (!drivers[i]->dev_clear) {
 324                         sr_err("No dev_clear in driver %d ('%s').", i, d);
 325                         errors++;
 326                 }
 327                 /* Note: config_get() is optional. */
 328                 if (!drivers[i]->config_set) {
 329                         sr_err("No config_set in driver %d ('%s').", i, d);
 330                         errors++;
 331                 }
 332                 /* Note: config_channel_set() is optional. */
 333                 /* Note: config_commit() is optional. */
 334                 if (!drivers[i]->config_list) {
 335                         sr_err("No config_list in driver %d ('%s').", i, d);
 336                         errors++;
 337                 }
 338                 if (!drivers[i]->dev_open) {
 339                         sr_err("No dev_open in driver %d ('%s').", i, d);
 340                         errors++;
 341                 }
 342                 if (!drivers[i]->dev_close) {
 343                         sr_err("No dev_close in driver %d ('%s').", i, d);
 344                         errors++;
 345                 }
 346                 if (!drivers[i]->dev_acquisition_start) {
 347                         sr_err("No dev_acquisition_start in driver %d ('%s').",
 348                                i, d);
 349                         errors++;
 350                 }
 351                 if (!drivers[i]->dev_acquisition_stop) {
 352                         sr_err("No dev_acquisition_stop in driver %d ('%s').",
 353                                i, d);
 354                         errors++;
 355                 }
 356
 357                 /* Note: 'priv' is allowed to be NULL. */
 358
 359                 if (errors == 0)
 360                         continue;
 361
 362                 ret = SR_ERR;
 363         }
 364
 365         return ret;
 366 }
 367
 368 /**
 369  * Sanity-check all libsigrok input modules.
 370  *
 371  * @retval SR_OK All modules are OK
 372  * @retval SR_ERR One or more modules have issues.
 373  */
 374 static int sanity_check_all_input_modules(void)
 375 {
 376         int i, errors, ret = SR_OK;
 377         const struct sr_input_module **inputs;
 378         const char *d;
 379
 380         sr_spew("Sanity-checking all input modules.");
 381
 382         inputs = sr_input_list();
 383         for (i = 0; inputs[i]; i++) {
 384                 errors = 0;
 385
 386                 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
 387
 388                 if (!inputs[i]->id) {
 389                         sr_err("No ID in module %d ('%s').", i, d);
 390                         errors++;
 391                 }
 392                 if (!inputs[i]->name) {
 393                         sr_err("No name in module %d ('%s').", i, d);
 394                         errors++;
 395                 }
 396                 if (!inputs[i]->desc) {
 397                         sr_err("No description in module %d ('%s').", i, d);
 398                         errors++;
 399                 }
 400                 if (!inputs[i]->init) {
 401                         sr_err("No init in module %d ('%s').", i, d);
 402                         errors++;
 403                 }
 404                 if (!inputs[i]->receive) {
 405                         sr_err("No receive in module %d ('%s').", i, d);
 406                         errors++;
 407                 }
 408                 if (!inputs[i]->end) {
 409                         sr_err("No end in module %d ('%s').", i, d);
 410                         errors++;
 411                 }
 412
 413                 if (errors == 0)
 414                         continue;
 415
 416                 ret = SR_ERR;
 417         }
 418
 419         return ret;
 420 }
 421
 422 /**
 423  * Sanity-check all libsigrok output modules.
 424  *
 425  * @retval SR_OK All modules are OK
 426  * @retval SR_ERR One or more modules have issues.
 427  */
 428 static int sanity_check_all_output_modules(void)
 429 {
 430         int i, errors, ret = SR_OK;
 431         const struct sr_output_module **outputs;
 432         const char *d;
 433
 434         sr_spew("Sanity-checking all output modules.");
 435
 436         outputs = sr_output_list();
 437         for (i = 0; outputs[i]; i++) {
 438                 errors = 0;
 439
 440                 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
 441
 442                 if (!outputs[i]->id) {
 443                         sr_err("No ID in module %d ('%s').", i, d);
 444                         errors++;
 445                 }
 446                 if (!outputs[i]->name) {
 447                         sr_err("No name in module %d ('%s').", i, d);
 448                         errors++;
 449                 }
 450                 if (!outputs[i]->desc) {
 451                         sr_err("No description in module '%s'.", d);
 452                         errors++;
 453                 }
 454                 if (!outputs[i]->receive) {
 455                         sr_err("No receive in module '%s'.", d);
 456                         errors++;
 457                 }
 458
 459                 if (errors == 0)
 460                         continue;
 461
 462                 ret = SR_ERR;
 463         }
 464
 465         return ret;
 466 }
 467
 468 /**
 469  * Sanity-check all libsigrok transform modules.
 470  *
 471  * @retval SR_OK All modules are OK
 472  * @retval SR_ERR One or more modules have issues.
 473  */
 474 static int sanity_check_all_transform_modules(void)
 475 {
 476         int i, errors, ret = SR_OK;
 477         const struct sr_transform_module **transforms;
 478         const char *d;
 479
 480         sr_spew("Sanity-checking all transform modules.");
 481
 482         transforms = sr_transform_list();
 483         for (i = 0; transforms[i]; i++) {
 484                 errors = 0;
 485
 486                 d = (transforms[i]->id) ? transforms[i]->id : "NULL";
 487
 488                 if (!transforms[i]->id) {
 489                         sr_err("No ID in module %d ('%s').", i, d);
 490                         errors++;
 491                 }
 492                 if (!transforms[i]->name) {
 493                         sr_err("No name in module %d ('%s').", i, d);
 494                         errors++;
 495                 }
 496                 if (!transforms[i]->desc) {
 497                         sr_err("No description in module '%s'.", d);
 498                         errors++;
 499                 }
 500                 /* Note: options() is optional. */
 501                 /* Note: init() is optional. */
 502                 if (!transforms[i]->receive) {
 503                         sr_err("No receive in module '%s'.", d);
 504                         errors++;
 505                 }
 506                 /* Note: cleanup() is optional. */
 507
 508                 if (errors == 0)
 509                         continue;
 510
 511                 ret = SR_ERR;
 512         }
 513
 514         return ret;
 515 }
 516
 517 /**
 518  * Initialize libsigrok.
 519  *
 520  * This function must be called before any other libsigrok function.
 521  *
 522  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
 523  *            This will be a pointer to a newly allocated libsigrok context
 524  *            object upon success, and is undefined upon errors.
 525  *
 526  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
 527  *         the 'ctx' pointer is undefined and should not be used. Upon success,
 528  *         the context will be free'd by sr_exit() as part of the libsigrok
 529  *         shutdown.
 530  *
 531  * @since 0.2.0
 532  */
 533 SR_API int sr_init(struct sr_context **ctx)
 534 {
 535         int ret = SR_ERR;
 536         struct sr_context *context;
 537 #ifdef _WIN32
 538         WSADATA wsadata;
 539 #endif
 540
 541         print_versions();
 542
 543         print_resourcepaths();
 544
 545         if (!ctx) {
 546                 sr_err("%s(): libsigrok context was NULL.", __func__);
 547                 return SR_ERR;
 548         }
 549
 550         context = g_malloc0(sizeof(struct sr_context));
 551
 552         sr_drivers_init(context);
 553
 554         if (sanity_check_all_drivers(context) < 0) {
 555                 sr_err("Internal driver error(s), aborting.");
 556                 goto done;
 557         }
 558
 559         if (sanity_check_all_input_modules() < 0) {
 560                 sr_err("Internal input module error(s), aborting.");
 561                 goto done;
 562         }
 563
 564         if (sanity_check_all_output_modules() < 0) {
 565                 sr_err("Internal output module error(s), aborting.");
 566                 goto done;
 567         }
 568
 569         if (sanity_check_all_transform_modules() < 0) {
 570                 sr_err("Internal transform module error(s), aborting.");
 571                 goto done;
 572         }
 573
 574 #ifdef _WIN32
 575         if ((ret = WSAStartup(MAKEWORD(2, 2), &wsadata)) != 0) {
 576                 sr_err("WSAStartup failed with error code %d.", ret);
 577                 ret = SR_ERR;
 578                 goto done;
 579         }
 580 #endif
 581
 582 #ifdef HAVE_LIBUSB_1_0
 583         ret = libusb_init(&context->libusb_ctx);
 584         if (LIBUSB_SUCCESS != ret) {
 585                 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
 586                 ret = SR_ERR;
 587                 goto done;
 588         }
 589 #endif
 590         sr_resource_set_hooks(context, NULL, NULL, NULL, NULL);
 591
 592         *ctx = context;
 593         context = NULL;
 594         ret = SR_OK;
 595
 596 done:
 597         g_free(context);
 598         return ret;
 599 }
 600
 601 /**
 602  * Shutdown libsigrok.
 603  *
 604  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
 605  *
 606  * @retval SR_OK Success
 607  * @retval other Error code SR_ERR, ...
 608  *
 609  * @since 0.2.0
 610  */
 611 SR_API int sr_exit(struct sr_context *ctx)
 612 {
 613         if (!ctx) {
 614                 sr_err("%s(): libsigrok context was NULL.", __func__);
 615                 return SR_ERR;
 616         }
 617
 618         sr_hw_cleanup_all(ctx);
 619
 620 #ifdef _WIN32
 621         WSACleanup();
 622 #endif
 623
 624 #ifdef HAVE_LIBUSB_1_0
 625         libusb_exit(ctx->libusb_ctx);
 626 #endif
 627
 628         g_free(sr_driver_list(ctx));
 629         g_free(ctx);
 630
 631         return SR_OK;
 632 }
 633
 634 /** @} */