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