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"
30 extern struct sr_session *session;
33 * @mainpage libsigrok API
35 * @section sec_intro Introduction
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).
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
49 * @section sec_api API reference
51 * See the "Modules" page for an introduction to various libsigrok
52 * related topics and the detailed API documentation of the respective
55 * You can also browse the API documentation by file, or review all
58 * @section sec_mailinglists Mailing lists
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>.
62 * @section sec_irc IRC
64 * You can find the sigrok developers in the
65 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
66 * IRC channel on Freenode.
68 * @section sec_website Website
70 * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
76 * Initializing and shutting down libsigrok.
80 * @defgroup grp_init Initialization
82 * Initializing and shutting down libsigrok.
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.
88 * When libsigrok functionality is no longer needed, sr_exit() should be
89 * called, which will (among other things) free the struct sr_context.
91 * Example for a minimal program using libsigrok:
95 * #include <libsigrok/libsigrok.h>
97 * int main(int argc, char **argv)
100 * struct sr_context *sr_ctx;
102 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
103 * printf("Error initializing libsigrok (%s): %s.\n",
104 * sr_strerror_name(ret), sr_strerror(ret));
108 * // Use libsigrok functions here...
110 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
111 * printf("Error shutting down libsigrok (%s): %s.\n",
112 * sr_strerror_name(ret), sr_strerror(ret));
124 * Sanity-check all libsigrok drivers.
126 * @retval SR_OK All drivers are OK
127 * @retval SR_ERR One or more drivers have issues.
129 static int sanity_check_all_drivers(void)
131 int i, errors, ret = SR_OK;
132 struct sr_dev_driver **drivers;
135 sr_spew("Sanity-checking all drivers.");
137 drivers = sr_driver_list();
138 for (i = 0; drivers[i]; i++) {
141 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
143 if (!drivers[i]->name) {
144 sr_err("No name in driver %d ('%s').", i, d);
147 if (!drivers[i]->longname) {
148 sr_err("No longname in driver %d ('%s').", i, d);
151 if (drivers[i]->api_version < 1) {
152 sr_err("API version in driver %d ('%s') < 1.", i, d);
155 if (!drivers[i]->init) {
156 sr_err("No init in driver %d ('%s').", i, d);
159 if (!drivers[i]->cleanup) {
160 sr_err("No cleanup in driver %d ('%s').", i, d);
163 if (!drivers[i]->scan) {
164 sr_err("No scan in driver %d ('%s').", i, d);
167 if (!drivers[i]->dev_list) {
168 sr_err("No dev_list in driver %d ('%s').", i, d);
171 /* Note: config_get() is optional. */
172 if (!drivers[i]->config_set) {
173 sr_err("No config_set in driver %d ('%s').", i, d);
176 if (!drivers[i]->config_list) {
177 sr_err("No config_list in driver %d ('%s').", i, d);
180 if (!drivers[i]->dev_open) {
181 sr_err("No dev_open in driver %d ('%s').", i, d);
184 if (!drivers[i]->dev_close) {
185 sr_err("No dev_close in driver %d ('%s').", i, d);
188 if (!drivers[i]->dev_acquisition_start) {
189 sr_err("No dev_acquisition_start in driver %d ('%s').",
193 if (!drivers[i]->dev_acquisition_stop) {
194 sr_err("No dev_acquisition_stop in driver %d ('%s').",
199 /* Note: 'priv' is allowed to be NULL. */
211 * Sanity-check all libsigrok input modules.
213 * @retval SR_OK All modules are OK
214 * @retval SR_ERR One or more modules have issues.
216 static int sanity_check_all_input_modules(void)
218 int i, errors, ret = SR_OK;
219 struct sr_input_format **inputs;
222 sr_spew("Sanity-checking all input modules.");
224 inputs = sr_input_list();
225 for (i = 0; inputs[i]; i++) {
228 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
230 if (!inputs[i]->id) {
231 sr_err("No ID in module %d ('%s').", i, d);
234 if (!inputs[i]->description) {
235 sr_err("No description in module %d ('%s').", i, d);
238 if (!inputs[i]->format_match) {
239 sr_err("No format_match in module %d ('%s').", i, d);
242 if (!inputs[i]->init) {
243 sr_err("No init in module %d ('%s').", i, d);
246 if (!inputs[i]->loadfile) {
247 sr_err("No loadfile in module %d ('%s').", i, d);
261 * Sanity-check all libsigrok output modules.
263 * @retval SR_OK All modules are OK
264 * @retval SR_ERR One or more modules have issues.
266 static int sanity_check_all_output_modules(void)
268 int i, errors, ret = SR_OK;
269 struct sr_output_format **outputs;
272 sr_spew("Sanity-checking all output modules.");
274 outputs = sr_output_list();
275 for (i = 0; outputs[i]; i++) {
278 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
280 if (!outputs[i]->id) {
281 sr_err("No ID in module %d ('%s').", i, d);
284 if (!outputs[i]->description) {
285 sr_err("No description in module '%s'.", d);
288 if (!outputs[i]->receive) {
289 sr_err("No receive in module '%s'.", d);
303 * Initialize libsigrok.
305 * This function must be called before any other libsigrok function.
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.
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
318 SR_API int sr_init(struct sr_context **ctx)
321 struct sr_context *context;
324 sr_err("%s(): libsigrok context was NULL.", __func__);
328 if (sanity_check_all_drivers() < 0) {
329 sr_err("Internal driver error(s), aborting.");
333 if (sanity_check_all_input_modules() < 0) {
334 sr_err("Internal input module error(s), aborting.");
338 if (sanity_check_all_output_modules() < 0) {
339 sr_err("Internal output module error(s), aborting.");
343 /* + 1 to handle when struct sr_context has no members. */
344 context = g_try_malloc0(sizeof(struct sr_context) + 1);
351 #ifdef HAVE_LIBUSB_1_0
352 ret = libusb_init(&context->libusb_ctx);
353 if (LIBUSB_SUCCESS != ret) {
354 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
372 * Shutdown libsigrok.
374 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
376 * @retval SR_OK Success
377 * @retval other Error code SR_ERR, ...
381 SR_API int sr_exit(struct sr_context *ctx)
384 sr_err("%s(): libsigrok context was NULL.", __func__);
390 #ifdef HAVE_LIBUSB_1_0
391 libusb_exit(ctx->libusb_ctx);