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/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 for
83 * sr_log_loglevel_set()), sr_init() must be called to initialize the
84 * library, which will return a struct sr_context when the initialization
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));
122 static void print_versions(void)
125 #ifdef HAVE_LIBUSB_1_0
126 const struct libusb_version *lv;
129 s = g_string_sized_new(200);
131 sr_dbg("libsigrok %s/%s (rt: %s/%s).",
132 SR_PACKAGE_VERSION_STRING, SR_LIB_VERSION_STRING,
133 sr_package_version_string_get(), sr_lib_version_string_get());
135 g_string_append(s, "Libs: ");
136 g_string_append_printf(s, "glib %d.%d.%d (rt: %d.%d.%d/%d:%d), ",
137 GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
138 glib_major_version, glib_minor_version, glib_micro_version,
139 glib_binary_age, glib_interface_age);
140 g_string_append_printf(s, "libzip %s, ", HAVE_LIBZIP_VER);
141 #ifdef HAVE_LIBSERIALPORT
142 g_string_append_printf(s, "libserialport %s/%s (rt: %s/%s), ",
143 SP_PACKAGE_VERSION_STRING, SP_LIB_VERSION_STRING,
144 sp_get_package_version_string(), sp_get_lib_version_string());
146 #ifdef HAVE_LIBUSB_1_0
147 lv = libusb_get_version();
148 g_string_append_printf(s, "libusb-1.0 %d.%d.%d.%d%s, ",
149 lv->major, lv->minor, lv->micro, lv->nano, lv->rc);
152 g_string_append_printf(s, "libftdi %s, ", HAVE_LIBFTDI_VER);
155 g_string_append_printf(s, "libgpib %s, ", HAVE_LIBGPIB_VER);
157 #ifdef HAVE_LIBREVISA
158 g_string_append_printf(s, "librevisa %s, ", HAVE_LIBREVISA_VER);
160 s->str[s->len - 2] = '.';
161 s->str[s->len - 1] = '\0';
162 sr_dbg("%s", s->str);
164 s = g_string_truncate(s, 0);
165 g_string_append_printf(s, "Host: %s, ", HOST);
166 #ifdef WORDS_BIGENDIAN
167 g_string_append_printf(s, "big-endian.");
169 g_string_append_printf(s, "little-endian.");
171 sr_dbg("%s", s->str);
173 s = g_string_truncate(s, 0);
174 g_string_append_printf(s, "SCPI backends: ");
176 g_string_append_printf(s, "TCP, ");
178 g_string_append_printf(s, "RPC, ");
180 #ifdef HAVE_LIBSERIALPORT
181 g_string_append_printf(s, "serial, ");
183 #ifdef HAVE_LIBREVISA
184 g_string_append_printf(s, "VISA, ");
187 g_string_append_printf(s, "GPIB, ");
189 #ifdef HAVE_LIBUSB_1_0
190 g_string_append_printf(s, "USBTMC, ");
192 s->str[s->len - 2] = '.';
193 s->str[s->len - 1] = '\0';
194 sr_dbg("%s", s->str);
196 g_string_free(s, TRUE);
200 * Sanity-check all libsigrok drivers.
202 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
204 * @retval SR_OK All drivers are OK
205 * @retval SR_ERR One or more drivers have issues.
206 * @retval SR_ERR_ARG Invalid argument.
208 static int sanity_check_all_drivers(const struct sr_context *ctx)
210 int i, errors, ret = SR_OK;
211 struct sr_dev_driver **drivers;
217 sr_spew("Sanity-checking all drivers.");
219 drivers = sr_driver_list(ctx);
220 for (i = 0; drivers[i]; i++) {
223 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
225 if (!drivers[i]->name) {
226 sr_err("No name in driver %d ('%s').", i, d);
229 if (!drivers[i]->longname) {
230 sr_err("No longname in driver %d ('%s').", i, d);
233 if (drivers[i]->api_version < 1) {
234 sr_err("API version in driver %d ('%s') < 1.", i, d);
237 if (!drivers[i]->init) {
238 sr_err("No init in driver %d ('%s').", i, d);
241 if (!drivers[i]->cleanup) {
242 sr_err("No cleanup in driver %d ('%s').", i, d);
245 if (!drivers[i]->scan) {
246 sr_err("No scan in driver %d ('%s').", i, d);
249 if (!drivers[i]->dev_list) {
250 sr_err("No dev_list in driver %d ('%s').", i, d);
253 /* Note: config_get() is optional. */
254 if (!drivers[i]->config_set) {
255 sr_err("No config_set in driver %d ('%s').", i, d);
258 if (!drivers[i]->config_list) {
259 sr_err("No config_list in driver %d ('%s').", i, d);
262 if (!drivers[i]->dev_open) {
263 sr_err("No dev_open in driver %d ('%s').", i, d);
266 if (!drivers[i]->dev_close) {
267 sr_err("No dev_close in driver %d ('%s').", i, d);
270 if (!drivers[i]->dev_acquisition_start) {
271 sr_err("No dev_acquisition_start in driver %d ('%s').",
275 if (!drivers[i]->dev_acquisition_stop) {
276 sr_err("No dev_acquisition_stop in driver %d ('%s').",
281 /* Note: 'priv' is allowed to be NULL. */
293 * Sanity-check all libsigrok input modules.
295 * @retval SR_OK All modules are OK
296 * @retval SR_ERR One or more modules have issues.
298 static int sanity_check_all_input_modules(void)
300 int i, errors, ret = SR_OK;
301 const struct sr_input_module **inputs;
304 sr_spew("Sanity-checking all input modules.");
306 inputs = sr_input_list();
307 for (i = 0; inputs[i]; i++) {
310 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
312 if (!inputs[i]->id) {
313 sr_err("No ID in module %d ('%s').", i, d);
316 if (!inputs[i]->name) {
317 sr_err("No name in module %d ('%s').", i, d);
320 if (!inputs[i]->desc) {
321 sr_err("No description in module %d ('%s').", i, d);
324 if (!inputs[i]->init) {
325 sr_err("No init in module %d ('%s').", i, d);
328 if (!inputs[i]->receive) {
329 sr_err("No receive in module %d ('%s').", i, d);
332 if (!inputs[i]->end) {
333 sr_err("No end in module %d ('%s').", i, d);
347 * Sanity-check all libsigrok output modules.
349 * @retval SR_OK All modules are OK
350 * @retval SR_ERR One or more modules have issues.
352 static int sanity_check_all_output_modules(void)
354 int i, errors, ret = SR_OK;
355 const struct sr_output_module **outputs;
358 sr_spew("Sanity-checking all output modules.");
360 outputs = sr_output_list();
361 for (i = 0; outputs[i]; i++) {
364 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
366 if (!outputs[i]->id) {
367 sr_err("No ID in module %d ('%s').", i, d);
370 if (!outputs[i]->name) {
371 sr_err("No name in module %d ('%s').", i, d);
374 if (!outputs[i]->desc) {
375 sr_err("No description in module '%s'.", d);
378 if (!outputs[i]->receive) {
379 sr_err("No receive in module '%s'.", d);
393 * Sanity-check all libsigrok transform modules.
395 * @retval SR_OK All modules are OK
396 * @retval SR_ERR One or more modules have issues.
398 static int sanity_check_all_transform_modules(void)
400 int i, errors, ret = SR_OK;
401 const struct sr_transform_module **transforms;
404 sr_spew("Sanity-checking all transform modules.");
406 transforms = sr_transform_list();
407 for (i = 0; transforms[i]; i++) {
410 d = (transforms[i]->id) ? transforms[i]->id : "NULL";
412 if (!transforms[i]->id) {
413 sr_err("No ID in module %d ('%s').", i, d);
416 if (!transforms[i]->name) {
417 sr_err("No name in module %d ('%s').", i, d);
420 if (!transforms[i]->desc) {
421 sr_err("No description in module '%s'.", d);
424 /* Note: options() is optional. */
425 /* Note: init() is optional. */
426 if (!transforms[i]->receive) {
427 sr_err("No receive in module '%s'.", d);
430 /* Note: cleanup() is optional. */
442 * Initialize libsigrok.
444 * This function must be called before any other libsigrok function.
446 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
447 * This will be a pointer to a newly allocated libsigrok context
448 * object upon success, and is undefined upon errors.
450 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
451 * the 'ctx' pointer is undefined and should not be used. Upon success,
452 * the context will be free'd by sr_exit() as part of the libsigrok
457 SR_API int sr_init(struct sr_context **ctx)
460 struct sr_context *context;
461 struct sr_dev_driver ***lists, **drivers;
467 sr_err("%s(): libsigrok context was NULL.", __func__);
471 context = g_malloc0(sizeof(struct sr_context));
473 /* Generate ctx->driver_list at runtime. */
474 array = g_array_new(TRUE, FALSE, sizeof(struct sr_dev_driver *));
475 for (lists = drivers_lists; *lists; lists++)
476 for (drivers = *lists; *drivers; drivers++)
477 g_array_append_val(array, *drivers);
478 context->driver_list = (struct sr_dev_driver **)array->data;
479 g_array_free(array, FALSE);
481 if (sanity_check_all_drivers(context) < 0) {
482 sr_err("Internal driver error(s), aborting.");
486 if (sanity_check_all_input_modules() < 0) {
487 sr_err("Internal input module error(s), aborting.");
491 if (sanity_check_all_output_modules() < 0) {
492 sr_err("Internal output module error(s), aborting.");
496 if (sanity_check_all_transform_modules() < 0) {
497 sr_err("Internal transform module error(s), aborting.");
501 #ifdef HAVE_LIBUSB_1_0
502 ret = libusb_init(&context->libusb_ctx);
503 if (LIBUSB_SUCCESS != ret) {
504 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
514 #ifdef HAVE_LIBUSB_1_0
522 * Shutdown libsigrok.
524 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
526 * @retval SR_OK Success
527 * @retval other Error code SR_ERR, ...
531 SR_API int sr_exit(struct sr_context *ctx)
534 sr_err("%s(): libsigrok context was NULL.", __func__);
538 sr_hw_cleanup_all(ctx);
540 #ifdef HAVE_LIBUSB_1_0
541 libusb_exit(ctx->libusb_ctx);
544 g_free(sr_driver_list(ctx));