]> sigrok.org Git - libsigrok.git/blobdiff - session.c
Add new triggering framework.
[libsigrok.git] / session.c
index 9130aa678f6bab62fb0d2a8bff816f3855f56659..742619a684272115729d428679794ce7b62c672c 100644 (file)
--- a/session.c
+++ b/session.c
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with subsystem-specific prefix string. */
-#define LOG_PREFIX "session: "
-#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
-#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
-#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
-#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
-#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
-#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
+/** @cond PRIVATE */
+#define LOG_PREFIX "session"
+/** @endcond */
 
 /**
  * @file
@@ -50,7 +45,7 @@
 
 struct source {
        int timeout;
-       sr_receive_data_callback_t cb;
+       sr_receive_data_callback cb;
        void *cb_data;
 
        /* This is used to keep track of the object (fd, pollfd or channel) which is
@@ -60,7 +55,7 @@ struct source {
 };
 
 struct datafeed_callback {
-       sr_datafeed_callback_t cb;
+       sr_datafeed_callback cb;
        void *cb_data;
 };
 
@@ -76,6 +71,8 @@ struct sr_session *session;
  *
  * @retval NULL Error.
  * @retval other A pointer to the newly allocated session.
+ *
+ * @since 0.1.0
  */
 SR_API struct sr_session *sr_session_new(void)
 {
@@ -98,6 +95,8 @@ SR_API struct sr_session *sr_session_new(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_destroy(void)
 {
@@ -126,6 +125,8 @@ SR_API int sr_session_destroy(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_dev_remove_all(void)
 {
@@ -150,6 +151,8 @@ SR_API int sr_session_dev_remove_all(void)
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
 {
@@ -183,12 +186,20 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
        session->devs = g_slist_append(session->devs, (gpointer)sdi);
 
        if (session->running) {
-               /* Adding a device to a running session. Start acquisition
-                * on that device now. */
+               /* Adding a device to a running session. Commit settings
+                * and start acquisition on that device now. */
+               if ((ret = sr_config_commit(sdi)) != SR_OK) {
+                       sr_err("Failed to commit device settings before "
+                              "starting acquisition in running session (%s)",
+                              sr_strerror(ret));
+                       return ret;
+               }
                if ((ret = sdi->driver->dev_acquisition_start(sdi,
-                                               (void *)sdi)) != SR_OK)
+                                               (void *)sdi)) != SR_OK) {
                        sr_err("Failed to start acquisition of device in "
-                                       "running session: %d", ret);
+                              "running session (%s)", sr_strerror(ret));
+                       return ret;
+               }
        }
 
        return SR_OK;
@@ -206,6 +217,8 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR Invalid argument.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_dev_list(GSList **devlist)
 {
@@ -225,6 +238,8 @@ SR_API int sr_session_dev_list(GSList **devlist)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_datafeed_callback_remove_all(void)
 {
@@ -248,8 +263,10 @@ SR_API int sr_session_datafeed_callback_remove_all(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.3.0
  */
-SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_data)
 {
        struct datafeed_callback *cb_struct;
 
@@ -275,6 +292,18 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_
        return SR_OK;
 }
 
+SR_PRIV struct sr_trigger *sr_session_trigger_get(void)
+{
+       return session->trigger;
+}
+
+SR_API int sr_session_trigger_set(struct sr_trigger *trig)
+{
+       session->trigger = trig;
+
+       return SR_OK;
+}
+
 /**
  * Call every device in the session's callback.
  *
@@ -330,6 +359,42 @@ static int sr_session_iteration(gboolean block)
        return SR_OK;
 }
 
+
+static int verify_trigger(struct sr_trigger *trigger)
+{
+       struct sr_trigger_stage *stage;
+       struct sr_trigger_match *match;
+       GSList *l, *m;
+
+       if (!trigger->stages) {
+               sr_err("No trigger stages defined.");
+               return SR_ERR;
+       }
+
+       sr_spew("Checking trigger:");
+       for (l = trigger->stages; l; l = l->next) {
+               stage = l->data;
+               if (!stage->matches) {
+                       sr_err("Stage %d has no matches defined.", stage->stage);
+                       return SR_ERR;
+               }
+               for (m = stage->matches; m; m = m->next) {
+                       match = m->data;
+                       if (!match->channel) {
+                               sr_err("Stage %d match has no channel.", stage->stage);
+                               return SR_ERR;
+                       }
+                       if (!match->match) {
+                               sr_err("Stage %d match is not defined.", stage->stage);
+                               return SR_ERR;
+                       }
+                       sr_spew("Stage %d match on channel %s, match %d", stage->stage,
+                                       match->channel->name, match->match);
+               }
+       }
+
+       return SR_OK;
+}
 /**
  * Start a session.
  *
@@ -337,6 +402,8 @@ static int sr_session_iteration(gboolean block)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR Error occured.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_start(void)
 {
@@ -356,11 +423,19 @@ SR_API int sr_session_start(void)
                return SR_ERR_BUG;
        }
 
+       if (session->trigger && verify_trigger(session->trigger) != SR_OK)
+               return SR_ERR;
+
        sr_info("Starting.");
 
        ret = SR_OK;
        for (l = session->devs; l; l = l->next) {
                sdi = l->data;
+               if ((ret = sr_config_commit(sdi)) != SR_OK) {
+                       sr_err("Failed to commit device settings before "
+                              "starting acquisition (%s)", sr_strerror(ret));
+                       break;
+               }
                if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
                        sr_err("%s: could not start an acquisition "
                               "(%s)", __func__, sr_strerror(ret));
@@ -378,6 +453,8 @@ SR_API int sr_session_start(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG Error occured.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_run(void)
 {
@@ -462,6 +539,8 @@ SR_PRIV int sr_session_stop_sync(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_stop(void)
 {
@@ -499,8 +578,8 @@ static void datafeed_dump(const struct sr_datafeed_packet *packet)
                break;
        case SR_DF_LOGIC:
                logic = packet->payload;
-               sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).",
-                      logic->length);
+               sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
+                      "unitsize = %d).", logic->length, logic->unitsize);
                break;
        case SR_DF_ANALOG:
                analog = packet->payload;
@@ -576,7 +655,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
  * @retval SR_ERR_MALLOC Memory allocation error.
  */
 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
-       sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
+       sr_receive_data_callback cb, void *cb_data, gintptr poll_object)
 {
        struct source *new_sources, *s;
        GPollFD *new_pollfds;
@@ -630,9 +709,11 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout,
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_add(int fd, int events, int timeout,
-               sr_receive_data_callback_t cb, void *cb_data)
+               sr_receive_data_callback cb, void *cb_data)
 {
        GPollFD p;
 
@@ -653,9 +734,11 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
-               sr_receive_data_callback_t cb, void *cb_data)
+               sr_receive_data_callback cb, void *cb_data)
 {
        return _sr_session_source_add(pollfd, timeout, cb,
                                      cb_data, (gintptr)pollfd);
@@ -673,9 +756,11 @@ SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
-               int timeout, sr_receive_data_callback_t cb, void *cb_data)
+               int timeout, sr_receive_data_callback cb, void *cb_data)
 {
        GPollFD p;
 
@@ -757,6 +842,8 @@ static int _sr_session_source_remove(gintptr poll_object)
  * @retval SR_ERR_ARG Invalid argument
  * @retval SR_ERR_MALLOC Memory allocation error.
  * @retval SR_ERR_BUG Internal error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_remove(int fd)
 {
@@ -771,6 +858,8 @@ SR_API int sr_session_source_remove(int fd)
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
  *         internal errors.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
 {
@@ -786,6 +875,8 @@ SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
  * @return SR_ERR_BUG Internal error.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
 {