]> sigrok.org Git - libsigrok.git/blame - backend.c
build: Portability fixes.
[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
2ad1deb8 26/** @cond PRIVATE */
3544f848 27#define LOG_PREFIX "backend"
2ad1deb8 28/** @endcond */
3544f848 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 *
d0a92abd
MH
82 * Before using any of the libsigrok functionality (except
83 * sr_log_loglevel_set() and sr_log_opts_set()), sr_init() must
afe2f28e
UH
84 * be called to initialize the library, which will return a struct sr_context
85 * when the initialization was successful.
86 *
87 * When libsigrok functionality is no longer needed, sr_exit() should be
88 * called, which will (among other things) free the struct sr_context.
89 *
90 * Example for a minimal program using libsigrok:
91 *
92 * @code{.c}
93 * #include <stdio.h>
94 * #include <libsigrok/libsigrok.h>
95 *
96 * int main(int argc, char **argv)
97 * {
98 * int ret;
99 * struct sr_context *sr_ctx;
100 *
101 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
df823ac4 102 * printf("Error initializing libsigrok (%s): %s.\n",
afe2f28e
UH
103 * sr_strerror_name(ret), sr_strerror(ret));
104 * return 1;
105 * }
106 *
107 * // Use libsigrok functions here...
108 *
109 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
df823ac4 110 * printf("Error shutting down libsigrok (%s): %s.\n",
afe2f28e
UH
111 * sr_strerror_name(ret), sr_strerror(ret));
112 * return 1;
113 * }
114 *
115 * return 0;
116 * }
117 * @endcode
118 *
7b870c38
UH
119 * @{
120 */
121
55a6daf5
UH
122/**
123 * Sanity-check all libsigrok drivers.
124 *
04cb9157
MH
125 * @retval SR_OK All drivers are OK
126 * @retval SR_ERR One or more drivers have issues.
55a6daf5
UH
127 */
128static int sanity_check_all_drivers(void)
129{
130 int i, errors, ret = SR_OK;
131 struct sr_dev_driver **drivers;
132 const char *d;
133
134 sr_spew("Sanity-checking all drivers.");
135
136 drivers = sr_driver_list();
137 for (i = 0; drivers[i]; i++) {
138 errors = 0;
139
140 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
141
142 if (!drivers[i]->name) {
143 sr_err("No name in driver %d ('%s').", i, d);
144 errors++;
145 }
146 if (!drivers[i]->longname) {
147 sr_err("No longname in driver %d ('%s').", i, d);
148 errors++;
149 }
150 if (drivers[i]->api_version < 1) {
151 sr_err("API version in driver %d ('%s') < 1.", i, d);
152 errors++;
153 }
154 if (!drivers[i]->init) {
155 sr_err("No init in driver %d ('%s').", i, d);
156 errors++;
157 }
158 if (!drivers[i]->cleanup) {
159 sr_err("No cleanup in driver %d ('%s').", i, d);
160 errors++;
161 }
162 if (!drivers[i]->scan) {
163 sr_err("No scan in driver %d ('%s').", i, d);
164 errors++;
165 }
166 if (!drivers[i]->dev_list) {
167 sr_err("No dev_list in driver %d ('%s').", i, d);
168 errors++;
169 }
6fab7b8f
UH
170 /* Note: config_get() is optional. */
171 if (!drivers[i]->config_set) {
172 sr_err("No config_set in driver %d ('%s').", i, d);
173 errors++;
174 }
175 if (!drivers[i]->config_list) {
176 sr_err("No config_list in driver %d ('%s').", i, d);
177 errors++;
178 }
55a6daf5
UH
179 if (!drivers[i]->dev_open) {
180 sr_err("No dev_open in driver %d ('%s').", i, d);
181 errors++;
182 }
183 if (!drivers[i]->dev_close) {
184 sr_err("No dev_close in driver %d ('%s').", i, d);
185 errors++;
186 }
55a6daf5
UH
187 if (!drivers[i]->dev_acquisition_start) {
188 sr_err("No dev_acquisition_start in driver %d ('%s').",
189 i, d);
190 errors++;
191 }
192 if (!drivers[i]->dev_acquisition_stop) {
193 sr_err("No dev_acquisition_stop in driver %d ('%s').",
194 i, d);
195 errors++;
196 }
197
198 /* Note: 'priv' is allowed to be NULL. */
199
200 if (errors == 0)
201 continue;
202
203 ret = SR_ERR;
204 }
205
206 return ret;
207}
208
218e629f
UH
209/**
210 * Sanity-check all libsigrok input modules.
211 *
04cb9157
MH
212 * @retval SR_OK All modules are OK
213 * @retval SR_ERR One or more modules have issues.
218e629f
UH
214 */
215static int sanity_check_all_input_modules(void)
216{
217 int i, errors, ret = SR_OK;
218 struct sr_input_format **inputs;
219 const char *d;
220
221 sr_spew("Sanity-checking all input modules.");
222
223 inputs = sr_input_list();
224 for (i = 0; inputs[i]; i++) {
225 errors = 0;
226
227 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
228
229 if (!inputs[i]->id) {
230 sr_err("No ID in module %d ('%s').", i, d);
231 errors++;
232 }
233 if (!inputs[i]->description) {
234 sr_err("No description in module %d ('%s').", i, d);
235 errors++;
236 }
237 if (!inputs[i]->format_match) {
238 sr_err("No format_match in module %d ('%s').", i, d);
239 errors++;
240 }
241 if (!inputs[i]->init) {
242 sr_err("No init in module %d ('%s').", i, d);
243 errors++;
244 }
245 if (!inputs[i]->loadfile) {
246 sr_err("No loadfile in module %d ('%s').", i, d);
247 errors++;
248 }
249
250 if (errors == 0)
251 continue;
252
253 ret = SR_ERR;
254 }
255
256 return ret;
257}
258
259/**
260 * Sanity-check all libsigrok output modules.
261 *
04cb9157
MH
262 * @retval SR_OK All modules are OK
263 * @retval SR_ERR One or more modules have issues.
218e629f
UH
264 */
265static int sanity_check_all_output_modules(void)
266{
267 int i, errors, ret = SR_OK;
268 struct sr_output_format **outputs;
269 const char *d;
270
271 sr_spew("Sanity-checking all output modules.");
272
273 outputs = sr_output_list();
274 for (i = 0; outputs[i]; i++) {
275 errors = 0;
276
277 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
278
279 if (!outputs[i]->id) {
280 sr_err("No ID in module %d ('%s').", i, d);
281 errors++;
282 }
283 if (!outputs[i]->description) {
44559b2c 284 sr_err("No description in module '%s'.", d);
218e629f
UH
285 errors++;
286 }
44559b2c
BV
287 if (!outputs[i]->receive) {
288 sr_err("No receive in module '%s'.", d);
218e629f
UH
289 errors++;
290 }
291
218e629f
UH
292 if (errors == 0)
293 continue;
294
295 ret = SR_ERR;
296 }
297
298 return ret;
299}
300
cd009d55
UH
301/**
302 * Initialize libsigrok.
303 *
c46762a2
UH
304 * This function must be called before any other libsigrok function.
305 *
306 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
307 * This will be a pointer to a newly allocated libsigrok context
308 * object upon success, and is undefined upon errors.
309 *
310 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
311 * the 'ctx' pointer is undefined and should not be used. Upon success,
312 * the context will be free'd by sr_exit() as part of the libsigrok
313 * shutdown.
9fb5f2df 314 *
53f05fa8 315 * @since 0.2.0
cd009d55 316 */
b8072700 317SR_API int sr_init(struct sr_context **ctx)
a1bb33af 318{
b8072700
PS
319 int ret = SR_ERR;
320 struct sr_context *context;
321
c46762a2
UH
322 if (!ctx) {
323 sr_err("%s(): libsigrok context was NULL.", __func__);
324 return SR_ERR;
325 }
326
55a6daf5
UH
327 if (sanity_check_all_drivers() < 0) {
328 sr_err("Internal driver error(s), aborting.");
329 return ret;
330 }
331
218e629f
UH
332 if (sanity_check_all_input_modules() < 0) {
333 sr_err("Internal input module error(s), aborting.");
334 return ret;
335 }
336
337 if (sanity_check_all_output_modules() < 0) {
338 sr_err("Internal output module error(s), aborting.");
339 return ret;
340 }
341
b8072700
PS
342 /* + 1 to handle when struct sr_context has no members. */
343 context = g_try_malloc0(sizeof(struct sr_context) + 1);
344
345 if (!context) {
346 ret = SR_ERR_MALLOC;
347 goto done;
348 }
349
785b9ff2
PS
350#ifdef HAVE_LIBUSB_1_0
351 ret = libusb_init(&context->libusb_ctx);
8e2d43cc 352 if (LIBUSB_SUCCESS != ret) {
9d122af8 353 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
63c07e48 354 ret = SR_ERR;
785b9ff2
PS
355 goto done;
356 }
357#endif
358
b8072700 359 *ctx = context;
123d97b1 360 context = 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/** @} */