#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)
+
+/**
+ * @file
+ *
+ * Creating, using, or destroying libsigrok sessions.
+ */
+
/**
* @defgroup grp_session Session handling
*
/**
* Create a new session.
*
- * TODO: Should it use the file-global "session" variable or take an argument?
+ * @todo Should it use the file-global "session" variable or take an argument?
* The same question applies to all the other session functions.
*
* @return A pointer to the newly allocated session, or NULL upon errors.
SR_API struct sr_session *sr_session_new(void)
{
if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
- sr_err("session: %s: session malloc failed", __func__);
- return NULL; /* TODO: SR_ERR_MALLOC? */
+ sr_err("Session malloc failed.");
+ return NULL;
}
session->source_timeout = -1;
SR_API int sr_session_destroy(void)
{
if (!session) {
- sr_err("session: %s: session was NULL", __func__);
+ sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
}
/* TODO: Error checks needed? */
- /* TODO: Loop over protocol decoders and free them. */
-
g_free(session);
session = NULL;
return SR_OK;
}
+/**
+ * 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)
{
- if (sdi->driver && sdi->driver->dev_close)
- sdi->driver->dev_close(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;
+ }
+
+ if (!sdi->driver->priv) {
+ sr_err("Driver not initialized, can't close device.");
+ return;
+ }
+
+ sr_spew("Closing '%s' device instance %d.", sdi->driver->name,
+ sdi->index);
+
+ if ((ret = sdi->driver->dev_close(sdi)) < 0)
+ sr_err("Failed to close device instance: %d.", ret);
}
/**
- * Remove all the devices from the current session. TODO?
+ * Remove all the devices from the current session.
*
* The session itself (i.e., the struct sr_session) is not free'd and still
* exists after this function returns.
SR_API int sr_session_dev_remove_all(void)
{
if (!session) {
- sr_err("session: %s: session was NULL", __func__);
+ sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
}
}
/**
- * Add a device to the current session.
+ * Add a device instance to the current session.
*
- * @param dev The device instance to add to the current session. Must not
+ * @param sdi The device instance to add to the current session. Must not
* be NULL. Also, sdi->driver and sdi->driver->dev_open must
* not be NULL.
*
int ret;
if (!sdi) {
- sr_err("session: %s: sdi was NULL", __func__);
+ sr_err("%s: sdi was NULL", __func__);
return SR_ERR_ARG;
}
if (!session) {
- sr_err("session: %s: session was NULL", __func__);
+ sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
}
/* If sdi->driver is NULL, this is a virtual device. */
if (!sdi->driver) {
- sr_dbg("session: %s: sdi->driver was NULL, this seems to be "
+ sr_dbg("%s: sdi->driver was NULL, this seems to be "
"a virtual device; continuing", __func__);
/* Just add the device, don't run dev_open(). */
session->devs = g_slist_append(session->devs, (gpointer)sdi);
/* sdi->driver is non-NULL (i.e. we have a real device). */
if (!sdi->driver->dev_open) {
- sr_err("session: %s: sdi->driver->dev_open was NULL", __func__);
+ sr_err("%s: sdi->driver->dev_open was NULL", __func__);
return SR_ERR_BUG;
}
if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) {
- sr_err("session: %s: dev_open failed (%d)", __func__, ret);
+ sr_err("%s: dev_open failed (%d)", __func__, ret);
return ret;
}
SR_API int sr_session_datafeed_callback_remove_all(void)
{
if (!session) {
- sr_err("session: %s: session was NULL", __func__);
+ sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
}
SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
{
if (!session) {
- sr_err("session: %s: session was NULL", __func__);
+ sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
}
if (!cb) {
- sr_err("session: %s: cb was NULL", __func__);
+ sr_err("%s: cb was NULL", __func__);
return SR_ERR_ARG;
}
int ret;
if (!session) {
- sr_err("session: %s: session was NULL; a session must be "
+ sr_err("%s: session was NULL; a session must be "
"created before starting it.", __func__);
return SR_ERR_BUG;
}
if (!session->devs) {
- sr_err("session: %s: session->devs was NULL; a session "
+ sr_err("%s: session->devs was NULL; a session "
"cannot be started without devices.", __func__);
return SR_ERR_BUG;
}
- sr_info("session: starting");
+ sr_info("Starting.");
+ ret = SR_OK;
for (l = session->devs; l; l = l->next) {
sdi = l->data;
if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
- sr_err("session: %s: could not start an acquisition "
+ sr_err("%s: could not start an acquisition "
"(%d)", __func__, ret);
break;
}
/**
* Run the session.
*
- * TODO: Various error checks etc.
- *
* @return SR_OK upon success, SR_ERR_BUG upon errors.
*/
SR_API int sr_session_run(void)
{
if (!session) {
- sr_err("session: %s: session was NULL; a session must be "
+ sr_err("%s: session was NULL; a session must be "
"created first, before running it.", __func__);
return SR_ERR_BUG;
}
if (!session->devs) {
/* TODO: Actually the case? */
- sr_err("session: %s: session->devs was NULL; a session "
+ sr_err("%s: session->devs was NULL; a session "
"cannot be run without devices.", __func__);
return SR_ERR_BUG;
}
- sr_info("session: running");
+ sr_info("Running.");
/* Do we have real sources? */
if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
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.
*
GSList *l;
if (!session) {
- sr_err("session: %s: session was NULL", __func__);
+ sr_err("%s: session was NULL", __func__);
return SR_ERR_BUG;
}
- sr_info("session: stopping");
+ sr_info("Stopping.");
for (l = session->devs; l; l = l->next) {
sdi = l->data;
}
}
+ /*
+ * 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;
}
*
* @param packet The packet to show debugging information for.
*/
-static void datafeed_dump(struct sr_datafeed_packet *packet)
+static void datafeed_dump(const struct sr_datafeed_packet *packet)
{
- struct sr_datafeed_logic *logic;
- struct sr_datafeed_analog *analog;
+ const struct sr_datafeed_logic *logic;
+ const struct sr_datafeed_analog *analog;
switch (packet->type) {
case SR_DF_HEADER:
- sr_dbg("bus: received SR_DF_HEADER");
+ sr_dbg("bus: Received SR_DF_HEADER packet.");
break;
case SR_DF_TRIGGER:
- sr_dbg("bus: received SR_DF_TRIGGER");
+ sr_dbg("bus: Received SR_DF_TRIGGER packet.");
break;
- case SR_DF_META_LOGIC:
- sr_dbg("bus: received SR_DF_META_LOGIC");
+ case SR_DF_META:
+ sr_dbg("bus: Received SR_DF_META packet.");
break;
case SR_DF_LOGIC:
logic = packet->payload;
- /* TODO: Check for logic != NULL. */
- sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length);
- break;
- case SR_DF_META_ANALOG:
- sr_dbg("bus: received SR_DF_META_ANALOG");
+ sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).",
+ logic->length);
break;
case SR_DF_ANALOG:
analog = packet->payload;
- /* TODO: Check for analog != NULL. */
- sr_dbg("bus: received SR_DF_ANALOG %d samples", analog->num_samples);
+ sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
+ analog->num_samples);
break;
case SR_DF_END:
- sr_dbg("bus: received SR_DF_END");
+ sr_dbg("bus: Received SR_DF_END packet.");
break;
case SR_DF_FRAME_BEGIN:
- sr_dbg("bus: received SR_DF_FRAME_BEGIN");
+ sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
break;
case SR_DF_FRAME_END:
- sr_dbg("bus: received SR_DF_FRAME_END");
+ sr_dbg("bus: Received SR_DF_FRAME_END packet.");
break;
default:
- sr_dbg("bus: received unknown packet type %d", packet->type);
+ sr_dbg("bus: Received unknown packet type: %d.", packet->type);
break;
}
}
*
* Hardware drivers use this to send a data packet to the frontend.
*
- * @param dev TODO.
+ * @param sdi TODO.
* @param packet The datafeed packet to send to the session bus.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
* @private
*/
SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
- struct sr_datafeed_packet *packet)
+ const struct sr_datafeed_packet *packet)
{
GSList *l;
sr_datafeed_callback_t cb;
if (!sdi) {
- sr_err("session: %s: sdi was NULL", __func__);
+ sr_err("%s: sdi was NULL", __func__);
return SR_ERR_ARG;
}
if (!packet) {
- sr_err("session: %s: packet was NULL", __func__);
+ sr_err("%s: packet was NULL", __func__);
return SR_ERR_ARG;
}
return SR_OK;
}
+/**
+ * Add an event source for a file descriptor.
+ *
+ * @param pollfd The GPollFD.
+ * @param timeout Max time to wait before the callback is called, ignored if 0.
+ * @param cb Callback function to add. Must not be NULL.
+ * @param cb_data Data for the callback function. Can be NULL.
+ * @param poll_object TODO.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ * 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)
{
GPollFD *new_pollfds;
if (!cb) {
- sr_err("session: %s: cb was NULL", __func__);
+ sr_err("%s: cb was NULL", __func__);
return SR_ERR_ARG;
}
new_pollfds = g_try_realloc(session->pollfds,
sizeof(GPollFD) * (session->num_sources + 1));
if (!new_pollfds) {
- sr_err("session: %s: new_pollfds malloc failed", __func__);
+ sr_err("%s: new_pollfds malloc failed", __func__);
return SR_ERR_MALLOC;
}
new_sources = g_try_realloc(session->sources, sizeof(struct source) *
(session->num_sources + 1));
if (!new_sources) {
- sr_err("session: %s: new_sources malloc failed", __func__);
+ sr_err("%s: new_sources malloc failed", __func__);
return SR_ERR_MALLOC;
}
}
/**
- * Add a event source for a file descriptor.
+ * Add an event source for a file descriptor.
*
* @param fd The file descriptor.
* @param events Events to check for.
/**
* Add an event source for a GPollFD.
*
- * TODO: More error checks etc.
- *
* @param pollfd The GPollFD.
* @param timeout Max time to wait before the callback is called, ignored if 0.
* @param cb Callback function to add. Must not be NULL.
/**
* Add an event source for a GIOChannel.
*
- * TODO: More error checks etc.
- *
* @param channel The GIOChannel.
* @param events Events to poll on.
* @param timeout Max time to wait before the callback is called, ignored if 0.
GPollFD p;
#ifdef _WIN32
- g_io_channel_win32_make_pollfd(channel,
- events, &p);
+ g_io_channel_win32_make_pollfd(channel, events, &p);
#else
p.fd = g_io_channel_unix_get_fd(channel);
p.events = events;
return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
}
-
+/**
+ * Remove the source belonging to the specified channel.
+ *
+ * @todo Add more error checks and logging.
+ *
+ * @param channel The channel for which the source should be removed.
+ *
+ * @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.
+ */
static int _sr_session_source_remove(gintptr poll_object)
{
struct source *new_sources;
unsigned int old;
if (!session->sources || !session->num_sources) {
- sr_err("session: %s: sources was NULL", __func__);
+ sr_err("%s: sources was NULL", __func__);
return SR_ERR_BUG;
}
new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
if (!new_pollfds && session->num_sources > 0) {
- sr_err("session: %s: new_pollfds malloc failed", __func__);
+ sr_err("%s: new_pollfds malloc failed", __func__);
return SR_ERR_MALLOC;
}
new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
if (!new_sources && session->num_sources > 0) {
- sr_err("session: %s: new_sources malloc failed", __func__);
+ sr_err("%s: new_sources malloc failed", __func__);
return SR_ERR_MALLOC;
}
return SR_OK;
}
-/*
+/**
* Remove the source belonging to the specified file descriptor.
*
- * TODO: More error checks.
- *
* @param fd The file descriptor for which the source should be removed.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
/**
* Remove the source belonging to the specified poll descriptor.
*
- * TODO: More error checks.
- *
* @param pollfd The poll descriptor for which the source should be removed.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
return _sr_session_source_remove((gintptr)pollfd);
}
-/*
+/**
* Remove the source belonging to the specified channel.
*
- * TODO: More error checks.
- *
* @param channel The channel for which the source should be removed.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
projects / libsigrok.git / blobdiff