2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2015 Daniel Elstner <daniel.kitta@gmail.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
32 #define LOG_PREFIX "session"
38 * Creating, using, or destroying libsigrok sessions.
42 * @defgroup grp_session Session handling
44 * Creating, using, or destroying libsigrok sessions.
49 struct datafeed_callback {
50 sr_datafeed_callback cb;
54 /** Custom GLib event source for generic descriptor I/O.
55 * @see https://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.html
64 /* Meta-data needed to keep track of installed sources */
65 struct sr_session *session;
71 /** FD event source prepare() method.
72 * This is called immediately before poll().
74 static gboolean fd_source_prepare(GSource *source, int *timeout)
77 struct fd_source *fsource;
80 fsource = (struct fd_source *)source;
82 if (fsource->timeout_us >= 0) {
83 now_us = g_source_get_time(source);
85 if (fsource->due_us == 0) {
86 /* First-time initialization of the expiration time */
87 fsource->due_us = now_us + fsource->timeout_us;
89 remaining_ms = (MAX(0, fsource->due_us - now_us) + 999) / 1000;
93 *timeout = remaining_ms;
95 return (remaining_ms == 0);
98 /** FD event source check() method.
99 * This is called after poll() returns to check whether an event fired.
101 static gboolean fd_source_check(GSource *source)
103 struct fd_source *fsource;
104 unsigned int revents;
106 fsource = (struct fd_source *)source;
107 revents = fsource->pollfd.revents;
109 return (revents != 0 || (fsource->timeout_us >= 0
110 && fsource->due_us <= g_source_get_time(source)));
113 /** FD event source dispatch() method.
114 * This is called if either prepare() or check() returned TRUE.
116 static gboolean fd_source_dispatch(GSource *source,
117 GSourceFunc callback, void *user_data)
119 struct fd_source *fsource;
120 unsigned int revents;
123 fsource = (struct fd_source *)source;
124 revents = fsource->pollfd.revents;
127 sr_err("Callback not set, cannot dispatch event.");
128 return G_SOURCE_REMOVE;
130 keep = (*(sr_receive_data_callback)callback)
131 (fsource->pollfd.fd, revents, user_data);
133 if (fsource->timeout_us >= 0 && G_LIKELY(keep)
134 && G_LIKELY(!g_source_is_destroyed(source)))
135 fsource->due_us = g_source_get_time(source)
136 + fsource->timeout_us;
140 /** FD event source finalize() method.
142 static void fd_source_finalize(GSource *source)
144 struct fd_source *fsource;
146 fsource = (struct fd_source *)source;
148 sr_dbg("%s: key %p", __func__, fsource->key);
150 sr_session_source_destroyed(fsource->session, fsource->key, source);
153 /** Create an event source for I/O on a file descriptor.
155 * In order to maintain API compatibility, this event source also doubles
156 * as a timer event source.
158 * @param session The session the event source belongs to.
159 * @param key The key used to identify this source.
160 * @param fd The file descriptor or HANDLE.
161 * @param timeout_ms The timeout interval in ms, or -1 to wait indefinitely.
162 * @return A new event source object, or NULL on failure.
164 static GSource *fd_source_new(struct sr_session *session, void *key,
165 gintptr fd, int events, int timeout_ms)
167 static GSourceFuncs fd_source_funcs = {
168 .prepare = &fd_source_prepare,
169 .check = &fd_source_check,
170 .dispatch = &fd_source_dispatch,
171 .finalize = &fd_source_finalize
174 struct fd_source *fsource;
176 source = g_source_new(&fd_source_funcs, sizeof(struct fd_source));
177 fsource = (struct fd_source *)source;
179 g_source_set_name(source, (fd < 0) ? "timer" : "fd");
181 if (timeout_ms >= 0) {
182 fsource->timeout_us = 1000 * (int64_t)timeout_ms;
185 fsource->timeout_us = -1;
186 fsource->due_us = INT64_MAX;
188 fsource->session = session;
191 fsource->pollfd.fd = fd;
192 fsource->pollfd.events = events;
193 fsource->pollfd.revents = 0;
196 g_source_add_poll(source, &fsource->pollfd);
202 * Create a new session.
204 * @param ctx The context in which to create the new session.
205 * @param new_session This will contain a pointer to the newly created
206 * session if the return value is SR_OK, otherwise the value
207 * is undefined and should not be used. Must not be NULL.
209 * @retval SR_OK Success.
210 * @retval SR_ERR_ARG Invalid argument.
214 SR_API int sr_session_new(struct sr_context *ctx,
215 struct sr_session **new_session)
217 struct sr_session *session;
222 session = g_malloc0(sizeof(struct sr_session));
226 g_mutex_init(&session->main_mutex);
228 /* To maintain API compatibility, we need a lookup table
229 * which maps poll_object IDs to GSource* pointers.
231 session->event_sources = g_hash_table_new(NULL, NULL);
233 *new_session = session;
240 * This frees up all memory used by the session.
242 * @param session The session to destroy. Must not be NULL.
244 * @retval SR_OK Success.
245 * @retval SR_ERR_ARG Invalid session passed.
249 SR_API int sr_session_destroy(struct sr_session *session)
252 sr_err("%s: session was NULL", __func__);
256 sr_session_dev_remove_all(session);
257 g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
259 g_hash_table_unref(session->event_sources);
261 g_mutex_clear(&session->main_mutex);
269 * Remove all the devices from a session.
271 * The session itself (i.e., the struct sr_session) is not free'd and still
272 * exists after this function returns.
274 * @param session The session to use. Must not be NULL.
276 * @retval SR_OK Success.
277 * @retval SR_ERR_BUG Invalid session passed.
281 SR_API int sr_session_dev_remove_all(struct sr_session *session)
283 struct sr_dev_inst *sdi;
287 sr_err("%s: session was NULL", __func__);
291 for (l = session->devs; l; l = l->next) {
292 sdi = (struct sr_dev_inst *) l->data;
296 g_slist_free(session->devs);
297 session->devs = NULL;
303 * Add a device instance to a session.
305 * @param session The session to add to. Must not be NULL.
306 * @param sdi The device instance to add to a session. Must not
307 * be NULL. Also, sdi->driver and sdi->driver->dev_open must
310 * @retval SR_OK Success.
311 * @retval SR_ERR_ARG Invalid argument.
315 SR_API int sr_session_dev_add(struct sr_session *session,
316 struct sr_dev_inst *sdi)
321 sr_err("%s: sdi was NULL", __func__);
326 sr_err("%s: session was NULL", __func__);
330 /* If sdi->session is not NULL, the device is already in this or
331 * another session. */
333 sr_err("%s: already assigned to session", __func__);
337 /* If sdi->driver is NULL, this is a virtual device. */
339 /* Just add the device, don't run dev_open(). */
340 session->devs = g_slist_append(session->devs, sdi);
341 sdi->session = session;
345 /* sdi->driver is non-NULL (i.e. we have a real device). */
346 if (!sdi->driver->dev_open) {
347 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
351 session->devs = g_slist_append(session->devs, sdi);
352 sdi->session = session;
354 /* TODO: This is invalid if the session runs in a different thread.
355 * The usage semantics and restrictions need to be documented.
357 if (session->running) {
358 /* Adding a device to a running session. Commit settings
359 * and start acquisition on that device now. */
360 if ((ret = sr_config_commit(sdi)) != SR_OK) {
361 sr_err("Failed to commit device settings before "
362 "starting acquisition in running session (%s)",
366 if ((ret = sdi->driver->dev_acquisition_start(sdi,
368 sr_err("Failed to start acquisition of device in "
369 "running session (%s)", sr_strerror(ret));
378 * List all device instances attached to a session.
380 * @param session The session to use. Must not be NULL.
381 * @param devlist A pointer where the device instance list will be
382 * stored on return. If no devices are in the session,
383 * this will be NULL. Each element in the list points
384 * to a struct sr_dev_inst *.
385 * The list must be freed by the caller, but not the
386 * elements pointed to.
388 * @retval SR_OK Success.
389 * @retval SR_ERR_ARG Invalid argument.
393 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist)
401 *devlist = g_slist_copy(session->devs);
407 * Remove all datafeed callbacks in a session.
409 * @param session The session to use. Must not be NULL.
411 * @retval SR_OK Success.
412 * @retval SR_ERR_ARG Invalid session passed.
416 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session)
419 sr_err("%s: session was NULL", __func__);
423 g_slist_free_full(session->datafeed_callbacks, g_free);
424 session->datafeed_callbacks = NULL;
430 * Add a datafeed callback to a session.
432 * @param session The session to use. Must not be NULL.
433 * @param cb Function to call when a chunk of data is received.
435 * @param cb_data Opaque pointer passed in by the caller.
437 * @retval SR_OK Success.
438 * @retval SR_ERR_BUG No session exists.
442 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
443 sr_datafeed_callback cb, void *cb_data)
445 struct datafeed_callback *cb_struct;
448 sr_err("%s: session was NULL", __func__);
453 sr_err("%s: cb was NULL", __func__);
457 cb_struct = g_malloc0(sizeof(struct datafeed_callback));
459 cb_struct->cb_data = cb_data;
461 session->datafeed_callbacks =
462 g_slist_append(session->datafeed_callbacks, cb_struct);
468 * Get the trigger assigned to this session.
470 * @param session The session to use.
472 * @retval NULL Invalid (NULL) session was passed to the function.
473 * @retval other The trigger assigned to this session (can be NULL).
477 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session)
482 return session->trigger;
486 * Set the trigger of this session.
488 * @param session The session to use. Must not be NULL.
489 * @param trig The trigger to assign to this session. Can be NULL.
491 * @retval SR_OK Success.
492 * @retval SR_ERR_ARG Invalid argument.
496 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
501 session->trigger = trig;
506 static int verify_trigger(struct sr_trigger *trigger)
508 struct sr_trigger_stage *stage;
509 struct sr_trigger_match *match;
512 if (!trigger->stages) {
513 sr_err("No trigger stages defined.");
517 sr_spew("Checking trigger:");
518 for (l = trigger->stages; l; l = l->next) {
520 if (!stage->matches) {
521 sr_err("Stage %d has no matches defined.", stage->stage);
524 for (m = stage->matches; m; m = m->next) {
526 if (!match->channel) {
527 sr_err("Stage %d match has no channel.", stage->stage);
531 sr_err("Stage %d match is not defined.", stage->stage);
534 sr_spew("Stage %d match on channel %s, match %d", stage->stage,
535 match->channel->name, match->match);
542 /** Set up the main context the session will be executing in.
544 * Must be called just before the session starts, by the thread which
545 * will execute the session main loop. Once acquired, the main context
546 * pointer is immutable for the duration of the session run.
548 static int set_main_context(struct sr_session *session)
550 GMainContext *main_context;
552 g_mutex_lock(&session->main_mutex);
554 /* May happen if sr_session_start() is called a second time
555 * while the session is still running.
557 if (session->main_context) {
558 sr_err("Main context already set.");
560 g_mutex_unlock(&session->main_mutex);
563 main_context = g_main_context_ref_thread_default();
565 * Try to use an existing main context if possible, but only if we
566 * can make it owned by the current thread. Otherwise, create our
567 * own main context so that event source callbacks can execute in
568 * the session thread.
570 if (g_main_context_acquire(main_context)) {
571 g_main_context_release(main_context);
573 sr_dbg("Using thread-default main context.");
575 g_main_context_unref(main_context);
577 sr_dbg("Creating our own main context.");
578 main_context = g_main_context_new();
580 session->main_context = main_context;
582 g_mutex_unlock(&session->main_mutex);
587 /** Unset the main context used for the current session run.
589 * Must be called right after stopping the session. Note that if the
590 * session is stopped asynchronously, the main loop may still be running
591 * after the main context has been unset. This is OK as long as no new
592 * event sources are created -- the main loop holds its own reference
593 * to the main context.
595 static int unset_main_context(struct sr_session *session)
599 g_mutex_lock(&session->main_mutex);
601 if (session->main_context) {
602 g_main_context_unref(session->main_context);
603 session->main_context = NULL;
606 /* May happen if the set/unset calls are not matched.
608 sr_err("No main context to unset.");
611 g_mutex_unlock(&session->main_mutex);
616 static unsigned int session_source_attach(struct sr_session *session,
621 g_mutex_lock(&session->main_mutex);
623 if (session->main_context)
624 id = g_source_attach(source, session->main_context);
626 sr_err("Cannot add event source without main context.");
628 g_mutex_unlock(&session->main_mutex);
633 /* Idle handler; invoked when the number of registered event sources
634 * for a running session drops to zero.
636 static gboolean delayed_stop_check(void *data)
638 struct sr_session *session;
641 session->stop_check_id = 0;
643 /* Session already ended? */
644 if (!session->running)
645 return G_SOURCE_REMOVE;
647 /* New event sources may have been installed in the meantime. */
648 if (g_hash_table_size(session->event_sources) != 0)
649 return G_SOURCE_REMOVE;
651 session->running = FALSE;
652 unset_main_context(session);
656 /* This indicates a bug in user code, since it is not valid to
657 * restart or destroy a session while it may still be running.
659 if (!session->main_loop && !session->stopped_callback) {
660 sr_err("BUG: Session stop left unhandled.");
661 return G_SOURCE_REMOVE;
663 if (session->main_loop)
664 g_main_loop_quit(session->main_loop);
666 if (session->stopped_callback)
667 (*session->stopped_callback)(session->stopped_cb_data);
669 return G_SOURCE_REMOVE;
672 static int stop_check_later(struct sr_session *session)
675 unsigned int source_id;
677 if (session->stop_check_id != 0)
678 return SR_OK; /* idle handler already installed */
680 source = g_idle_source_new();
681 g_source_set_callback(source, &delayed_stop_check, session, NULL);
683 source_id = session_source_attach(session, source);
684 session->stop_check_id = source_id;
686 g_source_unref(source);
688 return (source_id != 0) ? SR_OK : SR_ERR;
694 * When this function returns with a status code indicating success, the
695 * session is running. Use sr_session_stopped_callback_set() to receive
696 * notification upon completion, or call sr_session_run() to block until
699 * Session events will be processed in the context of the current thread.
700 * If a thread-default GLib main context has been set, and is not owned by
701 * any other thread, it will be used. Otherwise, libsigrok will create its
702 * own main context for the current thread.
704 * @param session The session to use. Must not be NULL.
706 * @retval SR_OK Success.
707 * @retval SR_ERR_ARG Invalid session passed.
708 * @retval SR_ERR Other error.
712 SR_API int sr_session_start(struct sr_session *session)
714 struct sr_dev_inst *sdi;
715 struct sr_channel *ch;
716 GSList *l, *c, *lend;
720 sr_err("%s: session was NULL", __func__);
724 if (!session->devs) {
725 sr_err("%s: session->devs was NULL; a session "
726 "cannot be started without devices.", __func__);
730 if (session->running) {
731 sr_err("Cannot (re-)start session while it is still running.");
735 if (session->trigger) {
736 ret = verify_trigger(session->trigger);
741 /* Check enabled channels and commit settings of all devices. */
742 for (l = session->devs; l; l = l->next) {
744 for (c = sdi->channels; c; c = c->next) {
750 sr_err("%s device %s has no enabled channels.",
751 sdi->driver->name, sdi->connection_id);
755 ret = sr_config_commit(sdi);
757 sr_err("Failed to commit %s device %s settings "
758 "before starting acquisition.",
759 sdi->driver->name, sdi->connection_id);
764 ret = set_main_context(session);
768 sr_info("Starting.");
770 session->running = TRUE;
772 /* Have all devices start acquisition. */
773 for (l = session->devs; l; l = l->next) {
775 ret = sdi->driver->dev_acquisition_start(sdi, sdi);
777 sr_err("Could not start %s device %s acquisition.",
778 sdi->driver->name, sdi->connection_id);
784 /* If there are multiple devices, some of them may already have
785 * started successfully. Stop them now before returning. */
787 for (l = session->devs; l != lend; l = l->next) {
789 if (sdi->driver->dev_acquisition_stop)
790 sdi->driver->dev_acquisition_stop(sdi, sdi);
792 /* TODO: Handle delayed stops. Need to iterate the event
794 session->running = FALSE;
796 unset_main_context(session);
800 if (g_hash_table_size(session->event_sources) == 0)
801 stop_check_later(session);
807 * Block until the running session stops.
809 * This is a convenience function which creates a GLib main loop and runs
810 * it to process session events until the session stops.
812 * Instead of using this function, applications may run their own GLib main
813 * loop, and use sr_session_stopped_callback_set() to receive notification
814 * when the session finished running.
816 * @param session The session to use. Must not be NULL.
818 * @retval SR_OK Success.
819 * @retval SR_ERR_ARG Invalid session passed.
820 * @retval SR_ERR Other error.
824 SR_API int sr_session_run(struct sr_session *session)
827 sr_err("%s: session was NULL", __func__);
830 if (!session->running) {
831 sr_err("No session running.");
834 if (session->main_loop) {
835 sr_err("Main loop already created.");
839 g_mutex_lock(&session->main_mutex);
841 if (!session->main_context) {
842 sr_err("Cannot run without main context.");
843 g_mutex_unlock(&session->main_mutex);
846 session->main_loop = g_main_loop_new(session->main_context, FALSE);
848 g_mutex_unlock(&session->main_mutex);
850 g_main_loop_run(session->main_loop);
852 g_main_loop_unref(session->main_loop);
853 session->main_loop = NULL;
858 static gboolean session_stop_sync(void *user_data)
860 struct sr_session *session;
861 struct sr_dev_inst *sdi;
866 if (!session->running)
867 return G_SOURCE_REMOVE;
869 sr_info("Stopping.");
871 for (node = session->devs; node; node = node->next) {
873 if (sdi->driver && sdi->driver->dev_acquisition_stop)
874 sdi->driver->dev_acquisition_stop(sdi, sdi);
877 return G_SOURCE_REMOVE;
883 * This requests the drivers of each device participating in the session to
884 * abort the acquisition as soon as possible. Even after this function returns,
885 * event processing still continues until all devices have actually stopped.
887 * Use sr_session_stopped_callback_set() to receive notification when the event
888 * processing finished.
890 * This function is reentrant. That is, it may be called from a different
891 * thread than the one executing the session, as long as it can be ensured
892 * that the session object is valid.
894 * If the session is not running, sr_session_stop() silently does nothing.
896 * @param session The session to use. Must not be NULL.
898 * @retval SR_OK Success.
899 * @retval SR_ERR_ARG Invalid session passed.
903 SR_API int sr_session_stop(struct sr_session *session)
905 GMainContext *main_context;
908 sr_err("%s: session was NULL", __func__);
912 g_mutex_lock(&session->main_mutex);
914 main_context = (session->main_context)
915 ? g_main_context_ref(session->main_context)
918 g_mutex_unlock(&session->main_mutex);
921 sr_dbg("No main context set; already stopped?");
922 /* Not an error; as it would be racy. */
925 g_main_context_invoke(main_context, &session_stop_sync, session);
926 g_main_context_unref(main_context);
932 * Return whether the session is currently running.
934 * Note that this function should be called from the same thread
935 * the session was started in.
937 * @param session The session to use. Must not be NULL.
939 * @retval TRUE Session is running.
940 * @retval FALSE Session is not running.
941 * @retval SR_ERR_ARG Invalid session passed.
945 SR_API int sr_session_is_running(struct sr_session *session)
948 sr_err("%s: session was NULL", __func__);
951 return session->running;
955 * Set the callback to be invoked after a session stopped running.
957 * Install a callback to receive notification when a session run stopped.
958 * This can be used to integrate session execution with an existing main
959 * loop, without having to block in sr_session_run().
961 * Note that the callback will be invoked in the context of the thread
962 * that calls sr_session_start().
964 * @param session The session to use. Must not be NULL.
965 * @param cb The callback to invoke on session stop. May be NULL to unset.
966 * @param cb_data User data pointer to be passed to the callback.
968 * @retval SR_OK Success.
969 * @retval SR_ERR_ARG Invalid session passed.
973 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
974 sr_session_stopped_callback cb, void *cb_data)
977 sr_err("%s: session was NULL", __func__);
980 session->stopped_callback = cb;
981 session->stopped_cb_data = cb_data;
989 * @param packet The packet to show debugging information for.
991 static void datafeed_dump(const struct sr_datafeed_packet *packet)
993 const struct sr_datafeed_logic *logic;
994 const struct sr_datafeed_analog_old *analog_old;
995 const struct sr_datafeed_analog *analog;
997 /* Please use the same order as in libsigrok.h. */
998 switch (packet->type) {
1000 sr_dbg("bus: Received SR_DF_HEADER packet.");
1003 sr_dbg("bus: Received SR_DF_END packet.");
1006 sr_dbg("bus: Received SR_DF_META packet.");
1009 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
1012 logic = packet->payload;
1013 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
1014 "unitsize = %d).", logic->length, logic->unitsize);
1016 case SR_DF_ANALOG_OLD:
1017 analog_old = packet->payload;
1018 sr_dbg("bus: Received SR_DF_ANALOG_OLD packet (%d samples).",
1019 analog_old->num_samples);
1021 case SR_DF_FRAME_BEGIN:
1022 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
1024 case SR_DF_FRAME_END:
1025 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
1028 analog = packet->payload;
1029 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
1030 analog->num_samples);
1033 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
1039 * Send a packet to whatever is listening on the datafeed bus.
1041 * Hardware drivers use this to send a data packet to the frontend.
1044 * @param packet The datafeed packet to send to the session bus.
1046 * @retval SR_OK Success.
1047 * @retval SR_ERR_ARG Invalid argument.
1051 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1052 const struct sr_datafeed_packet *packet)
1055 struct datafeed_callback *cb_struct;
1056 struct sr_datafeed_packet *packet_in, *packet_out;
1057 struct sr_transform *t;
1061 sr_err("%s: sdi was NULL", __func__);
1066 sr_err("%s: packet was NULL", __func__);
1070 if (!sdi->session) {
1071 sr_err("%s: session was NULL", __func__);
1075 if (packet->type == SR_DF_ANALOG_OLD) {
1076 /* Convert to SR_DF_ANALOG. */
1077 const struct sr_datafeed_analog_old *analog_old = packet->payload;
1078 struct sr_analog_encoding encoding;
1079 struct sr_analog_meaning meaning;
1080 struct sr_analog_spec spec;
1081 struct sr_datafeed_analog analog;
1082 struct sr_datafeed_packet new_packet;
1083 new_packet.type = SR_DF_ANALOG;
1084 new_packet.payload = &analog;
1085 analog.data = analog_old->data;
1086 analog.num_samples = analog_old->num_samples;
1087 analog.encoding = &encoding;
1088 analog.meaning = &meaning;
1089 analog.spec = &spec;
1090 encoding.unitsize = sizeof(float);
1091 encoding.is_signed = TRUE;
1092 encoding.is_float = TRUE;
1093 #ifdef WORDS_BIGENDIAN
1094 encoding.is_bigendian = TRUE;
1096 encoding.is_bigendian = FALSE;
1098 encoding.digits = 0;
1099 encoding.is_digits_decimal = FALSE;
1100 encoding.scale.p = 1;
1101 encoding.scale.q = 1;
1102 encoding.offset.p = 0;
1103 encoding.offset.q = 1;
1104 meaning.mq = analog_old->mq;
1105 meaning.unit = analog_old->unit;
1106 meaning.mqflags = analog_old->mqflags;
1107 meaning.channels = analog_old->channels;
1108 spec.spec_digits = 0;
1109 return sr_session_send(sdi, &new_packet);
1113 * Pass the packet to the first transform module. If that returns
1114 * another packet (instead of NULL), pass that packet to the next
1115 * transform module in the list, and so on.
1117 packet_in = (struct sr_datafeed_packet *)packet;
1118 for (l = sdi->session->transforms; l; l = l->next) {
1120 sr_spew("Running transform module '%s'.", t->module->id);
1121 ret = t->module->receive(t, packet_in, &packet_out);
1123 sr_err("Error while running transform module: %d.", ret);
1128 * If any of the transforms don't return an output
1131 sr_spew("Transform module didn't return a packet, aborting.");
1135 * Use this transform module's output packet as input
1136 * for the next transform module.
1138 packet_in = packet_out;
1144 * If the last transform did output a packet, pass it to all datafeed
1147 for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
1148 if (sr_log_loglevel_get() >= SR_LOG_DBG)
1149 datafeed_dump(packet);
1150 cb_struct = l->data;
1151 cb_struct->cb(sdi, packet, cb_struct->cb_data);
1158 * Add an event source for a file descriptor.
1160 * @param session The session to use. Must not be NULL.
1161 * @param key The key which identifies the event source.
1162 * @param source An event source object. Must not be NULL.
1164 * @retval SR_OK Success.
1165 * @retval SR_ERR_ARG Invalid argument.
1166 * @retval SR_ERR_BUG Event source with @a key already installed.
1167 * @retval SR_ERR Other error.
1171 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1172 void *key, GSource *source)
1175 * This must not ever happen, since the source has already been
1176 * created and its finalize() method will remove the key for the
1177 * already installed source. (Well it would, if we did not have
1178 * another sanity check there.)
1180 if (g_hash_table_contains(session->event_sources, key)) {
1181 sr_err("Event source with key %p already exists.", key);
1184 g_hash_table_insert(session->event_sources, key, source);
1186 if (session_source_attach(session, source) == 0)
1192 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1193 void *key, gintptr fd, int events, int timeout,
1194 sr_receive_data_callback cb, void *cb_data)
1199 source = fd_source_new(session, key, fd, events, timeout);
1203 g_source_set_callback(source, (GSourceFunc)cb, cb_data, NULL);
1205 ret = sr_session_source_add_internal(session, key, source);
1206 g_source_unref(source);
1212 * Add an event source for a file descriptor.
1214 * @param session The session to use. Must not be NULL.
1215 * @param fd The file descriptor, or a negative value to create a timer source.
1216 * @param events Events to check for.
1217 * @param timeout Max time in ms to wait before the callback is called,
1218 * or -1 to wait indefinitely.
1219 * @param cb Callback function to add. Must not be NULL.
1220 * @param cb_data Data for the callback function. Can be NULL.
1222 * @retval SR_OK Success.
1223 * @retval SR_ERR_ARG Invalid argument.
1228 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1229 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
1231 if (fd < 0 && timeout < 0) {
1232 sr_err("Cannot create timer source without timeout.");
1235 return sr_session_fd_source_add(session, GINT_TO_POINTER(fd),
1236 fd, events, timeout, cb, cb_data);
1240 * Add an event source for a GPollFD.
1242 * @param session The session to use. Must not be NULL.
1243 * @param pollfd The GPollFD. Must not be NULL.
1244 * @param timeout Max time in ms to wait before the callback is called,
1245 * or -1 to wait indefinitely.
1246 * @param cb Callback function to add. Must not be NULL.
1247 * @param cb_data Data for the callback function. Can be NULL.
1249 * @retval SR_OK Success.
1250 * @retval SR_ERR_ARG Invalid argument.
1255 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1256 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1260 sr_err("%s: pollfd was NULL", __func__);
1263 return sr_session_fd_source_add(session, pollfd, pollfd->fd,
1264 pollfd->events, timeout, cb, cb_data);
1268 * Add an event source for a GIOChannel.
1270 * @param session The session to use. Must not be NULL.
1271 * @param channel The GIOChannel.
1272 * @param events Events to poll on.
1273 * @param timeout Max time in ms to wait before the callback is called,
1274 * or -1 to wait indefinitely.
1275 * @param cb Callback function to add. Must not be NULL.
1276 * @param cb_data Data for the callback function. Can be NULL.
1278 * @retval SR_OK Success.
1279 * @retval SR_ERR_ARG Invalid argument.
1284 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1285 GIOChannel *channel, int events, int timeout,
1286 sr_receive_data_callback cb, void *cb_data)
1291 sr_err("%s: channel was NULL", __func__);
1294 /* We should be using g_io_create_watch(), but can't without
1295 * changing the driver API, as the callback signature is different.
1298 g_io_channel_win32_make_pollfd(channel, events, &pollfd);
1300 pollfd.fd = g_io_channel_unix_get_fd(channel);
1301 pollfd.events = events;
1303 return sr_session_fd_source_add(session, channel, pollfd.fd,
1304 pollfd.events, timeout, cb, cb_data);
1308 * Remove the source identified by the specified poll object.
1310 * @param session The session to use. Must not be NULL.
1311 * @param key The key by which the source is identified.
1313 * @retval SR_OK Success
1314 * @retval SR_ERR_BUG No event source for poll_object found.
1318 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1323 source = g_hash_table_lookup(session->event_sources, key);
1325 * Trying to remove an already removed event source is problematic
1326 * since the poll_object handle may have been reused in the meantime.
1329 sr_warn("Cannot remove non-existing event source %p.", key);
1332 g_source_destroy(source);
1338 * Remove the source belonging to the specified file descriptor.
1340 * @param session The session to use. Must not be NULL.
1341 * @param fd The file descriptor for which the source should be removed.
1343 * @retval SR_OK Success
1344 * @retval SR_ERR_ARG Invalid argument
1345 * @retval SR_ERR_BUG Internal error.
1350 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd)
1352 return sr_session_source_remove_internal(session, GINT_TO_POINTER(fd));
1356 * Remove the source belonging to the specified poll descriptor.
1358 * @param session The session to use. Must not be NULL.
1359 * @param pollfd The poll descriptor for which the source should be removed.
1361 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
1362 * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
1368 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1372 sr_err("%s: pollfd was NULL", __func__);
1375 return sr_session_source_remove_internal(session, pollfd);
1379 * Remove the source belonging to the specified channel.
1381 * @param session The session to use. Must not be NULL.
1382 * @param channel The channel for which the source should be removed.
1384 * @retval SR_OK Success.
1385 * @retval SR_ERR_ARG Invalid argument.
1386 * @return SR_ERR_BUG Internal error.
1391 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1392 GIOChannel *channel)
1395 sr_err("%s: channel was NULL", __func__);
1398 return sr_session_source_remove_internal(session, channel);
1401 /** Unregister an event source that has been destroyed.
1403 * This is intended to be called from a source's finalize() method.
1405 * @param session The session to use. Must not be NULL.
1406 * @param key The key used to identify @a source.
1407 * @param source The source object that was destroyed.
1409 * @retval SR_OK Success.
1410 * @retval SR_ERR_BUG Event source for @a key does not match @a source.
1411 * @retval SR_ERR Other error.
1415 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1416 void *key, GSource *source)
1418 GSource *registered_source;
1420 registered_source = g_hash_table_lookup(session->event_sources, key);
1422 * Trying to remove an already removed event source is problematic
1423 * since the poll_object handle may have been reused in the meantime.
1425 if (!registered_source) {
1426 sr_err("No event source for key %p found.", key);
1429 if (registered_source != source) {
1430 sr_err("Event source for key %p does not match"
1431 " destroyed source.", key);
1434 g_hash_table_remove(session->event_sources, key);
1436 if (g_hash_table_size(session->event_sources) > 0)
1439 /* If no event sources are left, consider the acquisition finished.
1440 * This is pretty crude, as it requires all event sources to be
1441 * registered via the libsigrok API.
1443 return stop_check_later(session);
1446 static void copy_src(struct sr_config *src, struct sr_datafeed_meta *meta_copy)
1448 g_variant_ref(src->data);
1449 meta_copy->config = g_slist_append(meta_copy->config,
1450 g_memdup(src, sizeof(struct sr_config)));
1453 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
1454 struct sr_datafeed_packet **copy)
1456 const struct sr_datafeed_meta *meta;
1457 struct sr_datafeed_meta *meta_copy;
1458 const struct sr_datafeed_logic *logic;
1459 struct sr_datafeed_logic *logic_copy;
1460 const struct sr_datafeed_analog_old *analog_old;
1461 struct sr_datafeed_analog_old *analog_old_copy;
1462 const struct sr_datafeed_analog *analog;
1463 struct sr_datafeed_analog *analog_copy;
1466 *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
1467 (*copy)->type = packet->type;
1469 switch (packet->type) {
1475 payload = g_malloc(sizeof(struct sr_datafeed_header));
1476 memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
1477 (*copy)->payload = payload;
1480 meta = packet->payload;
1481 meta_copy = g_malloc0(sizeof(struct sr_datafeed_meta));
1482 g_slist_foreach(meta->config, (GFunc)copy_src, meta_copy->config);
1483 (*copy)->payload = meta_copy;
1486 logic = packet->payload;
1487 logic_copy = g_malloc(sizeof(logic));
1488 logic_copy->length = logic->length;
1489 logic_copy->unitsize = logic->unitsize;
1490 memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
1491 (*copy)->payload = logic_copy;
1493 case SR_DF_ANALOG_OLD:
1494 analog_old = packet->payload;
1495 analog_old_copy = g_malloc(sizeof(analog_old));
1496 analog_old_copy->channels = g_slist_copy(analog_old->channels);
1497 analog_old_copy->num_samples = analog_old->num_samples;
1498 analog_old_copy->mq = analog_old->mq;
1499 analog_old_copy->unit = analog_old->unit;
1500 analog_old_copy->mqflags = analog_old->mqflags;
1501 analog_old_copy->data = g_malloc(analog_old->num_samples * sizeof(float));
1502 memcpy(analog_old_copy->data, analog_old->data,
1503 analog_old->num_samples * sizeof(float));
1504 (*copy)->payload = analog_old_copy;
1507 analog = packet->payload;
1508 analog_copy = g_malloc(sizeof(analog));
1509 analog_copy->data = g_malloc(
1510 analog->encoding->unitsize * analog->num_samples);
1511 memcpy(analog_copy->data, analog->data,
1512 analog->encoding->unitsize * analog->num_samples);
1513 analog_copy->num_samples = analog->num_samples;
1514 analog_copy->encoding = g_memdup(analog->encoding,
1515 sizeof(struct sr_analog_encoding));
1516 analog_copy->meaning = g_memdup(analog->meaning,
1517 sizeof(struct sr_analog_meaning));
1518 analog_copy->meaning->channels = g_slist_copy(
1519 analog->meaning->channels);
1520 analog_copy->spec = g_memdup(analog->spec,
1521 sizeof(struct sr_analog_spec));
1522 (*copy)->payload = analog_copy;
1525 sr_err("Unknown packet type %d", packet->type);
1532 void sr_packet_free(struct sr_datafeed_packet *packet)
1534 const struct sr_datafeed_meta *meta;
1535 const struct sr_datafeed_logic *logic;
1536 const struct sr_datafeed_analog_old *analog_old;
1537 const struct sr_datafeed_analog *analog;
1538 struct sr_config *src;
1541 switch (packet->type) {
1547 /* Payload is a simple struct. */
1548 g_free((void *)packet->payload);
1551 meta = packet->payload;
1552 for (l = meta->config; l; l = l->next) {
1554 g_variant_unref(src->data);
1557 g_slist_free(meta->config);
1558 g_free((void *)packet->payload);
1561 logic = packet->payload;
1562 g_free(logic->data);
1563 g_free((void *)packet->payload);
1565 case SR_DF_ANALOG_OLD:
1566 analog_old = packet->payload;
1567 g_slist_free(analog_old->channels);
1568 g_free(analog_old->data);
1569 g_free((void *)packet->payload);
1572 analog = packet->payload;
1573 g_free(analog->data);
1574 g_free(analog->encoding);
1575 g_slist_free(analog->meaning->channels);
1576 g_free(analog->meaning);
1577 g_free(analog->spec);
1578 g_free((void *)packet->payload);
1581 sr_err("Unknown packet type %d", packet->type);