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