/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
#include "libsigrok.h"
#include "libsigrok-internal.h"
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "session: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+/* 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)
/**
* @file
gintptr poll_object;
};
+struct datafeed_callback {
+ sr_datafeed_callback_t 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;
}
session->source_timeout = -1;
+ session->abort_session = FALSE;
+// g_mutex_init(&session->stop_mutex);
return session;
}
sr_session_dev_remove_all();
- /* TODO: Error checks needed? */
+ sr_session_datafeed_callback_remove_all();
- g_free(session);
- session = NULL;
+ if (session->sources) {
+ g_free(session->sources);
+ session->sources = NULL;
+ }
- return SR_OK;
-}
+ if (session->pollfds) {
+ g_free(session->pollfds);
+ session->pollfds = NULL;
+ }
-/**
- * Close a device instance.
- *
- * @param sdi The device instance to close. Must not be NULL. Also,
- * sdi->driver, sdi->driver->priv, and sdi->priv must not be NULL.
- */
-static void sr_dev_close(struct sr_dev_inst *sdi)
-{
- int ret;
-
- if (!sdi) {
- sr_err("Invalid device instance, can't close device.");
- return;
- }
-
- /* In the drivers sdi->priv is a 'struct dev_context *devc'. */
- if (!sdi->priv) {
- /*
- * Should be sr_err() in theory, but the 'demo' driver has
- * NULL for sdi->priv, so we use sr_dbg() until that's fixed.
- */
- sr_dbg("Invalid device context, can't close device.");
- return;
- }
-
- if (!sdi->driver) {
- sr_err("Invalid driver, can't close device.");
- return;
- }
+ /* TODO: Error checks needed? */
- if (!sdi->driver->priv) {
- sr_err("Driver not initialized, can't close device.");
- return;
- }
+// g_mutex_clear(&session->stop_mutex);
- sr_spew("Closing '%s' device instance %d.", sdi->driver->name,
- sdi->index);
+ g_free(session);
+ session = NULL;
- if ((ret = sdi->driver->dev_close(sdi)) < 0)
- sr_err("Failed to close device instance: %d.", ret);
+ return SR_OK;
}
/**
return SR_ERR_BUG;
}
- g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
+ g_slist_free(session->devs);
session->devs = NULL;
return SR_OK;
*/
SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
{
- int ret;
if (!sdi) {
sr_err("%s: sdi was NULL", __func__);
return SR_ERR_BUG;
}
- if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) {
- sr_err("%s: dev_open failed (%d)", __func__, ret);
- return ret;
- }
-
session->devs = g_slist_append(session->devs, (gpointer)sdi);
return SR_OK;
return SR_ERR_BUG;
}
- g_slist_free(session->datafeed_callbacks);
+ g_slist_free_full(session->datafeed_callbacks, g_free);
session->datafeed_callbacks = NULL;
return SR_OK;
*
* @param cb Function to call when a chunk of data is received.
* Must not be NULL.
+ * @param cb_data Opaque pointer passed in by the caller.
*
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
{
+ struct datafeed_callback *cb_struct;
+
if (!session) {
sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
return SR_ERR_ARG;
}
+ if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback))))
+ return SR_ERR_MALLOC;
+
+ cb_struct->cb = cb;
+ cb_struct->cb_data = cb_data;
+
session->datafeed_callbacks =
- g_slist_append(session->datafeed_callbacks, cb);
+ g_slist_append(session->datafeed_callbacks, cb_struct);
return SR_OK;
}
session->sources[i].cb_data))
sr_session_source_remove(session->sources[i].poll_object);
}
+ /*
+ * We want to take as little time as possible to stop
+ * the session if we have been told to do so. Therefore,
+ * we check the flag after processing every source, not
+ * just once per main event loop.
+ */
+// g_mutex_lock(&session->stop_mutex);
+ if (session->abort_session) {
+ sr_session_stop_sync();
+ /* But once is enough. */
+ session->abort_session = FALSE;
+ }
+// g_mutex_unlock(&session->stop_mutex);
}
}
return SR_ERR_BUG;
}
- sr_info("session: starting");
+ sr_info("Starting.");
ret = SR_OK;
for (l = session->devs; l; l = l->next) {
return SR_OK;
}
-/**
- * Halt the current session.
- *
- * This function is deprecated and should not be used in new code, use
- * sr_session_stop() instead. The behaviour of this function is identical to
- * sr_session_stop().
- *
- * @return SR_OK upon success, SR_ERR_BUG if no session exists.
- */
-SR_API int sr_session_halt(void)
-{
- return sr_session_stop();
-}
-
/**
* Stop the current session.
*
* The current session is stopped immediately, with all acquisition sessions
* being 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.
+ *
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-SR_API int sr_session_stop(void)
+SR_PRIV int sr_session_stop_sync(void)
{
struct sr_dev_inst *sdi;
GSList *l;
sdi = l->data;
if (sdi->driver) {
if (sdi->driver->dev_acquisition_stop)
- sdi->driver->dev_acquisition_stop(sdi, sdi);
+ sdi->driver->dev_acquisition_stop(sdi, NULL);
}
}
- /*
- * Some sources may not be necessarily associated with a device.
- * Those sources may still be present even after stopping all devices.
- * We need to make sure all sources are removed, or we risk running the
- * session in an infinite loop.
- */
- while (session->num_sources)
- sr_session_source_remove(session->sources[0].poll_object);
+ return SR_OK;
+}
+
+/**
+ * Stop the current session.
+ *
+ * The current 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
+ * to wait for the session thread to return before assuming that the session is
+ * completely decommissioned.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_stop(void)
+{
+ if (!session) {
+ sr_err("%s: session was NULL", __func__);
+ return SR_ERR_BUG;
+ }
+
+// g_mutex_lock(&session->stop_mutex);
+ session->abort_session = TRUE;
+// g_mutex_unlock(&session->stop_mutex);
return SR_OK;
}
const struct sr_datafeed_packet *packet)
{
GSList *l;
- sr_datafeed_callback_t cb;
+ struct datafeed_callback *cb_struct;
if (!sdi) {
sr_err("%s: sdi was NULL", __func__);
for (l = session->datafeed_callbacks; l; l = l->next) {
if (sr_log_loglevel_get() >= SR_LOG_DBG)
datafeed_dump(packet);
- cb = l->data;
- cb(sdi, packet);
+ cb_struct = l->data;
+ cb_struct->cb(sdi, packet, cb_struct->cb_data);
}
return SR_OK;
* SR_ERR_MALLOC upon memory allocation errors.
*/
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_t cb, const struct sr_dev_inst *sdi, gintptr poll_object)
{
struct source *new_sources, *s;
GPollFD *new_pollfds;
s = &new_sources[session->num_sources++];
s->timeout = timeout;
s->cb = cb;
- s->cb_data = cb_data;
+ s->cb_data = sdi;
s->poll_object = poll_object;
session->pollfds = new_pollfds;
session->sources = new_sources;
* SR_ERR_MALLOC upon memory allocation errors.
*/
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_t cb, const struct sr_dev_inst *sdi)
{
GPollFD p;
p.fd = fd;
p.events = events;
- return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
+ return _sr_session_source_add(&p, timeout, cb, sdi, (gintptr)fd);
}
/**
* SR_ERR_MALLOC upon memory allocation errors.
*/
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_t cb, const struct sr_dev_inst *sdi)
{
- return _sr_session_source_add(pollfd, timeout, cb,
- cb_data, (gintptr)pollfd);
+ return _sr_session_source_add(pollfd, timeout, cb,
+ sdi, (gintptr)pollfd);
}
/**
* SR_ERR_MALLOC upon memory allocation errors.
*/
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_t cb, const struct sr_dev_inst *sdi)
{
GPollFD p;
p.events = events;
#endif
- return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
+ return _sr_session_source_add(&p, timeout, cb, sdi, (gintptr)channel);
}
/**
projects / libsigrok.git / blobdiff