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