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"
26 extern struct sr_session *session;
29 * @mainpage libsigrok API
31 * @section sec_intro Introduction
33 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
34 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
35 * suite that supports various device types (such as logic analyzers,
36 * oscilloscopes, multimeters, and more).
38 * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
39 * library written in C which provides the basic API for talking to
40 * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
41 * and reading/writing the acquired data into various
42 * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
45 * @section sec_api API reference
47 * See the "Modules" page for an introduction to various libsigrok
48 * related topics and the detailed API documentation of the respective
51 * You can also browse the API documentation by file, or review all
54 * @section sec_mailinglists Mailing lists
56 * 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>.
58 * @section sec_irc IRC
60 * You can find the sigrok developers in the
61 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
62 * IRC channel on Freenode.
64 * @section sec_website Website
66 * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
72 * Initializing and shutting down libsigrok.
76 * @defgroup grp_init Initialization
78 * Initializing and shutting down libsigrok.
80 * Before using any of the libsigrok functionality, sr_init() must
81 * be called to initialize the library, which will return a struct sr_context
82 * when the initialization was successful.
84 * When libsigrok functionality is no longer needed, sr_exit() should be
85 * called, which will (among other things) free the struct sr_context.
87 * Example for a minimal program using libsigrok:
91 * #include <libsigrok/libsigrok.h>
93 * int main(int argc, char **argv)
96 * struct sr_context *sr_ctx;
98 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
99 * printf("Error initializing libsigrok (%s): %s.",
100 * sr_strerror_name(ret), sr_strerror(ret));
104 * // Use libsigrok functions here...
106 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
107 * printf("Error shutting down libsigrok (%s): %s.",
108 * sr_strerror_name(ret), sr_strerror(ret));
120 * Sanity-check all libsigrok drivers.
122 * @return SR_OK if all drivers are OK, SR_ERR if one or more have issues.
124 static int sanity_check_all_drivers(void)
126 int i, errors, ret = SR_OK;
127 struct sr_dev_driver **drivers;
130 sr_spew("Sanity-checking all drivers.");
132 drivers = sr_driver_list();
133 for (i = 0; drivers[i]; i++) {
136 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
138 if (!drivers[i]->name) {
139 sr_err("No name in driver %d ('%s').", i, d);
142 if (!drivers[i]->longname) {
143 sr_err("No longname in driver %d ('%s').", i, d);
146 if (drivers[i]->api_version < 1) {
147 sr_err("API version in driver %d ('%s') < 1.", i, d);
150 if (!drivers[i]->init) {
151 sr_err("No init in driver %d ('%s').", i, d);
154 if (!drivers[i]->cleanup) {
155 sr_err("No cleanup in driver %d ('%s').", i, d);
158 if (!drivers[i]->scan) {
159 sr_err("No scan in driver %d ('%s').", i, d);
162 if (!drivers[i]->dev_list) {
163 sr_err("No dev_list in driver %d ('%s').", i, d);
166 if (!drivers[i]->dev_clear) {
167 sr_err("No dev_clear in driver %d ('%s').", i, d);
170 /* Note: config_get() is optional. */
171 if (!drivers[i]->config_set) {
172 sr_err("No config_set in driver %d ('%s').", i, d);
175 if (!drivers[i]->config_list) {
176 sr_err("No config_list in driver %d ('%s').", i, d);
179 if (!drivers[i]->dev_open) {
180 sr_err("No dev_open in driver %d ('%s').", i, d);
183 if (!drivers[i]->dev_close) {
184 sr_err("No dev_close in driver %d ('%s').", i, d);
187 if (!drivers[i]->dev_acquisition_start) {
188 sr_err("No dev_acquisition_start in driver %d ('%s').",
192 if (!drivers[i]->dev_acquisition_stop) {
193 sr_err("No dev_acquisition_stop in driver %d ('%s').",
198 /* Note: 'priv' is allowed to be NULL. */
210 * Sanity-check all libsigrok input modules.
212 * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
214 static int sanity_check_all_input_modules(void)
216 int i, errors, ret = SR_OK;
217 struct sr_input_format **inputs;
220 sr_spew("Sanity-checking all input modules.");
222 inputs = sr_input_list();
223 for (i = 0; inputs[i]; i++) {
226 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
228 if (!inputs[i]->id) {
229 sr_err("No ID in module %d ('%s').", i, d);
232 if (!inputs[i]->description) {
233 sr_err("No description in module %d ('%s').", i, d);
236 if (!inputs[i]->format_match) {
237 sr_err("No format_match in module %d ('%s').", i, d);
240 if (!inputs[i]->init) {
241 sr_err("No init in module %d ('%s').", i, d);
244 if (!inputs[i]->loadfile) {
245 sr_err("No loadfile in module %d ('%s').", i, d);
259 * Sanity-check all libsigrok output modules.
261 * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
263 static int sanity_check_all_output_modules(void)
265 int i, errors, ret = SR_OK;
266 struct sr_output_format **outputs;
269 sr_spew("Sanity-checking all output modules.");
271 outputs = sr_output_list();
272 for (i = 0; outputs[i]; i++) {
275 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
277 if (!outputs[i]->id) {
278 sr_err("No ID in module %d ('%s').", i, d);
281 if (!outputs[i]->description) {
282 sr_err("No description in module %d ('%s').", i, d);
285 if (outputs[i]->df_type < 10000 || outputs[i]->df_type > 10007) {
286 sr_err("Invalid df_type %d in module %d ('%s').",
287 outputs[i]->df_type, i, d);
291 /* All modules must provide a data or recv API callback. */
292 if (!outputs[i]->data && !outputs[i]->receive) {
293 sr_err("No data/receive in module %d ('%s').", i, d);
298 * Currently most API calls are optional (their function
299 * pointers can thus be NULL) in theory: init, event, cleanup.
312 * Initialize libsigrok.
314 * This function must be called before any other libsigrok function.
316 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
317 * This will be a pointer to a newly allocated libsigrok context
318 * object upon success, and is undefined upon errors.
320 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
321 * the 'ctx' pointer is undefined and should not be used. Upon success,
322 * the context will be free'd by sr_exit() as part of the libsigrok
325 * @since 0.1.0 (but the API changed in 0.2.0)
327 SR_API int sr_init(struct sr_context **ctx)
330 struct sr_context *context;
333 sr_err("%s(): libsigrok context was NULL.", __func__);
337 if (sanity_check_all_drivers() < 0) {
338 sr_err("Internal driver error(s), aborting.");
342 if (sanity_check_all_input_modules() < 0) {
343 sr_err("Internal input module error(s), aborting.");
347 if (sanity_check_all_output_modules() < 0) {
348 sr_err("Internal output module error(s), aborting.");
352 /* + 1 to handle when struct sr_context has no members. */
353 context = g_try_malloc0(sizeof(struct sr_context) + 1);
360 #ifdef HAVE_LIBUSB_1_0
361 ret = libusb_init(&context->libusb_ctx);
362 if (LIBUSB_SUCCESS != ret) {
363 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
381 * Shutdown libsigrok.
383 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
385 * @return SR_OK upon success, a (negative) error code otherwise.
387 * @since 0.1.0 (but the API changed in 0.2.0)
389 SR_API int sr_exit(struct sr_context *ctx)
392 sr_err("%s(): libsigrok context was NULL.", __func__);
398 #ifdef HAVE_LIBUSB_1_0
399 libusb_exit(ctx->libusb_ctx);