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