backend.c

   1 /*
   2  * This file is part of the sigrok 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 "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24
  25 /**
  26  * @mainpage libsigrok API
  27  *
  28  * @section sec_intro Introduction
  29  *
  30  * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
  31  * portable, cross-platform, Free/Libre/Open-Source signal analysis software
  32  * suite that supports various device types (such as logic analyzers,
  33  * oscilloscopes, multimeters, and more).
  34  *
  35  * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
  36  * library written in C which provides the basic API for talking to
  37  * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
  38  * and reading/writing the acquired data into various
  39  * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
  40  * file formats</a>.
  41  *
  42  * @section sec_api API reference
  43  *
  44  * See the "Modules" page for an introduction to various libsigrok
  45  * related topics and the detailed API documentation of the respective
  46  * functions.
  47  *
  48  * You can also browse the API documentation by file, or review all
  49  * data structures.
  50  *
  51  * @section sec_mailinglists Mailing lists
  52  *
  53  * 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>.
  54  *
  55  * @section sec_irc IRC
  56  *
  57  * You can find the sigrok developers in the
  58  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
  59  * IRC channel on Freenode.
  60  *
  61  * @section sec_website Website
  62  *
  63  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
  64  */
  65
  66 /**
  67  * @file
  68  *
  69  * Initializing and shutting down libsigrok.
  70  */
  71
  72 /**
  73  * @defgroup grp_init Initialization
  74  *
  75  * Initializing and shutting down libsigrok.
  76  *
  77  * Before using any of the libsigrok functionality, sr_init() must
  78  * be called to initialize the library, which will return a struct sr_context
  79  * when the initialization was successful.
  80  *
  81  * When libsigrok functionality is no longer needed, sr_exit() should be
  82  * called, which will (among other things) free the struct sr_context.
  83  *
  84  * Example for a minimal program using libsigrok:
  85  *
  86  * @code{.c}
  87  *   #include <stdio.h>
  88  *   #include <libsigrok/libsigrok.h>
  89  *
  90  *   int main(int argc, char **argv)
  91  *   {
  92  *      int ret;
  93  *      struct sr_context *sr_ctx;
  94  *
  95  *      if ((ret = sr_init(&sr_ctx)) != SR_OK) {
  96  *              printf("Error initializing libsigrok (%s): %s.",
  97  *                     sr_strerror_name(ret), sr_strerror(ret));
  98  *              return 1;
  99  *      }
 100  *
 101  *      // Use libsigrok functions here...
 102  *
 103  *      if ((ret = sr_exit(sr_ctx)) != SR_OK) {
 104  *              printf("Error shutting down libsigrok (%s): %s.",
 105  *                     sr_strerror_name(ret), sr_strerror(ret));
 106  *              return 1;
 107  *      }
 108  *
 109  *      return 0;
 110  *   }
 111  * @endcode
 112  *
 113  * @{
 114  */
 115
 116 /**
 117  * Initialize libsigrok.
 118  *
 119  * This function must be called before any other libsigrok function.
 120  *
 121  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
 122  *            This will be a pointer to a newly allocated libsigrok context
 123  *            object upon success, and is undefined upon errors.
 124  *
 125  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
 126  *         the 'ctx' pointer is undefined and should not be used. Upon success,
 127  *         the context will be free'd by sr_exit() as part of the libsigrok
 128  *         shutdown.
 129  */
 130 SR_API int sr_init(struct sr_context **ctx)
 131 {
 132         int ret = SR_ERR;
 133         struct sr_context *context;
 134
 135         if (!ctx) {
 136                 sr_err("%s(): libsigrok context was NULL.", __func__);
 137                 return SR_ERR;
 138         }
 139
 140         /* + 1 to handle when struct sr_context has no members. */
 141         context = g_try_malloc0(sizeof(struct sr_context) + 1);
 142
 143         if (!context) {
 144                 ret = SR_ERR_MALLOC;
 145                 goto done;
 146         }
 147
 148 #ifdef HAVE_LIBUSB_1_0
 149         ret = libusb_init(&context->libusb_ctx);
 150         if (LIBUSB_SUCCESS != ret) {
 151                 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
 152                 goto done;
 153         }
 154 #endif
 155
 156         *ctx = context;
 157         ret = SR_OK;
 158
 159 done:
 160         return ret;
 161 }
 162
 163 /**
 164  * Shutdown libsigrok.
 165  *
 166  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
 167  *
 168  * @return SR_OK upon success, a (negative) error code otherwise.
 169  */
 170 SR_API int sr_exit(struct sr_context *ctx)
 171 {
 172         if (!ctx) {
 173                 sr_err("%s(): libsigrok context was NULL.", __func__);
 174                 return SR_ERR;
 175         }
 176
 177         sr_hw_cleanup_all();
 178
 179 #ifdef HAVE_LIBUSB_1_0
 180         libusb_exit(ctx->libusb_ctx);
 181 #endif
 182
 183         g_free(ctx);
 184
 185         return SR_OK;
 186 }
 187
 188 /** @} */