]>
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> |
a1bb33af UH |
5 | * |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #include <stdio.h> | |
21 | #include <stdlib.h> | |
22 | #include <unistd.h> | |
23 | #include <string.h> | |
544a4582 | 24 | #include <glib.h> |
45c59c8b BV |
25 | #include "libsigrok.h" |
26 | #include "libsigrok-internal.h" | |
aa4b1107 | 27 | |
2ad1deb8 | 28 | /** @cond PRIVATE */ |
3544f848 | 29 | #define LOG_PREFIX "session" |
2ad1deb8 | 30 | /** @endcond */ |
a421dc1d | 31 | |
393fb9cb UH |
32 | /** |
33 | * @file | |
34 | * | |
35 | * Creating, using, or destroying libsigrok sessions. | |
36 | */ | |
37 | ||
7b870c38 UH |
38 | /** |
39 | * @defgroup grp_session Session handling | |
40 | * | |
41 | * Creating, using, or destroying libsigrok sessions. | |
42 | * | |
43 | * @{ | |
44 | */ | |
45 | ||
544a4582 | 46 | struct source { |
544a4582 | 47 | int timeout; |
144f6660 | 48 | sr_receive_data_callback cb; |
1f9813eb | 49 | void *cb_data; |
aac0ea25 LPC |
50 | |
51 | /* This is used to keep track of the object (fd, pollfd or channel) which is | |
52 | * being polled and will be used to match the source when removing it again. | |
53 | */ | |
54 | gintptr poll_object; | |
544a4582 BV |
55 | }; |
56 | ||
2726474a | 57 | struct datafeed_callback { |
144f6660 | 58 | sr_datafeed_callback cb; |
2726474a ML |
59 | void *cb_data; |
60 | }; | |
61 | ||
7d658874 | 62 | /* There can only be one session at a time. */ |
a0ecd83b | 63 | /* 'session' is not static, it's used elsewhere (via 'extern'). */ |
2872d21e | 64 | struct sr_session *session; |
544a4582 | 65 | |
9f45fb3a UH |
66 | /** |
67 | * Create a new session. | |
68 | * | |
6b2d8d3e | 69 | * @todo Should it use the file-global "session" variable or take an argument? |
9f45fb3a UH |
70 | * The same question applies to all the other session functions. |
71 | * | |
04cb9157 | 72 | * @retval NULL Error. |
98582bf5 | 73 | * @retval other A pointer to the newly allocated session. |
47117241 UH |
74 | * |
75 | * @since 0.1.0 | |
9f45fb3a | 76 | */ |
1a081ca6 | 77 | SR_API struct sr_session *sr_session_new(void) |
a1bb33af | 78 | { |
133a37bf | 79 | if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { |
a421dc1d UH |
80 | sr_err("Session malloc failed."); |
81 | return NULL; | |
9f45fb3a | 82 | } |
a1bb33af | 83 | |
b7e94111 | 84 | session->source_timeout = -1; |
5451816f | 85 | session->running = FALSE; |
33c6e4c5 AG |
86 | session->abort_session = FALSE; |
87 | g_mutex_init(&session->stop_mutex); | |
b7e94111 | 88 | |
a1bb33af UH |
89 | return session; |
90 | } | |
91 | ||
9f45fb3a UH |
92 | /** |
93 | * Destroy the current session. | |
9f45fb3a UH |
94 | * This frees up all memory used by the session. |
95 | * | |
04cb9157 MH |
96 | * @retval SR_OK Success. |
97 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
98 | * |
99 | * @since 0.1.0 | |
9f45fb3a | 100 | */ |
1a081ca6 | 101 | SR_API int sr_session_destroy(void) |
a1bb33af | 102 | { |
9f45fb3a | 103 | if (!session) { |
a421dc1d | 104 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 105 | return SR_ERR_BUG; |
9f45fb3a UH |
106 | } |
107 | ||
ed229aaa | 108 | sr_session_dev_remove_all(); |
33c6e4c5 | 109 | g_mutex_clear(&session->stop_mutex); |
3d68b612 BV |
110 | if (session->trigger) |
111 | sr_trigger_free(session->trigger); | |
33c6e4c5 | 112 | |
a1bb33af | 113 | g_free(session); |
9f45fb3a | 114 | session = NULL; |
e0508e67 UH |
115 | |
116 | return SR_OK; | |
a1bb33af UH |
117 | } |
118 | ||
9f45fb3a | 119 | /** |
6b2d8d3e | 120 | * Remove all the devices from the current session. |
9f45fb3a UH |
121 | * |
122 | * The session itself (i.e., the struct sr_session) is not free'd and still | |
123 | * exists after this function returns. | |
124 | * | |
04cb9157 MH |
125 | * @retval SR_OK Success. |
126 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
127 | * |
128 | * @since 0.1.0 | |
9f45fb3a | 129 | */ |
01c3e9db | 130 | SR_API int sr_session_dev_remove_all(void) |
a1bb33af | 131 | { |
9f45fb3a | 132 | if (!session) { |
a421dc1d | 133 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 134 | return SR_ERR_BUG; |
9f45fb3a UH |
135 | } |
136 | ||
681803df | 137 | g_slist_free(session->devs); |
bb7ef793 | 138 | session->devs = NULL; |
e0508e67 UH |
139 | |
140 | return SR_OK; | |
a1bb33af UH |
141 | } |
142 | ||
9f45fb3a | 143 | /** |
9c5332d2 | 144 | * Add a device instance to the current session. |
9f45fb3a | 145 | * |
9c5332d2 | 146 | * @param sdi The device instance to add to the current session. Must not |
de4d3f99 BV |
147 | * be NULL. Also, sdi->driver and sdi->driver->dev_open must |
148 | * not be NULL. | |
9f45fb3a | 149 | * |
04cb9157 MH |
150 | * @retval SR_OK Success. |
151 | * @retval SR_ERR_ARG Invalid argument. | |
152 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
153 | * |
154 | * @since 0.2.0 | |
9f45fb3a | 155 | */ |
de4d3f99 | 156 | SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) |
a1bb33af | 157 | { |
5451816f | 158 | int ret; |
a1bb33af | 159 | |
de4d3f99 | 160 | if (!sdi) { |
a421dc1d | 161 | sr_err("%s: sdi was NULL", __func__); |
9f45fb3a UH |
162 | return SR_ERR_ARG; |
163 | } | |
164 | ||
d6eb0c33 | 165 | if (!session) { |
a421dc1d | 166 | sr_err("%s: session was NULL", __func__); |
d6eb0c33 UH |
167 | return SR_ERR_BUG; |
168 | } | |
169 | ||
de4d3f99 BV |
170 | /* If sdi->driver is NULL, this is a virtual device. */ |
171 | if (!sdi->driver) { | |
a421dc1d | 172 | sr_dbg("%s: sdi->driver was NULL, this seems to be " |
d6eb0c33 UH |
173 | "a virtual device; continuing", __func__); |
174 | /* Just add the device, don't run dev_open(). */ | |
de4d3f99 | 175 | session->devs = g_slist_append(session->devs, (gpointer)sdi); |
d6eb0c33 | 176 | return SR_OK; |
9f45fb3a UH |
177 | } |
178 | ||
de4d3f99 BV |
179 | /* sdi->driver is non-NULL (i.e. we have a real device). */ |
180 | if (!sdi->driver->dev_open) { | |
a421dc1d | 181 | sr_err("%s: sdi->driver->dev_open was NULL", __func__); |
8ec95d22 | 182 | return SR_ERR_BUG; |
9f45fb3a UH |
183 | } |
184 | ||
de4d3f99 | 185 | session->devs = g_slist_append(session->devs, (gpointer)sdi); |
aa4b1107 | 186 | |
5451816f | 187 | if (session->running) { |
32b7cd4f DE |
188 | /* Adding a device to a running session. Commit settings |
189 | * and start acquisition on that device now. */ | |
190 | if ((ret = sr_config_commit(sdi)) != SR_OK) { | |
191 | sr_err("Failed to commit device settings before " | |
192 | "starting acquisition in running session (%s)", | |
193 | sr_strerror(ret)); | |
194 | return ret; | |
195 | } | |
5451816f | 196 | if ((ret = sdi->driver->dev_acquisition_start(sdi, |
32b7cd4f | 197 | (void *)sdi)) != SR_OK) { |
5451816f | 198 | sr_err("Failed to start acquisition of device in " |
32b7cd4f DE |
199 | "running session (%s)", sr_strerror(ret)); |
200 | return ret; | |
201 | } | |
5451816f BV |
202 | } |
203 | ||
e46b8fb1 | 204 | return SR_OK; |
a1bb33af UH |
205 | } |
206 | ||
2bb311b4 BV |
207 | /** |
208 | * List all device instances attached to the current session. | |
209 | * | |
210 | * @param devlist A pointer where the device instance list will be | |
211 | * stored on return. If no devices are in the session, | |
212 | * this will be NULL. Each element in the list points | |
213 | * to a struct sr_dev_inst *. | |
214 | * The list must be freed by the caller, but not the | |
215 | * elements pointed to. | |
216 | * | |
04cb9157 MH |
217 | * @retval SR_OK Success. |
218 | * @retval SR_ERR Invalid argument. | |
47117241 UH |
219 | * |
220 | * @since 0.3.0 | |
2bb311b4 BV |
221 | */ |
222 | SR_API int sr_session_dev_list(GSList **devlist) | |
223 | { | |
224 | ||
225 | *devlist = NULL; | |
226 | ||
227 | if (!session) | |
228 | return SR_ERR; | |
229 | ||
230 | *devlist = g_slist_copy(session->devs); | |
231 | ||
232 | return SR_OK; | |
233 | } | |
234 | ||
9f45fb3a | 235 | /** |
01c3e9db | 236 | * Remove all datafeed callbacks in the current session. |
9f45fb3a | 237 | * |
04cb9157 MH |
238 | * @retval SR_OK Success. |
239 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
240 | * |
241 | * @since 0.1.0 | |
9f45fb3a | 242 | */ |
01c3e9db | 243 | SR_API int sr_session_datafeed_callback_remove_all(void) |
a1bb33af | 244 | { |
9f45fb3a | 245 | if (!session) { |
a421dc1d | 246 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 247 | return SR_ERR_BUG; |
9f45fb3a UH |
248 | } |
249 | ||
2726474a | 250 | g_slist_free_full(session->datafeed_callbacks, g_free); |
a1bb33af | 251 | session->datafeed_callbacks = NULL; |
e0508e67 UH |
252 | |
253 | return SR_OK; | |
a1bb33af UH |
254 | } |
255 | ||
9f45fb3a UH |
256 | /** |
257 | * Add a datafeed callback to the current session. | |
258 | * | |
d08490aa | 259 | * @param cb Function to call when a chunk of data is received. |
0abee507 | 260 | * Must not be NULL. |
85222791 | 261 | * @param cb_data Opaque pointer passed in by the caller. |
a1645fcd | 262 | * |
04cb9157 MH |
263 | * @retval SR_OK Success. |
264 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
265 | * |
266 | * @since 0.3.0 | |
9f45fb3a | 267 | */ |
144f6660 | 268 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_data) |
a1bb33af | 269 | { |
2726474a ML |
270 | struct datafeed_callback *cb_struct; |
271 | ||
9f45fb3a | 272 | if (!session) { |
a421dc1d | 273 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 274 | return SR_ERR_BUG; |
9f45fb3a UH |
275 | } |
276 | ||
0abee507 | 277 | if (!cb) { |
a421dc1d | 278 | sr_err("%s: cb was NULL", __func__); |
0abee507 UH |
279 | return SR_ERR_ARG; |
280 | } | |
9f45fb3a | 281 | |
2726474a ML |
282 | if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback)))) |
283 | return SR_ERR_MALLOC; | |
284 | ||
285 | cb_struct->cb = cb; | |
286 | cb_struct->cb_data = cb_data; | |
287 | ||
62c82025 | 288 | session->datafeed_callbacks = |
2726474a | 289 | g_slist_append(session->datafeed_callbacks, cb_struct); |
e0508e67 UH |
290 | |
291 | return SR_OK; | |
a1bb33af UH |
292 | } |
293 | ||
7b5e6d29 BV |
294 | SR_PRIV struct sr_trigger *sr_session_trigger_get(void) |
295 | { | |
296 | return session->trigger; | |
297 | } | |
298 | ||
299 | SR_API int sr_session_trigger_set(struct sr_trigger *trig) | |
300 | { | |
301 | session->trigger = trig; | |
302 | ||
303 | return SR_OK; | |
304 | } | |
305 | ||
b483be74 BV |
306 | /** |
307 | * Call every device in the session's callback. | |
308 | * | |
309 | * For sessions not driven by select loops such as sr_session_run(), | |
310 | * but driven by another scheduler, this can be used to poll the devices | |
311 | * from within that scheduler. | |
312 | * | |
f6eb2cb5 BV |
313 | * @param block If TRUE, this call will wait for any of the session's |
314 | * sources to fire an event on the file descriptors, or | |
315 | * any of their timeouts to activate. In other words, this | |
316 | * can be used as a select loop. | |
317 | * If FALSE, all sources have their callback run, regardless | |
318 | * of file descriptor or timeout status. | |
319 | * | |
04cb9157 MH |
320 | * @retval SR_OK Success. |
321 | * @retval SR_ERR Error occured. | |
b483be74 | 322 | */ |
1861be0b | 323 | static int sr_session_iteration(gboolean block) |
544a4582 | 324 | { |
b7e94111 LPC |
325 | unsigned int i; |
326 | int ret; | |
544a4582 | 327 | |
b483be74 BV |
328 | ret = g_poll(session->pollfds, session->num_sources, |
329 | block ? session->source_timeout : 0); | |
330 | for (i = 0; i < session->num_sources; i++) { | |
331 | if (session->pollfds[i].revents > 0 || (ret == 0 | |
332 | && session->source_timeout == session->sources[i].timeout)) { | |
33c6e4c5 | 333 | /* |
b483be74 BV |
334 | * Invoke the source's callback on an event, |
335 | * or if the poll timed out and this source | |
336 | * asked for that timeout. | |
33c6e4c5 | 337 | */ |
b483be74 BV |
338 | if (!session->sources[i].cb(session->pollfds[i].fd, |
339 | session->pollfds[i].revents, | |
340 | session->sources[i].cb_data)) | |
341 | sr_session_source_remove(session->sources[i].poll_object); | |
342 | } | |
343 | /* | |
344 | * We want to take as little time as possible to stop | |
345 | * the session if we have been told to do so. Therefore, | |
346 | * we check the flag after processing every source, not | |
347 | * just once per main event loop. | |
348 | */ | |
349 | g_mutex_lock(&session->stop_mutex); | |
350 | if (session->abort_session) { | |
351 | sr_session_stop_sync(); | |
352 | /* But once is enough. */ | |
353 | session->abort_session = FALSE; | |
544a4582 | 354 | } |
b483be74 | 355 | g_mutex_unlock(&session->stop_mutex); |
544a4582 | 356 | } |
e0508e67 UH |
357 | |
358 | return SR_OK; | |
544a4582 BV |
359 | } |
360 | ||
7b5e6d29 BV |
361 | |
362 | static int verify_trigger(struct sr_trigger *trigger) | |
363 | { | |
364 | struct sr_trigger_stage *stage; | |
365 | struct sr_trigger_match *match; | |
366 | GSList *l, *m; | |
367 | ||
368 | if (!trigger->stages) { | |
369 | sr_err("No trigger stages defined."); | |
370 | return SR_ERR; | |
371 | } | |
372 | ||
373 | sr_spew("Checking trigger:"); | |
374 | for (l = trigger->stages; l; l = l->next) { | |
375 | stage = l->data; | |
376 | if (!stage->matches) { | |
377 | sr_err("Stage %d has no matches defined.", stage->stage); | |
378 | return SR_ERR; | |
379 | } | |
380 | for (m = stage->matches; m; m = m->next) { | |
381 | match = m->data; | |
382 | if (!match->channel) { | |
383 | sr_err("Stage %d match has no channel.", stage->stage); | |
384 | return SR_ERR; | |
385 | } | |
386 | if (!match->match) { | |
387 | sr_err("Stage %d match is not defined.", stage->stage); | |
388 | return SR_ERR; | |
389 | } | |
390 | sr_spew("Stage %d match on channel %s, match %d", stage->stage, | |
391 | match->channel->name, match->match); | |
392 | } | |
393 | } | |
394 | ||
395 | return SR_OK; | |
396 | } | |
9f45fb3a UH |
397 | /** |
398 | * Start a session. | |
399 | * | |
a1645fcd | 400 | * There can only be one session at a time. |
9f45fb3a | 401 | * |
04cb9157 MH |
402 | * @retval SR_OK Success. |
403 | * @retval SR_ERR Error occured. | |
47117241 UH |
404 | * |
405 | * @since 0.1.0 | |
9f45fb3a | 406 | */ |
1a081ca6 | 407 | SR_API int sr_session_start(void) |
7d658874 | 408 | { |
de4d3f99 | 409 | struct sr_dev_inst *sdi; |
7d658874 BV |
410 | GSList *l; |
411 | int ret; | |
412 | ||
9f45fb3a | 413 | if (!session) { |
a421dc1d | 414 | sr_err("%s: session was NULL; a session must be " |
de4d3f99 | 415 | "created before starting it.", __func__); |
0abee507 | 416 | return SR_ERR_BUG; |
9f45fb3a UH |
417 | } |
418 | ||
bb7ef793 | 419 | if (!session->devs) { |
a421dc1d | 420 | sr_err("%s: session->devs was NULL; a session " |
9f45fb3a | 421 | "cannot be started without devices.", __func__); |
0abee507 | 422 | return SR_ERR_BUG; |
9f45fb3a UH |
423 | } |
424 | ||
7b5e6d29 BV |
425 | if (session->trigger && verify_trigger(session->trigger) != SR_OK) |
426 | return SR_ERR; | |
427 | ||
c7142604 | 428 | sr_info("Starting."); |
9f45fb3a | 429 | |
b7c3e849 | 430 | ret = SR_OK; |
bb7ef793 | 431 | for (l = session->devs; l; l = l->next) { |
de4d3f99 | 432 | sdi = l->data; |
32b7cd4f DE |
433 | if ((ret = sr_config_commit(sdi)) != SR_OK) { |
434 | sr_err("Failed to commit device settings before " | |
435 | "starting acquisition (%s)", sr_strerror(ret)); | |
436 | break; | |
437 | } | |
de4d3f99 | 438 | if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { |
a421dc1d | 439 | sr_err("%s: could not start an acquisition " |
568dcacc | 440 | "(%s)", __func__, sr_strerror(ret)); |
7d658874 | 441 | break; |
9f45fb3a | 442 | } |
7d658874 BV |
443 | } |
444 | ||
9f45fb3a UH |
445 | /* TODO: What if there are multiple devices? Which return code? */ |
446 | ||
7d658874 BV |
447 | return ret; |
448 | } | |
449 | ||
9f45fb3a UH |
450 | /** |
451 | * Run the session. | |
452 | * | |
04cb9157 MH |
453 | * @retval SR_OK Success. |
454 | * @retval SR_ERR_BUG Error occured. | |
47117241 UH |
455 | * |
456 | * @since 0.1.0 | |
9f45fb3a | 457 | */ |
1a081ca6 | 458 | SR_API int sr_session_run(void) |
7d658874 | 459 | { |
9f45fb3a | 460 | if (!session) { |
a421dc1d | 461 | sr_err("%s: session was NULL; a session must be " |
9f45fb3a | 462 | "created first, before running it.", __func__); |
e0508e67 | 463 | return SR_ERR_BUG; |
9f45fb3a UH |
464 | } |
465 | ||
bb7ef793 | 466 | if (!session->devs) { |
9f45fb3a | 467 | /* TODO: Actually the case? */ |
a421dc1d | 468 | sr_err("%s: session->devs was NULL; a session " |
9f45fb3a | 469 | "cannot be run without devices.", __func__); |
e0508e67 | 470 | return SR_ERR_BUG; |
9f45fb3a | 471 | } |
5451816f | 472 | session->running = TRUE; |
9f45fb3a | 473 | |
a421dc1d | 474 | sr_info("Running."); |
7d658874 | 475 | |
9f45fb3a | 476 | /* Do we have real sources? */ |
b7e94111 | 477 | if (session->num_sources == 1 && session->pollfds[0].fd == -1) { |
9f45fb3a | 478 | /* Dummy source, freewheel over it. */ |
2cbeb2b7 | 479 | while (session->num_sources) |
b7e94111 | 480 | session->sources[0].cb(-1, 0, session->sources[0].cb_data); |
9f45fb3a UH |
481 | } else { |
482 | /* Real sources, use g_poll() main loop. */ | |
b483be74 BV |
483 | while (session->num_sources) |
484 | sr_session_iteration(TRUE); | |
9f45fb3a UH |
485 | } |
486 | ||
e0508e67 | 487 | return SR_OK; |
7d658874 BV |
488 | } |
489 | ||
9f45fb3a UH |
490 | /** |
491 | * Stop the current session. | |
492 | * | |
a1645fcd | 493 | * The current session is stopped immediately, with all acquisition sessions |
c09f0b57 | 494 | * being stopped and hardware drivers cleaned up. |
9f45fb3a | 495 | * |
33c6e4c5 AG |
496 | * This must be called from within the session thread, to prevent freeing |
497 | * resources that the session thread will try to use. | |
498 | * | |
04cb9157 MH |
499 | * @retval SR_OK Success. |
500 | * @retval SR_ERR_BUG No session exists. | |
72a08bcc BV |
501 | * |
502 | * @private | |
9f45fb3a | 503 | */ |
33c6e4c5 | 504 | SR_PRIV int sr_session_stop_sync(void) |
a1bb33af | 505 | { |
de4d3f99 | 506 | struct sr_dev_inst *sdi; |
a1bb33af UH |
507 | GSList *l; |
508 | ||
9f45fb3a | 509 | if (!session) { |
a421dc1d | 510 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 511 | return SR_ERR_BUG; |
9f45fb3a UH |
512 | } |
513 | ||
a421dc1d | 514 | sr_info("Stopping."); |
e0508e67 | 515 | |
bb7ef793 | 516 | for (l = session->devs; l; l = l->next) { |
de4d3f99 BV |
517 | sdi = l->data; |
518 | if (sdi->driver) { | |
519 | if (sdi->driver->dev_acquisition_stop) | |
520 | sdi->driver->dev_acquisition_stop(sdi, sdi); | |
8c76be53 | 521 | } |
a1bb33af | 522 | } |
5451816f | 523 | session->running = FALSE; |
9f45fb3a | 524 | |
e0508e67 | 525 | return SR_OK; |
a1bb33af UH |
526 | } |
527 | ||
33c6e4c5 AG |
528 | /** |
529 | * Stop the current session. | |
530 | * | |
531 | * The current session is stopped immediately, with all acquisition sessions | |
532 | * being stopped and hardware drivers cleaned up. | |
533 | * | |
534 | * If the session is run in a separate thread, this function will not block | |
535 | * until the session is finished executing. It is the caller's responsibility | |
536 | * to wait for the session thread to return before assuming that the session is | |
537 | * completely decommissioned. | |
538 | * | |
04cb9157 MH |
539 | * @retval SR_OK Success. |
540 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
541 | * |
542 | * @since 0.1.0 | |
33c6e4c5 AG |
543 | */ |
544 | SR_API int sr_session_stop(void) | |
545 | { | |
546 | if (!session) { | |
547 | sr_err("%s: session was NULL", __func__); | |
548 | return SR_ERR_BUG; | |
549 | } | |
550 | ||
551 | g_mutex_lock(&session->stop_mutex); | |
552 | session->abort_session = TRUE; | |
553 | g_mutex_unlock(&session->stop_mutex); | |
554 | ||
555 | return SR_OK; | |
556 | } | |
557 | ||
9f45fb3a | 558 | /** |
a1645fcd | 559 | * Debug helper. |
9f45fb3a | 560 | * |
996b0c72 | 561 | * @param packet The packet to show debugging information for. |
9f45fb3a | 562 | */ |
bf53457d | 563 | static void datafeed_dump(const struct sr_datafeed_packet *packet) |
7d2afd6c | 564 | { |
bf53457d JH |
565 | const struct sr_datafeed_logic *logic; |
566 | const struct sr_datafeed_analog *analog; | |
7d2afd6c BV |
567 | |
568 | switch (packet->type) { | |
569 | case SR_DF_HEADER: | |
a421dc1d | 570 | sr_dbg("bus: Received SR_DF_HEADER packet."); |
7d2afd6c BV |
571 | break; |
572 | case SR_DF_TRIGGER: | |
a421dc1d | 573 | sr_dbg("bus: Received SR_DF_TRIGGER packet."); |
7d2afd6c | 574 | break; |
c71bac3b | 575 | case SR_DF_META: |
a421dc1d | 576 | sr_dbg("bus: Received SR_DF_META packet."); |
ee7489d2 | 577 | break; |
7d2afd6c BV |
578 | case SR_DF_LOGIC: |
579 | logic = packet->payload; | |
7ea45862 UH |
580 | sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, " |
581 | "unitsize = %d).", logic->length, logic->unitsize); | |
7d2afd6c | 582 | break; |
ee7489d2 BV |
583 | case SR_DF_ANALOG: |
584 | analog = packet->payload; | |
a421dc1d UH |
585 | sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", |
586 | analog->num_samples); | |
ee7489d2 | 587 | break; |
7d2afd6c | 588 | case SR_DF_END: |
a421dc1d | 589 | sr_dbg("bus: Received SR_DF_END packet."); |
7d2afd6c | 590 | break; |
6ea7669c | 591 | case SR_DF_FRAME_BEGIN: |
a421dc1d | 592 | sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); |
6ea7669c BV |
593 | break; |
594 | case SR_DF_FRAME_END: | |
a421dc1d | 595 | sr_dbg("bus: Received SR_DF_FRAME_END packet."); |
6ea7669c | 596 | break; |
7d2afd6c | 597 | default: |
a421dc1d | 598 | sr_dbg("bus: Received unknown packet type: %d.", packet->type); |
9f45fb3a | 599 | break; |
7d2afd6c | 600 | } |
7d2afd6c BV |
601 | } |
602 | ||
9f45fb3a | 603 | /** |
a1645fcd BV |
604 | * Send a packet to whatever is listening on the datafeed bus. |
605 | * | |
606 | * Hardware drivers use this to send a data packet to the frontend. | |
9f45fb3a | 607 | * |
6b2d8d3e | 608 | * @param sdi TODO. |
31ccebc4 | 609 | * @param packet The datafeed packet to send to the session bus. |
44dae539 | 610 | * |
04cb9157 MH |
611 | * @retval SR_OK Success. |
612 | * @retval SR_ERR_ARG Invalid argument. | |
b4bd7088 UH |
613 | * |
614 | * @private | |
9f45fb3a | 615 | */ |
de4d3f99 | 616 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, |
bf53457d | 617 | const struct sr_datafeed_packet *packet) |
a1bb33af UH |
618 | { |
619 | GSList *l; | |
2726474a | 620 | struct datafeed_callback *cb_struct; |
a1bb33af | 621 | |
de4d3f99 | 622 | if (!sdi) { |
a421dc1d | 623 | sr_err("%s: sdi was NULL", __func__); |
e0508e67 | 624 | return SR_ERR_ARG; |
9f45fb3a UH |
625 | } |
626 | ||
e0508e67 | 627 | if (!packet) { |
a421dc1d | 628 | sr_err("%s: packet was NULL", __func__); |
e0508e67 | 629 | return SR_ERR_ARG; |
9f45fb3a UH |
630 | } |
631 | ||
62c82025 | 632 | for (l = session->datafeed_callbacks; l; l = l->next) { |
18beaeff BV |
633 | if (sr_log_loglevel_get() >= SR_LOG_DBG) |
634 | datafeed_dump(packet); | |
2726474a ML |
635 | cb_struct = l->data; |
636 | cb_struct->cb(sdi, packet, cb_struct->cb_data); | |
a1bb33af | 637 | } |
9f45fb3a | 638 | |
e0508e67 | 639 | return SR_OK; |
a1bb33af UH |
640 | } |
641 | ||
6b2d8d3e UH |
642 | /** |
643 | * Add an event source for a file descriptor. | |
644 | * | |
645 | * @param pollfd The GPollFD. | |
04cb9157 MH |
646 | * @param[in] timeout Max time to wait before the callback is called, |
647 | * ignored if 0. | |
6b2d8d3e UH |
648 | * @param cb Callback function to add. Must not be NULL. |
649 | * @param cb_data Data for the callback function. Can be NULL. | |
650 | * @param poll_object TODO. | |
651 | * | |
04cb9157 MH |
652 | * @retval SR_OK Success. |
653 | * @retval SR_ERR_ARG Invalid argument. | |
654 | * @retval SR_ERR_MALLOC Memory allocation error. | |
6b2d8d3e | 655 | */ |
aac0ea25 | 656 | static int _sr_session_source_add(GPollFD *pollfd, int timeout, |
144f6660 | 657 | sr_receive_data_callback cb, void *cb_data, gintptr poll_object) |
544a4582 BV |
658 | { |
659 | struct source *new_sources, *s; | |
aac0ea25 | 660 | GPollFD *new_pollfds; |
544a4582 | 661 | |
d08490aa | 662 | if (!cb) { |
a421dc1d | 663 | sr_err("%s: cb was NULL", __func__); |
e0508e67 | 664 | return SR_ERR_ARG; |
9f45fb3a UH |
665 | } |
666 | ||
1f9813eb | 667 | /* Note: cb_data can be NULL, that's not a bug. */ |
9f45fb3a | 668 | |
2ac2e629 BV |
669 | new_pollfds = g_try_realloc(session->pollfds, |
670 | sizeof(GPollFD) * (session->num_sources + 1)); | |
0687dfcd | 671 | if (!new_pollfds) { |
a421dc1d | 672 | sr_err("%s: new_pollfds malloc failed", __func__); |
0687dfcd LPC |
673 | return SR_ERR_MALLOC; |
674 | } | |
675 | ||
b7e94111 | 676 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * |
2ac2e629 | 677 | (session->num_sources + 1)); |
9f45fb3a | 678 | if (!new_sources) { |
a421dc1d | 679 | sr_err("%s: new_sources malloc failed", __func__); |
e0508e67 | 680 | return SR_ERR_MALLOC; |
9f45fb3a | 681 | } |
544a4582 | 682 | |
b7e94111 LPC |
683 | new_pollfds[session->num_sources] = *pollfd; |
684 | s = &new_sources[session->num_sources++]; | |
544a4582 | 685 | s->timeout = timeout; |
d08490aa | 686 | s->cb = cb; |
1f9813eb | 687 | s->cb_data = cb_data; |
aac0ea25 | 688 | s->poll_object = poll_object; |
b7e94111 LPC |
689 | session->pollfds = new_pollfds; |
690 | session->sources = new_sources; | |
544a4582 | 691 | |
b7e94111 LPC |
692 | if (timeout != session->source_timeout && timeout > 0 |
693 | && (session->source_timeout == -1 || timeout < session->source_timeout)) | |
694 | session->source_timeout = timeout; | |
9f45fb3a | 695 | |
e0508e67 | 696 | return SR_OK; |
544a4582 BV |
697 | } |
698 | ||
9f45fb3a | 699 | /** |
6b2d8d3e | 700 | * Add an event source for a file descriptor. |
9f45fb3a | 701 | * |
aac0ea25 LPC |
702 | * @param fd The file descriptor. |
703 | * @param events Events to check for. | |
704 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
705 | * @param cb Callback function to add. Must not be NULL. | |
706 | * @param cb_data Data for the callback function. Can be NULL. | |
9f45fb3a | 707 | * |
04cb9157 MH |
708 | * @retval SR_OK Success. |
709 | * @retval SR_ERR_ARG Invalid argument. | |
710 | * @retval SR_ERR_MALLOC Memory allocation error. | |
47117241 UH |
711 | * |
712 | * @since 0.3.0 | |
aac0ea25 LPC |
713 | */ |
714 | SR_API int sr_session_source_add(int fd, int events, int timeout, | |
144f6660 | 715 | sr_receive_data_callback cb, void *cb_data) |
aac0ea25 LPC |
716 | { |
717 | GPollFD p; | |
718 | ||
aac0ea25 LPC |
719 | p.fd = fd; |
720 | p.events = events; | |
aac0ea25 LPC |
721 | |
722 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd); | |
723 | } | |
724 | ||
725 | /** | |
1a895c61 | 726 | * Add an event source for a GPollFD. |
aac0ea25 | 727 | * |
aac0ea25 LPC |
728 | * @param pollfd The GPollFD. |
729 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
730 | * @param cb Callback function to add. Must not be NULL. | |
731 | * @param cb_data Data for the callback function. Can be NULL. | |
44dae539 | 732 | * |
04cb9157 MH |
733 | * @retval SR_OK Success. |
734 | * @retval SR_ERR_ARG Invalid argument. | |
735 | * @retval SR_ERR_MALLOC Memory allocation error. | |
47117241 UH |
736 | * |
737 | * @since 0.3.0 | |
9f45fb3a | 738 | */ |
aac0ea25 | 739 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, |
144f6660 | 740 | sr_receive_data_callback cb, void *cb_data) |
aac0ea25 | 741 | { |
1a895c61 UH |
742 | return _sr_session_source_add(pollfd, timeout, cb, |
743 | cb_data, (gintptr)pollfd); | |
aac0ea25 LPC |
744 | } |
745 | ||
746 | /** | |
1a895c61 | 747 | * Add an event source for a GIOChannel. |
aac0ea25 | 748 | * |
aac0ea25 LPC |
749 | * @param channel The GIOChannel. |
750 | * @param events Events to poll on. | |
751 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
752 | * @param cb Callback function to add. Must not be NULL. | |
753 | * @param cb_data Data for the callback function. Can be NULL. | |
754 | * | |
04cb9157 MH |
755 | * @retval SR_OK Success. |
756 | * @retval SR_ERR_ARG Invalid argument. | |
757 | * @retval SR_ERR_MALLOC Memory allocation error. | |
47117241 UH |
758 | * |
759 | * @since 0.3.0 | |
aac0ea25 | 760 | */ |
1a895c61 | 761 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, |
144f6660 | 762 | int timeout, sr_receive_data_callback cb, void *cb_data) |
aac0ea25 LPC |
763 | { |
764 | GPollFD p; | |
765 | ||
766 | #ifdef _WIN32 | |
6b2d8d3e | 767 | g_io_channel_win32_make_pollfd(channel, events, &p); |
aac0ea25 LPC |
768 | #else |
769 | p.fd = g_io_channel_unix_get_fd(channel); | |
770 | p.events = events; | |
771 | #endif | |
772 | ||
773 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); | |
774 | } | |
775 | ||
6b2d8d3e UH |
776 | /** |
777 | * Remove the source belonging to the specified channel. | |
778 | * | |
779 | * @todo Add more error checks and logging. | |
780 | * | |
04cb9157 | 781 | * @param poll_object The channel for which the source should be removed. |
6b2d8d3e | 782 | * |
04cb9157 MH |
783 | * @retval SR_OK Success |
784 | * @retval SR_ERR_ARG Invalid arguments | |
785 | * @retval SR_ERR_MALLOC Memory allocation error | |
786 | * @retval SR_ERR_BUG Internal error | |
6b2d8d3e | 787 | */ |
aac0ea25 | 788 | static int _sr_session_source_remove(gintptr poll_object) |
544a4582 BV |
789 | { |
790 | struct source *new_sources; | |
0687dfcd | 791 | GPollFD *new_pollfds; |
b7e94111 | 792 | unsigned int old; |
544a4582 | 793 | |
b7e94111 | 794 | if (!session->sources || !session->num_sources) { |
a421dc1d | 795 | sr_err("%s: sources was NULL", __func__); |
0abee507 | 796 | return SR_ERR_BUG; |
e0508e67 UH |
797 | } |
798 | ||
b7e94111 LPC |
799 | for (old = 0; old < session->num_sources; old++) { |
800 | if (session->sources[old].poll_object == poll_object) | |
2bccd322 | 801 | break; |
9f45fb3a UH |
802 | } |
803 | ||
2bccd322 | 804 | /* fd not found, nothing to do */ |
b7e94111 | 805 | if (old == session->num_sources) |
2bccd322 LPC |
806 | return SR_OK; |
807 | ||
b7e94111 | 808 | session->num_sources -= 1; |
2bccd322 | 809 | |
b7e94111 LPC |
810 | if (old != session->num_sources) { |
811 | memmove(&session->pollfds[old], &session->pollfds[old+1], | |
812 | (session->num_sources - old) * sizeof(GPollFD)); | |
813 | memmove(&session->sources[old], &session->sources[old+1], | |
814 | (session->num_sources - old) * sizeof(struct source)); | |
9f45fb3a | 815 | } |
544a4582 | 816 | |
b7e94111 LPC |
817 | new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); |
818 | if (!new_pollfds && session->num_sources > 0) { | |
a421dc1d | 819 | sr_err("%s: new_pollfds malloc failed", __func__); |
0687dfcd LPC |
820 | return SR_ERR_MALLOC; |
821 | } | |
822 | ||
b7e94111 LPC |
823 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources); |
824 | if (!new_sources && session->num_sources > 0) { | |
a421dc1d | 825 | sr_err("%s: new_sources malloc failed", __func__); |
2bccd322 | 826 | return SR_ERR_MALLOC; |
544a4582 | 827 | } |
e0508e67 | 828 | |
b7e94111 LPC |
829 | session->pollfds = new_pollfds; |
830 | session->sources = new_sources; | |
2bccd322 | 831 | |
e0508e67 | 832 | return SR_OK; |
544a4582 | 833 | } |
aac0ea25 | 834 | |
6b2d8d3e | 835 | /** |
aac0ea25 LPC |
836 | * Remove the source belonging to the specified file descriptor. |
837 | * | |
1a895c61 | 838 | * @param fd The file descriptor for which the source should be removed. |
aac0ea25 | 839 | * |
04cb9157 MH |
840 | * @retval SR_OK Success |
841 | * @retval SR_ERR_ARG Invalid argument | |
842 | * @retval SR_ERR_MALLOC Memory allocation error. | |
843 | * @retval SR_ERR_BUG Internal error. | |
47117241 UH |
844 | * |
845 | * @since 0.3.0 | |
aac0ea25 LPC |
846 | */ |
847 | SR_API int sr_session_source_remove(int fd) | |
848 | { | |
849 | return _sr_session_source_remove((gintptr)fd); | |
850 | } | |
851 | ||
852 | /** | |
853 | * Remove the source belonging to the specified poll descriptor. | |
854 | * | |
aac0ea25 LPC |
855 | * @param pollfd The poll descriptor for which the source should be removed. |
856 | * | |
857 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
858 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
859 | * internal errors. | |
47117241 UH |
860 | * |
861 | * @since 0.2.0 | |
aac0ea25 LPC |
862 | */ |
863 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd) | |
864 | { | |
865 | return _sr_session_source_remove((gintptr)pollfd); | |
866 | } | |
867 | ||
6b2d8d3e | 868 | /** |
aac0ea25 LPC |
869 | * Remove the source belonging to the specified channel. |
870 | * | |
1a895c61 | 871 | * @param channel The channel for which the source should be removed. |
aac0ea25 | 872 | * |
04cb9157 MH |
873 | * @retval SR_OK Success. |
874 | * @retval SR_ERR_ARG Invalid argument. | |
875 | * @retval SR_ERR_MALLOC Memory allocation error. | |
876 | * @return SR_ERR_BUG Internal error. | |
47117241 UH |
877 | * |
878 | * @since 0.2.0 | |
aac0ea25 LPC |
879 | */ |
880 | SR_API int sr_session_source_remove_channel(GIOChannel *channel) | |
881 | { | |
882 | return _sr_session_source_remove((gintptr)channel); | |
883 | } | |
7b870c38 UH |
884 | |
885 | /** @} */ |