Doxygen: Add @file items for the relevant files.

[libsigrok.git] / backend.c

diff --git a/backend.c b/backend.c
index 6a49cde7c83cf01a253fc409ebc1a0ce55506147..9f0f119fa5bfc3b29cf37b4d1c7eeeb9e3f472fe 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -1,7 +1,8 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Peter Stuge <peter@stuge.se>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,23 +19,134 @@
  */
 
 #include <glib.h>
-#include "sigrok.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
-int sigrok_init(void)
+/**
+ * @mainpage libsigrok API
+ *
+ * @section sec_intro Introduction
+ *
+ * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
+ * portable, cross-platform, Free/Libre/Open-Source signal analysis software
+ * suite that supports various device types (such as logic analyzers,
+ * oscilloscopes, multimeters, and more).
+ *
+ * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
+ * library written in C which provides the basic API for talking to
+ * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
+ * and reading/writing the acquired data into various
+ * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
+ * file formats</a>.
+ *
+ * @section sec_api API reference
+ *
+ * See the "Modules" page for an introduction to various libsigrok
+ * related topics and the detailed API documentation of the respective
+ * functions.
+ *
+ * You can also browse the API documentation by file, or review all
+ * data structures.
+ *
+ * @section sec_mailinglists Mailing lists
+ *
+ * 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>.
+ *
+ * @section sec_irc IRC
+ *
+ * You can find the sigrok developers in the
+ * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
+ * IRC channel on Freenode.
+ *
+ * @section sec_website Website
+ *
+ * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
+ */
+
+/**
+ * @file
+ *
+ * Initializing and shutting down libsigrok.
+ */
+
+/**
+ * @defgroup grp_init Initialization
+ *
+ * Initializing and shutting down libsigrok.
+ *
+ * @{
+ */
+
+/**
+ * Initialize libsigrok.
+ *
+ * This function must be called before any other libsigrok function.
+ *
+ * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
+ *            This will be a pointer to a newly allocated libsigrok context
+ *            object upon success, and is undefined upon errors.
+ *
+ * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
+ *         the 'ctx' pointer is undefined and should not be used. Upon success,
+ *         the context will be free'd by sr_exit() as part of the libsigrok
+ *         shutdown.
+ */
+SR_API int sr_init(struct sr_context **ctx)
 {
-       int ret;
+       int ret = SR_ERR;
+       struct sr_context *context;
+
+       if (!ctx) {
+               sr_err("%s(): libsigrok context was NULL.", __func__);
+               return SR_ERR;
+       }
+
+       /* + 1 to handle when struct sr_context has no members. */
+       context = g_try_malloc0(sizeof(struct sr_context) + 1);
 
-       ret = load_hwplugins();
+       if (!context) {
+               ret = SR_ERR_MALLOC;
+               goto done;
+       }
 
+#ifdef HAVE_LIBUSB_1_0
+       ret = libusb_init(&context->libusb_ctx);
+       if (LIBUSB_SUCCESS != ret) {
+               sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
+               goto done;
+       }
+#endif
+
+       *ctx = context;
+       ret = SR_OK;
+
+done:
        return ret;
 }
 
-
-void sigrok_cleanup(void)
+/**
+ * Shutdown libsigrok.
+ *
+ * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
+ *
+ * @return SR_OK upon success, a (negative) error code otherwise.
+ */
+SR_API int sr_exit(struct sr_context *ctx)
 {
+       if (!ctx) {
+               sr_err("%s(): libsigrok context was NULL.", __func__);
+               return SR_ERR;
+       }
 
-       device_close_all();
+       sr_hw_cleanup_all();
 
-}
+#ifdef HAVE_LIBUSB_1_0
+       libusb_exit(ctx->libusb_ctx);
+#endif
 
+       g_free(ctx);
+
+       return SR_OK;
+}
 
+/** @} */