]> sigrok.org Git - libsigrok.git/blobdiff - session.c
sr: fx2lafw: Add basic support for USBee DX and clones
[libsigrok.git] / session.c
index 4bf96b8ccfe20f21f0ce486670e1aa5f0c1a625e..92ee648a631c77d41092beb3bf010f00c5537d30 100644 (file)
--- a/session.c
+++ b/session.c
 #include <unistd.h>
 #include <string.h>
 #include <glib.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
-
-/* demo.c. TODO: Should not be global! */
-extern SR_PRIV GIOChannel channels[2];
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
 struct source {
-       int fd;
-       int events;
        int timeout;
        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;
-static int num_sources = 0;
-
-static struct source *sources = NULL;
-static int source_timeout = -1;
 
 /**
  * Create a new session.
@@ -59,6 +55,8 @@ SR_API struct sr_session *sr_session_new(void)
                return NULL; /* TODO: SR_ERR_MALLOC? */
        }
 
+       session->source_timeout = -1;
+
        return session;
 }
 
@@ -76,8 +74,7 @@ SR_API int sr_session_destroy(void)
                return SR_ERR_BUG;
        }
 
-       g_slist_free(session->devs);
-       session->devs = NULL;
+       sr_session_dev_remove_all();
 
        /* TODO: Error checks needed? */
 
@@ -89,6 +86,12 @@ SR_API int sr_session_destroy(void)
        return SR_OK;
 }
 
+static void sr_dev_close(struct sr_dev *dev)
+{
+       if (dev && dev->driver && dev->driver->dev_close)
+               dev->driver->dev_close(dev->driver_index);
+}
+
 /**
  * Remove all the devices from the current session. TODO?
  *
@@ -104,7 +107,7 @@ SR_API int sr_session_dev_remove_all(void)
                return SR_ERR_BUG;
        }
 
-       g_slist_free(session->devs);
+       g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
        session->devs = NULL;
 
        return SR_OK;
@@ -207,47 +210,26 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb)
  */
 static int sr_session_run_poll(void)
 {
-       GPollFD *fds, my_gpollfd;
-       int ret, i;
+       unsigned int i;
+       int ret;
 
-       fds = NULL;
        while (session->running) {
-               /* TODO: Add comment. */
-               g_free(fds);
+               ret = g_poll(session->pollfds, session->num_sources, session->source_timeout);
 
-               /* Construct g_poll()'s array. */
-               if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) {
-                       sr_err("session: %s: fds malloc failed", __func__);
-                       return SR_ERR_MALLOC;
-               }
-               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
-               }
-
-               ret = g_poll(fds, num_sources, source_timeout);
-
-               for (i = 0; i < num_sources; i++) {
-                       if (fds[i].revents > 0 || (ret == 0
-                               && source_timeout == sources[i].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
                                 * asked for that timeout.
                                 */
-                               if (!sources[i].cb(fds[i].fd, fds[i].revents,
-                                                 sources[i].cb_data))
-                                       sr_session_source_remove(sources[i].fd);
+                               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);
                        }
                }
        }
-       g_free(fds);
 
        return SR_OK;
 }
@@ -324,10 +306,10 @@ SR_API int sr_session_run(void)
        session->running = TRUE;
 
        /* Do we have real sources? */
-       if (num_sources == 1 && sources[0].fd == -1) {
+       if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
                /* Dummy source, freewheel over it. */
                while (session->running)
-                       sources[0].cb(-1, 0, sources[0].cb_data);
+                       session->sources[0].cb(-1, 0, session->sources[0].cb_data);
        } else {
                /* Real sources, use g_poll() main loop. */
                sr_session_run_poll();
@@ -339,22 +321,15 @@ SR_API int sr_session_run(void)
 /**
  * Halt the current session.
  *
- * This requests the current session be stopped as soon as possible, for
- * example on receiving an SR_DF_END packet.
+ * 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)
 {
-       if (!session) {
-               sr_err("session: %s: session was NULL", __func__);
-               return SR_ERR_BUG;
-       }
-
-       sr_info("session: halting");
-       session->running = FALSE;
-
-       return SR_OK;
+       return sr_session_stop();
 }
 
 /**
@@ -384,8 +359,6 @@ SR_API int sr_session_stop(void)
                if (dev->driver) {
                        if (dev->driver->dev_acquisition_stop)
                                dev->driver->dev_acquisition_stop(dev->driver_index, dev);
-                       if (dev->driver->cleanup)
-                               dev->driver->cleanup();
                }
        }
 
@@ -428,6 +401,12 @@ static void datafeed_dump(struct sr_datafeed_packet *packet)
        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;
@@ -471,24 +450,11 @@ SR_PRIV int sr_session_send(struct sr_dev *dev,
        return SR_OK;
 }
 
-/**
- * TODO.
- *
- * TODO: More error checks etc.
- *
- * @param fd TODO.
- * @param events TODO.
- * @param timeout TODO.
- * @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)
+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;
 
        if (!cb) {
                sr_err("session: %s: cb was NULL", __func__);
@@ -497,76 +463,200 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
 
        /* Note: cb_data can be NULL, that's not a bug. */
 
-       new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1));
-       if (!new_sources) {
-               sr_err("session: %s: new_sources malloc failed", __func__);
+       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);
-               g_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 = cb;
        s->cb_data = cb_data;
-       sources = new_sources;
+       s->poll_object = poll_object;
+       session->pollfds = new_pollfds;
+       session->sources = new_sources;
 
-       if (timeout != source_timeout && timeout > 0
-           && (source_timeout == -1 || timeout < source_timeout))
-               source_timeout = timeout;
+       if (timeout != session->source_timeout && timeout > 0
+           && (session->source_timeout == -1 || timeout < session->source_timeout))
+               session->source_timeout = timeout;
 
        return SR_OK;
 }
 
 /**
- * Remove the source belonging to the specified file descriptor.
+ * Add a event source for a file descriptor.
  *
- * TODO: More error checks.
+ * @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.
  *
- * @param fd TODO.
+ * @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_ERR_BUG upon
- *         internal errors.
+ *         SR_ERR_MALLOC upon memory allocation errors.
  */
-SR_API int sr_session_source_remove(int fd)
+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);
+}
+
+/**
+ * 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);
+}
+
+
+static int _sr_session_source_remove(gintptr poll_object)
 {
        struct source *new_sources;
-       int old, new;
+       GPollFD *new_pollfds;
+       unsigned int old;
 
-       if (!sources) {
+       if (!session->sources || !session->num_sources) {
                sr_err("session: %s: sources was NULL", __func__);
                return SR_ERR_BUG;
        }
 
-       /* TODO: Check if 'fd' valid. */
+       for (old = 0; old < session->num_sources; old++) {
+               if (session->sources[old].poll_object == poll_object)
+                       break;
+       }
 
-       new_sources = g_try_malloc0(sizeof(struct source) * num_sources);
-       if (!new_sources) {
-               sr_err("session: %s: new_sources malloc failed", __func__);
-               return SR_ERR_MALLOC;
+       /* 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));
        }
 
-       for (old = 0, new = 0; old < num_sources; old++) {
-               if (sources[old].fd != fd)
-                       memcpy(&new_sources[new++], &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;
        }
 
-       if (old != new) {
-               g_free(sources);
-               sources = new_sources;
-               num_sources--;
-       } else {
-               /* Target fd was not found. */
-               g_free(new_sources);
+       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);
+}