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