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_error_handling Error handling
  43  *
  44  * libsigrok functions usually return @ref SR_OK upon success, or a negative
  45  * error code on failure.
  46  *
  47  * @section sec_mailinglists Mailing lists
  48  *
  49  * 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>.
  50  *
  51  * @section sec_irc IRC
  52  *
  53  * You can find the sigrok developers in the
  54  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
  55  * IRC channel on Freenode.
  56  *
  57  * @section sec_website Website
  58  *
  59  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
  60  */
  61
  62 /**
  63  * Initialize libsigrok.
  64  *
  65  * This function must be called before any other libsigrok function.
  66  *
  67  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
  68  *            This will be a pointer to a newly allocated libsigrok context
  69  *            object upon success, and is undefined upon errors.
  70  *
  71  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
  72  *         the 'ctx' pointer is undefined and should not be used. Upon success,
  73  *         the context will be free'd by sr_exit() as part of the libsigrok
  74  *         shutdown.
  75  */
  76 SR_API int sr_init(struct sr_context **ctx)
  77 {
  78         int ret = SR_ERR;
  79         struct sr_context *context;
  80
  81         if (!ctx) {
  82                 sr_err("%s(): libsigrok context was NULL.", __func__);
  83                 return SR_ERR;
  84         }
  85
  86         /* + 1 to handle when struct sr_context has no members. */
  87         context = g_try_malloc0(sizeof(struct sr_context) + 1);
  88
  89         if (!context) {
  90                 ret = SR_ERR_MALLOC;
  91                 goto done;
  92         }
  93
  94 #ifdef HAVE_LIBUSB_1_0
  95         ret = libusb_init(&context->libusb_ctx);
  96         if (LIBUSB_SUCCESS != ret) {
  97                 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
  98                 goto done;
  99         }
 100 #endif
 101
 102         *ctx = context;
 103         ret = SR_OK;
 104
 105 done:
 106         return ret;
 107 }
 108
 109 /**
 110  * Shutdown libsigrok.
 111  *
 112  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
 113  *
 114  * @return SR_OK upon success, a (negative) error code otherwise.
 115  */
 116 SR_API int sr_exit(struct sr_context *ctx)
 117 {
 118         if (!ctx) {
 119                 sr_err("%s(): libsigrok context was NULL.", __func__);
 120                 return SR_ERR;
 121         }
 122
 123         sr_hw_cleanup_all();
 124
 125 #ifdef HAVE_LIBUSB_1_0
 126         libusb_exit(ctx->libusb_ctx);
 127 #endif
 128
 129         g_free(ctx);
 130
 131         return SR_OK;
 132 }