/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "config.h"
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <glib.h>
-#include <sigrok.h>
-
-/* demo.c */
-extern GIOChannel channels[2];
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
struct source {
- int fd;
- int events;
int timeout;
- receive_data_callback cb;
- void *user_data;
+ sr_receive_data_callback_t cb;
+ void *cb_data;
+
+ /* This is used to keep track of the object (fd, pollfd or channel) which is
+ * being polled and will be used to match the source when removing it again.
+ */
+ gintptr poll_object;
};
/* There can only be one session at a time. */
+/* 'session' is not static, it's used elsewhere (via 'extern'). */
struct sr_session *session;
-int num_sources = 0;
-struct source *sources = NULL;
-int source_timeout = -1;
-
-
-struct sr_session *session_new(void)
+/**
+ * Create a new session.
+ *
+ * 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)
{
- session = calloc(1, sizeof(struct sr_session));
+ if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
+ sr_err("session: %s: session malloc failed", __func__);
+ return NULL; /* TODO: SR_ERR_MALLOC? */
+ }
+
+ session->source_timeout = -1;
return session;
}
-void session_destroy(void)
+/**
+ * Destroy the current session.
+ *
+ * This frees up all memory used by the session.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_destroy(void)
{
- g_slist_free(session->devices);
+ if (!session) {
+ sr_err("session: %s: session was NULL", __func__);
+ return SR_ERR_BUG;
+ }
+
+ sr_session_dev_remove_all();
+
+ /* TODO: Error checks needed? */
/* TODO: Loop over protocol decoders and free them. */
g_free(session);
+ session = NULL;
+
+ return SR_OK;
}
-void session_device_clear(void)
+static void sr_dev_close(struct sr_dev_inst *sdi)
{
- g_slist_free(session->devices);
- session->devices = NULL;
+ if (sdi->driver && sdi->driver->dev_close)
+ sdi->driver->dev_close(sdi);
}
-int session_device_add(struct sr_device *device)
+/**
+ * Remove all the devices from the current session. TODO?
+ *
+ * The session itself (i.e., the struct sr_session) is not free'd and still
+ * exists after this function returns.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_dev_remove_all(void)
{
- int ret;
-
- if (device->plugin && device->plugin->open) {
- ret = device->plugin->open(device->plugin_index);
- if (ret != SR_OK)
- return ret;
+ if (!session) {
+ sr_err("session: %s: session was NULL", __func__);
+ return SR_ERR_BUG;
}
- session->devices = g_slist_append(session->devices, device);
+ g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
+ session->devs = NULL;
return SR_OK;
}
-void session_pa_clear(void)
+/**
+ * Add a device to the current session.
+ *
+ * @param dev 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.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ */
+SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
{
- /*
- * The protocols are pointers to the global set of PA plugins,
- * so don't free them.
- */
- g_slist_free(session->analyzers);
- session->analyzers = NULL;
-}
+ int ret;
-void session_pa_add(struct analyzer *an)
-{
- session->analyzers = g_slist_append(session->analyzers, an);
+ if (!sdi) {
+ sr_err("session: %s: sdi was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ if (!session) {
+ sr_err("session: %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 "
+ "a virtual device; continuing", __func__);
+ /* Just add the device, don't run dev_open(). */
+ session->devs = g_slist_append(session->devs, (gpointer)sdi);
+ return SR_OK;
+ }
+
+ /* 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__);
+ 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);
+ return ret;
+ }
+
+ session->devs = g_slist_append(session->devs, (gpointer)sdi);
+
+ return SR_OK;
}
-void session_datafeed_callback_clear(void)
+/**
+ * Remove all datafeed callbacks in the current session.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_datafeed_callback_remove_all(void)
{
+ if (!session) {
+ sr_err("session: %s: session was NULL", __func__);
+ return SR_ERR_BUG;
+ }
+
g_slist_free(session->datafeed_callbacks);
session->datafeed_callbacks = NULL;
-}
-void session_datafeed_callback_add(datafeed_callback callback)
-{
- session->datafeed_callbacks =
- g_slist_append(session->datafeed_callbacks, callback);
+ return SR_OK;
}
-static void session_run_poll()
+/**
+ * Add a datafeed callback to the current session.
+ *
+ * @param cb Function to call when a chunk of data is received.
+ * Must not be NULL.
+ *
+ * @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)
{
- GPollFD *fds, my_gpollfd;
- int ret, i;
+ if (!session) {
+ sr_err("session: %s: session was NULL", __func__);
+ return SR_ERR_BUG;
+ }
- fds = NULL;
- while (session->running) {
- if (fds)
- free(fds);
+ if (!cb) {
+ sr_err("session: %s: cb was NULL", __func__);
+ return SR_ERR_ARG;
+ }
- /* Construct g_poll()'s array. */
- fds = malloc(sizeof(GPollFD) * num_sources);
- for (i = 0; i < num_sources; i++) {
-#ifdef _WIN32
- g_io_channel_win32_make_pollfd(&channels[0],
- sources[i].events, &my_gpollfd);
-#else
- my_gpollfd.fd = sources[i].fd;
- my_gpollfd.events = sources[i].events;
- fds[i] = my_gpollfd;
-#endif
- }
+ session->datafeed_callbacks =
+ g_slist_append(session->datafeed_callbacks, cb);
- ret = g_poll(fds, num_sources, source_timeout);
+ return SR_OK;
+}
- for (i = 0; i < num_sources; i++) {
- if (fds[i].revents > 0 || (ret == 0
- && source_timeout == sources[i].timeout)) {
+static int sr_session_run_poll(void)
+{
+ unsigned int i;
+ int ret;
+
+ while (session->num_sources > 0) {
+ ret = g_poll(session->pollfds, session->num_sources,
+ session->source_timeout);
+ for (i = 0; i < session->num_sources; i++) {
+ if (session->pollfds[i].revents > 0 || (ret == 0
+ && session->source_timeout == session->sources[i].timeout)) {
/*
* Invoke the source's callback on an event,
- * or if the poll timeout out and this source
+ * or if the poll timed out and this source
* asked for that timeout.
*/
- sources[i].cb(fds[i].fd, fds[i].revents,
- sources[i].user_data);
+ 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);
}
}
}
- free(fds);
+ return SR_OK;
}
-int session_start(void)
+/**
+ * Start a session.
+ *
+ * There can only be one session at a time.
+ *
+ * @return SR_OK upon success, SR_ERR upon errors.
+ */
+SR_API int sr_session_start(void)
{
- struct sr_device *device;
+ struct sr_dev_inst *sdi;
GSList *l;
int ret;
- g_message("session: starting");
- for (l = session->devices; l; l = l->next) {
- device = l->data;
- if ((ret = device->plugin->start_acquisition(
- device->plugin_index, device)) != SR_OK)
+ if (!session) {
+ sr_err("session: %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 "
+ "cannot be started without devices.", __func__);
+ return SR_ERR_BUG;
+ }
+
+ sr_info("session: starting");
+
+ 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 "
+ "(%d)", __func__, ret);
break;
+ }
}
+ /* TODO: What if there are multiple devices? Which return code? */
+
return ret;
}
-void session_run(void)
+/**
+ * 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 "
+ "created first, before running it.", __func__);
+ return SR_ERR_BUG;
+ }
- g_message("session: running");
- session->running = TRUE;
+ if (!session->devs) {
+ /* TODO: Actually the case? */
+ sr_err("session: %s: session->devs was NULL; a session "
+ "cannot be run without devices.", __func__);
+ return SR_ERR_BUG;
+ }
- /* do we have real sources? */
- if (num_sources == 1 && sources[0].fd == -1)
- /* dummy source, freewheel over it */
- while (session->running)
- sources[0].cb(-1, 0, sources[0].user_data);
- else
- /* real sources, use g_poll() main loop */
- session_run_poll();
+ sr_info("session: running");
+ /* Do we have real sources? */
+ if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
+ /* Dummy source, freewheel over it. */
+ while (session->num_sources)
+ session->sources[0].cb(-1, 0, session->sources[0].cb_data);
+ } else {
+ /* Real sources, use g_poll() main loop. */
+ sr_session_run_poll();
+ }
+
+ return SR_OK;
}
-void session_halt(void)
+/**
+ * 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)
{
-
- g_message("session: halting");
- session->running = FALSE;
-
+ return sr_session_stop();
}
-void session_stop(void)
+/**
+ * Stop the current session.
+ *
+ * The current session is stopped immediately, with all acquisition sessions
+ * being stopped and hardware drivers cleaned up.
+ *
+ * @return SR_OK upon success, SR_ERR_BUG if no session exists.
+ */
+SR_API int sr_session_stop(void)
{
- struct sr_device *device;
+ struct sr_dev_inst *sdi;
GSList *l;
- g_message("session: stopping");
- session->running = FALSE;
- for (l = session->devices; l; l = l->next) {
- device = l->data;
- if (device->plugin && device->plugin->stop_acquisition)
- device->plugin->stop_acquisition(device->plugin_index, device);
+ if (!session) {
+ sr_err("session: %s: session was NULL", __func__);
+ return SR_ERR_BUG;
+ }
+
+ sr_info("session: stopping");
+
+ for (l = session->devs; l; l = l->next) {
+ sdi = l->data;
+ if (sdi->driver) {
+ if (sdi->driver->dev_acquisition_stop)
+ sdi->driver->dev_acquisition_stop(sdi, sdi);
+ }
}
+ return SR_OK;
}
-void session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
+/**
+ * Debug helper.
+ *
+ * @param packet The packet to show debugging information for.
+ */
+static void datafeed_dump(struct sr_datafeed_packet *packet)
+{
+ struct sr_datafeed_logic *logic;
+ struct sr_datafeed_analog *analog;
+
+ switch (packet->type) {
+ case SR_DF_HEADER:
+ sr_dbg("bus: received SR_DF_HEADER");
+ break;
+ case SR_DF_TRIGGER:
+ sr_dbg("bus: received SR_DF_TRIGGER");
+ break;
+ case SR_DF_META_LOGIC:
+ sr_dbg("bus: received SR_DF_META_LOGIC");
+ 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");
+ 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);
+ break;
+ case SR_DF_END:
+ sr_dbg("bus: received SR_DF_END");
+ break;
+ case SR_DF_FRAME_BEGIN:
+ sr_dbg("bus: received SR_DF_FRAME_BEGIN");
+ break;
+ case SR_DF_FRAME_END:
+ sr_dbg("bus: received SR_DF_FRAME_END");
+ break;
+ default:
+ sr_dbg("bus: received unknown packet type %d", packet->type);
+ break;
+ }
+}
+
+/**
+ * Send a packet to whatever is listening on the datafeed bus.
+ *
+ * Hardware drivers use this to send a data packet to the frontend.
+ *
+ * @param dev TODO.
+ * @param packet The datafeed packet to send to the session bus.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ */
+SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
+ struct sr_datafeed_packet *packet)
{
GSList *l;
- datafeed_callback cb;
+ sr_datafeed_callback_t cb;
+
+ if (!sdi) {
+ sr_err("session: %s: sdi was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ if (!packet) {
+ sr_err("session: %s: packet was NULL", __func__);
+ return SR_ERR_ARG;
+ }
- /*
- * TODO: Send packet through PD pipe, and send the output of that to
- * the callbacks as well.
- */
for (l = session->datafeed_callbacks; l; l = l->next) {
+ if (sr_log_loglevel_get() >= SR_LOG_DBG)
+ datafeed_dump(packet);
cb = l->data;
- cb(device, packet);
+ cb(sdi, packet);
}
+
+ return SR_OK;
}
-void session_source_add(int fd, int events, int timeout,
- receive_data_callback callback, void *user_data)
+static int _sr_session_source_add(GPollFD *pollfd, int timeout,
+ sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
{
struct source *new_sources, *s;
+ GPollFD *new_pollfds;
- new_sources = calloc(1, sizeof(struct source) * (num_sources + 1));
+ if (!cb) {
+ sr_err("session: %s: cb was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ /* Note: cb_data can be NULL, that's not a bug. */
+
+ 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__);
+ return SR_ERR_MALLOC;
+ }
- if (sources) {
- memcpy(new_sources, sources,
- sizeof(struct source) * num_sources);
- free(sources);
+ 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__);
+ return SR_ERR_MALLOC;
}
- s = &new_sources[num_sources++];
- s->fd = fd;
- s->events = events;
+ new_pollfds[session->num_sources] = *pollfd;
+ s = &new_sources[session->num_sources++];
s->timeout = timeout;
- s->cb = callback;
- s->user_data = user_data;
- sources = new_sources;
+ s->cb = cb;
+ s->cb_data = cb_data;
+ s->poll_object = poll_object;
+ session->pollfds = new_pollfds;
+ session->sources = new_sources;
+
+ if (timeout != session->source_timeout && timeout > 0
+ && (session->source_timeout == -1 || timeout < session->source_timeout))
+ session->source_timeout = timeout;
+
+ return SR_OK;
+}
+
+/**
+ * Add a event source for a file descriptor.
+ *
+ * @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.
+ * @param cb Callback function to add. Must not be NULL.
+ * @param cb_data Data for the callback function. Can be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ * 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)
+{
+ GPollFD p;
+
+ p.fd = fd;
+ p.events = events;
+
+ return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
+}
+
+/**
+ * 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.
+ * @param cb_data Data for the callback function. Can be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ * 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)
+{
+ return _sr_session_source_add(pollfd, timeout, cb,
+ cb_data, (gintptr)pollfd);
+}
- if (timeout != source_timeout && timeout > 0
- && (source_timeout == -1 || timeout < source_timeout))
- source_timeout = timeout;
+/**
+ * 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.
+ * @param cb Callback function to add. Must not be NULL.
+ * @param cb_data Data for the callback function. Can be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ * 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)
+{
+ GPollFD p;
+
+#ifdef _WIN32
+ g_io_channel_win32_make_pollfd(channel,
+ events, &p);
+#else
+ p.fd = g_io_channel_unix_get_fd(channel);
+ p.events = events;
+#endif
+
+ return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
}
-void session_source_remove(int fd)
+
+static int _sr_session_source_remove(gintptr poll_object)
{
struct source *new_sources;
- int old, new;
+ GPollFD *new_pollfds;
+ unsigned int old;
- if (!sources)
- return;
+ if (!session->sources || !session->num_sources) {
+ sr_err("session: %s: sources was NULL", __func__);
+ return SR_ERR_BUG;
+ }
- new_sources = calloc(1, sizeof(struct source) * num_sources);
- for (old = 0; old < num_sources; old++)
- if (sources[old].fd != fd)
- memcpy(&new_sources[new++], &sources[old],
- sizeof(struct source));
+ for (old = 0; old < session->num_sources; old++) {
+ if (session->sources[old].poll_object == poll_object)
+ break;
+ }
- if (old != new) {
- free(sources);
- sources = new_sources;
- num_sources--;
- } else {
- /* Target fd was not found. */
- free(new_sources);
+ /* fd not found, nothing to do */
+ if (old == session->num_sources)
+ return SR_OK;
+
+ session->num_sources -= 1;
+
+ if (old != session->num_sources) {
+ memmove(&session->pollfds[old], &session->pollfds[old+1],
+ (session->num_sources - old) * sizeof(GPollFD));
+ memmove(&session->sources[old], &session->sources[old+1],
+ (session->num_sources - old) * sizeof(struct source));
}
+
+ 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__);
+ 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__);
+ return SR_ERR_MALLOC;
+ }
+
+ session->pollfds = new_pollfds;
+ session->sources = 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
+ * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
+ * internal errors.
+ */
+SR_API int sr_session_source_remove(int fd)
+{
+ return _sr_session_source_remove((gintptr)fd);
}
+/**
+ * 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
+ * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
+ * internal errors.
+ */
+SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
+{
+ 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
+ * SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
+ * internal errors.
+ */
+SR_API int sr_session_source_remove_channel(GIOChannel *channel)
+{
+ return _sr_session_source_remove((gintptr)channel);
+}
projects / libsigrok.git / blobdiff