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