]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
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> | |
24 | #include <glib.h> | |
25 | #include "libsigrok.h" | |
26 | #include "libsigrok-internal.h" | |
27 | ||
28 | /** @cond PRIVATE */ | |
29 | #define LOG_PREFIX "session" | |
30 | /** @endcond */ | |
31 | ||
32 | /** | |
33 | * @file | |
34 | * | |
35 | * Creating, using, or destroying libsigrok sessions. | |
36 | */ | |
37 | ||
38 | /** | |
39 | * @defgroup grp_session Session handling | |
40 | * | |
41 | * Creating, using, or destroying libsigrok sessions. | |
42 | * | |
43 | * @{ | |
44 | */ | |
45 | ||
46 | struct source { | |
47 | int timeout; | |
48 | sr_receive_data_callback cb; | |
49 | void *cb_data; | |
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; | |
55 | }; | |
56 | ||
57 | struct datafeed_callback { | |
58 | sr_datafeed_callback cb; | |
59 | void *cb_data; | |
60 | }; | |
61 | ||
62 | /** | |
63 | * Create a new session. | |
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. | |
68 | * | |
69 | * @retval SR_OK Success. | |
70 | * @retval SR_ERR_ARG Invalid argument. | |
71 | * | |
72 | * @since 0.4.0 | |
73 | */ | |
74 | SR_API int sr_session_new(struct sr_session **new_session) | |
75 | { | |
76 | struct sr_session *session; | |
77 | ||
78 | if (!new_session) | |
79 | return SR_ERR_ARG; | |
80 | ||
81 | session = g_malloc0(sizeof(struct sr_session)); | |
82 | ||
83 | session->source_timeout = -1; | |
84 | session->running = FALSE; | |
85 | session->abort_session = FALSE; | |
86 | g_mutex_init(&session->stop_mutex); | |
87 | ||
88 | *new_session = session; | |
89 | ||
90 | return SR_OK; | |
91 | } | |
92 | ||
93 | /** | |
94 | * Destroy a session. | |
95 | * This frees up all memory used by the session. | |
96 | * | |
97 | * @param session The session to destroy. Must not be NULL. | |
98 | * | |
99 | * @retval SR_OK Success. | |
100 | * @retval SR_ERR_ARG Invalid session passed. | |
101 | * | |
102 | * @since 0.4.0 | |
103 | */ | |
104 | SR_API int sr_session_destroy(struct sr_session *session) | |
105 | { | |
106 | if (!session) { | |
107 | sr_err("%s: session was NULL", __func__); | |
108 | return SR_ERR_ARG; | |
109 | } | |
110 | ||
111 | sr_session_dev_remove_all(session); | |
112 | g_mutex_clear(&session->stop_mutex); | |
113 | if (session->trigger) | |
114 | sr_trigger_free(session->trigger); | |
115 | ||
116 | g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free); | |
117 | ||
118 | g_free(session); | |
119 | ||
120 | return SR_OK; | |
121 | } | |
122 | ||
123 | /** | |
124 | * Remove all the devices from a session. | |
125 | * | |
126 | * The session itself (i.e., the struct sr_session) is not free'd and still | |
127 | * exists after this function returns. | |
128 | * | |
129 | * @param session The session to use. Must not be NULL. | |
130 | * | |
131 | * @retval SR_OK Success. | |
132 | * @retval SR_ERR_BUG Invalid session passed. | |
133 | * | |
134 | * @since 0.4.0 | |
135 | */ | |
136 | SR_API int sr_session_dev_remove_all(struct sr_session *session) | |
137 | { | |
138 | struct sr_dev_inst *sdi; | |
139 | GSList *l; | |
140 | ||
141 | if (!session) { | |
142 | sr_err("%s: session was NULL", __func__); | |
143 | return SR_ERR_ARG; | |
144 | } | |
145 | ||
146 | for (l = session->devs; l; l = l->next) { | |
147 | sdi = (struct sr_dev_inst *) l->data; | |
148 | sdi->session = NULL; | |
149 | } | |
150 | ||
151 | g_slist_free(session->devs); | |
152 | session->devs = NULL; | |
153 | ||
154 | return SR_OK; | |
155 | } | |
156 | ||
157 | /** | |
158 | * Add a device instance to a session. | |
159 | * | |
160 | * @param session The session to add to. Must not be NULL. | |
161 | * @param sdi The device instance to add to a session. Must not | |
162 | * be NULL. Also, sdi->driver and sdi->driver->dev_open must | |
163 | * not be NULL. | |
164 | * | |
165 | * @retval SR_OK Success. | |
166 | * @retval SR_ERR_ARG Invalid argument. | |
167 | * | |
168 | * @since 0.4.0 | |
169 | */ | |
170 | SR_API int sr_session_dev_add(struct sr_session *session, | |
171 | struct sr_dev_inst *sdi) | |
172 | { | |
173 | int ret; | |
174 | ||
175 | if (!sdi) { | |
176 | sr_err("%s: sdi was NULL", __func__); | |
177 | return SR_ERR_ARG; | |
178 | } | |
179 | ||
180 | if (!session) { | |
181 | sr_err("%s: session was NULL", __func__); | |
182 | return SR_ERR_ARG; | |
183 | } | |
184 | ||
185 | /* If sdi->session is not NULL, the device is already in this or | |
186 | * another session. */ | |
187 | if (sdi->session) { | |
188 | sr_err("%s: already assigned to session", __func__); | |
189 | return SR_ERR_ARG; | |
190 | } | |
191 | ||
192 | /* If sdi->driver is NULL, this is a virtual device. */ | |
193 | if (!sdi->driver) { | |
194 | /* Just add the device, don't run dev_open(). */ | |
195 | session->devs = g_slist_append(session->devs, (gpointer)sdi); | |
196 | sdi->session = session; | |
197 | return SR_OK; | |
198 | } | |
199 | ||
200 | /* sdi->driver is non-NULL (i.e. we have a real device). */ | |
201 | if (!sdi->driver->dev_open) { | |
202 | sr_err("%s: sdi->driver->dev_open was NULL", __func__); | |
203 | return SR_ERR_BUG; | |
204 | } | |
205 | ||
206 | session->devs = g_slist_append(session->devs, (gpointer)sdi); | |
207 | sdi->session = session; | |
208 | ||
209 | if (session->running) { | |
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 | } | |
218 | if ((ret = sdi->driver->dev_acquisition_start(sdi, | |
219 | (void *)sdi)) != SR_OK) { | |
220 | sr_err("Failed to start acquisition of device in " | |
221 | "running session (%s)", sr_strerror(ret)); | |
222 | return ret; | |
223 | } | |
224 | } | |
225 | ||
226 | return SR_OK; | |
227 | } | |
228 | ||
229 | /** | |
230 | * List all device instances attached to a session. | |
231 | * | |
232 | * @param session The session to use. Must not be NULL. | |
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 | * | |
240 | * @retval SR_OK Success. | |
241 | * @retval SR_ERR_ARG Invalid argument. | |
242 | * | |
243 | * @since 0.4.0 | |
244 | */ | |
245 | SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist) | |
246 | { | |
247 | if (!session) | |
248 | return SR_ERR_ARG; | |
249 | ||
250 | if (!devlist) | |
251 | return SR_ERR_ARG; | |
252 | ||
253 | *devlist = g_slist_copy(session->devs); | |
254 | ||
255 | return SR_OK; | |
256 | } | |
257 | ||
258 | /** | |
259 | * Remove all datafeed callbacks in a session. | |
260 | * | |
261 | * @param session The session to use. Must not be NULL. | |
262 | * | |
263 | * @retval SR_OK Success. | |
264 | * @retval SR_ERR_ARG Invalid session passed. | |
265 | * | |
266 | * @since 0.4.0 | |
267 | */ | |
268 | SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session) | |
269 | { | |
270 | if (!session) { | |
271 | sr_err("%s: session was NULL", __func__); | |
272 | return SR_ERR_ARG; | |
273 | } | |
274 | ||
275 | g_slist_free_full(session->datafeed_callbacks, g_free); | |
276 | session->datafeed_callbacks = NULL; | |
277 | ||
278 | return SR_OK; | |
279 | } | |
280 | ||
281 | /** | |
282 | * Add a datafeed callback to a session. | |
283 | * | |
284 | * @param session The session to use. Must not be NULL. | |
285 | * @param cb Function to call when a chunk of data is received. | |
286 | * Must not be NULL. | |
287 | * @param cb_data Opaque pointer passed in by the caller. | |
288 | * | |
289 | * @retval SR_OK Success. | |
290 | * @retval SR_ERR_BUG No session exists. | |
291 | * | |
292 | * @since 0.3.0 | |
293 | */ | |
294 | SR_API int sr_session_datafeed_callback_add(struct sr_session *session, | |
295 | sr_datafeed_callback cb, void *cb_data) | |
296 | { | |
297 | struct datafeed_callback *cb_struct; | |
298 | ||
299 | if (!session) { | |
300 | sr_err("%s: session was NULL", __func__); | |
301 | return SR_ERR_BUG; | |
302 | } | |
303 | ||
304 | if (!cb) { | |
305 | sr_err("%s: cb was NULL", __func__); | |
306 | return SR_ERR_ARG; | |
307 | } | |
308 | ||
309 | cb_struct = g_malloc0(sizeof(struct datafeed_callback)); | |
310 | cb_struct->cb = cb; | |
311 | cb_struct->cb_data = cb_data; | |
312 | ||
313 | session->datafeed_callbacks = | |
314 | g_slist_append(session->datafeed_callbacks, cb_struct); | |
315 | ||
316 | return SR_OK; | |
317 | } | |
318 | ||
319 | SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session) | |
320 | { | |
321 | return session->trigger; | |
322 | } | |
323 | ||
324 | SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig) | |
325 | { | |
326 | session->trigger = trig; | |
327 | ||
328 | return SR_OK; | |
329 | } | |
330 | ||
331 | /** | |
332 | * Call every device in the current session's callback. | |
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 | * | |
338 | * @param session The session to use. Must not be NULL. | |
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 | * | |
346 | * @retval SR_OK Success. | |
347 | * @retval SR_ERR Error occured. | |
348 | */ | |
349 | static int sr_session_iteration(struct sr_session *session, gboolean block) | |
350 | { | |
351 | unsigned int i; | |
352 | int ret; | |
353 | ||
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)) { | |
359 | /* | |
360 | * Invoke the source's callback on an event, | |
361 | * or if the poll timed out and this source | |
362 | * asked for that timeout. | |
363 | */ | |
364 | if (!session->sources[i].cb(session->pollfds[i].fd, | |
365 | session->pollfds[i].revents, | |
366 | session->sources[i].cb_data)) | |
367 | sr_session_source_remove(session, | |
368 | session->sources[i].poll_object); | |
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) { | |
378 | sr_session_stop_sync(session); | |
379 | /* But once is enough. */ | |
380 | session->abort_session = FALSE; | |
381 | } | |
382 | g_mutex_unlock(&session->stop_mutex); | |
383 | } | |
384 | ||
385 | return SR_OK; | |
386 | } | |
387 | ||
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 | } | |
424 | /** | |
425 | * Start a session. | |
426 | * | |
427 | * @param session The session to use. Must not be NULL. | |
428 | * | |
429 | * @retval SR_OK Success. | |
430 | * @retval SR_ERR_ARG Invalid session passed. | |
431 | * | |
432 | * @since 0.4.0 | |
433 | */ | |
434 | SR_API int sr_session_start(struct sr_session *session) | |
435 | { | |
436 | struct sr_dev_inst *sdi; | |
437 | struct sr_channel *ch; | |
438 | GSList *l, *c; | |
439 | int enabled_channels, ret; | |
440 | ||
441 | if (!session) { | |
442 | sr_err("%s: session was NULL", __func__); | |
443 | return SR_ERR_ARG; | |
444 | } | |
445 | ||
446 | if (!session->devs) { | |
447 | sr_err("%s: session->devs was NULL; a session " | |
448 | "cannot be started without devices.", __func__); | |
449 | return SR_ERR_ARG; | |
450 | } | |
451 | ||
452 | if (session->trigger && verify_trigger(session->trigger) != SR_OK) | |
453 | return SR_ERR; | |
454 | ||
455 | sr_info("Starting."); | |
456 | ||
457 | ret = SR_OK; | |
458 | for (l = session->devs; l; l = l->next) { | |
459 | sdi = l->data; | |
460 | enabled_channels = 0; | |
461 | for (c = sdi->channels; c; c = c->next) { | |
462 | ch = c->data; | |
463 | if (ch->enabled) { | |
464 | enabled_channels++; | |
465 | break; | |
466 | } | |
467 | } | |
468 | if (enabled_channels == 0) { | |
469 | ret = SR_ERR; | |
470 | sr_err("%s using connection %s has no enabled channels!", | |
471 | sdi->driver->name, sdi->connection_id); | |
472 | break; | |
473 | } | |
474 | ||
475 | if ((ret = sr_config_commit(sdi)) != SR_OK) { | |
476 | sr_err("Failed to commit device settings before " | |
477 | "starting acquisition (%s)", sr_strerror(ret)); | |
478 | break; | |
479 | } | |
480 | if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) { | |
481 | sr_err("%s: could not start an acquisition " | |
482 | "(%s)", __func__, sr_strerror(ret)); | |
483 | break; | |
484 | } | |
485 | } | |
486 | ||
487 | /* TODO: What if there are multiple devices? Which return code? */ | |
488 | ||
489 | return ret; | |
490 | } | |
491 | ||
492 | /** | |
493 | * Run a session. | |
494 | * | |
495 | * @param session The session to use. Must not be NULL. | |
496 | * | |
497 | * @retval SR_OK Success. | |
498 | * @retval SR_ERR_ARG Invalid session passed. | |
499 | * | |
500 | * @since 0.4.0 | |
501 | */ | |
502 | SR_API int sr_session_run(struct sr_session *session) | |
503 | { | |
504 | if (!session) { | |
505 | sr_err("%s: session was NULL", __func__); | |
506 | return SR_ERR_ARG; | |
507 | } | |
508 | ||
509 | if (!session->devs) { | |
510 | /* TODO: Actually the case? */ | |
511 | sr_err("%s: session->devs was NULL; a session " | |
512 | "cannot be run without devices.", __func__); | |
513 | return SR_ERR_ARG; | |
514 | } | |
515 | session->running = TRUE; | |
516 | ||
517 | sr_info("Running."); | |
518 | ||
519 | /* Do we have real sources? */ | |
520 | if (session->num_sources == 1 && session->pollfds[0].fd == -1) { | |
521 | /* Dummy source, freewheel over it. */ | |
522 | while (session->num_sources) | |
523 | session->sources[0].cb(-1, 0, session->sources[0].cb_data); | |
524 | } else { | |
525 | /* Real sources, use g_poll() main loop. */ | |
526 | while (session->num_sources) | |
527 | sr_session_iteration(session, TRUE); | |
528 | } | |
529 | ||
530 | return SR_OK; | |
531 | } | |
532 | ||
533 | /** | |
534 | * Stop a session. | |
535 | * | |
536 | * The session is stopped immediately, with all acquisition sessions stopped | |
537 | * and hardware drivers cleaned up. | |
538 | * | |
539 | * This must be called from within the session thread, to prevent freeing | |
540 | * resources that the session thread will try to use. | |
541 | * | |
542 | * @param session The session to use. Must not be NULL. | |
543 | * | |
544 | * @retval SR_OK Success. | |
545 | * @retval SR_ERR_ARG Invalid session passed. | |
546 | * | |
547 | * @private | |
548 | */ | |
549 | SR_PRIV int sr_session_stop_sync(struct sr_session *session) | |
550 | { | |
551 | struct sr_dev_inst *sdi; | |
552 | GSList *l; | |
553 | ||
554 | if (!session) { | |
555 | sr_err("%s: session was NULL", __func__); | |
556 | return SR_ERR_ARG; | |
557 | } | |
558 | ||
559 | sr_info("Stopping."); | |
560 | ||
561 | for (l = session->devs; l; l = l->next) { | |
562 | sdi = l->data; | |
563 | if (sdi->driver) { | |
564 | if (sdi->driver->dev_acquisition_stop) | |
565 | sdi->driver->dev_acquisition_stop(sdi, sdi); | |
566 | } | |
567 | } | |
568 | session->running = FALSE; | |
569 | ||
570 | return SR_OK; | |
571 | } | |
572 | ||
573 | /** | |
574 | * Stop a session. | |
575 | * | |
576 | * The session is stopped immediately, with all acquisition sessions being | |
577 | * stopped and hardware drivers cleaned up. | |
578 | * | |
579 | * If the session is run in a separate thread, this function will not block | |
580 | * until the session is finished executing. It is the caller's responsibility | |
581 | * to wait for the session thread to return before assuming that the session is | |
582 | * completely decommissioned. | |
583 | * | |
584 | * @param session The session to use. Must not be NULL. | |
585 | * | |
586 | * @retval SR_OK Success. | |
587 | * @retval SR_ERR_ARG Invalid session passed. | |
588 | * | |
589 | * @since 0.4.0 | |
590 | */ | |
591 | SR_API int sr_session_stop(struct sr_session *session) | |
592 | { | |
593 | if (!session) { | |
594 | sr_err("%s: session was NULL", __func__); | |
595 | return SR_ERR_BUG; | |
596 | } | |
597 | ||
598 | g_mutex_lock(&session->stop_mutex); | |
599 | session->abort_session = TRUE; | |
600 | g_mutex_unlock(&session->stop_mutex); | |
601 | ||
602 | return SR_OK; | |
603 | } | |
604 | ||
605 | /** | |
606 | * Debug helper. | |
607 | * | |
608 | * @param packet The packet to show debugging information for. | |
609 | */ | |
610 | static void datafeed_dump(const struct sr_datafeed_packet *packet) | |
611 | { | |
612 | const struct sr_datafeed_logic *logic; | |
613 | const struct sr_datafeed_analog *analog; | |
614 | const struct sr_datafeed_analog2 *analog2; | |
615 | ||
616 | switch (packet->type) { | |
617 | case SR_DF_HEADER: | |
618 | sr_dbg("bus: Received SR_DF_HEADER packet."); | |
619 | break; | |
620 | case SR_DF_TRIGGER: | |
621 | sr_dbg("bus: Received SR_DF_TRIGGER packet."); | |
622 | break; | |
623 | case SR_DF_META: | |
624 | sr_dbg("bus: Received SR_DF_META packet."); | |
625 | break; | |
626 | case SR_DF_LOGIC: | |
627 | logic = packet->payload; | |
628 | sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, " | |
629 | "unitsize = %d).", logic->length, logic->unitsize); | |
630 | break; | |
631 | case SR_DF_ANALOG: | |
632 | analog = packet->payload; | |
633 | sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).", | |
634 | analog->num_samples); | |
635 | break; | |
636 | case SR_DF_ANALOG2: | |
637 | analog2 = packet->payload; | |
638 | sr_dbg("bus: Received SR_DF_ANALOG2 packet (%d samples).", | |
639 | analog2->num_samples); | |
640 | break; | |
641 | case SR_DF_END: | |
642 | sr_dbg("bus: Received SR_DF_END packet."); | |
643 | break; | |
644 | case SR_DF_FRAME_BEGIN: | |
645 | sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet."); | |
646 | break; | |
647 | case SR_DF_FRAME_END: | |
648 | sr_dbg("bus: Received SR_DF_FRAME_END packet."); | |
649 | break; | |
650 | default: | |
651 | sr_dbg("bus: Received unknown packet type: %d.", packet->type); | |
652 | break; | |
653 | } | |
654 | } | |
655 | ||
656 | /** | |
657 | * Send a packet to whatever is listening on the datafeed bus. | |
658 | * | |
659 | * Hardware drivers use this to send a data packet to the frontend. | |
660 | * | |
661 | * @param sdi TODO. | |
662 | * @param packet The datafeed packet to send to the session bus. | |
663 | * | |
664 | * @retval SR_OK Success. | |
665 | * @retval SR_ERR_ARG Invalid argument. | |
666 | * | |
667 | * @private | |
668 | */ | |
669 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, | |
670 | const struct sr_datafeed_packet *packet) | |
671 | { | |
672 | GSList *l; | |
673 | struct datafeed_callback *cb_struct; | |
674 | ||
675 | if (!sdi) { | |
676 | sr_err("%s: sdi was NULL", __func__); | |
677 | return SR_ERR_ARG; | |
678 | } | |
679 | ||
680 | if (!packet) { | |
681 | sr_err("%s: packet was NULL", __func__); | |
682 | return SR_ERR_ARG; | |
683 | } | |
684 | ||
685 | if (!sdi->session) { | |
686 | sr_err("%s: session was NULL", __func__); | |
687 | return SR_ERR_BUG; | |
688 | } | |
689 | ||
690 | for (l = sdi->session->datafeed_callbacks; l; l = l->next) { | |
691 | if (sr_log_loglevel_get() >= SR_LOG_DBG) | |
692 | datafeed_dump(packet); | |
693 | cb_struct = l->data; | |
694 | cb_struct->cb(sdi, packet, cb_struct->cb_data); | |
695 | } | |
696 | ||
697 | return SR_OK; | |
698 | } | |
699 | ||
700 | /** | |
701 | * Add an event source for a file descriptor. | |
702 | * | |
703 | * @param session The session to use. Must not be NULL. | |
704 | * @param pollfd The GPollFD. | |
705 | * @param[in] timeout Max time to wait before the callback is called, | |
706 | * ignored if 0. | |
707 | * @param cb Callback function to add. Must not be NULL. | |
708 | * @param cb_data Data for the callback function. Can be NULL. | |
709 | * @param poll_object TODO. | |
710 | * | |
711 | * @retval SR_OK Success. | |
712 | * @retval SR_ERR_ARG Invalid argument. | |
713 | */ | |
714 | static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd, | |
715 | int timeout, sr_receive_data_callback cb, void *cb_data, gintptr poll_object) | |
716 | { | |
717 | struct source *new_sources, *s; | |
718 | GPollFD *new_pollfds; | |
719 | ||
720 | if (!cb) { | |
721 | sr_err("%s: cb was NULL", __func__); | |
722 | return SR_ERR_ARG; | |
723 | } | |
724 | ||
725 | /* Note: cb_data can be NULL, that's not a bug. */ | |
726 | ||
727 | new_pollfds = g_realloc(session->pollfds, | |
728 | sizeof(GPollFD) * (session->num_sources + 1)); | |
729 | new_sources = g_realloc(session->sources, sizeof(struct source) * | |
730 | (session->num_sources + 1)); | |
731 | ||
732 | new_pollfds[session->num_sources] = *pollfd; | |
733 | s = &new_sources[session->num_sources++]; | |
734 | s->timeout = timeout; | |
735 | s->cb = cb; | |
736 | s->cb_data = cb_data; | |
737 | s->poll_object = poll_object; | |
738 | session->pollfds = new_pollfds; | |
739 | session->sources = new_sources; | |
740 | ||
741 | if (timeout != session->source_timeout && timeout > 0 | |
742 | && (session->source_timeout == -1 || timeout < session->source_timeout)) | |
743 | session->source_timeout = timeout; | |
744 | ||
745 | return SR_OK; | |
746 | } | |
747 | ||
748 | /** | |
749 | * Add an event source for a file descriptor. | |
750 | * | |
751 | * @param session The session to use. Must not be NULL. | |
752 | * @param fd The file descriptor. | |
753 | * @param events Events to check for. | |
754 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
755 | * @param cb Callback function to add. Must not be NULL. | |
756 | * @param cb_data Data for the callback function. Can be NULL. | |
757 | * | |
758 | * @retval SR_OK Success. | |
759 | * @retval SR_ERR_ARG Invalid argument. | |
760 | * | |
761 | * @since 0.3.0 | |
762 | */ | |
763 | SR_API int sr_session_source_add(struct sr_session *session, int fd, | |
764 | int events, int timeout, sr_receive_data_callback cb, void *cb_data) | |
765 | { | |
766 | GPollFD p; | |
767 | ||
768 | p.fd = fd; | |
769 | p.events = events; | |
770 | ||
771 | return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd); | |
772 | } | |
773 | ||
774 | /** | |
775 | * Add an event source for a GPollFD. | |
776 | * | |
777 | * @param session The session to use. Must not be NULL. | |
778 | * @param pollfd The GPollFD. | |
779 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
780 | * @param cb Callback function to add. Must not be NULL. | |
781 | * @param cb_data Data for the callback function. Can be NULL. | |
782 | * | |
783 | * @retval SR_OK Success. | |
784 | * @retval SR_ERR_ARG Invalid argument. | |
785 | * | |
786 | * @since 0.3.0 | |
787 | */ | |
788 | SR_API int sr_session_source_add_pollfd(struct sr_session *session, | |
789 | GPollFD *pollfd, int timeout, sr_receive_data_callback cb, | |
790 | void *cb_data) | |
791 | { | |
792 | return _sr_session_source_add(session, pollfd, timeout, cb, | |
793 | cb_data, (gintptr)pollfd); | |
794 | } | |
795 | ||
796 | /** | |
797 | * Add an event source for a GIOChannel. | |
798 | * | |
799 | * @param session The session to use. Must not be NULL. | |
800 | * @param channel The GIOChannel. | |
801 | * @param events Events to poll on. | |
802 | * @param timeout Max time to wait before the callback is called, ignored if 0. | |
803 | * @param cb Callback function to add. Must not be NULL. | |
804 | * @param cb_data Data for the callback function. Can be NULL. | |
805 | * | |
806 | * @retval SR_OK Success. | |
807 | * @retval SR_ERR_ARG Invalid argument. | |
808 | * | |
809 | * @since 0.3.0 | |
810 | */ | |
811 | SR_API int sr_session_source_add_channel(struct sr_session *session, | |
812 | GIOChannel *channel, int events, int timeout, | |
813 | sr_receive_data_callback cb, void *cb_data) | |
814 | { | |
815 | GPollFD p; | |
816 | ||
817 | #ifdef _WIN32 | |
818 | g_io_channel_win32_make_pollfd(channel, events, &p); | |
819 | #else | |
820 | p.fd = g_io_channel_unix_get_fd(channel); | |
821 | p.events = events; | |
822 | #endif | |
823 | ||
824 | return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel); | |
825 | } | |
826 | ||
827 | /** | |
828 | * Remove the source belonging to the specified channel. | |
829 | * | |
830 | * @param session The session to use. Must not be NULL. | |
831 | * @param poll_object The channel for which the source should be removed. | |
832 | * | |
833 | * @retval SR_OK Success | |
834 | * @retval SR_ERR_ARG Invalid arguments | |
835 | * @retval SR_ERR_BUG Internal error | |
836 | */ | |
837 | static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object) | |
838 | { | |
839 | unsigned int old; | |
840 | ||
841 | if (!session->sources || !session->num_sources) { | |
842 | sr_err("%s: sources was NULL", __func__); | |
843 | return SR_ERR_BUG; | |
844 | } | |
845 | ||
846 | for (old = 0; old < session->num_sources; old++) { | |
847 | if (session->sources[old].poll_object == poll_object) | |
848 | break; | |
849 | } | |
850 | ||
851 | /* fd not found, nothing to do */ | |
852 | if (old == session->num_sources) | |
853 | return SR_OK; | |
854 | ||
855 | session->num_sources--; | |
856 | ||
857 | if (old != session->num_sources) { | |
858 | memmove(&session->pollfds[old], &session->pollfds[old + 1], | |
859 | (session->num_sources - old) * sizeof(GPollFD)); | |
860 | memmove(&session->sources[old], &session->sources[old + 1], | |
861 | (session->num_sources - old) * sizeof(struct source)); | |
862 | } | |
863 | ||
864 | session->pollfds = g_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources); | |
865 | session->sources = g_realloc(session->sources, sizeof(struct source) * session->num_sources); | |
866 | ||
867 | return SR_OK; | |
868 | } | |
869 | ||
870 | /** | |
871 | * Remove the source belonging to the specified file descriptor. | |
872 | * | |
873 | * @param session The session to use. Must not be NULL. | |
874 | * @param fd The file descriptor for which the source should be removed. | |
875 | * | |
876 | * @retval SR_OK Success | |
877 | * @retval SR_ERR_ARG Invalid argument | |
878 | * @retval SR_ERR_BUG Internal error. | |
879 | * | |
880 | * @since 0.3.0 | |
881 | */ | |
882 | SR_API int sr_session_source_remove(struct sr_session *session, int fd) | |
883 | { | |
884 | return _sr_session_source_remove(session, (gintptr)fd); | |
885 | } | |
886 | ||
887 | /** | |
888 | * Remove the source belonging to the specified poll descriptor. | |
889 | * | |
890 | * @param session The session to use. Must not be NULL. | |
891 | * @param pollfd The poll descriptor for which the source should be removed. | |
892 | * | |
893 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or | |
894 | * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon | |
895 | * internal errors. | |
896 | * | |
897 | * @since 0.2.0 | |
898 | */ | |
899 | SR_API int sr_session_source_remove_pollfd(struct sr_session *session, | |
900 | GPollFD *pollfd) | |
901 | { | |
902 | return _sr_session_source_remove(session, (gintptr)pollfd); | |
903 | } | |
904 | ||
905 | /** | |
906 | * Remove the source belonging to the specified channel. | |
907 | * | |
908 | * @param session The session to use. Must not be NULL. | |
909 | * @param channel The channel for which the source should be removed. | |
910 | * | |
911 | * @retval SR_OK Success. | |
912 | * @retval SR_ERR_ARG Invalid argument. | |
913 | * @return SR_ERR_BUG Internal error. | |
914 | * | |
915 | * @since 0.2.0 | |
916 | */ | |
917 | SR_API int sr_session_source_remove_channel(struct sr_session *session, | |
918 | GIOChannel *channel) | |
919 | { | |
920 | return _sr_session_source_remove(session, (gintptr)channel); | |
921 | } | |
922 | ||
923 | static void *copy_src(struct sr_config *src) | |
924 | { | |
925 | struct sr_config *new_src; | |
926 | ||
927 | new_src = g_malloc(sizeof(struct sr_config)); | |
928 | memcpy(new_src, src, sizeof(struct sr_config)); | |
929 | g_variant_ref(src->data); | |
930 | ||
931 | return new_src; | |
932 | } | |
933 | ||
934 | SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet, | |
935 | struct sr_datafeed_packet **copy) | |
936 | { | |
937 | const struct sr_datafeed_meta *meta; | |
938 | struct sr_datafeed_meta *meta_copy; | |
939 | const struct sr_datafeed_logic *logic; | |
940 | struct sr_datafeed_logic *logic_copy; | |
941 | const struct sr_datafeed_analog *analog; | |
942 | struct sr_datafeed_analog *analog_copy; | |
943 | uint8_t *payload; | |
944 | ||
945 | *copy = g_malloc0(sizeof(struct sr_datafeed_packet)); | |
946 | (*copy)->type = packet->type; | |
947 | ||
948 | switch (packet->type) { | |
949 | case SR_DF_TRIGGER: | |
950 | case SR_DF_END: | |
951 | /* No payload. */ | |
952 | break; | |
953 | case SR_DF_HEADER: | |
954 | payload = g_malloc(sizeof(struct sr_datafeed_header)); | |
955 | memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header)); | |
956 | (*copy)->payload = payload; | |
957 | break; | |
958 | case SR_DF_META: | |
959 | meta = packet->payload; | |
960 | meta_copy = g_malloc(sizeof(struct sr_datafeed_meta)); | |
961 | meta_copy->config = g_slist_copy_deep(meta->config, | |
962 | (GCopyFunc)copy_src, NULL); | |
963 | (*copy)->payload = meta_copy; | |
964 | break; | |
965 | case SR_DF_LOGIC: | |
966 | logic = packet->payload; | |
967 | logic_copy = g_malloc(sizeof(logic)); | |
968 | logic_copy->length = logic->length; | |
969 | logic_copy->unitsize = logic->unitsize; | |
970 | memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize); | |
971 | (*copy)->payload = logic_copy; | |
972 | break; | |
973 | case SR_DF_ANALOG: | |
974 | analog = packet->payload; | |
975 | analog_copy = g_malloc(sizeof(analog)); | |
976 | analog_copy->channels = g_slist_copy(analog->channels); | |
977 | analog_copy->num_samples = analog->num_samples; | |
978 | analog_copy->mq = analog->mq; | |
979 | analog_copy->unit = analog->unit; | |
980 | analog_copy->mqflags = analog->mqflags; | |
981 | memcpy(analog_copy->data, analog->data, | |
982 | analog->num_samples * sizeof(float)); | |
983 | (*copy)->payload = analog_copy; | |
984 | break; | |
985 | default: | |
986 | sr_err("Unknown packet type %d", packet->type); | |
987 | return SR_ERR; | |
988 | } | |
989 | ||
990 | return SR_OK; | |
991 | } | |
992 | ||
993 | void sr_packet_free(struct sr_datafeed_packet *packet) | |
994 | { | |
995 | const struct sr_datafeed_meta *meta; | |
996 | const struct sr_datafeed_logic *logic; | |
997 | const struct sr_datafeed_analog *analog; | |
998 | struct sr_config *src; | |
999 | GSList *l; | |
1000 | ||
1001 | switch (packet->type) { | |
1002 | case SR_DF_TRIGGER: | |
1003 | case SR_DF_END: | |
1004 | /* No payload. */ | |
1005 | break; | |
1006 | case SR_DF_HEADER: | |
1007 | /* Payload is a simple struct. */ | |
1008 | g_free((void *)packet->payload); | |
1009 | break; | |
1010 | case SR_DF_META: | |
1011 | meta = packet->payload; | |
1012 | for (l = meta->config; l; l = l->next) { | |
1013 | src = l->data; | |
1014 | g_variant_unref(src->data); | |
1015 | g_free(src); | |
1016 | } | |
1017 | g_slist_free(meta->config); | |
1018 | g_free((void *)packet->payload); | |
1019 | break; | |
1020 | case SR_DF_LOGIC: | |
1021 | logic = packet->payload; | |
1022 | g_free(logic->data); | |
1023 | g_free((void *)packet->payload); | |
1024 | break; | |
1025 | case SR_DF_ANALOG: | |
1026 | analog = packet->payload; | |
1027 | g_slist_free(analog->channels); | |
1028 | g_free(analog->data); | |
1029 | g_free((void *)packet->payload); | |
1030 | break; | |
1031 | default: | |
1032 | sr_err("Unknown packet type %d", packet->type); | |
1033 | } | |
1034 | g_free(packet); | |
1035 | ||
1036 | } | |
1037 | ||
1038 | /** @} */ |