]> sigrok.org Git - libsigrok.git/blob - backend.c
Add downsample and skip parameters to input/vcd.
[libsigrok.git] / 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 "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
23 #include "libsigrok.h"
24 #include "libsigrok-internal.h"
25
26 /**
27  * @mainpage libsigrok API
28  *
29  * @section sec_intro Introduction
30  *
31  * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
32  * portable, cross-platform, Free/Libre/Open-Source signal analysis software
33  * suite that supports various device types (such as logic analyzers,
34  * oscilloscopes, multimeters, and more).
35  *
36  * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
37  * library written in C which provides the basic API for talking to
38  * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
39  * and reading/writing the acquired data into various
40  * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
41  * file formats</a>.
42  *
43  * @section sec_api API reference
44  *
45  * See the "Modules" page for an introduction to various libsigrok
46  * related topics and the detailed API documentation of the respective
47  * functions.
48  *
49  * You can also browse the API documentation by file, or review all
50  * data structures.
51  *
52  * @section sec_mailinglists Mailing lists
53  *
54  * 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>.
55  *
56  * @section sec_irc IRC
57  *
58  * You can find the sigrok developers in the
59  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
60  * IRC channel on Freenode.
61  *
62  * @section sec_website Website
63  *
64  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
65  */
66
67 /**
68  * @file
69  *
70  * Initializing and shutting down libsigrok.
71  */
72
73 /**
74  * @defgroup grp_init Initialization
75  *
76  * Initializing and shutting down libsigrok.
77  *
78  * Before using any of the libsigrok functionality, sr_init() must
79  * be called to initialize the library, which will return a struct sr_context
80  * when the initialization was successful.
81  *
82  * When libsigrok functionality is no longer needed, sr_exit() should be
83  * called, which will (among other things) free the struct sr_context.
84  *
85  * Example for a minimal program using libsigrok:
86  *
87  * @code{.c}
88  *   #include <stdio.h>
89  *   #include <libsigrok/libsigrok.h>
90  *
91  *   int main(int argc, char **argv)
92  *   {
93  *      int ret;
94  *      struct sr_context *sr_ctx;
95  *
96  *      if ((ret = sr_init(&sr_ctx)) != SR_OK) {
97  *              printf("Error initializing libsigrok (%s): %s.",
98  *                     sr_strerror_name(ret), sr_strerror(ret));
99  *              return 1;
100  *      }
101  *
102  *      // Use libsigrok functions here...
103  *
104  *      if ((ret = sr_exit(sr_ctx)) != SR_OK) {
105  *              printf("Error shutting down libsigrok (%s): %s.",
106  *                     sr_strerror_name(ret), sr_strerror(ret));
107  *              return 1;
108  *      }
109  *
110  *      return 0;
111  *   }
112  * @endcode
113  *
114  * @{
115  */
116
117 /**
118  * Initialize libsigrok.
119  *
120  * This function must be called before any other libsigrok function.
121  *
122  * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
123  *            This will be a pointer to a newly allocated libsigrok context
124  *            object upon success, and is undefined upon errors.
125  *
126  * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
127  *         the 'ctx' pointer is undefined and should not be used. Upon success,
128  *         the context will be free'd by sr_exit() as part of the libsigrok
129  *         shutdown.
130  */
131 SR_API int sr_init(struct sr_context **ctx)
132 {
133         int ret = SR_ERR;
134         struct sr_context *context;
135
136         if (!ctx) {
137                 sr_err("%s(): libsigrok context was NULL.", __func__);
138                 return SR_ERR;
139         }
140
141         /* + 1 to handle when struct sr_context has no members. */
142         context = g_try_malloc0(sizeof(struct sr_context) + 1);
143
144         if (!context) {
145                 ret = SR_ERR_MALLOC;
146                 goto done;
147         }
148
149 #ifdef HAVE_LIBUSB_1_0
150         ret = libusb_init(&context->libusb_ctx);
151         if (LIBUSB_SUCCESS != ret) {
152                 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
153                 goto done;
154         }
155 #endif
156
157         *ctx = context;
158         ret = SR_OK;
159
160 done:
161         return ret;
162 }
163
164 /**
165  * Shutdown libsigrok.
166  *
167  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
168  *
169  * @return SR_OK upon success, a (negative) error code otherwise.
170  */
171 SR_API int sr_exit(struct sr_context *ctx)
172 {
173         if (!ctx) {
174                 sr_err("%s(): libsigrok context was NULL.", __func__);
175                 return SR_ERR;
176         }
177
178         sr_hw_cleanup_all();
179
180 #ifdef HAVE_LIBUSB_1_0
181         libusb_exit(ctx->libusb_ctx);
182 #endif
183
184         g_free(ctx);
185
186         return SR_OK;
187 }
188
189 /** @} */