2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Peter Stuge <peter@stuge.se>
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.
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.
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/>.
22 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
23 #include "libsigrok.h"
24 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "backend"
31 * @mainpage libsigrok API
33 * @section sec_intro Introduction
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).
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
47 * @section sec_api API reference
49 * See the "Modules" page for an introduction to various libsigrok
50 * related topics and the detailed API documentation of the respective
53 * You can also browse the API documentation by file, or review all
56 * @section sec_mailinglists Mailing lists
58 * There is one mailing list for sigrok/libsigrok: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a>.
60 * @section sec_irc IRC
62 * You can find the sigrok developers in the
63 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
64 * IRC channel on Freenode.
66 * @section sec_website Website
68 * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
74 * Initializing and shutting down libsigrok.
78 * @defgroup grp_init Initialization
80 * Initializing and shutting down libsigrok.
82 * Before using any of the libsigrok functionality (except
83 * sr_log_loglevel_set() and sr_log_opts_set()), sr_init() must
84 * be called to initialize the library, which will return a struct sr_context
85 * when the initialization was successful.
87 * When libsigrok functionality is no longer needed, sr_exit() should be
88 * called, which will (among other things) free the struct sr_context.
90 * Example for a minimal program using libsigrok:
94 * #include <libsigrok/libsigrok.h>
96 * int main(int argc, char **argv)
99 * struct sr_context *sr_ctx;
101 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
102 * printf("Error initializing libsigrok (%s): %s.\n",
103 * sr_strerror_name(ret), sr_strerror(ret));
107 * // Use libsigrok functions here...
109 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
110 * printf("Error shutting down libsigrok (%s): %s.\n",
111 * sr_strerror_name(ret), sr_strerror(ret));
123 * Sanity-check all libsigrok drivers.
125 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
127 * @retval SR_OK All drivers are OK
128 * @retval SR_ERR One or more drivers have issues.
129 * @retval SR_ERR_ARG Invalid argument.
131 static int sanity_check_all_drivers(const struct sr_context *ctx)
133 int i, errors, ret = SR_OK;
134 struct sr_dev_driver **drivers;
140 sr_spew("Sanity-checking all drivers.");
142 drivers = sr_driver_list(ctx);
143 for (i = 0; drivers[i]; i++) {
146 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
148 if (!drivers[i]->name) {
149 sr_err("No name in driver %d ('%s').", i, d);
152 if (!drivers[i]->longname) {
153 sr_err("No longname in driver %d ('%s').", i, d);
156 if (drivers[i]->api_version < 1) {
157 sr_err("API version in driver %d ('%s') < 1.", i, d);
160 if (!drivers[i]->init) {
161 sr_err("No init in driver %d ('%s').", i, d);
164 if (!drivers[i]->cleanup) {
165 sr_err("No cleanup in driver %d ('%s').", i, d);
168 if (!drivers[i]->scan) {
169 sr_err("No scan in driver %d ('%s').", i, d);
172 if (!drivers[i]->dev_list) {
173 sr_err("No dev_list in driver %d ('%s').", i, d);
176 /* Note: config_get() is optional. */
177 if (!drivers[i]->config_set) {
178 sr_err("No config_set in driver %d ('%s').", i, d);
181 if (!drivers[i]->config_list) {
182 sr_err("No config_list in driver %d ('%s').", i, d);
185 if (!drivers[i]->dev_open) {
186 sr_err("No dev_open in driver %d ('%s').", i, d);
189 if (!drivers[i]->dev_close) {
190 sr_err("No dev_close in driver %d ('%s').", i, d);
193 if (!drivers[i]->dev_acquisition_start) {
194 sr_err("No dev_acquisition_start in driver %d ('%s').",
198 if (!drivers[i]->dev_acquisition_stop) {
199 sr_err("No dev_acquisition_stop in driver %d ('%s').",
204 /* Note: 'priv' is allowed to be NULL. */
216 * Sanity-check all libsigrok input modules.
218 * @retval SR_OK All modules are OK
219 * @retval SR_ERR One or more modules have issues.
221 static int sanity_check_all_input_modules(void)
223 int i, errors, ret = SR_OK;
224 const struct sr_input_module **inputs;
227 sr_spew("Sanity-checking all input modules.");
229 inputs = sr_input_list();
230 for (i = 0; inputs[i]; i++) {
233 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
235 if (!inputs[i]->id) {
236 sr_err("No ID in module %d ('%s').", i, d);
239 if (!inputs[i]->name) {
240 sr_err("No name in module %d ('%s').", i, d);
243 if (!inputs[i]->desc) {
244 sr_err("No description in module %d ('%s').", i, d);
247 if (!inputs[i]->init) {
248 sr_err("No init in module %d ('%s').", i, d);
251 if (!inputs[i]->receive) {
252 sr_err("No receive in module %d ('%s').", i, d);
255 if (!inputs[i]->end) {
256 sr_err("No end in module %d ('%s').", i, d);
270 * Sanity-check all libsigrok output modules.
272 * @retval SR_OK All modules are OK
273 * @retval SR_ERR One or more modules have issues.
275 static int sanity_check_all_output_modules(void)
277 int i, errors, ret = SR_OK;
278 const struct sr_output_module **outputs;
281 sr_spew("Sanity-checking all output modules.");
283 outputs = sr_output_list();
284 for (i = 0; outputs[i]; i++) {
287 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
289 if (!outputs[i]->id) {
290 sr_err("No ID in module %d ('%s').", i, d);
293 if (!outputs[i]->name) {
294 sr_err("No name in module %d ('%s').", i, d);
297 if (!outputs[i]->desc) {
298 sr_err("No description in module '%s'.", d);
301 if (!outputs[i]->receive) {
302 sr_err("No receive in module '%s'.", d);
316 * Sanity-check all libsigrok transform modules.
318 * @retval SR_OK All modules are OK
319 * @retval SR_ERR One or more modules have issues.
321 static int sanity_check_all_transform_modules(void)
323 int i, errors, ret = SR_OK;
324 const struct sr_transform_module **transforms;
327 sr_spew("Sanity-checking all transform modules.");
329 transforms = sr_transform_list();
330 for (i = 0; transforms[i]; i++) {
333 d = (transforms[i]->id) ? transforms[i]->id : "NULL";
335 if (!transforms[i]->id) {
336 sr_err("No ID in module %d ('%s').", i, d);
339 if (!transforms[i]->name) {
340 sr_err("No name in module %d ('%s').", i, d);
343 if (!transforms[i]->desc) {
344 sr_err("No description in module '%s'.", d);
347 /* Note: options() is optional. */
348 /* Note: init() is optional. */
349 if (!transforms[i]->receive) {
350 sr_err("No receive in module '%s'.", d);
353 /* Note: cleanup() is optional. */
365 * Initialize libsigrok.
367 * This function must be called before any other libsigrok function.
369 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
370 * This will be a pointer to a newly allocated libsigrok context
371 * object upon success, and is undefined upon errors.
373 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
374 * the 'ctx' pointer is undefined and should not be used. Upon success,
375 * the context will be free'd by sr_exit() as part of the libsigrok
380 SR_API int sr_init(struct sr_context **ctx)
383 struct sr_context *context;
384 struct sr_dev_driver ***lists, **drivers;
388 sr_err("%s(): libsigrok context was NULL.", __func__);
392 context = g_malloc0(sizeof(struct sr_context));
394 /* Generate ctx->driver_list at runtime. */
395 array = g_array_new(TRUE, FALSE, sizeof(struct sr_dev_driver *));
396 for (lists = drivers_lists; *lists; lists++)
397 for (drivers = *lists; *drivers; drivers++)
398 g_array_append_val(array, *drivers);
399 context->driver_list = (struct sr_dev_driver **)array->data;
400 g_array_free(array, FALSE);
402 if (sanity_check_all_drivers(context) < 0) {
403 sr_err("Internal driver error(s), aborting.");
407 if (sanity_check_all_input_modules() < 0) {
408 sr_err("Internal input module error(s), aborting.");
412 if (sanity_check_all_output_modules() < 0) {
413 sr_err("Internal output module error(s), aborting.");
417 if (sanity_check_all_transform_modules() < 0) {
418 sr_err("Internal transform module error(s), aborting.");
422 #ifdef HAVE_LIBUSB_1_0
423 ret = libusb_init(&context->libusb_ctx);
424 if (LIBUSB_SUCCESS != ret) {
425 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
435 #ifdef HAVE_LIBUSB_1_0
443 * Shutdown libsigrok.
445 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
447 * @retval SR_OK Success
448 * @retval other Error code SR_ERR, ...
452 SR_API int sr_exit(struct sr_context *ctx)
455 sr_err("%s(): libsigrok context was NULL.", __func__);
459 sr_hw_cleanup_all(ctx);
461 #ifdef HAVE_LIBUSB_1_0
462 libusb_exit(ctx->libusb_ctx);
465 g_free(sr_driver_list(ctx));