X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=d8a3b00b5efabe157ab546498bee39139b249853;hb=3337e9a1c9e853a57beed80084d1f5ca93e0a3db;hp=9130aa678f6bab62fb0d2a8bff816f3855f56659;hpb=98582bf53f61043e6918be291648f8f6dfb5f6b4;p=libsigrok.git diff --git a/session.c b/session.c index 9130aa67..d8a3b00b 100644 --- a/session.c +++ b/session.c @@ -25,14 +25,9 @@ #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,78 +55,85 @@ struct source { }; struct datafeed_callback { - sr_datafeed_callback_t cb; + sr_datafeed_callback cb; void *cb_data; }; -/* There can only be one session at a time. */ -/* 'session' is not static, it's used elsewhere (via 'extern'). */ -struct sr_session *session; - /** * Create a new session. + * Currently, there can be only one session at a time within the same process. * - * @todo Should it use the file-global "session" variable or take an argument? - * The same question applies to all the other session functions. + * @retval SR_OK Success. + * @retval SR_ERR_BUG A session exists already. * - * @retval NULL Error. - * @retval other A pointer to the newly allocated session. + * @since 0.4.0 */ -SR_API struct sr_session *sr_session_new(void) +SR_API int sr_session_new(struct sr_session **new_session) { - if (!(session = g_try_malloc0(sizeof(struct sr_session)))) { - sr_err("Session malloc failed."); - return NULL; - } + struct sr_session *session; + + session = g_malloc0(sizeof(struct sr_session)); session->source_timeout = -1; session->running = FALSE; session->abort_session = FALSE; g_mutex_init(&session->stop_mutex); - return session; + *new_session = session; + + return SR_OK; } /** - * Destroy the current session. + * Destroy a session. * This frees up all memory used by the session. * * @retval SR_OK Success. - * @retval SR_ERR_BUG No session exists. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_destroy(void) +SR_API int sr_session_destroy(struct sr_session *session) { if (!session) { sr_err("%s: session was NULL", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; } - sr_session_dev_remove_all(); - - /* TODO: Error checks needed? */ - + sr_session_dev_remove_all(session); g_mutex_clear(&session->stop_mutex); + if (session->trigger) + sr_trigger_free(session->trigger); g_free(session); - session = NULL; return SR_OK; } /** - * Remove all the devices from the current session. + * Remove all the devices from a session. * * The session itself (i.e., the struct sr_session) is not free'd and still * exists after this function returns. * * @retval SR_OK Success. - * @retval SR_ERR_BUG No session exists. + * @retval SR_ERR_BUG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_dev_remove_all(void) +SR_API int sr_session_dev_remove_all(struct sr_session *session) { + struct sr_dev_inst *sdi; + GSList *l; + if (!session) { sr_err("%s: session was NULL", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; + } + + for (l = session->devs; l; l = l->next) { + sdi = (struct sr_dev_inst *) l->data; + sdi->session = NULL; } g_slist_free(session->devs); @@ -141,17 +143,19 @@ SR_API int sr_session_dev_remove_all(void) } /** - * Add a device instance to the current session. + * Add a device instance to a session. * - * @param sdi The device instance to add to the current session. Must not + * @param sdi The device instance to add to a session. Must not * be NULL. Also, sdi->driver and sdi->driver->dev_open must * not be NULL. * * @retval SR_OK Success. * @retval SR_ERR_ARG Invalid argument. - * @retval SR_ERR_BUG No session exists. + * + * @since 0.4.0 */ -SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) +SR_API int sr_session_dev_add(struct sr_session *session, + struct sr_dev_inst *sdi) { int ret; @@ -162,7 +166,14 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) if (!session) { sr_err("%s: session was NULL", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; + } + + /* If sdi->session is not NULL, the device is already in this or + * another session. */ + if (sdi->session) { + sr_err("%s: already assigned to session", __func__); + return SR_ERR_ARG; } /* If sdi->driver is NULL, this is a virtual device. */ @@ -171,6 +182,7 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) "a virtual device; continuing", __func__); /* Just add the device, don't run dev_open(). */ session->devs = g_slist_append(session->devs, (gpointer)sdi); + sdi->session = session; return SR_OK; } @@ -181,21 +193,30 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) } session->devs = g_slist_append(session->devs, (gpointer)sdi); + sdi->session = session; 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; } /** - * List all device instances attached to the current session. + * List all device instances attached to a session. * * @param devlist A pointer where the device instance list will be * stored on return. If no devices are in the session, @@ -205,15 +226,17 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi) * elements pointed to. * * @retval SR_OK Success. - * @retval SR_ERR Invalid argument. + * @retval SR_ERR_ARG Invalid argument. + * + * @since 0.4.0 */ -SR_API int sr_session_dev_list(GSList **devlist) +SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist) { - - *devlist = NULL; - if (!session) - return SR_ERR; + return SR_ERR_ARG; + + if (!devlist) + return SR_ERR_ARG; *devlist = g_slist_copy(session->devs); @@ -221,16 +244,18 @@ SR_API int sr_session_dev_list(GSList **devlist) } /** - * Remove all datafeed callbacks in the current session. + * Remove all datafeed callbacks in a session. * * @retval SR_OK Success. - * @retval SR_ERR_BUG No session exists. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_datafeed_callback_remove_all(void) +SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session) { if (!session) { sr_err("%s: session was NULL", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; } g_slist_free_full(session->datafeed_callbacks, g_free); @@ -240,7 +265,7 @@ SR_API int sr_session_datafeed_callback_remove_all(void) } /** - * Add a datafeed callback to the current session. + * Add a datafeed callback to a session. * * @param cb Function to call when a chunk of data is received. * Must not be NULL. @@ -248,8 +273,11 @@ 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(struct sr_session *session, + sr_datafeed_callback cb, void *cb_data) { struct datafeed_callback *cb_struct; @@ -275,8 +303,20 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_ return SR_OK; } +SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session) +{ + return session->trigger; +} + +SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig) +{ + session->trigger = trig; + + return SR_OK; +} + /** - * Call every device in the session's callback. + * Call every device in the current session's callback. * * For sessions not driven by select loops such as sr_session_run(), * but driven by another scheduler, this can be used to poll the devices @@ -292,7 +332,7 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_ * @retval SR_OK Success. * @retval SR_ERR Error occured. */ -static int sr_session_iteration(gboolean block) +static int sr_session_iteration(struct sr_session *session, gboolean block) { unsigned int i; int ret; @@ -310,7 +350,8 @@ static int sr_session_iteration(gboolean block) if (!session->sources[i].cb(session->pollfds[i].fd, session->pollfds[i].revents, session->sources[i].cb_data)) - sr_session_source_remove(session->sources[i].poll_object); + sr_session_source_remove(session, + session->sources[i].poll_object); } /* * We want to take as little time as possible to stop @@ -320,7 +361,7 @@ static int sr_session_iteration(gboolean block) */ g_mutex_lock(&session->stop_mutex); if (session->abort_session) { - sr_session_stop_sync(); + sr_session_stop_sync(session); /* But once is enough. */ session->abort_session = FALSE; } @@ -330,37 +371,80 @@ 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. * - * There can only be one session at a time. - * * @retval SR_OK Success. - * @retval SR_ERR Error occured. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_start(void) +SR_API int sr_session_start(struct sr_session *session) { struct sr_dev_inst *sdi; GSList *l; int ret; if (!session) { - sr_err("%s: session was NULL; a session must be " - "created before starting it.", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } if (!session->devs) { sr_err("%s: session->devs was NULL; a session " "cannot be started without devices.", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; } + 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)); @@ -374,24 +458,25 @@ SR_API int sr_session_start(void) } /** - * Run the session. + * Run a session. * * @retval SR_OK Success. - * @retval SR_ERR_BUG Error occured. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_run(void) +SR_API int sr_session_run(struct sr_session *session) { if (!session) { - sr_err("%s: session was NULL; a session must be " - "created first, before running it.", __func__); - return SR_ERR_BUG; + sr_err("%s: session was NULL", __func__); + return SR_ERR_ARG; } if (!session->devs) { /* TODO: Actually the case? */ sr_err("%s: session->devs was NULL; a session " "cannot be run without devices.", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; } session->running = TRUE; @@ -405,34 +490,34 @@ SR_API int sr_session_run(void) } else { /* Real sources, use g_poll() main loop. */ while (session->num_sources) - sr_session_iteration(TRUE); + sr_session_iteration(session, TRUE); } return SR_OK; } /** - * Stop the current session. + * Stop a session. * - * The current session is stopped immediately, with all acquisition sessions - * being stopped and hardware drivers cleaned up. + * The session is stopped immediately, with all acquisition sessions stopped + * and hardware drivers cleaned up. * * This must be called from within the session thread, to prevent freeing * resources that the session thread will try to use. * * @retval SR_OK Success. - * @retval SR_ERR_BUG No session exists. + * @retval SR_ERR_ARG Invalid session passed. * * @private */ -SR_PRIV int sr_session_stop_sync(void) +SR_PRIV int sr_session_stop_sync(struct sr_session *session) { struct sr_dev_inst *sdi; GSList *l; if (!session) { sr_err("%s: session was NULL", __func__); - return SR_ERR_BUG; + return SR_ERR_ARG; } sr_info("Stopping."); @@ -450,10 +535,10 @@ SR_PRIV int sr_session_stop_sync(void) } /** - * Stop the current session. + * Stop a session. * - * The current session is stopped immediately, with all acquisition sessions - * being stopped and hardware drivers cleaned up. + * The session is stopped immediately, with all acquisition sessions being + * stopped and hardware drivers cleaned up. * * If the session is run in a separate thread, this function will not block * until the session is finished executing. It is the caller's responsibility @@ -461,9 +546,11 @@ SR_PRIV int sr_session_stop_sync(void) * completely decommissioned. * * @retval SR_OK Success. - * @retval SR_ERR_BUG No session exists. + * @retval SR_ERR_ARG Invalid session passed. + * + * @since 0.4.0 */ -SR_API int sr_session_stop(void) +SR_API int sr_session_stop(struct sr_session *session) { if (!session) { sr_err("%s: session was NULL", __func__); @@ -499,8 +586,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; @@ -551,7 +638,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, return SR_ERR_ARG; } - for (l = session->datafeed_callbacks; l; l = l->next) { + for (l = sdi->session->datafeed_callbacks; l; l = l->next) { if (sr_log_loglevel_get() >= SR_LOG_DBG) datafeed_dump(packet); cb_struct = l->data; @@ -575,8 +662,8 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, * @retval SR_ERR_ARG Invalid argument. * @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) +static int _sr_session_source_add(struct sr_session *session, GPollFD *pollfd, + int timeout, sr_receive_data_callback cb, void *cb_data, gintptr poll_object) { struct source *new_sources, *s; GPollFD *new_pollfds; @@ -630,16 +717,20 @@ 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_API int sr_session_source_add(struct sr_session *session, int fd, + int events, int timeout, sr_receive_data_callback cb, void *cb_data) { GPollFD p; + (void) session; + p.fd = fd; p.events = events; - return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd); + return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)fd); } /** @@ -653,11 +744,16 @@ 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_API int sr_session_source_add_pollfd(struct sr_session *session, + GPollFD *pollfd, int timeout, sr_receive_data_callback cb, + void *cb_data) { - return _sr_session_source_add(pollfd, timeout, cb, + (void) session; + + return _sr_session_source_add(session, pollfd, timeout, cb, cb_data, (gintptr)pollfd); } @@ -673,12 +769,17 @@ 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) +SR_API int sr_session_source_add_channel(struct sr_session *session, + GIOChannel *channel, int events, int timeout, + sr_receive_data_callback cb, void *cb_data) { GPollFD p; + (void) session; + #ifdef _WIN32 g_io_channel_win32_make_pollfd(channel, events, &p); #else @@ -686,7 +787,7 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, p.events = events; #endif - return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); + return _sr_session_source_add(session, &p, timeout, cb, cb_data, (gintptr)channel); } /** @@ -701,7 +802,7 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, * @retval SR_ERR_MALLOC Memory allocation error * @retval SR_ERR_BUG Internal error */ -static int _sr_session_source_remove(gintptr poll_object) +static int _sr_session_source_remove(struct sr_session *session, gintptr poll_object) { struct source *new_sources; GPollFD *new_pollfds; @@ -757,10 +858,14 @@ 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) +SR_API int sr_session_source_remove(struct sr_session *session, int fd) { - return _sr_session_source_remove((gintptr)fd); + (void) session; + + return _sr_session_source_remove(session, (gintptr)fd); } /** @@ -771,10 +876,15 @@ 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) +SR_API int sr_session_source_remove_pollfd(struct sr_session *session, + GPollFD *pollfd) { - return _sr_session_source_remove((gintptr)pollfd); + (void) session; + + return _sr_session_source_remove(session, (gintptr)pollfd); } /** @@ -786,10 +896,15 @@ 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) +SR_API int sr_session_source_remove_channel(struct sr_session *session, + GIOChannel *channel) { - return _sr_session_source_remove((gintptr)channel); + (void) session; + + return _sr_session_source_remove(session, (gintptr)channel); } /** @} */