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 #define LOG_PREFIX "backend"
28 extern struct sr_session *session;
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 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>.
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, sr_init() must
83 * be called to initialize the library, which will return a struct sr_context
84 * when the initialization was successful.
86 * When libsigrok functionality is no longer needed, sr_exit() should be
87 * called, which will (among other things) free the struct sr_context.
89 * Example for a minimal program using libsigrok:
93 * #include <libsigrok/libsigrok.h>
95 * int main(int argc, char **argv)
98 * struct sr_context *sr_ctx;
100 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
101 * printf("Error initializing libsigrok (%s): %s.\n",
102 * sr_strerror_name(ret), sr_strerror(ret));
106 * // Use libsigrok functions here...
108 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
109 * printf("Error shutting down libsigrok (%s): %s.\n",
110 * sr_strerror_name(ret), sr_strerror(ret));
122 * Sanity-check all libsigrok drivers.
124 * @retval SR_OK All drivers are OK
125 * @retval SR_ERR One or more drivers have issues.
127 static int sanity_check_all_drivers(void)
129 int i, errors, ret = SR_OK;
130 struct sr_dev_driver **drivers;
133 sr_spew("Sanity-checking all drivers.");
135 drivers = sr_driver_list();
136 for (i = 0; drivers[i]; i++) {
139 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
141 if (!drivers[i]->name) {
142 sr_err("No name in driver %d ('%s').", i, d);
145 if (!drivers[i]->longname) {
146 sr_err("No longname in driver %d ('%s').", i, d);
149 if (drivers[i]->api_version < 1) {
150 sr_err("API version in driver %d ('%s') < 1.", i, d);
153 if (!drivers[i]->init) {
154 sr_err("No init in driver %d ('%s').", i, d);
157 if (!drivers[i]->cleanup) {
158 sr_err("No cleanup in driver %d ('%s').", i, d);
161 if (!drivers[i]->scan) {
162 sr_err("No scan in driver %d ('%s').", i, d);
165 if (!drivers[i]->dev_list) {
166 sr_err("No dev_list in driver %d ('%s').", i, d);
169 if (!drivers[i]->dev_clear) {
170 sr_err("No dev_clear in driver %d ('%s').", i, d);
173 /* Note: config_get() is optional. */
174 if (!drivers[i]->config_set) {
175 sr_err("No config_set in driver %d ('%s').", i, d);
178 if (!drivers[i]->config_list) {
179 sr_err("No config_list in driver %d ('%s').", i, d);
182 if (!drivers[i]->dev_open) {
183 sr_err("No dev_open in driver %d ('%s').", i, d);
186 if (!drivers[i]->dev_close) {
187 sr_err("No dev_close in driver %d ('%s').", i, d);
190 if (!drivers[i]->dev_acquisition_start) {
191 sr_err("No dev_acquisition_start in driver %d ('%s').",
195 if (!drivers[i]->dev_acquisition_stop) {
196 sr_err("No dev_acquisition_stop in driver %d ('%s').",
201 /* Note: 'priv' is allowed to be NULL. */
213 * Sanity-check all libsigrok input modules.
215 * @retval SR_OK All modules are OK
216 * @retval SR_ERR One or more modules have issues.
218 static int sanity_check_all_input_modules(void)
220 int i, errors, ret = SR_OK;
221 struct sr_input_format **inputs;
224 sr_spew("Sanity-checking all input modules.");
226 inputs = sr_input_list();
227 for (i = 0; inputs[i]; i++) {
230 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
232 if (!inputs[i]->id) {
233 sr_err("No ID in module %d ('%s').", i, d);
236 if (!inputs[i]->description) {
237 sr_err("No description in module %d ('%s').", i, d);
240 if (!inputs[i]->format_match) {
241 sr_err("No format_match in module %d ('%s').", i, d);
244 if (!inputs[i]->init) {
245 sr_err("No init in module %d ('%s').", i, d);
248 if (!inputs[i]->loadfile) {
249 sr_err("No loadfile in module %d ('%s').", i, d);
263 * Sanity-check all libsigrok output modules.
265 * @retval SR_OK All modules are OK
266 * @retval SR_ERR One or more modules have issues.
268 static int sanity_check_all_output_modules(void)
270 int i, errors, ret = SR_OK;
271 struct sr_output_format **outputs;
274 sr_spew("Sanity-checking all output modules.");
276 outputs = sr_output_list();
277 for (i = 0; outputs[i]; i++) {
280 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
282 if (!outputs[i]->id) {
283 sr_err("No ID in module %d ('%s').", i, d);
286 if (!outputs[i]->description) {
287 sr_err("No description in module %d ('%s').", i, d);
290 if (outputs[i]->df_type < 10000 || outputs[i]->df_type > 10007) {
291 sr_err("Invalid df_type %d in module %d ('%s').",
292 outputs[i]->df_type, i, d);
296 /* All modules must provide a data or recv API callback. */
297 if (!outputs[i]->data && !outputs[i]->receive) {
298 sr_err("No data/receive in module %d ('%s').", i, d);
303 * Currently most API calls are optional (their function
304 * pointers can thus be NULL) in theory: init, event, cleanup.
317 * Initialize libsigrok.
319 * This function must be called before any other libsigrok function.
321 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
322 * This will be a pointer to a newly allocated libsigrok context
323 * object upon success, and is undefined upon errors.
325 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
326 * the 'ctx' pointer is undefined and should not be used. Upon success,
327 * the context will be free'd by sr_exit() as part of the libsigrok
332 SR_API int sr_init(struct sr_context **ctx)
335 struct sr_context *context;
338 sr_err("%s(): libsigrok context was NULL.", __func__);
342 if (sanity_check_all_drivers() < 0) {
343 sr_err("Internal driver error(s), aborting.");
347 if (sanity_check_all_input_modules() < 0) {
348 sr_err("Internal input module error(s), aborting.");
352 if (sanity_check_all_output_modules() < 0) {
353 sr_err("Internal output module error(s), aborting.");
357 /* + 1 to handle when struct sr_context has no members. */
358 context = g_try_malloc0(sizeof(struct sr_context) + 1);
365 #ifdef HAVE_LIBUSB_1_0
366 ret = libusb_init(&context->libusb_ctx);
367 if (LIBUSB_SUCCESS != ret) {
368 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
386 * Shutdown libsigrok.
388 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
390 * @retval SR_OK Success
391 * @retval other Error code SR_ERR, ...
395 SR_API int sr_exit(struct sr_context *ctx)
398 sr_err("%s(): libsigrok context was NULL.", __func__);
404 #ifdef HAVE_LIBUSB_1_0
405 libusb_exit(ctx->libusb_ctx);