]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
5 | * Copyright (C) 2012 Peter Stuge <peter@stuge.se> | |
6 | * | |
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. | |
11 | * | |
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. | |
16 | * | |
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/>. | |
19 | */ | |
20 | ||
21 | #include <glib.h> | |
22 | #include "libsigrok.h" | |
23 | #include "libsigrok-internal.h" | |
24 | ||
25 | /** | |
26 | * @mainpage libsigrok API | |
27 | * | |
28 | * @section sec_intro Introduction | |
29 | * | |
30 | * The <a href="http://sigrok.org">sigrok</a> project aims at creating a | |
31 | * portable, cross-platform, Free/Libre/Open-Source signal analysis software | |
32 | * suite that supports various device types (such as logic analyzers, | |
33 | * oscilloscopes, multimeters, and more). | |
34 | * | |
35 | * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared | |
36 | * library written in C which provides the basic API for talking to | |
37 | * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a> | |
38 | * and reading/writing the acquired data into various | |
39 | * <a href="http://sigrok.org/wiki/Input_output_formats">input/output | |
40 | * file formats</a>. | |
41 | * | |
42 | * @section sec_error_handling Error handling | |
43 | * | |
44 | * libsigrok functions usually return @ref SR_OK upon success, or a negative | |
45 | * error code on failure. | |
46 | * | |
47 | * @section sec_mailinglists Mailing lists | |
48 | * | |
49 | * 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>. | |
50 | * | |
51 | * @section sec_irc IRC | |
52 | * | |
53 | * You can find the sigrok developers in the | |
54 | * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a> | |
55 | * IRC channel on Freenode. | |
56 | * | |
57 | * @section sec_website Website | |
58 | * | |
59 | * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a> | |
60 | */ | |
61 | ||
62 | /** | |
63 | * @defgroup grp_init Initialization | |
64 | * | |
65 | * Initializing and shutting down libsigrok. | |
66 | * | |
67 | * @{ | |
68 | */ | |
69 | ||
70 | /** | |
71 | * Initialize libsigrok. | |
72 | * | |
73 | * This function must be called before any other libsigrok function. | |
74 | * | |
75 | * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL. | |
76 | * This will be a pointer to a newly allocated libsigrok context | |
77 | * object upon success, and is undefined upon errors. | |
78 | * | |
79 | * @return SR_OK upon success, a (negative) error code otherwise. Upon errors | |
80 | * the 'ctx' pointer is undefined and should not be used. Upon success, | |
81 | * the context will be free'd by sr_exit() as part of the libsigrok | |
82 | * shutdown. | |
83 | */ | |
84 | SR_API int sr_init(struct sr_context **ctx) | |
85 | { | |
86 | int ret = SR_ERR; | |
87 | struct sr_context *context; | |
88 | ||
89 | if (!ctx) { | |
90 | sr_err("%s(): libsigrok context was NULL.", __func__); | |
91 | return SR_ERR; | |
92 | } | |
93 | ||
94 | /* + 1 to handle when struct sr_context has no members. */ | |
95 | context = g_try_malloc0(sizeof(struct sr_context) + 1); | |
96 | ||
97 | if (!context) { | |
98 | ret = SR_ERR_MALLOC; | |
99 | goto done; | |
100 | } | |
101 | ||
102 | #ifdef HAVE_LIBUSB_1_0 | |
103 | ret = libusb_init(&context->libusb_ctx); | |
104 | if (LIBUSB_SUCCESS != ret) { | |
105 | sr_err("libusb_init() returned %s.\n", libusb_error_name(ret)); | |
106 | goto done; | |
107 | } | |
108 | #endif | |
109 | ||
110 | *ctx = context; | |
111 | ret = SR_OK; | |
112 | ||
113 | done: | |
114 | return ret; | |
115 | } | |
116 | ||
117 | /** | |
118 | * Shutdown libsigrok. | |
119 | * | |
120 | * @param ctx Pointer to a libsigrok context struct. Must not be NULL. | |
121 | * | |
122 | * @return SR_OK upon success, a (negative) error code otherwise. | |
123 | */ | |
124 | SR_API int sr_exit(struct sr_context *ctx) | |
125 | { | |
126 | if (!ctx) { | |
127 | sr_err("%s(): libsigrok context was NULL.", __func__); | |
128 | return SR_ERR; | |
129 | } | |
130 | ||
131 | sr_hw_cleanup_all(); | |
132 | ||
133 | #ifdef HAVE_LIBUSB_1_0 | |
134 | libusb_exit(ctx->libusb_ctx); | |
135 | #endif | |
136 | ||
137 | g_free(ctx); | |
138 | ||
139 | return SR_OK; | |
140 | } | |
141 | ||
142 | /** @} */ |