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 * @mainpage libsigrok API
29 * @section sec_intro Introduction
31 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
32 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
33 * suite that supports various device types (such as logic analyzers,
34 * oscilloscopes, multimeters, and more).
36 * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
37 * library written in C which provides the basic API for talking to
38 * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
39 * and reading/writing the acquired data into various
40 * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
43 * @section sec_api API reference
45 * See the "Modules" page for an introduction to various libsigrok
46 * related topics and the detailed API documentation of the respective
49 * You can also browse the API documentation by file, or review all
52 * @section sec_mailinglists Mailing lists
54 * 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>.
56 * @section sec_irc IRC
58 * You can find the sigrok developers in the
59 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
60 * IRC channel on Freenode.
62 * @section sec_website Website
64 * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
70 * Initializing and shutting down libsigrok.
74 * @defgroup grp_init Initialization
76 * Initializing and shutting down libsigrok.
78 * Before using any of the libsigrok functionality, sr_init() must
79 * be called to initialize the library, which will return a struct sr_context
80 * when the initialization was successful.
82 * When libsigrok functionality is no longer needed, sr_exit() should be
83 * called, which will (among other things) free the struct sr_context.
85 * Example for a minimal program using libsigrok:
89 * #include <libsigrok/libsigrok.h>
91 * int main(int argc, char **argv)
94 * struct sr_context *sr_ctx;
96 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
97 * printf("Error initializing libsigrok (%s): %s.",
98 * sr_strerror_name(ret), sr_strerror(ret));
102 * // Use libsigrok functions here...
104 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
105 * printf("Error shutting down libsigrok (%s): %s.",
106 * sr_strerror_name(ret), sr_strerror(ret));
118 * Sanity-check all libsigrok drivers.
120 * @return SR_OK if all drivers are OK, SR_ERR if one or more have issues.
122 static int sanity_check_all_drivers(void)
124 int i, errors, ret = SR_OK;
125 struct sr_dev_driver **drivers;
128 sr_spew("Sanity-checking all drivers.");
130 drivers = sr_driver_list();
131 for (i = 0; drivers[i]; i++) {
134 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
136 if (!drivers[i]->name) {
137 sr_err("No name in driver %d ('%s').", i, d);
140 if (!drivers[i]->longname) {
141 sr_err("No longname in driver %d ('%s').", i, d);
144 if (drivers[i]->api_version < 1) {
145 sr_err("API version in driver %d ('%s') < 1.", i, d);
148 if (!drivers[i]->init) {
149 sr_err("No init in driver %d ('%s').", i, d);
152 if (!drivers[i]->cleanup) {
153 sr_err("No cleanup in driver %d ('%s').", i, d);
156 if (!drivers[i]->scan) {
157 sr_err("No scan in driver %d ('%s').", i, d);
160 if (!drivers[i]->dev_list) {
161 sr_err("No dev_list in driver %d ('%s').", i, d);
164 if (!drivers[i]->dev_clear) {
165 sr_err("No dev_clear in driver %d ('%s').", i, d);
168 /* Note: config_get() is optional. */
169 if (!drivers[i]->config_set) {
170 sr_err("No config_set in driver %d ('%s').", i, d);
173 if (!drivers[i]->config_list) {
174 sr_err("No config_list in driver %d ('%s').", i, d);
177 if (!drivers[i]->dev_open) {
178 sr_err("No dev_open in driver %d ('%s').", i, d);
181 if (!drivers[i]->dev_close) {
182 sr_err("No dev_close in driver %d ('%s').", i, d);
185 if (!drivers[i]->dev_acquisition_start) {
186 sr_err("No dev_acquisition_start in driver %d ('%s').",
190 if (!drivers[i]->dev_acquisition_stop) {
191 sr_err("No dev_acquisition_stop in driver %d ('%s').",
196 /* Note: 'priv' is allowed to be NULL. */
208 * Sanity-check all libsigrok input modules.
210 * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
212 static int sanity_check_all_input_modules(void)
214 int i, errors, ret = SR_OK;
215 struct sr_input_format **inputs;
218 sr_spew("Sanity-checking all input modules.");
220 inputs = sr_input_list();
221 for (i = 0; inputs[i]; i++) {
224 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
226 if (!inputs[i]->id) {
227 sr_err("No ID in module %d ('%s').", i, d);
230 if (!inputs[i]->description) {
231 sr_err("No description in module %d ('%s').", i, d);
234 if (!inputs[i]->format_match) {
235 sr_err("No format_match in module %d ('%s').", i, d);
238 if (!inputs[i]->init) {
239 sr_err("No init in module %d ('%s').", i, d);
242 if (!inputs[i]->loadfile) {
243 sr_err("No loadfile in module %d ('%s').", i, d);
257 * Sanity-check all libsigrok output modules.
259 * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
261 static int sanity_check_all_output_modules(void)
263 int i, errors, ret = SR_OK;
264 struct sr_output_format **outputs;
267 sr_spew("Sanity-checking all output modules.");
269 outputs = sr_output_list();
270 for (i = 0; outputs[i]; i++) {
273 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
275 if (!outputs[i]->id) {
276 sr_err("No ID in module %d ('%s').", i, d);
279 if (!outputs[i]->description) {
280 sr_err("No description in module %d ('%s').", i, d);
283 if (outputs[i]->df_type < 10000 || outputs[i]->df_type > 10007) {
284 sr_err("Invalid df_type %d in module %d ('%s').",
285 outputs[i]->df_type, i, d);
289 /* All modules must provide a data or recv API callback. */
290 if (!outputs[i]->data && !outputs[i]->receive) {
291 sr_err("No data/receive in module %d ('%s').", i, d);
296 * Currently most API calls are optional (their function
297 * pointers can thus be NULL) in theory: init, event, cleanup.
310 * Initialize libsigrok.
312 * This function must be called before any other libsigrok function.
314 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
315 * This will be a pointer to a newly allocated libsigrok context
316 * object upon success, and is undefined upon errors.
318 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
319 * the 'ctx' pointer is undefined and should not be used. Upon success,
320 * the context will be free'd by sr_exit() as part of the libsigrok
323 * @since 0.1.0 (but the API changed in 0.2.0)
325 SR_API int sr_init(struct sr_context **ctx)
328 struct sr_context *context;
331 sr_err("%s(): libsigrok context was NULL.", __func__);
335 if (sanity_check_all_drivers() < 0) {
336 sr_err("Internal driver error(s), aborting.");
340 if (sanity_check_all_input_modules() < 0) {
341 sr_err("Internal input module error(s), aborting.");
345 if (sanity_check_all_output_modules() < 0) {
346 sr_err("Internal output module error(s), aborting.");
350 /* + 1 to handle when struct sr_context has no members. */
351 context = g_try_malloc0(sizeof(struct sr_context) + 1);
358 #ifdef HAVE_LIBUSB_1_0
359 ret = libusb_init(&context->libusb_ctx);
360 if (LIBUSB_SUCCESS != ret) {
361 sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
378 * Shutdown libsigrok.
380 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
382 * @return SR_OK upon success, a (negative) error code otherwise.
384 * @since 0.1.0 (but the API changed in 0.2.0)
386 SR_API int sr_exit(struct sr_context *ctx)
389 sr_err("%s(): libsigrok context was NULL.", __func__);
395 #ifdef HAVE_LIBUSB_1_0
396 libusb_exit(ctx->libusb_ctx);