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  * Initialize libsigrok.
  27  *
  28  * This function must be called before any other libsigrok function.
  29  *
  30  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
  31  *            This will be a pointer to a newly allocated libsigrok context
  32  *            object upon success, and is undefined upon errors.
  33  *
  34  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
  35  *         the 'ctx' pointer is undefined and should not be used. Upon success,
  36  *         the context will be free'd by sr_exit() as part of the libsigrok
  37  *         shutdown.
  38  */
  39 SR_API int sr_init(struct sr_context **ctx)
  40 {
  41         int ret = SR_ERR;
  42         struct sr_context *context;
  43
  44         if (!ctx) {
  45                 sr_err("%s(): libsigrok context was NULL.", __func__);
  46                 return SR_ERR;
  47         }
  48
  49         /* + 1 to handle when struct sr_context has no members. */
  50         context = g_try_malloc0(sizeof(struct sr_context) + 1);
  51
  52         if (!context) {
  53                 ret = SR_ERR_MALLOC;
  54                 goto done;
  55         }
  56
  57 #ifdef HAVE_LIBUSB_1_0
  58         ret = libusb_init(&context->libusb_ctx);
  59         if (LIBUSB_SUCCESS == ret) {
  60                 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
  61                 goto done;
  62         }
  63 #endif
  64
  65         *ctx = context;
  66         ret = SR_OK;
  67
  68 done:
  69         return ret;
  70 }
  71
  72 /**
  73  * Shutdown libsigrok.
  74  *
  75  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
  76  *
  77  * @return SR_OK upon success, a (negative) error code otherwise.
  78  */
  79 SR_API int sr_exit(struct sr_context *ctx)
  80 {
  81         if (!ctx) {
  82                 sr_err("%s(): libsigrok context was NULL.", __func__);
  83                 return SR_ERR;
  84         }
  85
  86         sr_hw_cleanup_all();
  87
  88 #ifdef HAVE_LIBUSB_1_0
  89         libusb_exit(ctx->libusb_ctx);
  90 #endif
  91
  92         g_free(ctx);
  93
  94         return SR_OK;
  95 }