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/>.
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "backend"
34 * @mainpage libsigrok API
36 * @section sec_intro Introduction
38 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
39 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
40 * suite that supports various device types (such as logic analyzers,
41 * oscilloscopes, multimeters, and more).
43 * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
44 * library written in C which provides the basic API for talking to
45 * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
46 * and reading/writing the acquired data into various
47 * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
50 * @section sec_api API reference
52 * See the "Modules" page for an introduction to various libsigrok
53 * related topics and the detailed API documentation of the respective
56 * You can also browse the API documentation by file, or review all
59 * @section sec_mailinglists Mailing lists
61 * There is one mailing list for sigrok/libsigrok: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a>.
63 * @section sec_irc IRC
65 * You can find the sigrok developers in the
66 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
67 * IRC channel on Freenode.
69 * @section sec_website Website
71 * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
77 * Initializing and shutting down libsigrok.
81 * @defgroup grp_init Initialization
83 * Initializing and shutting down libsigrok.
85 * Before using any of the libsigrok functionality (except for
86 * sr_log_loglevel_set()), sr_init() must be called to initialize the
87 * library, which will return a struct sr_context when the initialization
90 * When libsigrok functionality is no longer needed, sr_exit() should be
91 * called, which will (among other things) free the struct sr_context.
93 * Example for a minimal program using libsigrok:
97 * #include <libsigrok/libsigrok.h>
99 * int main(int argc, char **argv)
102 * struct sr_context *sr_ctx;
104 * if ((ret = sr_init(&sr_ctx)) != SR_OK) {
105 * printf("Error initializing libsigrok (%s): %s.\n",
106 * sr_strerror_name(ret), sr_strerror(ret));
110 * // Use libsigrok functions here...
112 * if ((ret = sr_exit(sr_ctx)) != SR_OK) {
113 * printf("Error shutting down libsigrok (%s): %s.\n",
114 * sr_strerror_name(ret), sr_strerror(ret));
125 SR_API GSList *sr_buildinfo_libs_get(void)
127 GSList *l = NULL, *m = NULL;
128 #if defined(HAVE_LIBUSB_1_0) && !defined(__FreeBSD__)
129 const struct libusb_version *lv;
132 m = g_slist_append(NULL, g_strdup("glib"));
133 m = g_slist_append(m, g_strdup_printf("%d.%d.%d (rt: %d.%d.%d/%d:%d)",
134 GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION,
135 glib_major_version, glib_minor_version, glib_micro_version,
136 glib_binary_age, glib_interface_age));
137 l = g_slist_append(l, m);
139 m = g_slist_append(NULL, g_strdup("libzip"));
140 m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBZIP_VERSION));
141 l = g_slist_append(l, m);
143 #ifdef HAVE_LIBSERIALPORT
144 m = g_slist_append(NULL, g_strdup("libserialport"));
145 m = g_slist_append(m, g_strdup_printf("%s/%s (rt: %s/%s)",
146 SP_PACKAGE_VERSION_STRING, SP_LIB_VERSION_STRING,
147 sp_get_package_version_string(), sp_get_lib_version_string()));
148 l = g_slist_append(l, m);
150 #ifdef HAVE_LIBUSB_1_0
151 m = g_slist_append(NULL, g_strdup("libusb-1.0"));
153 m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBUSB_1_0_VERSION));
155 lv = libusb_get_version();
156 m = g_slist_append(m, g_strdup_printf("%d.%d.%d.%d%s",
157 lv->major, lv->minor, lv->micro, lv->nano, lv->rc));
159 l = g_slist_append(l, m);
162 m = g_slist_append(NULL, g_strdup("libftdi"));
163 m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBFTDI_VERSION));
164 l = g_slist_append(l, m);
167 m = g_slist_append(NULL, g_strdup("libgpib"));
168 m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBGPIB_VERSION));
169 l = g_slist_append(l, m);
171 #ifdef HAVE_LIBREVISA
172 m = g_slist_append(NULL, g_strdup("librevisa"));
173 m = g_slist_append(m, g_strdup_printf("%s", CONF_LIBREVISA_VERSION));
174 l = g_slist_append(l, m);
180 SR_API char *sr_buildinfo_host_get(void)
182 return g_strdup_printf("%s, %s-endian", CONF_HOST,
183 #ifdef WORDS_BIGENDIAN
191 SR_API char *sr_buildinfo_scpi_backends_get(void)
196 s = g_string_sized_new(200);
198 g_string_append_printf(s, "TCP, ");
200 g_string_append_printf(s, "RPC, ");
202 #ifdef HAVE_LIBSERIALPORT
203 g_string_append_printf(s, "serial, ");
205 #ifdef HAVE_LIBREVISA
206 g_string_append_printf(s, "VISA, ");
209 g_string_append_printf(s, "GPIB, ");
211 #ifdef HAVE_LIBUSB_1_0
212 g_string_append_printf(s, "USBTMC, ");
214 s->str[s->len - 2] = '\0';
216 str = g_strdup(s->str);
217 g_string_free(s, TRUE);
222 static void print_versions(void)
225 GSList *l, *l_orig, *m;
227 const char *lib, *version;
229 sr_dbg("libsigrok %s/%s (rt: %s/%s).",
230 SR_PACKAGE_VERSION_STRING, SR_LIB_VERSION_STRING,
231 sr_package_version_string_get(), sr_lib_version_string_get());
233 s = g_string_sized_new(200);
234 g_string_append(s, "Libs: ");
235 l_orig = sr_buildinfo_libs_get();
236 for (l = l_orig; l; l = l->next) {
239 version = m->next->data;
240 g_string_append_printf(s, "%s %s, ", lib, version);
241 g_slist_free_full(m, g_free);
243 g_slist_free(l_orig);
244 s->str[s->len - 2] = '.';
245 s->str[s->len - 1] = '\0';
246 sr_dbg("%s", s->str);
247 g_string_free(s, TRUE);
249 str = sr_buildinfo_host_get();
250 sr_dbg("Host: %s.", str);
253 str = sr_buildinfo_scpi_backends_get();
254 sr_dbg("SCPI backends: %s.", str);
258 static void print_resourcepaths(void)
262 sr_dbg("Firmware search paths:");
263 l_orig = sr_resourcepaths_get(SR_RESOURCE_FIRMWARE);
264 for (l = l_orig; l; l = l->next)
265 sr_dbg(" - %s", (const char *)l->data);
266 g_slist_free_full(l_orig, g_free);
270 * Sanity-check all libsigrok drivers.
272 * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
274 * @retval SR_OK All drivers are OK
275 * @retval SR_ERR One or more drivers have issues.
276 * @retval SR_ERR_ARG Invalid argument.
278 static int sanity_check_all_drivers(const struct sr_context *ctx)
280 int i, errors, ret = SR_OK;
281 struct sr_dev_driver **drivers;
287 sr_spew("Sanity-checking all drivers.");
289 drivers = sr_driver_list(ctx);
290 for (i = 0; drivers[i]; i++) {
293 d = (drivers[i]->name) ? drivers[i]->name : "NULL";
295 if (!drivers[i]->name) {
296 sr_err("No name in driver %d ('%s').", i, d);
299 if (!drivers[i]->longname) {
300 sr_err("No longname in driver %d ('%s').", i, d);
303 if (drivers[i]->api_version < 1) {
304 sr_err("API version in driver %d ('%s') < 1.", i, d);
307 if (!drivers[i]->init) {
308 sr_err("No init in driver %d ('%s').", i, d);
311 if (!drivers[i]->cleanup) {
312 sr_err("No cleanup in driver %d ('%s').", i, d);
315 if (!drivers[i]->scan) {
316 sr_err("No scan in driver %d ('%s').", i, d);
319 if (!drivers[i]->dev_list) {
320 sr_err("No dev_list in driver %d ('%s').", i, d);
323 if (!drivers[i]->dev_clear) {
324 sr_err("No dev_clear in driver %d ('%s').", i, d);
327 /* Note: config_get() is optional. */
328 if (!drivers[i]->config_set) {
329 sr_err("No config_set in driver %d ('%s').", i, d);
332 /* Note: config_channel_set() is optional. */
333 /* Note: config_commit() is optional. */
334 if (!drivers[i]->config_list) {
335 sr_err("No config_list in driver %d ('%s').", i, d);
338 if (!drivers[i]->dev_open) {
339 sr_err("No dev_open in driver %d ('%s').", i, d);
342 if (!drivers[i]->dev_close) {
343 sr_err("No dev_close in driver %d ('%s').", i, d);
346 if (!drivers[i]->dev_acquisition_start) {
347 sr_err("No dev_acquisition_start in driver %d ('%s').",
351 if (!drivers[i]->dev_acquisition_stop) {
352 sr_err("No dev_acquisition_stop in driver %d ('%s').",
357 /* Note: 'priv' is allowed to be NULL. */
369 * Sanity-check all libsigrok input modules.
371 * @retval SR_OK All modules are OK
372 * @retval SR_ERR One or more modules have issues.
374 static int sanity_check_all_input_modules(void)
376 int i, errors, ret = SR_OK;
377 const struct sr_input_module **inputs;
380 sr_spew("Sanity-checking all input modules.");
382 inputs = sr_input_list();
383 for (i = 0; inputs[i]; i++) {
386 d = (inputs[i]->id) ? inputs[i]->id : "NULL";
388 if (!inputs[i]->id) {
389 sr_err("No ID in module %d ('%s').", i, d);
392 if (!inputs[i]->name) {
393 sr_err("No name in module %d ('%s').", i, d);
396 if (!inputs[i]->desc) {
397 sr_err("No description in module %d ('%s').", i, d);
400 if (!inputs[i]->init) {
401 sr_err("No init in module %d ('%s').", i, d);
404 if (!inputs[i]->receive) {
405 sr_err("No receive in module %d ('%s').", i, d);
408 if (!inputs[i]->end) {
409 sr_err("No end in module %d ('%s').", i, d);
423 * Sanity-check all libsigrok output modules.
425 * @retval SR_OK All modules are OK
426 * @retval SR_ERR One or more modules have issues.
428 static int sanity_check_all_output_modules(void)
430 int i, errors, ret = SR_OK;
431 const struct sr_output_module **outputs;
434 sr_spew("Sanity-checking all output modules.");
436 outputs = sr_output_list();
437 for (i = 0; outputs[i]; i++) {
440 d = (outputs[i]->id) ? outputs[i]->id : "NULL";
442 if (!outputs[i]->id) {
443 sr_err("No ID in module %d ('%s').", i, d);
446 if (!outputs[i]->name) {
447 sr_err("No name in module %d ('%s').", i, d);
450 if (!outputs[i]->desc) {
451 sr_err("No description in module '%s'.", d);
454 if (!outputs[i]->receive) {
455 sr_err("No receive in module '%s'.", d);
469 * Sanity-check all libsigrok transform modules.
471 * @retval SR_OK All modules are OK
472 * @retval SR_ERR One or more modules have issues.
474 static int sanity_check_all_transform_modules(void)
476 int i, errors, ret = SR_OK;
477 const struct sr_transform_module **transforms;
480 sr_spew("Sanity-checking all transform modules.");
482 transforms = sr_transform_list();
483 for (i = 0; transforms[i]; i++) {
486 d = (transforms[i]->id) ? transforms[i]->id : "NULL";
488 if (!transforms[i]->id) {
489 sr_err("No ID in module %d ('%s').", i, d);
492 if (!transforms[i]->name) {
493 sr_err("No name in module %d ('%s').", i, d);
496 if (!transforms[i]->desc) {
497 sr_err("No description in module '%s'.", d);
500 /* Note: options() is optional. */
501 /* Note: init() is optional. */
502 if (!transforms[i]->receive) {
503 sr_err("No receive in module '%s'.", d);
506 /* Note: cleanup() is optional. */
518 * Initialize libsigrok.
520 * This function must be called before any other libsigrok function.
522 * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
523 * This will be a pointer to a newly allocated libsigrok context
524 * object upon success, and is undefined upon errors.
526 * @return SR_OK upon success, a (negative) error code otherwise. Upon errors
527 * the 'ctx' pointer is undefined and should not be used. Upon success,
528 * the context will be free'd by sr_exit() as part of the libsigrok
533 SR_API int sr_init(struct sr_context **ctx)
536 struct sr_context *context;
543 print_resourcepaths();
546 sr_err("%s(): libsigrok context was NULL.", __func__);
550 context = g_malloc0(sizeof(struct sr_context));
552 sr_drivers_init(context);
554 if (sanity_check_all_drivers(context) < 0) {
555 sr_err("Internal driver error(s), aborting.");
559 if (sanity_check_all_input_modules() < 0) {
560 sr_err("Internal input module error(s), aborting.");
564 if (sanity_check_all_output_modules() < 0) {
565 sr_err("Internal output module error(s), aborting.");
569 if (sanity_check_all_transform_modules() < 0) {
570 sr_err("Internal transform module error(s), aborting.");
575 if ((ret = WSAStartup(MAKEWORD(2, 2), &wsadata)) != 0) {
576 sr_err("WSAStartup failed with error code %d.", ret);
582 #ifdef HAVE_LIBUSB_1_0
583 ret = libusb_init(&context->libusb_ctx);
584 if (LIBUSB_SUCCESS != ret) {
585 sr_err("libusb_init() returned %s.", libusb_error_name(ret));
590 sr_resource_set_hooks(context, NULL, NULL, NULL, NULL);
602 * Shutdown libsigrok.
604 * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
606 * @retval SR_OK Success
607 * @retval other Error code SR_ERR, ...
611 SR_API int sr_exit(struct sr_context *ctx)
614 sr_err("%s(): libsigrok context was NULL.", __func__);
618 sr_hw_cleanup_all(ctx);
624 #ifdef HAVE_LIBUSB_1_0
625 libusb_exit(ctx->libusb_ctx);
628 g_free(sr_driver_list(ctx));