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 API 0x%08x",
 157                 lv->major, lv->minor, lv->micro, lv->nano, lv->rc,
 158 #if defined(LIBUSB_API_VERSION)
 159                 LIBUSB_API_VERSION
 160 #elif defined(LIBUSBX_API_VERSION)
 161                 LIBUSBX_API_VERSION
 162 #endif
 163                 ));
 164 #endif
 165         l = g_slist_append(l, m);
 166 #endif
 167 #ifdef HAVE_LIBFTDI
 168         m = g_slist_append(NULL, g_strdup("libftdi"));
 169         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBFTDI_VERSION));
 170         l = g_slist_append(l, m);
 171 #endif
 172 #ifdef HAVE_LIBGPIB
 173         m = g_slist_append(NULL, g_strdup("libgpib"));
 174         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBGPIB_VERSION));
 175         l = g_slist_append(l, m);
 176 #endif
 177 #ifdef HAVE_LIBREVISA
 178         m = g_slist_append(NULL, g_strdup("librevisa"));
 179         m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBREVISA_VERSION));
 180         l = g_slist_append(l, m);
 181 #endif
 182
 183         return l;
 184 }
 185
 186 SR_API char *sr_buildinfo_host_get(void)
 187 {
 188         return g_strdup_printf("%s, %s-endian", CONF_HOST,
 189 #ifdef WORDS_BIGENDIAN
 190         "big"
 191 #else
 192         "little"
 193 #endif
 194         );
 195 }
 196
 197 SR_API char *sr_buildinfo_scpi_backends_get(void)
 198 {
 199         GString *s;
 200         char *str;
 201
 202         s = g_string_sized_new(200);
 203
 204         g_string_append_printf(s, "TCP, ");
 205 #if HAVE_RPC
 206         g_string_append_printf(s, "RPC, ");
 207 #endif
 208 #ifdef HAVE_SERIAL_COMM
 209         g_string_append_printf(s, "serial, ");
 210 #endif
 211 #ifdef HAVE_LIBREVISA
 212         g_string_append_printf(s, "VISA, ");
 213 #endif
 214 #ifdef HAVE_LIBGPIB
 215         g_string_append_printf(s, "GPIB, ");
 216 #endif
 217 #ifdef HAVE_LIBUSB_1_0
 218         g_string_append_printf(s, "USBTMC, ");
 219 #endif
 220         s->str[s->len - 2] = '\0';
 221
 222         str = g_strdup(s->str);
 223         g_string_free(s, TRUE);
 224
 225         return str;
 226 }
 227
 228 static void print_versions(void)
 229 {
 230         GString *s;
 231         GSList *l, *l_orig, *m;
 232         char *str;
 233         const char *lib, *version;
 234
 235         sr_dbg("libsigrok %s/%s.",
 236                 sr_package_version_string_get(), sr_lib_version_string_get());
 237
 238         s = g_string_sized_new(200);
 239         g_string_append(s, "Libs: ");
 240         l_orig = sr_buildinfo_libs_get();
 241         for (l = l_orig; l; l = l->next) {
 242                 m = l->data;
 243                 lib = m->data;
 244                 version = m->next->data;
 245                 g_string_append_printf(s, "%s %s, ", lib, version);
 246                 g_slist_free_full(m, g_free);
 247         }
 248         g_slist_free(l_orig);
 249         s->str[s->len - 2] = '.';
 250         s->str[s->len - 1] = '\0';
 251         sr_dbg("%s", s->str);
 252         g_string_free(s, TRUE);
 253
 254         str = sr_buildinfo_host_get();
 255         sr_dbg("Host: %s.", str);
 256         g_free(str);
 257
 258         str = sr_buildinfo_scpi_backends_get();
 259         sr_dbg("SCPI backends: %s.", str);
 260         g_free(str);
 261 }
 262
 263 static void print_resourcepaths(void)
 264 {
 265         GSList *l, *l_orig;
 266
 267         sr_dbg("Firmware search paths:");
 268         l_orig = sr_resourcepaths_get(SR_RESOURCE_FIRMWARE);
 269         for (l = l_orig; l; l = l->next)
 270                 sr_dbg(" - %s", (const char *)l->data);
 271         g_slist_free_full(l_orig, g_free);
 272 }
 273
 274 /**
 275  * Sanity-check all libsigrok drivers.
 276  *
 277  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 278  *
 279  * @retval SR_OK All drivers are OK
 280  * @retval SR_ERR One or more drivers have issues.
 281  * @retval SR_ERR_ARG Invalid argument.
 282  */
 283 static int sanity_check_all_drivers(const struct sr_context *ctx)
 284 {
 285         int i, errors, ret = SR_OK;
 286         struct sr_dev_driver **drivers;
 287         const char *d;
 288
 289         if (!ctx)
 290                 return SR_ERR_ARG;
 291
 292         sr_spew("Sanity-checking all drivers.");
 293
 294         drivers = sr_driver_list(ctx);
 295         for (i = 0; drivers[i]; i++) {
 296                 errors = 0;
 297
 298                 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
 299
 300                 if (!drivers[i]->name) {
 301                         sr_err("No name in driver %d ('%s').", i, d);
 302                         errors++;
 303                 }
 304                 if (!drivers[i]->longname) {
 305                         sr_err("No longname in driver %d ('%s').", i, d);
 306                         errors++;
 307                 }
 308                 if (drivers[i]->api_version < 1) {
 309                         sr_err("API version in driver %d ('%s') < 1.", i, d);
 310                         errors++;
 311                 }
 312                 if (!drivers[i]->init) {
 313                         sr_err("No init in driver %d ('%s').", i, d);
 314                         errors++;
 315                 }
 316                 if (!drivers[i]->cleanup) {
 317                         sr_err("No cleanup in driver %d ('%s').", i, d);
 318                         errors++;
 319                 }
 320                 if (!drivers[i]->scan) {
 321                         sr_err("No scan in driver %d ('%s').", i, d);
 322                         errors++;
 323                 }
 324                 if (!drivers[i]->dev_list) {
 325                         sr_err("No dev_list in driver %d ('%s').", i, d);
 326                         errors++;
 327                 }
 328                 if (!drivers[i]->dev_clear) {
 329                         sr_err("No dev_clear in driver %d ('%s').", i, d);
 330                         errors++;
 331                 }
 332                 /* Note: config_get() is optional. */
 333                 if (!drivers[i]->config_set) {
 334                         sr_err("No config_set in driver %d ('%s').", i, d);
 335                         errors++;
 336                 }
 337                 /* Note: config_channel_set() is optional. */
 338                 /* Note: config_commit() is optional. */
 339                 if (!drivers[i]->config_list) {
 340                         sr_err("No config_list in driver %d ('%s').", i, d);
 341                         errors++;
 342                 }
 343                 if (!drivers[i]->dev_open) {
 344                         sr_err("No dev_open in driver %d ('%s').", i, d);
 345                         errors++;
 346                 }
 347                 if (!drivers[i]->dev_close) {
 348                         sr_err("No dev_close in driver %d ('%s').", i, d);
 349                         errors++;
 350                 }
 351                 if (!drivers[i]->dev_acquisition_start) {
 352                         sr_err("No dev_acquisition_start in driver %d ('%s').",
 353                                i, d);
 354                         errors++;
 355                 }
 356                 if (!drivers[i]->dev_acquisition_stop) {
 357                         sr_err("No dev_acquisition_stop in driver %d ('%s').",
 358                                i, d);
 359                         errors++;
 360                 }
 361
 362                 /* Note: 'priv' is allowed to be NULL. */
 363
 364                 if (errors == 0)
 365                         continue;
 366
 367                 ret = SR_ERR;
 368         }
 369
 370         return ret;
 371 }
 372
 373 /**
 374  * Sanity-check all libsigrok input modules.
 375  *
 376  * @retval SR_OK All modules are OK
 377  * @retval SR_ERR One or more modules have issues.
 378  */
 379 static int sanity_check_all_input_modules(void)
 380 {
 381         int i, errors, ret = SR_OK;
 382         const struct sr_input_module **inputs;
 383         const char *d;
 384
 385         sr_spew("Sanity-checking all input modules.");
 386
 387         inputs = sr_input_list();
 388         for (i = 0; inputs[i]; i++) {
 389                 errors = 0;
 390
 391                 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
 392
 393                 if (!inputs[i]->id) {
 394                         sr_err("No ID in module %d ('%s').", i, d);
 395                         errors++;
 396                 }
 397                 if (!inputs[i]->name) {
 398                         sr_err("No name in module %d ('%s').", i, d);
 399                         errors++;
 400                 }
 401                 if (!inputs[i]->desc) {
 402                         sr_err("No description in module %d ('%s').", i, d);
 403                         errors++;
 404                 }
 405                 if (!inputs[i]->init) {
 406                         sr_err("No init in module %d ('%s').", i, d);
 407                         errors++;
 408                 }
 409                 if (!inputs[i]->receive) {
 410                         sr_err("No receive in module %d ('%s').", i, d);
 411                         errors++;
 412                 }
 413                 if (!inputs[i]->end) {
 414                         sr_err("No end in module %d ('%s').", i, d);
 415                         errors++;
 416                 }
 417
 418                 if (errors == 0)
 419                         continue;
 420
 421                 ret = SR_ERR;
 422         }
 423
 424         return ret;
 425 }
 426
 427 /**
 428  * Sanity-check all libsigrok output modules.
 429  *
 430  * @retval SR_OK All modules are OK
 431  * @retval SR_ERR One or more modules have issues.
 432  */
 433 static int sanity_check_all_output_modules(void)
 434 {
 435         int i, errors, ret = SR_OK;
 436         const struct sr_output_module **outputs;
 437         const char *d;
 438
 439         sr_spew("Sanity-checking all output modules.");
 440
 441         outputs = sr_output_list();
 442         for (i = 0; outputs[i]; i++) {
 443                 errors = 0;
 444
 445                 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
 446
 447                 if (!outputs[i]->id) {
 448                         sr_err("No ID in module %d ('%s').", i, d);
 449                         errors++;
 450                 }
 451                 if (!outputs[i]->name) {
 452                         sr_err("No name in module %d ('%s').", i, d);
 453                         errors++;
 454                 }
 455                 if (!outputs[i]->desc) {
 456                         sr_err("No description in module '%s'.", d);
 457                         errors++;
 458                 }
 459                 if (!outputs[i]->receive) {
 460                         sr_err("No receive in module '%s'.", d);
 461                         errors++;
 462                 }
 463
 464                 if (errors == 0)
 465                         continue;
 466
 467                 ret = SR_ERR;
 468         }
 469
 470         return ret;
 471 }
 472
 473 /**
 474  * Sanity-check all libsigrok transform modules.
 475  *
 476  * @retval SR_OK All modules are OK
 477  * @retval SR_ERR One or more modules have issues.
 478  */
 479 static int sanity_check_all_transform_modules(void)
 480 {
 481         int i, errors, ret = SR_OK;
 482         const struct sr_transform_module **transforms;
 483         const char *d;
 484
 485         sr_spew("Sanity-checking all transform modules.");
 486
 487         transforms = sr_transform_list();
 488         for (i = 0; transforms[i]; i++) {
 489                 errors = 0;
 490
 491                 d = (transforms[i]->id) ? transforms[i]->id : "NULL";
 492
 493                 if (!transforms[i]->id) {
 494                         sr_err("No ID in module %d ('%s').", i, d);
 495                         errors++;
 496                 }
 497                 if (!transforms[i]->name) {
 498                         sr_err("No name in module %d ('%s').", i, d);
 499                         errors++;
 500                 }
 501                 if (!transforms[i]->desc) {
 502                         sr_err("No description in module '%s'.", d);
 503                         errors++;
 504                 }
 505                 /* Note: options() is optional. */
 506                 /* Note: init() is optional. */
 507                 if (!transforms[i]->receive) {
 508                         sr_err("No receive in module '%s'.", d);
 509                         errors++;
 510                 }
 511                 /* Note: cleanup() is optional. */
 512
 513                 if (errors == 0)
 514                         continue;
 515
 516                 ret = SR_ERR;
 517         }
 518
 519         return ret;
 520 }
 521
 522 /**
 523  * Initialize libsigrok.
 524  *
 525  * This function must be called before any other libsigrok function.
 526  *
 527  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
 528  *            This will be a pointer to a newly allocated libsigrok context
 529  *            object upon success, and is undefined upon errors.
 530  *
 531  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
 532  *         the 'ctx' pointer is undefined and should not be used. Upon success,
 533  *         the context will be free'd by sr_exit() as part of the libsigrok
 534  *         shutdown.
 535  *
 536  * @since 0.2.0
 537  */
 538 SR_API int sr_init(struct sr_context **ctx)
 539 {
 540         int ret = SR_ERR;
 541         struct sr_context *context;
 542 #ifdef _WIN32
 543         WSADATA wsadata;
 544 #endif
 545
 546         print_versions();
 547
 548         print_resourcepaths();
 549
 550         if (!ctx) {
 551                 sr_err("%s(): libsigrok context was NULL.", __func__);
 552                 return SR_ERR;
 553         }
 554
 555         context = g_malloc0(sizeof(struct sr_context));
 556
 557         sr_drivers_init(context);
 558
 559         if (sanity_check_all_drivers(context) < 0) {
 560                 sr_err("Internal driver error(s), aborting.");
 561                 goto done;
 562         }
 563
 564         if (sanity_check_all_input_modules() < 0) {
 565                 sr_err("Internal input module error(s), aborting.");
 566                 goto done;
 567         }
 568
 569         if (sanity_check_all_output_modules() < 0) {
 570                 sr_err("Internal output module error(s), aborting.");
 571                 goto done;
 572         }
 573
 574         if (sanity_check_all_transform_modules() < 0) {
 575                 sr_err("Internal transform module error(s), aborting.");
 576                 goto done;
 577         }
 578
 579 #ifdef _WIN32
 580         if ((ret = WSAStartup(MAKEWORD(2, 2), &wsadata)) != 0) {
 581                 sr_err("WSAStartup failed with error code %d.", ret);
 582                 ret = SR_ERR;
 583                 goto done;
 584         }
 585 #endif
 586
 587 #ifdef HAVE_LIBUSB_1_0
 588         ret = libusb_init(&context->libusb_ctx);
 589         if (LIBUSB_SUCCESS != ret) {
 590                 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
 591                 ret = SR_ERR;
 592                 goto done;
 593         }
 594 #endif
 595         sr_resource_set_hooks(context, NULL, NULL, NULL, NULL);
 596
 597         *ctx = context;
 598         context = NULL;
 599         ret = SR_OK;
 600
 601 done:
 602         g_free(context);
 603         return ret;
 604 }
 605
 606 /**
 607  * Shutdown libsigrok.
 608  *
 609  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
 610  *
 611  * @retval SR_OK Success
 612  * @retval other Error code SR_ERR, ...
 613  *
 614  * @since 0.2.0
 615  */
 616 SR_API int sr_exit(struct sr_context *ctx)
 617 {
 618         if (!ctx) {
 619                 sr_err("%s(): libsigrok context was NULL.", __func__);
 620                 return SR_ERR;
 621         }
 622
 623         sr_hw_cleanup_all(ctx);
 624
 625 #ifdef _WIN32
 626         WSACleanup();
 627 #endif
 628
 629 #ifdef HAVE_LIBUSB_1_0
 630         libusb_exit(ctx->libusb_ctx);
 631 #endif
 632
 633         g_free(sr_driver_list(ctx));
 634         g_free(ctx);
 635
 636         return SR_OK;
 637 }
 638
 639 /** @} */