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