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