]>
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. |
a1645fcd | 253 | * |
e0508e67 | 254 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. |
9f45fb3a | 255 | */ |
2726474a | 256 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data) |
a1bb33af | 257 | { |
2726474a ML |
258 | struct datafeed_callback *cb_struct; |
259 | ||
9f45fb3a | 260 | if (!session) { |
a421dc1d | 261 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 262 | return SR_ERR_BUG; |
9f45fb3a UH |
263 | } |
264 | ||
0abee507 | 265 | if (!cb) { |
a421dc1d | 266 | sr_err("%s: cb was NULL", __func__); |
0abee507 UH |
267 | return SR_ERR_ARG; |
268 | } | |
9f45fb3a | 269 | |
2726474a ML |
270 | if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback)))) |
271 | return SR_ERR_MALLOC; | |
272 | ||
273 | cb_struct->cb = cb; | |
274 | cb_struct->cb_data = cb_data; | |
275 | ||
62c82025 | 276 | session->datafeed_callbacks = |
2726474a | 277 | g_slist_append(session->datafeed_callbacks, cb_struct); |
e0508e67 UH |
278 | |
279 | return SR_OK; | |
a1bb33af UH |
280 | } |
281 | ||
e0508e67 | 282 | static int sr_session_run_poll(void) |
544a4582 | 283 | { |
b7e94111 LPC |
284 | unsigned int i; |
285 | int ret; | |
544a4582 | 286 | |
2cbeb2b7 BV |
287 | while (session->num_sources > 0) { |
288 | ret = g_poll(session->pollfds, session->num_sources, | |
289 | session->source_timeout); | |
b7e94111 LPC |
290 | for (i = 0; i < session->num_sources; i++) { |
291 | if (session->pollfds[i].revents > 0 || (ret == 0 | |
292 | && session->source_timeout == session->sources[i].timeout)) { | |
544a4582 BV |
293 | /* |
294 | * Invoke the source's callback on an event, | |
2cbeb2b7 | 295 | * or if the poll timed out and this source |
544a4582 BV |
296 | * asked for that timeout. |
297 | */ | |
2cbeb2b7 BV |
298 | if (!session->sources[i].cb(session->pollfds[i].fd, |
299 | session->pollfds[i].revents, | |
300 | session->sources[i].cb_data)) | |
b7e94111 | 301 | sr_session_source_remove(session->sources[i].poll_object); |
544a4582 | 302 | } |
33c6e4c5 AG |
303 | /* |
304 | * We want to take as little time as possible to stop | |
305 | * the session if we have been told to do so. Therefore, | |
306 | * we check the flag after processing every source, not | |
307 | * just once per main event loop. | |
308 | */ | |
309 | g_mutex_lock(&session->stop_mutex); | |
310 | if (session->abort_session) | |
311 | sr_session_stop_sync(); | |
312 | g_mutex_unlock(&session->stop_mutex); | |
544a4582 BV |
313 | } |
314 | } | |
e0508e67 UH |
315 | |
316 | return SR_OK; | |
544a4582 BV |
317 | } |
318 | ||
9f45fb3a UH |
319 | /** |
320 | * Start a session. | |
321 | * | |
a1645fcd | 322 | * There can only be one session at a time. |
9f45fb3a UH |
323 | * |
324 | * @return SR_OK upon success, SR_ERR upon errors. | |
325 | */ | |
1a081ca6 | 326 | SR_API int sr_session_start(void) |
7d658874 | 327 | { |
de4d3f99 | 328 | struct sr_dev_inst *sdi; |
7d658874 BV |
329 | GSList *l; |
330 | int ret; | |
331 | ||
9f45fb3a | 332 | if (!session) { |
a421dc1d | 333 | sr_err("%s: session was NULL; a session must be " |
de4d3f99 | 334 | "created before starting it.", __func__); |
0abee507 | 335 | return SR_ERR_BUG; |
9f45fb3a UH |
336 | } |
337 | ||
bb7ef793 | 338 | if (!session->devs) { |
a421dc1d | 339 | sr_err("%s: session->devs was NULL; a session " |
9f45fb3a | 340 | "cannot be started without devices.", __func__); |
0abee507 | 341 | return SR_ERR_BUG; |
9f45fb3a UH |
342 | } |
343 | ||
c7142604 | 344 | sr_info("Starting."); |
9f45fb3a | 345 | |
b7c3e849 | 346 | ret = SR_OK; |
bb7ef793 | 347 | for (l = session->devs; l; l = l->next) { |
de4d3f99 BV |
348 | sdi = l->data; |
349 | if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { | |
a421dc1d | 350 | sr_err("%s: could not start an acquisition " |
9f45fb3a | 351 | "(%d)", __func__, ret); |
7d658874 | 352 | break; |
9f45fb3a | 353 | } |
7d658874 BV |
354 | } |
355 | ||
9f45fb3a UH |
356 | /* TODO: What if there are multiple devices? Which return code? */ |
357 | ||
7d658874 BV |
358 | return ret; |
359 | } | |
360 | ||
9f45fb3a UH |
361 | /** |
362 | * Run the session. | |
363 | * | |
e0508e67 | 364 | * @return SR_OK upon success, SR_ERR_BUG upon errors. |
9f45fb3a | 365 | */ |
1a081ca6 | 366 | SR_API int sr_session_run(void) |
7d658874 | 367 | { |
9f45fb3a | 368 | if (!session) { |
a421dc1d | 369 | sr_err("%s: session was NULL; a session must be " |
9f45fb3a | 370 | "created first, before running it.", __func__); |
e0508e67 | 371 | return SR_ERR_BUG; |
9f45fb3a UH |
372 | } |
373 | ||
bb7ef793 | 374 | if (!session->devs) { |
9f45fb3a | 375 | /* TODO: Actually the case? */ |
a421dc1d | 376 | sr_err("%s: session->devs was NULL; a session " |
9f45fb3a | 377 | "cannot be run without devices.", __func__); |
e0508e67 | 378 | return SR_ERR_BUG; |
9f45fb3a UH |
379 | } |
380 | ||
a421dc1d | 381 | sr_info("Running."); |
7d658874 | 382 | |
9f45fb3a | 383 | /* Do we have real sources? */ |
b7e94111 | 384 | if (session->num_sources == 1 && session->pollfds[0].fd == -1) { |
9f45fb3a | 385 | /* Dummy source, freewheel over it. */ |
2cbeb2b7 | 386 | while (session->num_sources) |
b7e94111 | 387 | session->sources[0].cb(-1, 0, session->sources[0].cb_data); |
9f45fb3a UH |
388 | } else { |
389 | /* Real sources, use g_poll() main loop. */ | |
8a2efef2 | 390 | sr_session_run_poll(); |
9f45fb3a UH |
391 | } |
392 | ||
e0508e67 | 393 | return SR_OK; |
7d658874 BV |
394 | } |
395 | ||
9f45fb3a UH |
396 | /** |
397 | * Stop the current session. | |
398 | * | |
a1645fcd | 399 | * The current session is stopped immediately, with all acquisition sessions |
c09f0b57 | 400 | * being stopped and hardware drivers cleaned up. |
9f45fb3a | 401 | * |
33c6e4c5 AG |
402 | * This must be called from within the session thread, to prevent freeing |
403 | * resources that the session thread will try to use. | |
404 | * | |
e0508e67 | 405 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. |
9f45fb3a | 406 | */ |
33c6e4c5 | 407 | SR_PRIV int sr_session_stop_sync(void) |
a1bb33af | 408 | { |
de4d3f99 | 409 | struct sr_dev_inst *sdi; |
a1bb33af UH |
410 | GSList *l; |
411 | ||
9f45fb3a | 412 | if (!session) { |
a421dc1d | 413 | sr_err("%s: session was NULL", __func__); |
e0508e67 | 414 | return SR_ERR_BUG; |
9f45fb3a UH |
415 | } |
416 | ||
a421dc1d | 417 | sr_info("Stopping."); |
e0508e67 | 418 | |
bb7ef793 | 419 | for (l = session->devs; l; l = l->next) { |
de4d3f99 BV |
420 | sdi = l->data; |
421 | if (sdi->driver) { | |
422 | if (sdi->driver->dev_acquisition_stop) | |
423 | sdi->driver->dev_acquisition_stop(sdi, sdi); | |
8c76be53 | 424 | } |
a1bb33af | 425 | } |
9f45fb3a | 426 | |
f1f7e62d AG |
427 | /* |
428 | * Some sources may not be necessarily associated with a device. | |
429 | * Those sources may still be present even after stopping all devices. | |
430 | * We need to make sure all sources are removed, or we risk running the | |
431 | * session in an infinite loop. | |
432 | */ | |
433 | while (session->num_sources) | |
434 | sr_session_source_remove(session->sources[0].poll_object); | |
435 | ||
e0508e67 | 436 | return SR_OK; |
a1bb33af UH |
437 | } |
438 | ||
33c6e4c5 AG |
439 | /** |
440 | * Stop the current session. | |
441 | * | |
442 | * The current session is stopped immediately, with all acquisition sessions | |
443 | * being stopped and hardware drivers cleaned up. | |
444 | * | |
445 | * If the session is run in a separate thread, this function will not block | |
446 | * until the session is finished executing. It is the caller's responsibility | |
447 | * to wait for the session thread to return before assuming that the session is | |
448 | * completely decommissioned. | |
449 | * | |
450 | * @return SR_OK upon success, SR_ERR_BUG if no session exists. | |
451 | */ | |
452 | SR_API int sr_session_stop(void) | |
453 | { | |
454 | if (!session) { | |
455 | sr_err("%s: session was NULL", __func__); | |
456 | return SR_ERR_BUG; | |
457 | } | |
458 | ||
459 | g_mutex_lock(&session->stop_mutex); | |
460 | session->abort_session = TRUE; | |
461 | g_mutex_unlock(&session->stop_mutex); | |
462 | ||
463 | return SR_OK; | |
464 | } | |
465 | ||
9f45fb3a | 466 | /** |
a1645fcd | 467 | * Debug helper. |
9f45fb3a | 468 | * |
996b0c72 | 469 | * @param packet The packet to show debugging information for. |
9f45fb3a | 470 | */ |
bf53457d | 471 | static void datafeed_dump(const struct sr_datafeed_packet *packet) |
7d2afd6c | 472 | { |
bf53457d JH |
473 | const struct sr_datafeed_logic *logic; |
474 | const struct sr_datafeed_analog *analog; | |
7d2afd6c BV |
475 | |
476 | switch (packet->type) { | |
477 | case SR_DF_HEADER: | |
a421dc1d | 478 | sr_dbg("bus: Received SR_DF_HEADER packet."); |
7d2afd6c BV |
479 | break; |
480 | case SR_DF_TRIGGER: | |
a421dc1d | 481 | sr_dbg("bus: Received SR_DF_TRIGGER packet."); |
7d2afd6c | 482 | break; |
c71bac3b | 483 | case SR_DF_META: |
a421dc1d | 484 | sr_dbg("bus: Received SR_DF_META packet."); |
ee7489d2 | 485 | break; |
7d2afd6c BV |
486 | case SR_DF_LOGIC: |
487 | logic = packet->payload; | |
a421dc1d UH |
488 | sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).", |
489 | logic->length); | |
7d2afd6c | 490 | break; |
ee7489d2 BV |
491 | case SR_DF_ANALOG: |
492 | analog = packet->payload; | |
a421dc1d UH |
493 | sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", |
494 | analog->num_samples); | |
ee7489d2 | 495 | break; |
7d2afd6c | 496 | case SR_DF_END: |
a421dc1d | 497 | sr_dbg("bus: Received SR_DF_END packet."); |
7d2afd6c | 498 | break; |
6ea7669c | 499 | case SR_DF_FRAME_BEGIN: |
a421dc1d | 500 | sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); |
6ea7669c BV |
501 | break; |
502 | case SR_DF_FRAME_END: | |
a421dc1d | 503 | sr_dbg("bus: Received SR_DF_FRAME_END packet."); |
6ea7669c | 504 | break; |
7d2afd6c | 505 | default: |
a421dc1d | 506 | sr_dbg("bus: Received unknown packet type: %d.", packet->type); |
9f45fb3a | 507 | break; |
7d2afd6c | 508 | } |
7d2afd6c BV |
509 | } |
510 | ||
9f45fb3a | 511 | /** |
a1645fcd BV |
512 | * Send a packet to whatever is listening on the datafeed bus. |
513 | * | |
514 | * Hardware drivers use this to send a data packet to the frontend. | |
9f45fb3a | 515 | * |
6b2d8d3e | 516 | * @param sdi TODO. |
31ccebc4 | 517 | * @param packet The datafeed packet to send to the session bus. |
44dae539 | 518 | * |
e0508e67 | 519 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. |
b4bd7088 UH |
520 | * |
521 | * @private | |
9f45fb3a | 522 | */ |
de4d3f99 | 523 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, |
bf53457d | 524 | const struct sr_datafeed_packet *packet) |
a1bb33af UH |
525 | { |
526 | GSList *l; | |
2726474a | 527 | struct datafeed_callback *cb_struct; |
a1bb33af | 528 | |
de4d3f99 | 529 | if (!sdi) { |
a421dc1d | 530 | sr_err("%s: sdi was NULL", __func__); |
e0508e67 | 531 | return SR_ERR_ARG; |
9f45fb3a UH |
532 | } |
533 | ||
e0508e67 | 534 | if (!packet) { |
a421dc1d | 535 | sr_err("%s: packet was NULL", __func__); |
e0508e67 | 536 | return SR_ERR_ARG; |
9f45fb3a UH |
537 | } |
538 | ||
62c82025 | 539 | for (l = session->datafeed_callbacks; l; l = l->next) { |
18beaeff BV |
540 | if (sr_log_loglevel_get() >= SR_LOG_DBG) |
541 | datafeed_dump(packet); | |
2726474a ML |
542 | cb_struct = l->data; |
543 | cb_struct->cb(sdi, packet, cb_struct->cb_data); | |
a1bb33af | 544 | } |
9f45fb3a | 545 | |
e0508e67 | 546 | return SR_OK; |
a1bb33af UH |
547 | } |
548 | ||
6b2d8d3e UH |
549 | /** |
550 | * Add an event source for a file descriptor. | |
551 | * | |
552 | * @param pollfd The GPollFD. | |
553 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
554 | * @param cb Callback function to add. Must not be NULL. | |
555 | * @param cb_data Data for the callback function. Can be NULL. | |
556 | * @param poll_object TODO. | |
557 | * | |
558 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
559 | * SR_ERR_MALLOC upon memory allocation errors. | |
560 | */ | |
aac0ea25 | 561 | static int _sr_session_source_add(GPollFD *pollfd, int timeout, |
1a895c61 | 562 | sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object) |
544a4582 BV |
563 | { |
564 | struct source *new_sources, *s; | |
aac0ea25 | 565 | GPollFD *new_pollfds; |
544a4582 | 566 | |
d08490aa | 567 | if (!cb) { |
a421dc1d | 568 | sr_err("%s: cb was NULL", __func__); |
e0508e67 | 569 | return SR_ERR_ARG; |
9f45fb3a UH |
570 | } |
571 | ||
1f9813eb | 572 | /* Note: cb_data can be NULL, that's not a bug. */ |
9f45fb3a | 573 | |
2ac2e629 BV |
574 | new_pollfds = g_try_realloc(session->pollfds, |
575 | sizeof(GPollFD) * (session->num_sources + 1)); | |
0687dfcd | 576 | if (!new_pollfds) { |
a421dc1d | 577 | sr_err("%s: new_pollfds malloc failed", __func__); |
0687dfcd LPC |
578 | return SR_ERR_MALLOC; |
579 | } | |
580 | ||
b7e94111 | 581 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * |
2ac2e629 | 582 | (session->num_sources + 1)); |
9f45fb3a | 583 | if (!new_sources) { |
a421dc1d | 584 | sr_err("%s: new_sources malloc failed", __func__); |
e0508e67 | 585 | return SR_ERR_MALLOC; |
9f45fb3a | 586 | } |
544a4582 | 587 | |
b7e94111 LPC |
588 | new_pollfds[session->num_sources] = *pollfd; |
589 | s = &new_sources[session->num_sources++]; | |
544a4582 | 590 | s->timeout = timeout; |
d08490aa | 591 | s->cb = cb; |
1f9813eb | 592 | s->cb_data = cb_data; |
aac0ea25 | 593 | s->poll_object = poll_object; |
b7e94111 LPC |
594 | session->pollfds = new_pollfds; |
595 | session->sources = new_sources; | |
544a4582 | 596 | |
b7e94111 LPC |
597 | if (timeout != session->source_timeout && timeout > 0 |
598 | && (session->source_timeout == -1 || timeout < session->source_timeout)) | |
599 | session->source_timeout = timeout; | |
9f45fb3a | 600 | |
e0508e67 | 601 | return SR_OK; |
544a4582 BV |
602 | } |
603 | ||
9f45fb3a | 604 | /** |
6b2d8d3e | 605 | * Add an event source for a file descriptor. |
9f45fb3a | 606 | * |
aac0ea25 LPC |
607 | * @param fd The file descriptor. |
608 | * @param events Events to check for. | |
609 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
610 | * @param cb Callback function to add. Must not be NULL. | |
611 | * @param cb_data Data for the callback function. Can be NULL. | |
9f45fb3a | 612 | * |
aac0ea25 LPC |
613 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or |
614 | * SR_ERR_MALLOC upon memory allocation errors. | |
615 | */ | |
616 | SR_API int sr_session_source_add(int fd, int events, int timeout, | |
617 | sr_receive_data_callback_t cb, void *cb_data) | |
618 | { | |
619 | GPollFD p; | |
620 | ||
aac0ea25 LPC |
621 | p.fd = fd; |
622 | p.events = events; | |
aac0ea25 LPC |
623 | |
624 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd); | |
625 | } | |
626 | ||
627 | /** | |
1a895c61 | 628 | * Add an event source for a GPollFD. |
aac0ea25 | 629 | * |
aac0ea25 LPC |
630 | * @param pollfd The GPollFD. |
631 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
632 | * @param cb Callback function to add. Must not be NULL. | |
633 | * @param cb_data Data for the callback function. Can be NULL. | |
44dae539 | 634 | * |
e0508e67 | 635 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or |
aac0ea25 | 636 | * SR_ERR_MALLOC upon memory allocation errors. |
9f45fb3a | 637 | */ |
aac0ea25 LPC |
638 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, |
639 | sr_receive_data_callback_t cb, void *cb_data) | |
640 | { | |
1a895c61 UH |
641 | return _sr_session_source_add(pollfd, timeout, cb, |
642 | cb_data, (gintptr)pollfd); | |
aac0ea25 LPC |
643 | } |
644 | ||
645 | /** | |
1a895c61 | 646 | * Add an event source for a GIOChannel. |
aac0ea25 | 647 | * |
aac0ea25 LPC |
648 | * @param channel The GIOChannel. |
649 | * @param events Events to poll on. | |
650 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
651 | * @param cb Callback function to add. Must not be NULL. | |
652 | * @param cb_data Data for the callback function. Can be NULL. | |
653 | * | |
654 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
655 | * SR_ERR_MALLOC upon memory allocation errors. | |
656 | */ | |
1a895c61 UH |
657 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, |
658 | int timeout, sr_receive_data_callback_t cb, void *cb_data) | |
aac0ea25 LPC |
659 | { |
660 | GPollFD p; | |
661 | ||
662 | #ifdef _WIN32 | |
6b2d8d3e | 663 | g_io_channel_win32_make_pollfd(channel, events, &p); |
aac0ea25 LPC |
664 | #else |
665 | p.fd = g_io_channel_unix_get_fd(channel); | |
666 | p.events = events; | |
667 | #endif | |
668 | ||
669 | return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); | |
670 | } | |
671 | ||
6b2d8d3e UH |
672 | /** |
673 | * Remove the source belonging to the specified channel. | |
674 | * | |
675 | * @todo Add more error checks and logging. | |
676 | * | |
677 | * @param channel The channel for which the source should be removed. | |
678 | * | |
679 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
680 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
681 | * internal errors. | |
682 | */ | |
aac0ea25 | 683 | static int _sr_session_source_remove(gintptr poll_object) |
544a4582 BV |
684 | { |
685 | struct source *new_sources; | |
0687dfcd | 686 | GPollFD *new_pollfds; |
b7e94111 | 687 | unsigned int old; |
544a4582 | 688 | |
b7e94111 | 689 | if (!session->sources || !session->num_sources) { |
a421dc1d | 690 | sr_err("%s: sources was NULL", __func__); |
0abee507 | 691 | return SR_ERR_BUG; |
e0508e67 UH |
692 | } |
693 | ||
b7e94111 LPC |
694 | for (old = 0; old < session->num_sources; old++) { |
695 | if (session->sources[old].poll_object == poll_object) | |
2bccd322 | 696 | break; |
9f45fb3a UH |
697 | } |
698 | ||
2bccd322 | 699 | /* fd not found, nothing to do */ |
b7e94111 | 700 | if (old == session->num_sources) |
2bccd322 LPC |
701 | return SR_OK; |
702 | ||
b7e94111 | 703 | session->num_sources -= 1; |
2bccd322 | 704 | |
b7e94111 LPC |
705 | if (old != session->num_sources) { |
706 | memmove(&session->pollfds[old], &session->pollfds[old+1], | |
707 | (session->num_sources - old) * sizeof(GPollFD)); | |
708 | memmove(&session->sources[old], &session->sources[old+1], | |
709 | (session->num_sources - old) * sizeof(struct source)); | |
9f45fb3a | 710 | } |
544a4582 | 711 | |
b7e94111 LPC |
712 | new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); |
713 | if (!new_pollfds && session->num_sources > 0) { | |
a421dc1d | 714 | sr_err("%s: new_pollfds malloc failed", __func__); |
0687dfcd LPC |
715 | return SR_ERR_MALLOC; |
716 | } | |
717 | ||
b7e94111 LPC |
718 | new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources); |
719 | if (!new_sources && session->num_sources > 0) { | |
a421dc1d | 720 | sr_err("%s: new_sources malloc failed", __func__); |
2bccd322 | 721 | return SR_ERR_MALLOC; |
544a4582 | 722 | } |
e0508e67 | 723 | |
b7e94111 LPC |
724 | session->pollfds = new_pollfds; |
725 | session->sources = new_sources; | |
2bccd322 | 726 | |
e0508e67 | 727 | return SR_OK; |
544a4582 | 728 | } |
aac0ea25 | 729 | |
6b2d8d3e | 730 | /** |
aac0ea25 LPC |
731 | * Remove the source belonging to the specified file descriptor. |
732 | * | |
1a895c61 | 733 | * @param fd The file descriptor for which the source should be removed. |
aac0ea25 LPC |
734 | * |
735 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
736 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
737 | * internal errors. | |
738 | */ | |
739 | SR_API int sr_session_source_remove(int fd) | |
740 | { | |
741 | return _sr_session_source_remove((gintptr)fd); | |
742 | } | |
743 | ||
744 | /** | |
745 | * Remove the source belonging to the specified poll descriptor. | |
746 | * | |
aac0ea25 LPC |
747 | * @param pollfd The poll descriptor for which the source should be removed. |
748 | * | |
749 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
750 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
751 | * internal errors. | |
752 | */ | |
753 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd) | |
754 | { | |
755 | return _sr_session_source_remove((gintptr)pollfd); | |
756 | } | |
757 | ||
6b2d8d3e | 758 | /** |
aac0ea25 LPC |
759 | * Remove the source belonging to the specified channel. |
760 | * | |
1a895c61 | 761 | * @param channel The channel for which the source should be removed. |
aac0ea25 LPC |
762 | * |
763 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
764 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
765 | * internal errors. | |
766 | */ | |
767 | SR_API int sr_session_source_remove_channel(GIOChannel *channel) | |
768 | { | |
769 | return _sr_session_source_remove((gintptr)channel); | |
770 | } | |
7b870c38 UH |
771 | |
772 | /** @} */ |