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