#include "libsigrok.h"
#include "libsigrok-internal.h"
+/**
+ * @file
+ *
+ * Creating, using, or destroying libsigrok sessions.
+ */
+
+/**
+ * @defgroup grp_session Session handling
+ *
+ * Creating, using, or destroying libsigrok sessions.
+ *
+ * @{
+ */
+
struct source {
int timeout;
sr_receive_data_callback_t cb;
/**
* 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.
/* TODO: Error checks needed? */
- /* TODO: Loop over protocol decoders and free them. */
-
g_free(session);
session = NULL;
}
/**
- * 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.
}
/**
- * 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.
*
sr_info("session: 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) {
/**
* 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)
}
}
+ /*
+ * 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:
*
* 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;
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)
{
}
/**
- * 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;
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
{
return _sr_session_source_remove((gintptr)channel);
}
+
+/** @} */
projects / libsigrok.git / blobdiff