]>
Commit | Line | Data |
---|---|---|
a1bb33af | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
a1bb33af | 3 | * |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> |
b8072700 | 5 | * Copyright (C) 2012 Peter Stuge <peter@stuge.se> |
a1bb33af UH |
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> | |
545f9786 | 22 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ |
45c59c8b BV |
23 | #include "libsigrok.h" |
24 | #include "libsigrok-internal.h" | |
a1bb33af | 25 | |
fa93154f BV |
26 | extern struct sr_session *session; |
27 | ||
5b30cca7 UH |
28 | /** |
29 | * @mainpage libsigrok API | |
30 | * | |
31 | * @section sec_intro Introduction | |
32 | * | |
33 | * The <a href="http://sigrok.org">sigrok</a> project aims at creating a | |
34 | * portable, cross-platform, Free/Libre/Open-Source signal analysis software | |
35 | * suite that supports various device types (such as logic analyzers, | |
36 | * oscilloscopes, multimeters, and more). | |
37 | * | |
38 | * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared | |
39 | * library written in C which provides the basic API for talking to | |
40 | * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a> | |
41 | * and reading/writing the acquired data into various | |
42 | * <a href="http://sigrok.org/wiki/Input_output_formats">input/output | |
43 | * file formats</a>. | |
44 | * | |
f21193fa | 45 | * @section sec_api API reference |
5b30cca7 | 46 | * |
f21193fa UH |
47 | * See the "Modules" page for an introduction to various libsigrok |
48 | * related topics and the detailed API documentation of the respective | |
49 | * functions. | |
50 | * | |
51 | * You can also browse the API documentation by file, or review all | |
52 | * data structures. | |
5b30cca7 UH |
53 | * |
54 | * @section sec_mailinglists Mailing lists | |
55 | * | |
56 | * 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>. | |
57 | * | |
58 | * @section sec_irc IRC | |
59 | * | |
60 | * You can find the sigrok developers in the | |
61 | * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a> | |
62 | * IRC channel on Freenode. | |
63 | * | |
64 | * @section sec_website Website | |
65 | * | |
66 | * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a> | |
67 | */ | |
68 | ||
393fb9cb UH |
69 | /** |
70 | * @file | |
71 | * | |
72 | * Initializing and shutting down libsigrok. | |
73 | */ | |
74 | ||
7b870c38 UH |
75 | /** |
76 | * @defgroup grp_init Initialization | |
77 | * | |
78 | * Initializing and shutting down libsigrok. | |
79 | * | |
afe2f28e UH |
80 | * Before using any of the libsigrok functionality, sr_init() must |
81 | * be called to initialize the library, which will return a struct sr_context | |
82 | * when the initialization was successful. | |
83 | * | |
84 | * When libsigrok functionality is no longer needed, sr_exit() should be | |
85 | * called, which will (among other things) free the struct sr_context. | |
86 | * | |
87 | * Example for a minimal program using libsigrok: | |
88 | * | |
89 | * @code{.c} | |
90 | * #include <stdio.h> | |
91 | * #include <libsigrok/libsigrok.h> | |
92 | * | |
93 | * int main(int argc, char **argv) | |
94 | * { | |
95 | * int ret; | |
96 | * struct sr_context *sr_ctx; | |
97 | * | |
98 | * if ((ret = sr_init(&sr_ctx)) != SR_OK) { | |
99 | * printf("Error initializing libsigrok (%s): %s.", | |
100 | * sr_strerror_name(ret), sr_strerror(ret)); | |
101 | * return 1; | |
102 | * } | |
103 | * | |
104 | * // Use libsigrok functions here... | |
105 | * | |
106 | * if ((ret = sr_exit(sr_ctx)) != SR_OK) { | |
107 | * printf("Error shutting down libsigrok (%s): %s.", | |
108 | * sr_strerror_name(ret), sr_strerror(ret)); | |
109 | * return 1; | |
110 | * } | |
111 | * | |
112 | * return 0; | |
113 | * } | |
114 | * @endcode | |
115 | * | |
7b870c38 UH |
116 | * @{ |
117 | */ | |
118 | ||
55a6daf5 UH |
119 | /** |
120 | * Sanity-check all libsigrok drivers. | |
121 | * | |
04cb9157 MH |
122 | * @retval SR_OK All drivers are OK |
123 | * @retval SR_ERR One or more drivers have issues. | |
55a6daf5 UH |
124 | */ |
125 | static int sanity_check_all_drivers(void) | |
126 | { | |
127 | int i, errors, ret = SR_OK; | |
128 | struct sr_dev_driver **drivers; | |
129 | const char *d; | |
130 | ||
131 | sr_spew("Sanity-checking all drivers."); | |
132 | ||
133 | drivers = sr_driver_list(); | |
134 | for (i = 0; drivers[i]; i++) { | |
135 | errors = 0; | |
136 | ||
137 | d = (drivers[i]->name) ? drivers[i]->name : "NULL"; | |
138 | ||
139 | if (!drivers[i]->name) { | |
140 | sr_err("No name in driver %d ('%s').", i, d); | |
141 | errors++; | |
142 | } | |
143 | if (!drivers[i]->longname) { | |
144 | sr_err("No longname in driver %d ('%s').", i, d); | |
145 | errors++; | |
146 | } | |
147 | if (drivers[i]->api_version < 1) { | |
148 | sr_err("API version in driver %d ('%s') < 1.", i, d); | |
149 | errors++; | |
150 | } | |
151 | if (!drivers[i]->init) { | |
152 | sr_err("No init in driver %d ('%s').", i, d); | |
153 | errors++; | |
154 | } | |
155 | if (!drivers[i]->cleanup) { | |
156 | sr_err("No cleanup in driver %d ('%s').", i, d); | |
157 | errors++; | |
158 | } | |
159 | if (!drivers[i]->scan) { | |
160 | sr_err("No scan in driver %d ('%s').", i, d); | |
161 | errors++; | |
162 | } | |
163 | if (!drivers[i]->dev_list) { | |
164 | sr_err("No dev_list in driver %d ('%s').", i, d); | |
165 | errors++; | |
166 | } | |
167 | if (!drivers[i]->dev_clear) { | |
168 | sr_err("No dev_clear in driver %d ('%s').", i, d); | |
169 | errors++; | |
170 | } | |
6fab7b8f UH |
171 | /* Note: config_get() is optional. */ |
172 | if (!drivers[i]->config_set) { | |
173 | sr_err("No config_set in driver %d ('%s').", i, d); | |
174 | errors++; | |
175 | } | |
176 | if (!drivers[i]->config_list) { | |
177 | sr_err("No config_list in driver %d ('%s').", i, d); | |
178 | errors++; | |
179 | } | |
55a6daf5 UH |
180 | if (!drivers[i]->dev_open) { |
181 | sr_err("No dev_open in driver %d ('%s').", i, d); | |
182 | errors++; | |
183 | } | |
184 | if (!drivers[i]->dev_close) { | |
185 | sr_err("No dev_close in driver %d ('%s').", i, d); | |
186 | errors++; | |
187 | } | |
55a6daf5 UH |
188 | if (!drivers[i]->dev_acquisition_start) { |
189 | sr_err("No dev_acquisition_start in driver %d ('%s').", | |
190 | i, d); | |
191 | errors++; | |
192 | } | |
193 | if (!drivers[i]->dev_acquisition_stop) { | |
194 | sr_err("No dev_acquisition_stop in driver %d ('%s').", | |
195 | i, d); | |
196 | errors++; | |
197 | } | |
198 | ||
199 | /* Note: 'priv' is allowed to be NULL. */ | |
200 | ||
201 | if (errors == 0) | |
202 | continue; | |
203 | ||
204 | ret = SR_ERR; | |
205 | } | |
206 | ||
207 | return ret; | |
208 | } | |
209 | ||
218e629f UH |
210 | /** |
211 | * Sanity-check all libsigrok input modules. | |
212 | * | |
04cb9157 MH |
213 | * @retval SR_OK All modules are OK |
214 | * @retval SR_ERR One or more modules have issues. | |
218e629f UH |
215 | */ |
216 | static int sanity_check_all_input_modules(void) | |
217 | { | |
218 | int i, errors, ret = SR_OK; | |
219 | struct sr_input_format **inputs; | |
220 | const char *d; | |
221 | ||
222 | sr_spew("Sanity-checking all input modules."); | |
223 | ||
224 | inputs = sr_input_list(); | |
225 | for (i = 0; inputs[i]; i++) { | |
226 | errors = 0; | |
227 | ||
228 | d = (inputs[i]->id) ? inputs[i]->id : "NULL"; | |
229 | ||
230 | if (!inputs[i]->id) { | |
231 | sr_err("No ID in module %d ('%s').", i, d); | |
232 | errors++; | |
233 | } | |
234 | if (!inputs[i]->description) { | |
235 | sr_err("No description in module %d ('%s').", i, d); | |
236 | errors++; | |
237 | } | |
238 | if (!inputs[i]->format_match) { | |
239 | sr_err("No format_match in module %d ('%s').", i, d); | |
240 | errors++; | |
241 | } | |
242 | if (!inputs[i]->init) { | |
243 | sr_err("No init in module %d ('%s').", i, d); | |
244 | errors++; | |
245 | } | |
246 | if (!inputs[i]->loadfile) { | |
247 | sr_err("No loadfile in module %d ('%s').", i, d); | |
248 | errors++; | |
249 | } | |
250 | ||
251 | if (errors == 0) | |
252 | continue; | |
253 | ||
254 | ret = SR_ERR; | |
255 | } | |
256 | ||
257 | return ret; | |
258 | } | |
259 | ||
260 | /** | |
261 | * Sanity-check all libsigrok output modules. | |
262 | * | |
04cb9157 MH |
263 | * @retval SR_OK All modules are OK |
264 | * @retval SR_ERR One or more modules have issues. | |
218e629f UH |
265 | */ |
266 | static int sanity_check_all_output_modules(void) | |
267 | { | |
268 | int i, errors, ret = SR_OK; | |
269 | struct sr_output_format **outputs; | |
270 | const char *d; | |
271 | ||
272 | sr_spew("Sanity-checking all output modules."); | |
273 | ||
274 | outputs = sr_output_list(); | |
275 | for (i = 0; outputs[i]; i++) { | |
276 | errors = 0; | |
277 | ||
278 | d = (outputs[i]->id) ? outputs[i]->id : "NULL"; | |
279 | ||
280 | if (!outputs[i]->id) { | |
281 | sr_err("No ID in module %d ('%s').", i, d); | |
282 | errors++; | |
283 | } | |
284 | if (!outputs[i]->description) { | |
285 | sr_err("No description in module %d ('%s').", i, d); | |
286 | errors++; | |
287 | } | |
288 | if (outputs[i]->df_type < 10000 || outputs[i]->df_type > 10007) { | |
289 | sr_err("Invalid df_type %d in module %d ('%s').", | |
290 | outputs[i]->df_type, i, d); | |
291 | errors++; | |
292 | } | |
293 | ||
294 | /* All modules must provide a data or recv API callback. */ | |
17f63de6 BV |
295 | if (!outputs[i]->data && !outputs[i]->receive) { |
296 | sr_err("No data/receive in module %d ('%s').", i, d); | |
218e629f UH |
297 | errors++; |
298 | } | |
299 | ||
300 | /* | |
301 | * Currently most API calls are optional (their function | |
302 | * pointers can thus be NULL) in theory: init, event, cleanup. | |
303 | */ | |
304 | ||
305 | if (errors == 0) | |
306 | continue; | |
307 | ||
308 | ret = SR_ERR; | |
309 | } | |
310 | ||
311 | return ret; | |
312 | } | |
313 | ||
cd009d55 UH |
314 | /** |
315 | * Initialize libsigrok. | |
316 | * | |
c46762a2 UH |
317 | * This function must be called before any other libsigrok function. |
318 | * | |
319 | * @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL. | |
320 | * This will be a pointer to a newly allocated libsigrok context | |
321 | * object upon success, and is undefined upon errors. | |
322 | * | |
323 | * @return SR_OK upon success, a (negative) error code otherwise. Upon errors | |
324 | * the 'ctx' pointer is undefined and should not be used. Upon success, | |
325 | * the context will be free'd by sr_exit() as part of the libsigrok | |
326 | * shutdown. | |
9fb5f2df | 327 | * |
53f05fa8 | 328 | * @since 0.2.0 |
cd009d55 | 329 | */ |
b8072700 | 330 | SR_API int sr_init(struct sr_context **ctx) |
a1bb33af | 331 | { |
b8072700 PS |
332 | int ret = SR_ERR; |
333 | struct sr_context *context; | |
334 | ||
c46762a2 UH |
335 | if (!ctx) { |
336 | sr_err("%s(): libsigrok context was NULL.", __func__); | |
337 | return SR_ERR; | |
338 | } | |
339 | ||
55a6daf5 UH |
340 | if (sanity_check_all_drivers() < 0) { |
341 | sr_err("Internal driver error(s), aborting."); | |
342 | return ret; | |
343 | } | |
344 | ||
218e629f UH |
345 | if (sanity_check_all_input_modules() < 0) { |
346 | sr_err("Internal input module error(s), aborting."); | |
347 | return ret; | |
348 | } | |
349 | ||
350 | if (sanity_check_all_output_modules() < 0) { | |
351 | sr_err("Internal output module error(s), aborting."); | |
352 | return ret; | |
353 | } | |
354 | ||
b8072700 PS |
355 | /* + 1 to handle when struct sr_context has no members. */ |
356 | context = g_try_malloc0(sizeof(struct sr_context) + 1); | |
357 | ||
358 | if (!context) { | |
359 | ret = SR_ERR_MALLOC; | |
360 | goto done; | |
361 | } | |
362 | ||
785b9ff2 PS |
363 | #ifdef HAVE_LIBUSB_1_0 |
364 | ret = libusb_init(&context->libusb_ctx); | |
8e2d43cc | 365 | if (LIBUSB_SUCCESS != ret) { |
c46762a2 | 366 | sr_err("libusb_init() returned %s.\n", libusb_error_name(ret)); |
63c07e48 | 367 | ret = SR_ERR; |
785b9ff2 PS |
368 | goto done; |
369 | } | |
370 | #endif | |
371 | ||
b8072700 | 372 | *ctx = context; |
123d97b1 | 373 | context = NULL; |
fa93154f | 374 | session = NULL; |
b8072700 PS |
375 | ret = SR_OK; |
376 | ||
377 | done: | |
123d97b1 PS |
378 | if (context) |
379 | g_free(context); | |
b8072700 | 380 | return ret; |
a1bb33af UH |
381 | } |
382 | ||
cd009d55 UH |
383 | /** |
384 | * Shutdown libsigrok. | |
385 | * | |
c46762a2 UH |
386 | * @param ctx Pointer to a libsigrok context struct. Must not be NULL. |
387 | * | |
04cb9157 MH |
388 | * @retval SR_OK Success |
389 | * @retval other Error code SR_ERR, ... | |
9fb5f2df | 390 | * |
53f05fa8 | 391 | * @since 0.2.0 |
cd009d55 | 392 | */ |
b8072700 | 393 | SR_API int sr_exit(struct sr_context *ctx) |
a1bb33af | 394 | { |
c46762a2 UH |
395 | if (!ctx) { |
396 | sr_err("%s(): libsigrok context was NULL.", __func__); | |
397 | return SR_ERR; | |
398 | } | |
399 | ||
93a04e3b | 400 | sr_hw_cleanup_all(); |
cd009d55 | 401 | |
785b9ff2 PS |
402 | #ifdef HAVE_LIBUSB_1_0 |
403 | libusb_exit(ctx->libusb_ctx); | |
404 | #endif | |
405 | ||
b8072700 PS |
406 | g_free(ctx); |
407 | ||
cd009d55 | 408 | return SR_OK; |
a1bb33af | 409 | } |
7b870c38 UH |
410 | |
411 | /** @} */ |