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