]> sigrok.org Git - libsigrok.git/blame - backend.c
configure.ac: Separate library flags from other CFLAGS.
[libsigrok.git] / backend.c
CommitLineData
a1bb33af 1/*
50985c20 2 * This file is part of the libsigrok project.
a1bb33af 3 *
c73d2ea4 4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
b8072700 5 * Copyright (C) 2012 Peter Stuge <peter@stuge.se>
a1bb33af
UH
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>
545f9786 22#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
45c59c8b
BV
23#include "libsigrok.h"
24#include "libsigrok-internal.h"
a1bb33af 25
3544f848
ML
26#define LOG_PREFIX "backend"
27
fa93154f
BV
28extern struct sr_session *session;
29
5b30cca7
UH
30/**
31 * @mainpage libsigrok API
32 *
33 * @section sec_intro Introduction
34 *
35 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
36 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
37 * suite that supports various device types (such as logic analyzers,
38 * oscilloscopes, multimeters, and more).
39 *
40 * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
41 * library written in C which provides the basic API for talking to
42 * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
43 * and reading/writing the acquired data into various
44 * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
45 * file formats</a>.
46 *
f21193fa 47 * @section sec_api API reference
5b30cca7 48 *
f21193fa
UH
49 * See the "Modules" page for an introduction to various libsigrok
50 * related topics and the detailed API documentation of the respective
51 * functions.
52 *
53 * You can also browse the API documentation by file, or review all
54 * data structures.
5b30cca7
UH
55 *
56 * @section sec_mailinglists Mailing lists
57 *
58 * 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>.
59 *
60 * @section sec_irc IRC
61 *
62 * You can find the sigrok developers in the
63 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
64 * IRC channel on Freenode.
65 *
66 * @section sec_website Website
67 *
68 * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
69 */
70
393fb9cb
UH
71/**
72 * @file
73 *
74 * Initializing and shutting down libsigrok.
75 */
76
7b870c38
UH
77/**
78 * @defgroup grp_init Initialization
79 *
80 * Initializing and shutting down libsigrok.
81 *
afe2f28e
UH
82 * Before using any of the libsigrok functionality, sr_init() must
83 * be called to initialize the library, which will return a struct sr_context
84 * when the initialization was successful.
85 *
86 * When libsigrok functionality is no longer needed, sr_exit() should be
87 * called, which will (among other things) free the struct sr_context.
88 *
89 * Example for a minimal program using libsigrok:
90 *
91 * @code{.c}
92 * #include <stdio.h>
93 * #include <libsigrok/libsigrok.h>
94 *
95 * int main(int argc, char **argv)
96 * {
97 * int ret;
98 * struct sr_context *sr_ctx;
99 *
100 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
df823ac4 101 * printf("Error initializing libsigrok (%s): %s.\n",
afe2f28e
UH
102 * sr_strerror_name(ret), sr_strerror(ret));
103 * return 1;
104 * }
105 *
106 * // Use libsigrok functions here...
107 *
108 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
df823ac4 109 * printf("Error shutting down libsigrok (%s): %s.\n",
afe2f28e
UH
110 * sr_strerror_name(ret), sr_strerror(ret));
111 * return 1;
112 * }
113 *
114 * return 0;
115 * }
116 * @endcode
117 *
7b870c38
UH
118 * @{
119 */
120
55a6daf5
UH
121/**
122 * Sanity-check all libsigrok drivers.
123 *
04cb9157
MH
124 * @retval SR_OK All drivers are OK
125 * @retval SR_ERR One or more drivers have issues.
55a6daf5
UH
126 */
127static int sanity_check_all_drivers(void)
128{
129 int i, errors, ret = SR_OK;
130 struct sr_dev_driver **drivers;
131 const char *d;
132
133 sr_spew("Sanity-checking all drivers.");
134
135 drivers = sr_driver_list();
136 for (i = 0; drivers[i]; i++) {
137 errors = 0;
138
139 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
140
141 if (!drivers[i]->name) {
142 sr_err("No name in driver %d ('%s').", i, d);
143 errors++;
144 }
145 if (!drivers[i]->longname) {
146 sr_err("No longname in driver %d ('%s').", i, d);
147 errors++;
148 }
149 if (drivers[i]->api_version < 1) {
150 sr_err("API version in driver %d ('%s') < 1.", i, d);
151 errors++;
152 }
153 if (!drivers[i]->init) {
154 sr_err("No init in driver %d ('%s').", i, d);
155 errors++;
156 }
157 if (!drivers[i]->cleanup) {
158 sr_err("No cleanup in driver %d ('%s').", i, d);
159 errors++;
160 }
161 if (!drivers[i]->scan) {
162 sr_err("No scan in driver %d ('%s').", i, d);
163 errors++;
164 }
165 if (!drivers[i]->dev_list) {
166 sr_err("No dev_list in driver %d ('%s').", i, d);
167 errors++;
168 }
6fab7b8f
UH
169 /* Note: config_get() is optional. */
170 if (!drivers[i]->config_set) {
171 sr_err("No config_set in driver %d ('%s').", i, d);
172 errors++;
173 }
174 if (!drivers[i]->config_list) {
175 sr_err("No config_list in driver %d ('%s').", i, d);
176 errors++;
177 }
55a6daf5
UH
178 if (!drivers[i]->dev_open) {
179 sr_err("No dev_open in driver %d ('%s').", i, d);
180 errors++;
181 }
182 if (!drivers[i]->dev_close) {
183 sr_err("No dev_close in driver %d ('%s').", i, d);
184 errors++;
185 }
55a6daf5
UH
186 if (!drivers[i]->dev_acquisition_start) {
187 sr_err("No dev_acquisition_start in driver %d ('%s').",
188 i, d);
189 errors++;
190 }
191 if (!drivers[i]->dev_acquisition_stop) {
192 sr_err("No dev_acquisition_stop in driver %d ('%s').",
193 i, d);
194 errors++;
195 }
196
197 /* Note: 'priv' is allowed to be NULL. */
198
199 if (errors == 0)
200 continue;
201
202 ret = SR_ERR;
203 }
204
205 return ret;
206}
207
218e629f
UH
208/**
209 * Sanity-check all libsigrok input modules.
210 *
04cb9157
MH
211 * @retval SR_OK All modules are OK
212 * @retval SR_ERR One or more modules have issues.
218e629f
UH
213 */
214static int sanity_check_all_input_modules(void)
215{
216 int i, errors, ret = SR_OK;
217 struct sr_input_format **inputs;
218 const char *d;
219
220 sr_spew("Sanity-checking all input modules.");
221
222 inputs = sr_input_list();
223 for (i = 0; inputs[i]; i++) {
224 errors = 0;
225
226 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
227
228 if (!inputs[i]->id) {
229 sr_err("No ID in module %d ('%s').", i, d);
230 errors++;
231 }
232 if (!inputs[i]->description) {
233 sr_err("No description in module %d ('%s').", i, d);
234 errors++;
235 }
236 if (!inputs[i]->format_match) {
237 sr_err("No format_match in module %d ('%s').", i, d);
238 errors++;
239 }
240 if (!inputs[i]->init) {
241 sr_err("No init in module %d ('%s').", i, d);
242 errors++;
243 }
244 if (!inputs[i]->loadfile) {
245 sr_err("No loadfile in module %d ('%s').", i, d);
246 errors++;
247 }
248
249 if (errors == 0)
250 continue;
251
252 ret = SR_ERR;
253 }
254
255 return ret;
256}
257
258/**
259 * Sanity-check all libsigrok output modules.
260 *
04cb9157
MH
261 * @retval SR_OK All modules are OK
262 * @retval SR_ERR One or more modules have issues.
218e629f
UH
263 */
264static int sanity_check_all_output_modules(void)
265{
266 int i, errors, ret = SR_OK;
267 struct sr_output_format **outputs;
268 const char *d;
269
270 sr_spew("Sanity-checking all output modules.");
271
272 outputs = sr_output_list();
273 for (i = 0; outputs[i]; i++) {
274 errors = 0;
275
276 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
277
278 if (!outputs[i]->id) {
279 sr_err("No ID in module %d ('%s').", i, d);
280 errors++;
281 }
282 if (!outputs[i]->description) {
44559b2c 283 sr_err("No description in module '%s'.", d);
218e629f
UH
284 errors++;
285 }
44559b2c
BV
286 if (!outputs[i]->receive) {
287 sr_err("No receive in module '%s'.", d);
218e629f
UH
288 errors++;
289 }
290
218e629f
UH
291 if (errors == 0)
292 continue;
293
294 ret = SR_ERR;
295 }
296
297 return ret;
298}
299
cd009d55
UH
300/**
301 * Initialize libsigrok.
302 *
c46762a2
UH
303 * This function must be called before any other libsigrok function.
304 *
305 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
306 * This will be a pointer to a newly allocated libsigrok context
307 * object upon success, and is undefined upon errors.
308 *
309 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
310 * the 'ctx' pointer is undefined and should not be used. Upon success,
311 * the context will be free'd by sr_exit() as part of the libsigrok
312 * shutdown.
9fb5f2df 313 *
53f05fa8 314 * @since 0.2.0
cd009d55 315 */
b8072700 316SR_API int sr_init(struct sr_context **ctx)
a1bb33af 317{
b8072700
PS
318 int ret = SR_ERR;
319 struct sr_context *context;
320
c46762a2
UH
321 if (!ctx) {
322 sr_err("%s(): libsigrok context was NULL.", __func__);
323 return SR_ERR;
324 }
325
55a6daf5
UH
326 if (sanity_check_all_drivers() < 0) {
327 sr_err("Internal driver error(s), aborting.");
328 return ret;
329 }
330
218e629f
UH
331 if (sanity_check_all_input_modules() < 0) {
332 sr_err("Internal input module error(s), aborting.");
333 return ret;
334 }
335
336 if (sanity_check_all_output_modules() < 0) {
337 sr_err("Internal output module error(s), aborting.");
338 return ret;
339 }
340
b8072700
PS
341 /* + 1 to handle when struct sr_context has no members. */
342 context = g_try_malloc0(sizeof(struct sr_context) + 1);
343
344 if (!context) {
345 ret = SR_ERR_MALLOC;
346 goto done;
347 }
348
785b9ff2
PS
349#ifdef HAVE_LIBUSB_1_0
350 ret = libusb_init(&context->libusb_ctx);
8e2d43cc 351 if (LIBUSB_SUCCESS != ret) {
9d122af8 352 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
63c07e48 353 ret = SR_ERR;
785b9ff2
PS
354 goto done;
355 }
356#endif
357
b8072700 358 *ctx = context;
123d97b1 359 context = NULL;
fa93154f 360 session = NULL;
b8072700
PS
361 ret = SR_OK;
362
363done:
123d97b1
PS
364 if (context)
365 g_free(context);
b8072700 366 return ret;
a1bb33af
UH
367}
368
cd009d55
UH
369/**
370 * Shutdown libsigrok.
371 *
c46762a2
UH
372 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
373 *
04cb9157
MH
374 * @retval SR_OK Success
375 * @retval other Error code SR_ERR, ...
9fb5f2df 376 *
53f05fa8 377 * @since 0.2.0
cd009d55 378 */
b8072700 379SR_API int sr_exit(struct sr_context *ctx)
a1bb33af 380{
c46762a2
UH
381 if (!ctx) {
382 sr_err("%s(): libsigrok context was NULL.", __func__);
383 return SR_ERR;
384 }
385
93a04e3b 386 sr_hw_cleanup_all();
cd009d55 387
785b9ff2
PS
388#ifdef HAVE_LIBUSB_1_0
389 libusb_exit(ctx->libusb_ctx);
390#endif
391
b8072700
PS
392 g_free(ctx);
393
cd009d55 394 return SR_OK;
a1bb33af 395}
7b870c38
UH
396
397/** @} */