/**
* Create a new session.
- * Currently, there can be only one session at a time within the same process.
+ *
+ * @param new_session This will contain a pointer to the newly created
+ * session if the return value is SR_OK, otherwise the value
+ * is undefined and should not be used. Must not be NULL.
*
* @retval SR_OK Success.
- * @retval SR_ERR_BUG A session exists already.
+ * @retval SR_ERR_ARG Invalid argument.
*
* @since 0.4.0
*/
{
struct sr_session *session;
+ if (!new_session)
+ return SR_ERR_ARG;
+
session = g_malloc0(sizeof(struct sr_session));
session->source_timeout = -1;
* Destroy a session.
* This frees up all memory used by the session.
*
+ * @param session The session to destroy. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
if (session->trigger)
sr_trigger_free(session->trigger);
+ g_slist_free_full(session->owned_devs, (GDestroyNotify)sr_dev_inst_free);
+
g_free(session);
return SR_OK;
* The session itself (i.e., the struct sr_session) is not free'd and still
* exists after this function returns.
*
+ * @param session The session to use. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_BUG Invalid session passed.
*
/**
* Add a device instance to a session.
*
+ * @param session The session to add to. Must not be NULL.
* @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.
/* If sdi->driver is NULL, this is a virtual device. */
if (!sdi->driver) {
- 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->session = session;
/**
* List all device instances attached to a session.
*
+ * @param session The session to use. Must not be NULL.
* @param devlist A pointer where the device instance list will be
* stored on return. If no devices are in the session,
* this will be NULL. Each element in the list points
/**
* Remove all datafeed callbacks in a session.
*
+ * @param session The session to use. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
/**
* Add a datafeed callback to a session.
*
+ * @param session The session to use. Must not be NULL.
* @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.
* but driven by another scheduler, this can be used to poll the devices
* from within that scheduler.
*
+ * @param session The session to use. Must not be NULL.
* @param block If TRUE, this call will wait for any of the session's
* sources to fire an event on the file descriptors, or
* any of their timeouts to activate. In other words, this
/**
* Start a session.
*
+ * @param session The session to use. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
SR_API int sr_session_start(struct sr_session *session)
{
struct sr_dev_inst *sdi;
- GSList *l;
- int ret;
+ struct sr_channel *ch;
+ GSList *l, *c;
+ int enabled_channels, ret;
if (!session) {
sr_err("%s: session was NULL", __func__);
ret = SR_OK;
for (l = session->devs; l; l = l->next) {
sdi = l->data;
+ enabled_channels = 0;
+ for (c = sdi->channels; c; c = c->next) {
+ ch = c->data;
+ if (ch->enabled) {
+ enabled_channels++;
+ break;
+ }
+ }
+ if (enabled_channels == 0) {
+ ret = SR_ERR;
+ sr_err("%s using connection %s has no enabled channels!",
+ sdi->driver->name, sdi->connection_id);
+ break;
+ }
+
if ((ret = sr_config_commit(sdi)) != SR_OK) {
sr_err("Failed to commit device settings before "
"starting acquisition (%s)", sr_strerror(ret));
/**
* Run a session.
*
+ * @param session The session to use. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
* This must be called from within the session thread, to prevent freeing
* resources that the session thread will try to use.
*
+ * @param session The session to use. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
* to wait for the session thread to return before assuming that the session is
* completely decommissioned.
*
+ * @param session The session to use. Must not be NULL.
+ *
* @retval SR_OK Success.
* @retval SR_ERR_ARG Invalid session passed.
*
* @private
*/
SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
- const struct sr_datafeed_packet *packet)
+ const struct sr_datafeed_packet *packet)
{
GSList *l;
struct datafeed_callback *cb_struct;
return SR_ERR_ARG;
}
+ if (!sdi->session) {
+ sr_err("%s: session was NULL", __func__);
+ return SR_ERR_BUG;
+ }
+
for (l = sdi->session->datafeed_callbacks; l; l = l->next) {
if (sr_log_loglevel_get() >= SR_LOG_DBG)
datafeed_dump(packet);
/**
* Add an event source for a file descriptor.
*
+ * @param session The session to use. Must not be NULL.
* @param pollfd The GPollFD.
* @param[in] timeout Max time to wait before the callback is called,
* ignored if 0.
/**
* Add an event source for a file descriptor.
*
+ * @param session The session to use. Must not be NULL.
* @param fd The file descriptor.
* @param events Events to check for.
* @param timeout Max time to wait before the callback is called, ignored if 0.
{
GPollFD p;
- (void) session;
-
p.fd = fd;
p.events = events;
/**
* Add an event source for a GPollFD.
*
+ * @param session The session to use. Must not be NULL.
* @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.
GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
void *cb_data)
{
- (void) session;
-
return _sr_session_source_add(session, pollfd, timeout, cb,
- cb_data, (gintptr)pollfd);
+ cb_data, (gintptr)pollfd);
}
/**
* Add an event source for a GIOChannel.
*
+ * @param session The session to use. Must not be NULL.
* @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;
- (void) session;
-
#ifdef _WIN32
g_io_channel_win32_make_pollfd(channel, events, &p);
#else
*
* @todo Add more error checks and logging.
*
+ * @param session The session to use. Must not be NULL.
* @param poll_object The channel for which the source should be removed.
*
* @retval SR_OK Success
/**
* Remove the source belonging to the specified file descriptor.
*
+ * @param session The session to use. Must not be NULL.
* @param fd The file descriptor for which the source should be removed.
*
* @retval SR_OK Success
*/
SR_API int sr_session_source_remove(struct sr_session *session, int fd)
{
- (void) session;
-
return _sr_session_source_remove(session, (gintptr)fd);
}
/**
* Remove the source belonging to the specified poll descriptor.
*
+ * @param session The session to use. Must not be NULL.
* @param pollfd The poll descriptor for which the source should be removed.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
GPollFD *pollfd)
{
- (void) session;
-
return _sr_session_source_remove(session, (gintptr)pollfd);
}
/**
* Remove the source belonging to the specified channel.
*
+ * @param session The session to use. Must not be NULL.
* @param channel The channel for which the source should be removed.
*
* @retval SR_OK Success.
SR_API int sr_session_source_remove_channel(struct sr_session *session,
GIOChannel *channel)
{
- (void) session;
-
return _sr_session_source_remove(session, (gintptr)channel);
}
+static void *copy_src(struct sr_config *src)
+{
+ struct sr_config *new_src;
+
+ new_src = g_malloc(sizeof(struct sr_config));
+ memcpy(new_src, src, sizeof(struct sr_config));
+ g_variant_ref(src->data);
+
+ return new_src;
+}
+
+SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
+ struct sr_datafeed_packet **copy)
+{
+ const struct sr_datafeed_meta *meta;
+ struct sr_datafeed_meta *meta_copy;
+ const struct sr_datafeed_logic *logic;
+ struct sr_datafeed_logic *logic_copy;
+ const struct sr_datafeed_analog *analog;
+ struct sr_datafeed_analog *analog_copy;
+ uint8_t *payload;
+
+ *copy = g_malloc0(sizeof(struct sr_datafeed_packet));
+ (*copy)->type = packet->type;
+
+ switch (packet->type) {
+ case SR_DF_TRIGGER:
+ case SR_DF_END:
+ /* No payload. */
+ break;
+ case SR_DF_HEADER:
+ payload = g_malloc(sizeof(struct sr_datafeed_header));
+ memcpy(payload, packet->payload, sizeof(struct sr_datafeed_header));
+ (*copy)->payload = payload;
+ break;
+ case SR_DF_META:
+ meta = packet->payload;
+ meta_copy = g_malloc(sizeof(struct sr_datafeed_meta));
+ meta_copy->config = g_slist_copy_deep(meta->config,
+ (GCopyFunc)copy_src, NULL);
+ (*copy)->payload = meta_copy;
+ break;
+ case SR_DF_LOGIC:
+ logic = packet->payload;
+ logic_copy = g_malloc(sizeof(logic));
+ logic_copy->length = logic->length;
+ logic_copy->unitsize = logic->unitsize;
+ memcpy(logic_copy->data, logic->data, logic->length * logic->unitsize);
+ (*copy)->payload = logic_copy;
+ break;
+ case SR_DF_ANALOG:
+ analog = packet->payload;
+ analog_copy = g_malloc(sizeof(analog));
+ analog_copy->channels = g_slist_copy(analog->channels);
+ analog_copy->num_samples = analog->num_samples;
+ analog_copy->mq = analog->mq;
+ analog_copy->unit = analog->unit;
+ analog_copy->mqflags = analog->mqflags;
+ memcpy(analog_copy->data, analog->data,
+ analog->num_samples * sizeof(float));
+ (*copy)->payload = analog_copy;
+ break;
+ default:
+ sr_err("Unknown packet type %d", packet->type);
+ return SR_ERR;
+ }
+
+ return SR_OK;
+}
+
+void sr_packet_free(struct sr_datafeed_packet *packet)
+{
+ const struct sr_datafeed_meta *meta;
+ const struct sr_datafeed_logic *logic;
+ const struct sr_datafeed_analog *analog;
+ struct sr_config *src;
+ GSList *l;
+
+ switch (packet->type) {
+ case SR_DF_TRIGGER:
+ case SR_DF_END:
+ /* No payload. */
+ break;
+ case SR_DF_HEADER:
+ /* Payload is a simple struct. */
+ g_free((void *)packet->payload);
+ break;
+ case SR_DF_META:
+ meta = packet->payload;
+ for (l = meta->config; l; l = l->next) {
+ src = l->data;
+ g_variant_unref(src->data);
+ g_free(src);
+ }
+ g_slist_free(meta->config);
+ g_free((void *)packet->payload);
+ break;
+ case SR_DF_LOGIC:
+ logic = packet->payload;
+ g_free(logic->data);
+ g_free((void *)packet->payload);
+ break;
+ case SR_DF_ANALOG:
+ analog = packet->payload;
+ g_slist_free(analog->channels);
+ g_free(analog->data);
+ g_free((void *)packet->payload);
+ break;
+ default:
+ sr_err("Unknown packet type %d", packet->type);
+ }
+ g_free(packet);
+
+}
+
/** @} */
projects / libsigrok.git / blobdiff