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  * @defgroup grp_init Initialization
  68  *
  69  * Initializing and shutting down libsigrok.
  70  *
  71  * @{
  72  */
  73
  74 /**
  75  * Initialize libsigrok.
  76  *
  77  * This function must be called before any other libsigrok function.
  78  *
  79  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
  80  *            This will be a pointer to a newly allocated libsigrok context
  81  *            object upon success, and is undefined upon errors.
  82  *
  83  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
  84  *         the 'ctx' pointer is undefined and should not be used. Upon success,
  85  *         the context will be free'd by sr_exit() as part of the libsigrok
  86  *         shutdown.
  87  */
  88 SR_API int sr_init(struct sr_context **ctx)
  89 {
  90         int ret = SR_ERR;
  91         struct sr_context *context;
  92
  93         if (!ctx) {
  94                 sr_err("%s(): libsigrok context was NULL.", __func__);
  95                 return SR_ERR;
  96         }
  97
  98         /* + 1 to handle when struct sr_context has no members. */
  99         context = g_try_malloc0(sizeof(struct sr_context) + 1);
 100
 101         if (!context) {
 102                 ret = SR_ERR_MALLOC;
 103                 goto done;
 104         }
 105
 106 #ifdef HAVE_LIBUSB_1_0
 107         ret = libusb_init(&context->libusb_ctx);
 108         if (LIBUSB_SUCCESS != ret) {
 109                 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
 110                 goto done;
 111         }
 112 #endif
 113
 114         *ctx = context;
 115         ret = SR_OK;
 116
 117 done:
 118         return ret;
 119 }
 120
 121 /**
 122  * Shutdown libsigrok.
 123  *
 124  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
 125  *
 126  * @return SR_OK upon success, a (negative) error code otherwise.
 127  */
 128 SR_API int sr_exit(struct sr_context *ctx)
 129 {
 130         if (!ctx) {
 131                 sr_err("%s(): libsigrok context was NULL.", __func__);
 132                 return SR_ERR;
 133         }
 134
 135         sr_hw_cleanup_all();
 136
 137 #ifdef HAVE_LIBUSB_1_0
 138         libusb_exit(ctx->libusb_ctx);
 139 #endif
 140
 141         g_free(ctx);
 142
 143         return SR_OK;
 144 }
 145
 146 /** @} */