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