]>
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 | ||
32af282c | 20 | #include <errno.h> |
a1bb33af UH |
21 | #include <stdio.h> |
22 | #include <stdlib.h> | |
23 | #include <unistd.h> | |
24 | #include <string.h> | |
544a4582 | 25 | #include <glib.h> |
c1aae900 | 26 | #include <libsigrok/libsigrok.h> |
45c59c8b | 27 | #include "libsigrok-internal.h" |
aa4b1107 | 28 | |
2ad1deb8 | 29 | /** @cond PRIVATE */ |
3544f848 | 30 | #define LOG_PREFIX "session" |
2ad1deb8 | 31 | /** @endcond */ |
a421dc1d | 32 | |
393fb9cb UH |
33 | /** |
34 | * @file | |
35 | * | |
36 | * Creating, using, or destroying libsigrok sessions. | |
37 | */ | |
38 | ||
7b870c38 UH |
39 | /** |
40 | * @defgroup grp_session Session handling | |
41 | * | |
42 | * Creating, using, or destroying libsigrok sessions. | |
43 | * | |
44 | * @{ | |
45 | */ | |
46 | ||
544a4582 | 47 | struct source { |
faa5d7d9 DE |
48 | int64_t timeout; /* microseconds */ |
49 | int64_t due; /* microseconds */ | |
92248e78 | 50 | |
144f6660 | 51 | sr_receive_data_callback cb; |
1f9813eb | 52 | void *cb_data; |
aac0ea25 LPC |
53 | |
54 | /* This is used to keep track of the object (fd, pollfd or channel) which is | |
55 | * being polled and will be used to match the source when removing it again. | |
56 | */ | |
57 | gintptr poll_object; | |
62d7945f | 58 | |
92248e78 DE |
59 | /* Number of fds to poll for this source. This will be 0 for timer |
60 | * sources, 1 for normal I/O sources, and 1 or more for libusb I/O | |
61 | * sources on Unix platforms. | |
62 | */ | |
63 | int num_fds; | |
64 | ||
faa5d7d9 | 65 | gboolean triggered; |
544a4582 BV |
66 | }; |
67 | ||
2726474a | 68 | struct datafeed_callback { |
144f6660 | 69 | sr_datafeed_callback cb; |
2726474a ML |
70 | void *cb_data; |
71 | }; | |
72 | ||
9f45fb3a UH |
73 | /** |
74 | * Create a new session. | |
7efe889e | 75 | * |
61e6e2da | 76 | * @param ctx The context in which to create the new session. |
7efe889e UH |
77 | * @param new_session This will contain a pointer to the newly created |
78 | * session if the return value is SR_OK, otherwise the value | |
79 | * is undefined and should not be used. Must not be NULL. | |
9f45fb3a | 80 | * |
0812c40e | 81 | * @retval SR_OK Success. |
41de54ff | 82 | * @retval SR_ERR_ARG Invalid argument. |
47117241 | 83 | * |
0812c40e | 84 | * @since 0.4.0 |
9f45fb3a | 85 | */ |
61e6e2da ML |
86 | SR_API int sr_session_new(struct sr_context *ctx, |
87 | struct sr_session **new_session) | |
a1bb33af | 88 | { |
3337e9a1 | 89 | struct sr_session *session; |
a1bb33af | 90 | |
41de54ff UH |
91 | if (!new_session) |
92 | return SR_ERR_ARG; | |
93 | ||
3337e9a1 | 94 | session = g_malloc0(sizeof(struct sr_session)); |
b7e94111 | 95 | |
4ed5d21d | 96 | session->ctx = ctx; |
faa5d7d9 DE |
97 | |
98 | session->sources = g_array_new(FALSE, FALSE, sizeof(struct source)); | |
99 | session->pollfds = g_array_new(FALSE, FALSE, sizeof(GPollFD)); | |
100 | ||
3337e9a1 | 101 | g_mutex_init(&session->stop_mutex); |
0812c40e | 102 | |
3337e9a1 | 103 | *new_session = session; |
0812c40e ML |
104 | |
105 | return SR_OK; | |
a1bb33af UH |
106 | } |
107 | ||
9f45fb3a | 108 | /** |
0812c40e | 109 | * Destroy a session. |
9f45fb3a UH |
110 | * This frees up all memory used by the session. |
111 | * | |
7efe889e UH |
112 | * @param session The session to destroy. Must not be NULL. |
113 | * | |
04cb9157 | 114 | * @retval SR_OK Success. |
0812c40e | 115 | * @retval SR_ERR_ARG Invalid session passed. |
47117241 | 116 | * |
0812c40e | 117 | * @since 0.4.0 |
9f45fb3a | 118 | */ |
0812c40e | 119 | SR_API int sr_session_destroy(struct sr_session *session) |
a1bb33af | 120 | { |
9f45fb3a | 121 | if (!session) { |
a421dc1d | 122 | sr_err("%s: session was NULL", __func__); |
0812c40e | 123 | return SR_ERR_ARG; |
9f45fb3a UH |
124 | } |
125 | ||
0812c40e | 126 | sr_session_dev_remove_all(session); |
33c6e4c5 | 127 | g_mutex_clear(&session->stop_mutex); |
3d68b612 BV |
128 | if (session->trigger) |
129 | sr_trigger_free(session->trigger); | |
33c6e4c5 | 130 | |
1de3cced ML |
131 | g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free); |
132 | ||
faa5d7d9 DE |
133 | g_array_unref(session->pollfds); |
134 | g_array_unref(session->sources); | |
135 | ||
a1bb33af | 136 | g_free(session); |
0812c40e | 137 | |
e0508e67 | 138 | return SR_OK; |
a1bb33af UH |
139 | } |
140 | ||
9f45fb3a | 141 | /** |
0812c40e | 142 | * Remove all the devices from a session. |
9f45fb3a UH |
143 | * |
144 | * The session itself (i.e., the struct sr_session) is not free'd and still | |
145 | * exists after this function returns. | |
146 | * | |
7efe889e UH |
147 | * @param session The session to use. Must not be NULL. |
148 | * | |
04cb9157 | 149 | * @retval SR_OK Success. |
0812c40e | 150 | * @retval SR_ERR_BUG Invalid session passed. |
47117241 | 151 | * |
0812c40e | 152 | * @since 0.4.0 |
9f45fb3a | 153 | */ |
0812c40e | 154 | SR_API int sr_session_dev_remove_all(struct sr_session *session) |
a1bb33af | 155 | { |
0812c40e ML |
156 | struct sr_dev_inst *sdi; |
157 | GSList *l; | |
158 | ||
9f45fb3a | 159 | if (!session) { |
a421dc1d | 160 | sr_err("%s: session was NULL", __func__); |
0812c40e ML |
161 | return SR_ERR_ARG; |
162 | } | |
163 | ||
164 | for (l = session->devs; l; l = l->next) { | |
165 | sdi = (struct sr_dev_inst *) l->data; | |
166 | sdi->session = NULL; | |
9f45fb3a UH |
167 | } |
168 | ||
681803df | 169 | g_slist_free(session->devs); |
bb7ef793 | 170 | session->devs = NULL; |
e0508e67 UH |
171 | |
172 | return SR_OK; | |
a1bb33af UH |
173 | } |
174 | ||
9f45fb3a | 175 | /** |
0812c40e | 176 | * Add a device instance to a session. |
9f45fb3a | 177 | * |
7efe889e | 178 | * @param session The session to add to. Must not be NULL. |
0812c40e | 179 | * @param sdi The device instance to add to a session. Must not |
de4d3f99 BV |
180 | * be NULL. Also, sdi->driver and sdi->driver->dev_open must |
181 | * not be NULL. | |
9f45fb3a | 182 | * |
04cb9157 MH |
183 | * @retval SR_OK Success. |
184 | * @retval SR_ERR_ARG Invalid argument. | |
47117241 | 185 | * |
0812c40e | 186 | * @since 0.4.0 |
9f45fb3a | 187 | */ |
0812c40e ML |
188 | SR_API int sr_session_dev_add(struct sr_session *session, |
189 | struct sr_dev_inst *sdi) | |
a1bb33af | 190 | { |
5451816f | 191 | int ret; |
a1bb33af | 192 | |
de4d3f99 | 193 | if (!sdi) { |
a421dc1d | 194 | sr_err("%s: sdi was NULL", __func__); |
9f45fb3a UH |
195 | return SR_ERR_ARG; |
196 | } | |
197 | ||
d6eb0c33 | 198 | if (!session) { |
a421dc1d | 199 | sr_err("%s: session was NULL", __func__); |
0812c40e ML |
200 | return SR_ERR_ARG; |
201 | } | |
202 | ||
203 | /* If sdi->session is not NULL, the device is already in this or | |
204 | * another session. */ | |
205 | if (sdi->session) { | |
206 | sr_err("%s: already assigned to session", __func__); | |
207 | return SR_ERR_ARG; | |
d6eb0c33 UH |
208 | } |
209 | ||
de4d3f99 BV |
210 | /* If sdi->driver is NULL, this is a virtual device. */ |
211 | if (!sdi->driver) { | |
d6eb0c33 | 212 | /* Just add the device, don't run dev_open(). */ |
de4d3f99 | 213 | session->devs = g_slist_append(session->devs, (gpointer)sdi); |
0812c40e | 214 | sdi->session = session; |
d6eb0c33 | 215 | return SR_OK; |
9f45fb3a UH |
216 | } |
217 | ||
de4d3f99 BV |
218 | /* sdi->driver is non-NULL (i.e. we have a real device). */ |
219 | if (!sdi->driver->dev_open) { | |
a421dc1d | 220 | sr_err("%s: sdi->driver->dev_open was NULL", __func__); |
8ec95d22 | 221 | return SR_ERR_BUG; |
9f45fb3a UH |
222 | } |
223 | ||
de4d3f99 | 224 | session->devs = g_slist_append(session->devs, (gpointer)sdi); |
0812c40e | 225 | sdi->session = session; |
aa4b1107 | 226 | |
5451816f | 227 | if (session->running) { |
32b7cd4f DE |
228 | /* Adding a device to a running session. Commit settings |
229 | * and start acquisition on that device now. */ | |
230 | if ((ret = sr_config_commit(sdi)) != SR_OK) { | |
231 | sr_err("Failed to commit device settings before " | |
232 | "starting acquisition in running session (%s)", | |
233 | sr_strerror(ret)); | |
234 | return ret; | |
235 | } | |
5451816f | 236 | if ((ret = sdi->driver->dev_acquisition_start(sdi, |
32b7cd4f | 237 | (void *)sdi)) != SR_OK) { |
5451816f | 238 | sr_err("Failed to start acquisition of device in " |
32b7cd4f DE |
239 | "running session (%s)", sr_strerror(ret)); |
240 | return ret; | |
241 | } | |
5451816f BV |
242 | } |
243 | ||
e46b8fb1 | 244 | return SR_OK; |
a1bb33af UH |
245 | } |
246 | ||
2bb311b4 | 247 | /** |
0812c40e | 248 | * List all device instances attached to a session. |
2bb311b4 | 249 | * |
7efe889e | 250 | * @param session The session to use. Must not be NULL. |
2bb311b4 BV |
251 | * @param devlist A pointer where the device instance list will be |
252 | * stored on return. If no devices are in the session, | |
253 | * this will be NULL. Each element in the list points | |
254 | * to a struct sr_dev_inst *. | |
255 | * The list must be freed by the caller, but not the | |
256 | * elements pointed to. | |
257 | * | |
04cb9157 | 258 | * @retval SR_OK Success. |
0812c40e | 259 | * @retval SR_ERR_ARG Invalid argument. |
47117241 | 260 | * |
0812c40e | 261 | * @since 0.4.0 |
2bb311b4 | 262 | */ |
0812c40e | 263 | SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist) |
2bb311b4 | 264 | { |
2bb311b4 | 265 | if (!session) |
0812c40e ML |
266 | return SR_ERR_ARG; |
267 | ||
268 | if (!devlist) | |
269 | return SR_ERR_ARG; | |
2bb311b4 BV |
270 | |
271 | *devlist = g_slist_copy(session->devs); | |
272 | ||
273 | return SR_OK; | |
274 | } | |
275 | ||
9f45fb3a | 276 | /** |
0812c40e | 277 | * Remove all datafeed callbacks in a session. |
9f45fb3a | 278 | * |
7efe889e UH |
279 | * @param session The session to use. Must not be NULL. |
280 | * | |
04cb9157 | 281 | * @retval SR_OK Success. |
0812c40e | 282 | * @retval SR_ERR_ARG Invalid session passed. |
47117241 | 283 | * |
0812c40e | 284 | * @since 0.4.0 |
9f45fb3a | 285 | */ |
0812c40e | 286 | SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session) |
a1bb33af | 287 | { |
9f45fb3a | 288 | if (!session) { |
a421dc1d | 289 | sr_err("%s: session was NULL", __func__); |
0812c40e | 290 | return SR_ERR_ARG; |
9f45fb3a UH |
291 | } |
292 | ||
2726474a | 293 | g_slist_free_full(session->datafeed_callbacks, g_free); |
a1bb33af | 294 | session->datafeed_callbacks = NULL; |
e0508e67 UH |
295 | |
296 | return SR_OK; | |
a1bb33af UH |
297 | } |
298 | ||
9f45fb3a | 299 | /** |
0812c40e | 300 | * Add a datafeed callback to a session. |
9f45fb3a | 301 | * |
7efe889e | 302 | * @param session The session to use. Must not be NULL. |
d08490aa | 303 | * @param cb Function to call when a chunk of data is received. |
0abee507 | 304 | * Must not be NULL. |
85222791 | 305 | * @param cb_data Opaque pointer passed in by the caller. |
a1645fcd | 306 | * |
04cb9157 MH |
307 | * @retval SR_OK Success. |
308 | * @retval SR_ERR_BUG No session exists. | |
47117241 UH |
309 | * |
310 | * @since 0.3.0 | |
9f45fb3a | 311 | */ |
0812c40e ML |
312 | SR_API int sr_session_datafeed_callback_add(struct sr_session *session, |
313 | sr_datafeed_callback cb, void *cb_data) | |
a1bb33af | 314 | { |
2726474a ML |
315 | struct datafeed_callback *cb_struct; |
316 | ||
9f45fb3a | 317 | if (!session) { |
a421dc1d | 318 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 319 | return SR_ERR_BUG; |
9f45fb3a UH |
320 | } |
321 | ||
0abee507 | 322 | if (!cb) { |
a421dc1d | 323 | sr_err("%s: cb was NULL", __func__); |
0abee507 UH |
324 | return SR_ERR_ARG; |
325 | } | |
9f45fb3a | 326 | |
91219afc | 327 | cb_struct = g_malloc0(sizeof(struct datafeed_callback)); |
2726474a ML |
328 | cb_struct->cb = cb; |
329 | cb_struct->cb_data = cb_data; | |
330 | ||
62c82025 | 331 | session->datafeed_callbacks = |
2726474a | 332 | g_slist_append(session->datafeed_callbacks, cb_struct); |
e0508e67 UH |
333 | |
334 | return SR_OK; | |
a1bb33af UH |
335 | } |
336 | ||
9f42e2e6 UH |
337 | /** |
338 | * Get the trigger assigned to this session. | |
339 | * | |
340 | * @param session The session to use. | |
341 | * | |
342 | * @retval NULL Invalid (NULL) session was passed to the function. | |
343 | * @retval other The trigger assigned to this session (can be NULL). | |
344 | * | |
345 | * @since 0.4.0 | |
346 | */ | |
0812c40e | 347 | SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session) |
7b5e6d29 | 348 | { |
9f42e2e6 UH |
349 | if (!session) |
350 | return NULL; | |
351 | ||
7b5e6d29 BV |
352 | return session->trigger; |
353 | } | |
354 | ||
9f42e2e6 UH |
355 | /** |
356 | * Set the trigger of this session. | |
357 | * | |
358 | * @param session The session to use. Must not be NULL. | |
359 | * @param trig The trigger to assign to this session. Can be NULL. | |
360 | * | |
361 | * @retval SR_OK Success. | |
362 | * @retval SR_ERR_ARG Invalid argument. | |
363 | * | |
364 | * @since 0.4.0 | |
365 | */ | |
0812c40e | 366 | SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig) |
7b5e6d29 | 367 | { |
9f42e2e6 UH |
368 | if (!session) |
369 | return SR_ERR_ARG; | |
370 | ||
7b5e6d29 BV |
371 | session->trigger = trig; |
372 | ||
373 | return SR_OK; | |
374 | } | |
375 | ||
32af282c DE |
376 | static gboolean sr_session_check_aborted(struct sr_session *session) |
377 | { | |
378 | gboolean stop; | |
379 | ||
380 | g_mutex_lock(&session->stop_mutex); | |
381 | stop = session->abort_session; | |
382 | if (stop) { | |
383 | sr_session_stop_sync(session); | |
384 | /* But once is enough. */ | |
385 | session->abort_session = FALSE; | |
386 | } | |
387 | g_mutex_unlock(&session->stop_mutex); | |
388 | ||
389 | return stop; | |
390 | } | |
391 | ||
b483be74 | 392 | /** |
faa5d7d9 | 393 | * Poll the session's event sources. |
b483be74 | 394 | * |
7efe889e | 395 | * @param session The session to use. Must not be NULL. |
04cb9157 | 396 | * @retval SR_OK Success. |
f3f19d11 | 397 | * @retval SR_ERR Error occurred. |
b483be74 | 398 | */ |
62d7945f | 399 | static int sr_session_iteration(struct sr_session *session) |
544a4582 | 400 | { |
faa5d7d9 DE |
401 | int64_t start_time, stop_time, min_due, due; |
402 | int timeout_ms; | |
b7e94111 | 403 | unsigned int i; |
92248e78 | 404 | int k, fd_index; |
faa5d7d9 DE |
405 | int ret; |
406 | int fd; | |
4399cc0f | 407 | int revents; |
faa5d7d9 | 408 | gboolean triggered, stopped; |
4399cc0f DE |
409 | struct source *source; |
410 | GPollFD *pollfd; | |
62d7945f | 411 | gintptr poll_object; |
92248e78 | 412 | #if HAVE_LIBUSB_1_0 && !defined(G_OS_WIN32) |
7637fa35 | 413 | int64_t usb_timeout; |
62d7945f | 414 | int64_t usb_due; |
bb5f6110 ML |
415 | struct timeval tv; |
416 | #endif | |
faa5d7d9 | 417 | if (session->sources->len == 0) { |
62d7945f DE |
418 | sr_session_check_aborted(session); |
419 | return SR_OK; | |
420 | } | |
421 | start_time = g_get_monotonic_time(); | |
422 | min_due = INT64_MAX; | |
bb5f6110 | 423 | |
faa5d7d9 DE |
424 | for (i = 0; i < session->sources->len; ++i) { |
425 | source = &g_array_index(session->sources, struct source, i); | |
426 | if (source->due < min_due) | |
427 | min_due = source->due; | |
428 | source->triggered = FALSE; | |
62d7945f | 429 | } |
92248e78 | 430 | #if HAVE_LIBUSB_1_0 && !defined(G_OS_WIN32) |
62d7945f | 431 | usb_due = INT64_MAX; |
1190c653 | 432 | if (session->ctx->usb_source_present) { |
1190c653 UH |
433 | ret = libusb_get_next_timeout(session->ctx->libusb_ctx, &tv); |
434 | if (ret < 0) { | |
435 | sr_err("Error getting libusb timeout: %s", | |
436 | libusb_error_name(ret)); | |
437 | return SR_ERR; | |
438 | } else if (ret == 1) { | |
7637fa35 DE |
439 | usb_timeout = (int64_t)tv.tv_sec * G_USEC_PER_SEC |
440 | + tv.tv_usec; | |
441 | usb_due = start_time + usb_timeout; | |
62d7945f DE |
442 | if (usb_due < min_due) |
443 | min_due = usb_due; | |
7637fa35 DE |
444 | |
445 | sr_spew("poll: next USB timeout %g ms", | |
446 | 1e-3 * usb_timeout); | |
1190c653 | 447 | } |
bb5f6110 ML |
448 | } |
449 | #endif | |
faa5d7d9 DE |
450 | if (min_due == INT64_MAX) |
451 | timeout_ms = -1; | |
452 | else if (min_due > start_time) | |
453 | timeout_ms = MIN((min_due - start_time + 999) / 1000, INT_MAX); | |
62d7945f | 454 | else |
faa5d7d9 | 455 | timeout_ms = 0; |
544a4582 | 456 | |
7637fa35 DE |
457 | sr_spew("poll enter: %u sources, %u fds, %d ms timeout", |
458 | session->sources->len, session->pollfds->len, timeout_ms); | |
459 | ||
faa5d7d9 DE |
460 | ret = g_poll((GPollFD *)session->pollfds->data, |
461 | session->pollfds->len, timeout_ms); | |
4399cc0f | 462 | #ifdef G_OS_UNIX |
32af282c DE |
463 | if (ret < 0 && errno != EINTR) { |
464 | sr_err("Error in poll: %s", g_strerror(errno)); | |
465 | return SR_ERR; | |
466 | } | |
4399cc0f DE |
467 | #else |
468 | if (ret < 0) { | |
469 | sr_err("Error in poll: %d", ret); | |
470 | return SR_ERR; | |
471 | } | |
472 | #endif | |
62d7945f | 473 | stop_time = g_get_monotonic_time(); |
b5887bd0 | 474 | |
7637fa35 DE |
475 | sr_spew("poll leave: %g ms elapsed, %d events", |
476 | 1e-3 * (stop_time - start_time), ret); | |
b5887bd0 | 477 | |
faa5d7d9 | 478 | triggered = FALSE; |
32af282c | 479 | stopped = FALSE; |
92248e78 | 480 | fd_index = 0; |
32af282c | 481 | |
faa5d7d9 DE |
482 | for (i = 0; i < session->sources->len; ++i) { |
483 | source = &g_array_index(session->sources, struct source, i); | |
faa5d7d9 DE |
484 | |
485 | poll_object = source->poll_object; | |
486 | fd = (int)poll_object; | |
487 | revents = 0; | |
488 | ||
92248e78 DE |
489 | for (k = 0; k < source->num_fds; ++k) { |
490 | pollfd = &g_array_index(session->pollfds, | |
491 | GPollFD, fd_index + k); | |
faa5d7d9 | 492 | fd = pollfd->fd; |
92248e78 | 493 | revents |= pollfd->revents; |
faa5d7d9 | 494 | } |
92248e78 DE |
495 | fd_index += source->num_fds; |
496 | ||
497 | if (source->triggered) | |
498 | continue; /* already handled */ | |
faa5d7d9 DE |
499 | if (ret > 0 && revents == 0) |
500 | continue; /* skip timeouts if any I/O event occurred */ | |
501 | ||
92248e78 DE |
502 | /* Make invalid to avoid confusion in case of multiple FDs. */ |
503 | if (source->num_fds > 1) | |
504 | fd = -1; | |
505 | if (ret <= 0) | |
506 | revents = 0; | |
507 | ||
62d7945f | 508 | due = source->due; |
92248e78 DE |
509 | #if HAVE_LIBUSB_1_0 && !defined(G_OS_WIN32) |
510 | if (usb_due < due && source->poll_object | |
511 | == (gintptr)session->ctx->libusb_ctx) | |
62d7945f DE |
512 | due = usb_due; |
513 | #endif | |
514 | if (revents == 0 && stop_time < due) | |
515 | continue; | |
516 | /* | |
517 | * The source may be gone after the callback returns, | |
518 | * so access any data now that needs accessing. | |
519 | */ | |
faa5d7d9 DE |
520 | if (source->timeout >= 0) |
521 | source->due = stop_time + source->timeout; | |
522 | source->triggered = TRUE; | |
523 | triggered = TRUE; | |
62d7945f DE |
524 | /* |
525 | * Invoke the source's callback on an event or timeout. | |
526 | */ | |
faa5d7d9 | 527 | if (!source->cb(fd, revents, source->cb_data)) |
92248e78 | 528 | sr_session_source_remove_internal(session, poll_object); |
62d7945f DE |
529 | /* |
530 | * We want to take as little time as possible to stop | |
531 | * the session if we have been told to do so. Therefore, | |
532 | * we check the flag after processing every source, not | |
533 | * just once per main event loop. | |
534 | */ | |
faa5d7d9 | 535 | if (!stopped) |
62d7945f | 536 | stopped = sr_session_check_aborted(session); |
faa5d7d9 | 537 | |
62d7945f | 538 | /* Restart loop as the sources list may have changed. */ |
92248e78 | 539 | fd_index = 0; |
62d7945f | 540 | i = 0; |
544a4582 | 541 | } |
faa5d7d9 DE |
542 | |
543 | /* Check for abort at least once per iteration. */ | |
544 | if (!triggered) | |
32af282c | 545 | sr_session_check_aborted(session); |
e0508e67 UH |
546 | |
547 | return SR_OK; | |
544a4582 BV |
548 | } |
549 | ||
7b5e6d29 BV |
550 | static int verify_trigger(struct sr_trigger *trigger) |
551 | { | |
552 | struct sr_trigger_stage *stage; | |
553 | struct sr_trigger_match *match; | |
554 | GSList *l, *m; | |
555 | ||
556 | if (!trigger->stages) { | |
557 | sr_err("No trigger stages defined."); | |
558 | return SR_ERR; | |
559 | } | |
560 | ||
561 | sr_spew("Checking trigger:"); | |
562 | for (l = trigger->stages; l; l = l->next) { | |
563 | stage = l->data; | |
564 | if (!stage->matches) { | |
565 | sr_err("Stage %d has no matches defined.", stage->stage); | |
566 | return SR_ERR; | |
567 | } | |
568 | for (m = stage->matches; m; m = m->next) { | |
569 | match = m->data; | |
570 | if (!match->channel) { | |
571 | sr_err("Stage %d match has no channel.", stage->stage); | |
572 | return SR_ERR; | |
573 | } | |
574 | if (!match->match) { | |
575 | sr_err("Stage %d match is not defined.", stage->stage); | |
576 | return SR_ERR; | |
577 | } | |
578 | sr_spew("Stage %d match on channel %s, match %d", stage->stage, | |
579 | match->channel->name, match->match); | |
580 | } | |
581 | } | |
582 | ||
583 | return SR_OK; | |
584 | } | |
1beccaed | 585 | |
9f45fb3a UH |
586 | /** |
587 | * Start a session. | |
588 | * | |
7efe889e UH |
589 | * @param session The session to use. Must not be NULL. |
590 | * | |
04cb9157 | 591 | * @retval SR_OK Success. |
0812c40e | 592 | * @retval SR_ERR_ARG Invalid session passed. |
47117241 | 593 | * |
0812c40e | 594 | * @since 0.4.0 |
9f45fb3a | 595 | */ |
0812c40e | 596 | SR_API int sr_session_start(struct sr_session *session) |
7d658874 | 597 | { |
de4d3f99 | 598 | struct sr_dev_inst *sdi; |
013ec84b BV |
599 | struct sr_channel *ch; |
600 | GSList *l, *c; | |
601 | int enabled_channels, ret; | |
7d658874 | 602 | |
9f45fb3a | 603 | if (!session) { |
0812c40e ML |
604 | sr_err("%s: session was NULL", __func__); |
605 | return SR_ERR_ARG; | |
9f45fb3a UH |
606 | } |
607 | ||
bb7ef793 | 608 | if (!session->devs) { |
a421dc1d | 609 | sr_err("%s: session->devs was NULL; a session " |
9f45fb3a | 610 | "cannot be started without devices.", __func__); |
0812c40e | 611 | return SR_ERR_ARG; |
9f45fb3a UH |
612 | } |
613 | ||
7b5e6d29 BV |
614 | if (session->trigger && verify_trigger(session->trigger) != SR_OK) |
615 | return SR_ERR; | |
616 | ||
c7142604 | 617 | sr_info("Starting."); |
9f45fb3a | 618 | |
b7c3e849 | 619 | ret = SR_OK; |
bb7ef793 | 620 | for (l = session->devs; l; l = l->next) { |
de4d3f99 | 621 | sdi = l->data; |
013ec84b BV |
622 | enabled_channels = 0; |
623 | for (c = sdi->channels; c; c = c->next) { | |
624 | ch = c->data; | |
625 | if (ch->enabled) { | |
626 | enabled_channels++; | |
627 | break; | |
628 | } | |
629 | } | |
630 | if (enabled_channels == 0) { | |
631 | ret = SR_ERR; | |
1b9e567b SA |
632 | sr_err("%s using connection %s has no enabled channels!", |
633 | sdi->driver->name, sdi->connection_id); | |
013ec84b BV |
634 | break; |
635 | } | |
636 | ||
32b7cd4f DE |
637 | if ((ret = sr_config_commit(sdi)) != SR_OK) { |
638 | sr_err("Failed to commit device settings before " | |
639 | "starting acquisition (%s)", sr_strerror(ret)); | |
640 | break; | |
641 | } | |
de4d3f99 | 642 | if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { |
a421dc1d | 643 | sr_err("%s: could not start an acquisition " |
568dcacc | 644 | "(%s)", __func__, sr_strerror(ret)); |
7d658874 | 645 | break; |
9f45fb3a | 646 | } |
7d658874 BV |
647 | } |
648 | ||
9f45fb3a UH |
649 | /* TODO: What if there are multiple devices? Which return code? */ |
650 | ||
7d658874 BV |
651 | return ret; |
652 | } | |
653 | ||
9f45fb3a | 654 | /** |
0812c40e | 655 | * Run a session. |
9f45fb3a | 656 | * |
7efe889e UH |
657 | * @param session The session to use. Must not be NULL. |
658 | * | |
04cb9157 | 659 | * @retval SR_OK Success. |
0812c40e | 660 | * @retval SR_ERR_ARG Invalid session passed. |
faa5d7d9 | 661 | * @retval SR_ERR Error during event processing. |
47117241 | 662 | * |
0812c40e | 663 | * @since 0.4.0 |
9f45fb3a | 664 | */ |
0812c40e | 665 | SR_API int sr_session_run(struct sr_session *session) |
7d658874 | 666 | { |
faa5d7d9 DE |
667 | int ret; |
668 | ||
9f45fb3a | 669 | if (!session) { |
0812c40e ML |
670 | sr_err("%s: session was NULL", __func__); |
671 | return SR_ERR_ARG; | |
9f45fb3a UH |
672 | } |
673 | ||
bb7ef793 | 674 | if (!session->devs) { |
9f45fb3a | 675 | /* TODO: Actually the case? */ |
a421dc1d | 676 | sr_err("%s: session->devs was NULL; a session " |
9f45fb3a | 677 | "cannot be run without devices.", __func__); |
0812c40e | 678 | return SR_ERR_ARG; |
9f45fb3a | 679 | } |
5451816f | 680 | session->running = TRUE; |
9f45fb3a | 681 | |
a421dc1d | 682 | sr_info("Running."); |
7d658874 | 683 | |
faa5d7d9 DE |
684 | /* Poll event sources until none are left. */ |
685 | while (session->sources->len > 0) { | |
686 | ret = sr_session_iteration(session); | |
687 | if (ret != SR_OK) | |
688 | return ret; | |
9f45fb3a | 689 | } |
e0508e67 | 690 | return SR_OK; |
7d658874 BV |
691 | } |
692 | ||
9f45fb3a | 693 | /** |
0812c40e | 694 | * Stop a session. |
9f45fb3a | 695 | * |
0812c40e ML |
696 | * The session is stopped immediately, with all acquisition sessions stopped |
697 | * and hardware drivers cleaned up. | |
9f45fb3a | 698 | * |
33c6e4c5 AG |
699 | * This must be called from within the session thread, to prevent freeing |
700 | * resources that the session thread will try to use. | |
701 | * | |
7efe889e UH |
702 | * @param session The session to use. Must not be NULL. |
703 | * | |
04cb9157 | 704 | * @retval SR_OK Success. |
0812c40e | 705 | * @retval SR_ERR_ARG Invalid session passed. |
72a08bcc BV |
706 | * |
707 | * @private | |
9f45fb3a | 708 | */ |
0812c40e | 709 | SR_PRIV int sr_session_stop_sync(struct sr_session *session) |
a1bb33af | 710 | { |
de4d3f99 | 711 | struct sr_dev_inst *sdi; |
a1bb33af UH |
712 | GSList *l; |
713 | ||
9f45fb3a | 714 | if (!session) { |
a421dc1d | 715 | sr_err("%s: session was NULL", __func__); |
0812c40e | 716 | return SR_ERR_ARG; |
9f45fb3a UH |
717 | } |
718 | ||
a421dc1d | 719 | sr_info("Stopping."); |
e0508e67 | 720 | |
bb7ef793 | 721 | for (l = session->devs; l; l = l->next) { |
de4d3f99 BV |
722 | sdi = l->data; |
723 | if (sdi->driver) { | |
724 | if (sdi->driver->dev_acquisition_stop) | |
725 | sdi->driver->dev_acquisition_stop(sdi, sdi); | |
8c76be53 | 726 | } |
a1bb33af | 727 | } |
5451816f | 728 | session->running = FALSE; |
9f45fb3a | 729 | |
e0508e67 | 730 | return SR_OK; |
a1bb33af UH |
731 | } |
732 | ||
33c6e4c5 | 733 | /** |
0812c40e | 734 | * Stop a session. |
33c6e4c5 | 735 | * |
0812c40e ML |
736 | * The session is stopped immediately, with all acquisition sessions being |
737 | * stopped and hardware drivers cleaned up. | |
33c6e4c5 AG |
738 | * |
739 | * If the session is run in a separate thread, this function will not block | |
740 | * until the session is finished executing. It is the caller's responsibility | |
741 | * to wait for the session thread to return before assuming that the session is | |
742 | * completely decommissioned. | |
743 | * | |
7efe889e UH |
744 | * @param session The session to use. Must not be NULL. |
745 | * | |
04cb9157 | 746 | * @retval SR_OK Success. |
0812c40e | 747 | * @retval SR_ERR_ARG Invalid session passed. |
47117241 | 748 | * |
0812c40e | 749 | * @since 0.4.0 |
33c6e4c5 | 750 | */ |
0812c40e | 751 | SR_API int sr_session_stop(struct sr_session *session) |
33c6e4c5 AG |
752 | { |
753 | if (!session) { | |
754 | sr_err("%s: session was NULL", __func__); | |
755 | return SR_ERR_BUG; | |
756 | } | |
757 | ||
758 | g_mutex_lock(&session->stop_mutex); | |
759 | session->abort_session = TRUE; | |
760 | g_mutex_unlock(&session->stop_mutex); | |
761 | ||
762 | return SR_OK; | |
763 | } | |
764 | ||
9f45fb3a | 765 | /** |
a1645fcd | 766 | * Debug helper. |
9f45fb3a | 767 | * |
996b0c72 | 768 | * @param packet The packet to show debugging information for. |
9f45fb3a | 769 | */ |
bf53457d | 770 | static void datafeed_dump(const struct sr_datafeed_packet *packet) |
7d2afd6c | 771 | { |
bf53457d JH |
772 | const struct sr_datafeed_logic *logic; |
773 | const struct sr_datafeed_analog *analog; | |
1954dfa9 | 774 | const struct sr_datafeed_analog2 *analog2; |
7d2afd6c | 775 | |
ca7dbb56 | 776 | /* Please use the same order as in libsigrok.h. */ |
7d2afd6c BV |
777 | switch (packet->type) { |
778 | case SR_DF_HEADER: | |
a421dc1d | 779 | sr_dbg("bus: Received SR_DF_HEADER packet."); |
7d2afd6c | 780 | break; |
55c9f09d UH |
781 | case SR_DF_END: |
782 | sr_dbg("bus: Received SR_DF_END packet."); | |
7d2afd6c | 783 | break; |
c71bac3b | 784 | case SR_DF_META: |
a421dc1d | 785 | sr_dbg("bus: Received SR_DF_META packet."); |
ee7489d2 | 786 | break; |
55c9f09d UH |
787 | case SR_DF_TRIGGER: |
788 | sr_dbg("bus: Received SR_DF_TRIGGER packet."); | |
789 | break; | |
7d2afd6c BV |
790 | case SR_DF_LOGIC: |
791 | logic = packet->payload; | |
7ea45862 UH |
792 | sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, " |
793 | "unitsize = %d).", logic->length, logic->unitsize); | |
7d2afd6c | 794 | break; |
ee7489d2 BV |
795 | case SR_DF_ANALOG: |
796 | analog = packet->payload; | |
a421dc1d UH |
797 | sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", |
798 | analog->num_samples); | |
ee7489d2 | 799 | break; |
6ea7669c | 800 | case SR_DF_FRAME_BEGIN: |
a421dc1d | 801 | sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); |
6ea7669c BV |
802 | break; |
803 | case SR_DF_FRAME_END: | |
a421dc1d | 804 | sr_dbg("bus: Received SR_DF_FRAME_END packet."); |
6ea7669c | 805 | break; |
55c9f09d UH |
806 | case SR_DF_ANALOG2: |
807 | analog2 = packet->payload; | |
808 | sr_dbg("bus: Received SR_DF_ANALOG2 packet (%d samples).", | |
809 | analog2->num_samples); | |
810 | break; | |
7d2afd6c | 811 | default: |
a421dc1d | 812 | sr_dbg("bus: Received unknown packet type: %d.", packet->type); |
9f45fb3a | 813 | break; |
7d2afd6c | 814 | } |
7d2afd6c BV |
815 | } |
816 | ||
9f45fb3a | 817 | /** |
a1645fcd BV |
818 | * Send a packet to whatever is listening on the datafeed bus. |
819 | * | |
820 | * Hardware drivers use this to send a data packet to the frontend. | |
9f45fb3a | 821 | * |
6b2d8d3e | 822 | * @param sdi TODO. |
31ccebc4 | 823 | * @param packet The datafeed packet to send to the session bus. |
44dae539 | 824 | * |
04cb9157 MH |
825 | * @retval SR_OK Success. |
826 | * @retval SR_ERR_ARG Invalid argument. | |
b4bd7088 UH |
827 | * |
828 | * @private | |
9f45fb3a | 829 | */ |
de4d3f99 | 830 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, |
8143cfdc | 831 | const struct sr_datafeed_packet *packet) |
a1bb33af UH |
832 | { |
833 | GSList *l; | |
2726474a | 834 | struct datafeed_callback *cb_struct; |
c0a1e532 UH |
835 | struct sr_datafeed_packet *packet_in, *packet_out; |
836 | struct sr_transform *t; | |
837 | int ret; | |
a1bb33af | 838 | |
de4d3f99 | 839 | if (!sdi) { |
a421dc1d | 840 | sr_err("%s: sdi was NULL", __func__); |
e0508e67 | 841 | return SR_ERR_ARG; |
9f45fb3a UH |
842 | } |
843 | ||
e0508e67 | 844 | if (!packet) { |
a421dc1d | 845 | sr_err("%s: packet was NULL", __func__); |
e0508e67 | 846 | return SR_ERR_ARG; |
9f45fb3a UH |
847 | } |
848 | ||
79f92686 BV |
849 | if (!sdi->session) { |
850 | sr_err("%s: session was NULL", __func__); | |
851 | return SR_ERR_BUG; | |
852 | } | |
853 | ||
c0a1e532 UH |
854 | /* |
855 | * Pass the packet to the first transform module. If that returns | |
856 | * another packet (instead of NULL), pass that packet to the next | |
857 | * transform module in the list, and so on. | |
858 | */ | |
859 | packet_in = (struct sr_datafeed_packet *)packet; | |
860 | for (l = sdi->session->transforms; l; l = l->next) { | |
861 | t = l->data; | |
862 | sr_spew("Running transform module '%s'.", t->module->id); | |
863 | ret = t->module->receive(t, packet_in, &packet_out); | |
864 | if (ret < 0) { | |
865 | sr_err("Error while running transform module: %d.", ret); | |
866 | return SR_ERR; | |
867 | } | |
868 | if (!packet_out) { | |
869 | /* | |
870 | * If any of the transforms don't return an output | |
871 | * packet, abort. | |
872 | */ | |
873 | sr_spew("Transform module didn't return a packet, aborting."); | |
874 | return SR_OK; | |
875 | } else { | |
876 | /* | |
877 | * Use this transform module's output packet as input | |
878 | * for the next transform module. | |
879 | */ | |
880 | packet_in = packet_out; | |
881 | } | |
882 | } | |
4ec436c4 | 883 | packet = packet_in; |
c0a1e532 UH |
884 | |
885 | /* | |
886 | * If the last transform did output a packet, pass it to all datafeed | |
887 | * callbacks. | |
888 | */ | |
3337e9a1 | 889 | for (l = sdi->session->datafeed_callbacks; l; l = l->next) { |
18beaeff BV |
890 | if (sr_log_loglevel_get() >= SR_LOG_DBG) |
891 | datafeed_dump(packet); | |
2726474a ML |
892 | cb_struct = l->data; |
893 | cb_struct->cb(sdi, packet, cb_struct->cb_data); | |
a1bb33af | 894 | } |
9f45fb3a | 895 | |
e0508e67 | 896 | return SR_OK; |
a1bb33af UH |
897 | } |
898 | ||
6b2d8d3e UH |
899 | /** |
900 | * Add an event source for a file descriptor. | |
901 | * | |
7efe889e | 902 | * @param session The session to use. Must not be NULL. |
92248e78 DE |
903 | * @param[in] pollfds The FDs to poll, or NULL if @a num_fds is 0. |
904 | * @param[in] num_fds Number of FDs in the array. | |
faa5d7d9 DE |
905 | * @param[in] timeout Max time in ms to wait before the callback is called, |
906 | * or -1 to wait indefinitely. | |
6b2d8d3e UH |
907 | * @param cb Callback function to add. Must not be NULL. |
908 | * @param cb_data Data for the callback function. Can be NULL. | |
62d7945f | 909 | * @param poll_object Handle by which the source is identified |
6b2d8d3e | 910 | * |
04cb9157 MH |
911 | * @retval SR_OK Success. |
912 | * @retval SR_ERR_ARG Invalid argument. | |
92248e78 | 913 | * @retval SR_ERR An event source for @a poll_object is already installed. |
6b2d8d3e | 914 | */ |
62d7945f | 915 | SR_PRIV int sr_session_source_add_internal(struct sr_session *session, |
92248e78 DE |
916 | const GPollFD *pollfds, int num_fds, int timeout, |
917 | sr_receive_data_callback cb, void *cb_data, | |
918 | gintptr poll_object) | |
544a4582 | 919 | { |
faa5d7d9 | 920 | struct source src; |
92248e78 | 921 | unsigned int i; |
544a4582 | 922 | |
92248e78 | 923 | /* Note: cb_data can be NULL, that's not a bug. */ |
d08490aa | 924 | if (!cb) { |
a421dc1d | 925 | sr_err("%s: cb was NULL", __func__); |
e0508e67 | 926 | return SR_ERR_ARG; |
9f45fb3a | 927 | } |
92248e78 DE |
928 | if (!pollfds && num_fds != 0) { |
929 | sr_err("%s: pollfds was NULL", __func__); | |
930 | return SR_ERR_ARG; | |
931 | } | |
932 | /* Make sure that poll_object is unique. | |
933 | */ | |
934 | for (i = 0; i < session->sources->len; ++i) { | |
935 | if (g_array_index(session->sources, struct source, i) | |
936 | .poll_object == poll_object) { | |
937 | sr_err("Event source for object %" G_GINTPTR_FORMAT | |
938 | " already installed.", poll_object); | |
939 | return SR_ERR; | |
940 | } | |
941 | } | |
faa5d7d9 DE |
942 | src.cb = cb; |
943 | src.cb_data = cb_data; | |
944 | src.poll_object = poll_object; | |
92248e78 | 945 | src.num_fds = num_fds; |
faa5d7d9 | 946 | src.triggered = FALSE; |
544a4582 | 947 | |
faa5d7d9 DE |
948 | if (timeout >= 0) { |
949 | src.timeout = INT64_C(1000) * timeout; | |
950 | src.due = g_get_monotonic_time() + src.timeout; | |
951 | } else { | |
952 | src.timeout = -1; | |
953 | src.due = INT64_MAX; | |
954 | } | |
92248e78 | 955 | g_array_append_val(session->sources, src); |
faa5d7d9 | 956 | |
92248e78 DE |
957 | if (num_fds > 0) |
958 | g_array_append_vals(session->pollfds, pollfds, num_fds); | |
544a4582 | 959 | |
e0508e67 | 960 | return SR_OK; |
544a4582 BV |
961 | } |
962 | ||
9f45fb3a | 963 | /** |
6b2d8d3e | 964 | * Add an event source for a file descriptor. |
9f45fb3a | 965 | * |
7efe889e | 966 | * @param session The session to use. Must not be NULL. |
aac0ea25 LPC |
967 | * @param fd The file descriptor. |
968 | * @param events Events to check for. | |
faa5d7d9 DE |
969 | * @param timeout Max time in ms to wait before the callback is called, |
970 | * or -1 to wait indefinitely. | |
aac0ea25 LPC |
971 | * @param cb Callback function to add. Must not be NULL. |
972 | * @param cb_data Data for the callback function. Can be NULL. | |
9f45fb3a | 973 | * |
04cb9157 MH |
974 | * @retval SR_OK Success. |
975 | * @retval SR_ERR_ARG Invalid argument. | |
47117241 UH |
976 | * |
977 | * @since 0.3.0 | |
aac0ea25 | 978 | */ |
0812c40e ML |
979 | SR_API int sr_session_source_add(struct sr_session *session, int fd, |
980 | int events, int timeout, sr_receive_data_callback cb, void *cb_data) | |
aac0ea25 LPC |
981 | { |
982 | GPollFD p; | |
983 | ||
faa5d7d9 DE |
984 | if (fd < 0 && timeout < 0) { |
985 | sr_err("Timer source without timeout would block indefinitely"); | |
986 | return SR_ERR_ARG; | |
987 | } | |
aac0ea25 LPC |
988 | p.fd = fd; |
989 | p.events = events; | |
89efe064 | 990 | p.revents = 0; |
aac0ea25 | 991 | |
faa5d7d9 | 992 | return sr_session_source_add_internal(session, |
92248e78 | 993 | &p, (fd < 0) ? 0 : 1, timeout, cb, cb_data, fd); |
aac0ea25 LPC |
994 | } |
995 | ||
996 | /** | |
1a895c61 | 997 | * Add an event source for a GPollFD. |
aac0ea25 | 998 | * |
7efe889e | 999 | * @param session The session to use. Must not be NULL. |
faa5d7d9 DE |
1000 | * @param pollfd The GPollFD. Must not be NULL. |
1001 | * @param timeout Max time in ms to wait before the callback is called, | |
1002 | * or -1 to wait indefinitely. | |
aac0ea25 LPC |
1003 | * @param cb Callback function to add. Must not be NULL. |
1004 | * @param cb_data Data for the callback function. Can be NULL. | |
44dae539 | 1005 | * |
04cb9157 MH |
1006 | * @retval SR_OK Success. |
1007 | * @retval SR_ERR_ARG Invalid argument. | |
47117241 UH |
1008 | * |
1009 | * @since 0.3.0 | |
9f45fb3a | 1010 | */ |
0812c40e ML |
1011 | SR_API int sr_session_source_add_pollfd(struct sr_session *session, |
1012 | GPollFD *pollfd, int timeout, sr_receive_data_callback cb, | |
1013 | void *cb_data) | |
aac0ea25 | 1014 | { |
faa5d7d9 DE |
1015 | if (!pollfd) { |
1016 | sr_err("%s: pollfd was NULL", __func__); | |
1017 | return SR_ERR_ARG; | |
1018 | } | |
92248e78 DE |
1019 | return sr_session_source_add_internal(session, pollfd, 1, |
1020 | timeout, cb, cb_data, (gintptr)pollfd); | |
aac0ea25 LPC |
1021 | } |
1022 | ||
1023 | /** | |
1a895c61 | 1024 | * Add an event source for a GIOChannel. |
aac0ea25 | 1025 | * |
7efe889e | 1026 | * @param session The session to use. Must not be NULL. |
aac0ea25 LPC |
1027 | * @param channel The GIOChannel. |
1028 | * @param events Events to poll on. | |
faa5d7d9 DE |
1029 | * @param timeout Max time in ms to wait before the callback is called, |
1030 | * or -1 to wait indefinitely. | |
aac0ea25 LPC |
1031 | * @param cb Callback function to add. Must not be NULL. |
1032 | * @param cb_data Data for the callback function. Can be NULL. | |
1033 | * | |
04cb9157 MH |
1034 | * @retval SR_OK Success. |
1035 | * @retval SR_ERR_ARG Invalid argument. | |
47117241 UH |
1036 | * |
1037 | * @since 0.3.0 | |
aac0ea25 | 1038 | */ |
0812c40e ML |
1039 | SR_API int sr_session_source_add_channel(struct sr_session *session, |
1040 | GIOChannel *channel, int events, int timeout, | |
1041 | sr_receive_data_callback cb, void *cb_data) | |
aac0ea25 LPC |
1042 | { |
1043 | GPollFD p; | |
1044 | ||
faa5d7d9 | 1045 | #ifdef G_OS_WIN32 |
6b2d8d3e | 1046 | g_io_channel_win32_make_pollfd(channel, events, &p); |
aac0ea25 LPC |
1047 | #else |
1048 | p.fd = g_io_channel_unix_get_fd(channel); | |
1049 | p.events = events; | |
89efe064 | 1050 | p.revents = 0; |
aac0ea25 | 1051 | #endif |
92248e78 DE |
1052 | return sr_session_source_add_internal(session, &p, 1, |
1053 | timeout, cb, cb_data, (gintptr)channel); | |
aac0ea25 LPC |
1054 | } |
1055 | ||
6b2d8d3e | 1056 | /** |
92248e78 | 1057 | * Remove the source identified by the specified poll object. |
6b2d8d3e | 1058 | * |
7efe889e | 1059 | * @param session The session to use. Must not be NULL. |
04cb9157 | 1060 | * @param poll_object The channel for which the source should be removed. |
6b2d8d3e | 1061 | * |
04cb9157 | 1062 | * @retval SR_OK Success |
92248e78 | 1063 | * @retval SR_ERR_BUG No event source for poll_object found. |
6b2d8d3e | 1064 | */ |
92248e78 DE |
1065 | SR_PRIV int sr_session_source_remove_internal(struct sr_session *session, |
1066 | gintptr poll_object) | |
544a4582 | 1067 | { |
92248e78 | 1068 | struct source *source; |
faa5d7d9 | 1069 | unsigned int i; |
92248e78 | 1070 | int fd_index = 0; |
544a4582 | 1071 | |
faa5d7d9 | 1072 | for (i = 0; i < session->sources->len; ++i) { |
92248e78 | 1073 | source = &g_array_index(session->sources, struct source, i); |
e0508e67 | 1074 | |
92248e78 DE |
1075 | if (source->poll_object == poll_object) { |
1076 | if (source->num_fds > 0) | |
1077 | g_array_remove_range(session->pollfds, | |
1078 | fd_index, source->num_fds); | |
faa5d7d9 | 1079 | g_array_remove_index(session->sources, i); |
92248e78 | 1080 | return SR_OK; |
faa5d7d9 | 1081 | } |
92248e78 | 1082 | fd_index += source->num_fds; |
9f45fb3a | 1083 | } |
92248e78 DE |
1084 | /* Trying to remove an already removed event source is problematic |
1085 | * since the poll_object handle may have been reused in the meantime. | |
1086 | */ | |
1087 | sr_warn("Cannot remove non-existing event source for object %" | |
1088 | G_GINTPTR_FORMAT ".", poll_object); | |
1089 | ||
1090 | return SR_ERR_BUG; | |
544a4582 | 1091 | } |
aac0ea25 | 1092 | |
6b2d8d3e | 1093 | /** |
aac0ea25 LPC |
1094 | * Remove the source belonging to the specified file descriptor. |
1095 | * | |
7efe889e | 1096 | * @param session The session to use. Must not be NULL. |
1a895c61 | 1097 | * @param fd The file descriptor for which the source should be removed. |
aac0ea25 | 1098 | * |
04cb9157 MH |
1099 | * @retval SR_OK Success |
1100 | * @retval SR_ERR_ARG Invalid argument | |
04cb9157 | 1101 | * @retval SR_ERR_BUG Internal error. |
47117241 UH |
1102 | * |
1103 | * @since 0.3.0 | |
aac0ea25 | 1104 | */ |
0812c40e | 1105 | SR_API int sr_session_source_remove(struct sr_session *session, int fd) |
aac0ea25 | 1106 | { |
92248e78 | 1107 | return sr_session_source_remove_internal(session, fd); |
aac0ea25 LPC |
1108 | } |
1109 | ||
1110 | /** | |
1111 | * Remove the source belonging to the specified poll descriptor. | |
1112 | * | |
7efe889e | 1113 | * @param session The session to use. Must not be NULL. |
aac0ea25 | 1114 | * @param pollfd The poll descriptor for which the source should be removed. |
faa5d7d9 | 1115 | * Must not be NULL. |
aac0ea25 LPC |
1116 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or |
1117 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
1118 | * internal errors. | |
47117241 UH |
1119 | * |
1120 | * @since 0.2.0 | |
aac0ea25 | 1121 | */ |
0812c40e ML |
1122 | SR_API int sr_session_source_remove_pollfd(struct sr_session *session, |
1123 | GPollFD *pollfd) | |
aac0ea25 | 1124 | { |
faa5d7d9 DE |
1125 | if (!pollfd) { |
1126 | sr_err("%s: pollfd was NULL", __func__); | |
1127 | return SR_ERR_ARG; | |
1128 | } | |
92248e78 | 1129 | return sr_session_source_remove_internal(session, (gintptr)pollfd); |
aac0ea25 LPC |
1130 | } |
1131 | ||
6b2d8d3e | 1132 | /** |
aac0ea25 LPC |
1133 | * Remove the source belonging to the specified channel. |
1134 | * | |
7efe889e | 1135 | * @param session The session to use. Must not be NULL. |
1a895c61 | 1136 | * @param channel The channel for which the source should be removed. |
faa5d7d9 | 1137 | * Must not be NULL. |
04cb9157 MH |
1138 | * @retval SR_OK Success. |
1139 | * @retval SR_ERR_ARG Invalid argument. | |
04cb9157 | 1140 | * @return SR_ERR_BUG Internal error. |
47117241 UH |
1141 | * |
1142 | * @since 0.2.0 | |
aac0ea25 | 1143 | */ |
0812c40e ML |
1144 | SR_API int sr_session_source_remove_channel(struct sr_session *session, |
1145 | GIOChannel *channel) | |
aac0ea25 | 1146 | { |
faa5d7d9 DE |
1147 | if (!channel) { |
1148 | sr_err("%s: channel was NULL", __func__); | |
1149 | return SR_ERR_ARG; | |
1150 | } | |
92248e78 | 1151 | return sr_session_source_remove_internal(session, (gintptr)channel); |
aac0ea25 | 1152 | } |
7b870c38 | 1153 | |
ee29d92e | 1154 | static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy) |
8143cfdc | 1155 | { |
8143cfdc | 1156 | g_variant_ref(src->data); |
ee29d92e AJ |
1157 | meta_copy->config = g_slist_append(meta_copy->config, |
1158 | g_memdup(src, sizeof(struct sr_config))); | |
8143cfdc BV |
1159 | } |
1160 | ||
1161 | SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet, | |
1162 | struct sr_datafeed_packet **copy) | |
1163 | { | |
1164 | const struct sr_datafeed_meta *meta; | |
1165 | struct sr_datafeed_meta *meta_copy; | |
1166 | const struct sr_datafeed_logic *logic; | |
1167 | struct sr_datafeed_logic *logic_copy; | |
1168 | const struct sr_datafeed_analog *analog; | |
1169 | struct sr_datafeed_analog *analog_copy; | |
1170 | uint8_t *payload; | |
1171 | ||
1172 | *copy = g_malloc0(sizeof(struct sr_datafeed_packet)); | |
1173 | (*copy)->type = packet->type; | |
1174 | ||
1175 | switch (packet->type) { | |
1176 | case SR_DF_TRIGGER: | |
1177 | case SR_DF_END: | |
1178 | /* No payload. */ | |
1179 | break; | |
1180 | case SR_DF_HEADER: | |
1181 | payload = g_malloc(sizeof(struct sr_datafeed_header)); | |
1182 | memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header)); | |
1183 | (*copy)->payload = payload; | |
1184 | break; | |
1185 | case SR_DF_META: | |
1186 | meta = packet->payload; | |
ee29d92e AJ |
1187 | meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta)); |
1188 | g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config); | |
8143cfdc BV |
1189 | (*copy)->payload = meta_copy; |
1190 | break; | |
1191 | case SR_DF_LOGIC: | |
1192 | logic = packet->payload; | |
1193 | logic_copy = g_malloc(sizeof(logic)); | |
1194 | logic_copy->length = logic->length; | |
1195 | logic_copy->unitsize = logic->unitsize; | |
1196 | memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize); | |
1197 | (*copy)->payload = logic_copy; | |
1198 | break; | |
1199 | case SR_DF_ANALOG: | |
1200 | analog = packet->payload; | |
1201 | analog_copy = g_malloc(sizeof(analog)); | |
1202 | analog_copy->channels = g_slist_copy(analog->channels); | |
1203 | analog_copy->num_samples = analog->num_samples; | |
1204 | analog_copy->mq = analog->mq; | |
1205 | analog_copy->unit = analog->unit; | |
1206 | analog_copy->mqflags = analog->mqflags; | |
1207 | memcpy(analog_copy->data, analog->data, | |
1208 | analog->num_samples * sizeof(float)); | |
1209 | (*copy)->payload = analog_copy; | |
1210 | break; | |
1211 | default: | |
1212 | sr_err("Unknown packet type %d", packet->type); | |
1213 | return SR_ERR; | |
1214 | } | |
1215 | ||
1216 | return SR_OK; | |
1217 | } | |
1218 | ||
1219 | void sr_packet_free(struct sr_datafeed_packet *packet) | |
1220 | { | |
1221 | const struct sr_datafeed_meta *meta; | |
1222 | const struct sr_datafeed_logic *logic; | |
1223 | const struct sr_datafeed_analog *analog; | |
1224 | struct sr_config *src; | |
1225 | GSList *l; | |
1226 | ||
1227 | switch (packet->type) { | |
1228 | case SR_DF_TRIGGER: | |
1229 | case SR_DF_END: | |
1230 | /* No payload. */ | |
1231 | break; | |
1232 | case SR_DF_HEADER: | |
1233 | /* Payload is a simple struct. */ | |
1234 | g_free((void *)packet->payload); | |
1235 | break; | |
1236 | case SR_DF_META: | |
1237 | meta = packet->payload; | |
1238 | for (l = meta->config; l; l = l->next) { | |
1239 | src = l->data; | |
1240 | g_variant_unref(src->data); | |
1241 | g_free(src); | |
1242 | } | |
1243 | g_slist_free(meta->config); | |
1244 | g_free((void *)packet->payload); | |
1245 | break; | |
1246 | case SR_DF_LOGIC: | |
1247 | logic = packet->payload; | |
1248 | g_free(logic->data); | |
1249 | g_free((void *)packet->payload); | |
1250 | break; | |
1251 | case SR_DF_ANALOG: | |
1252 | analog = packet->payload; | |
1253 | g_slist_free(analog->channels); | |
1254 | g_free(analog->data); | |
1255 | g_free((void *)packet->payload); | |
1256 | break; | |
1257 | default: | |
1258 | sr_err("Unknown packet type %d", packet->type); | |
1259 | } | |
1260 | g_free(packet); | |
1261 | ||
1262 | } | |
1263 | ||
7b870c38 | 1264 | /** @} */ |