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