X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=session.c;h=9fc77659499c840cf734983c354d93486fa5f237;hb=e7d087bf0e35ff97abae8bdd0c50e400c87b4b4d;hp=b33baa5c57f32a990d62dba28ce3e0816dc87d2d;hpb=996b0c7234c5cc420181b57370f6ba264aee24d2;p=libsigrok.git diff --git a/session.c b/session.c index b33baa5c..9fc77659 100644 --- a/session.c +++ b/session.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2012 Bert Vermeulen + * Copyright (C) 2010-2012 Bert Vermeulen * * 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 @@ -22,18 +22,18 @@ #include #include #include -#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 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. */ @@ -41,15 +41,18 @@ struct source { struct sr_session *session; static int num_sources = 0; +/* Both "sources" and "pollfds" are of the same size and contain pairs of + * descriptor and callback function. We can not embed the GPollFD into the + * source struct since we want to be able to pass the array of all poll + * descriptors to g_poll. + */ static struct source *sources = NULL; +static GPollFD *pollfds; static int source_timeout = -1; /** * Create a new session. * - * TODO. - * - * TODO: Should return int? * TODO: Should it use the file-global "session" variable or take an argument? * The same question applies to all the other session functions. * @@ -79,8 +82,8 @@ SR_API int sr_session_destroy(void) return SR_ERR_BUG; } - g_slist_free(session->devices); - session->devices = NULL; + g_slist_free(session->devs); + session->devs = NULL; /* TODO: Error checks needed? */ @@ -100,15 +103,15 @@ SR_API int sr_session_destroy(void) * * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -SR_API int sr_session_device_clear(void) +SR_API int sr_session_dev_remove_all(void) { if (!session) { sr_err("session: %s: session was NULL", __func__); return SR_ERR_BUG; } - g_slist_free(session->devices); - session->devices = NULL; + g_slist_free(session->devs); + session->devs = NULL; return SR_OK; } @@ -116,55 +119,57 @@ SR_API int sr_session_device_clear(void) /** * Add a device to the current session. * - * @param device The device to add to the current session. Must not be NULL. - * Also, device->plugin and device->plugin->opendev must not - * be NULL. + * @param dev The device to add to the current session. Must not be NULL. + * Also, dev->driver and dev->driver->dev_open must not be NULL. * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. */ -SR_API int sr_session_device_add(struct sr_device *device) +SR_API int sr_session_dev_add(struct sr_dev *dev) { int ret; - if (!device) { - sr_err("session: %s: device was NULL", __func__); + if (!dev) { + sr_err("session: %s: dev was NULL", __func__); return SR_ERR_ARG; } - if (!device->plugin) { - sr_err("session: %s: device->plugin was NULL", __func__); - return SR_ERR_ARG; + if (!session) { + sr_err("session: %s: session was NULL", __func__); + return SR_ERR_BUG; } - if (!device->plugin->opendev) { - sr_err("session: %s: device->plugin->opendev was NULL", - __func__); - return SR_ERR_ARG; + /* If dev->driver is NULL, this is a virtual device. */ + if (!dev->driver) { + sr_dbg("session: %s: dev->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, dev); + return SR_OK; } - if (!session) { - sr_err("session: %s: session was NULL", __func__); - return SR_ERR; /* TODO: SR_ERR_BUG? */ + /* dev->driver is non-NULL (i.e. we have a real device). */ + if (!dev->driver->dev_open) { + sr_err("session: %s: dev->driver->dev_open was NULL", + __func__); + return SR_ERR_BUG; } - if ((ret = device->plugin->opendev(device->plugin_index)) != SR_OK) { - sr_err("session: %s: opendev failed (%d)", __func__, ret); + if ((ret = dev->driver->dev_open(dev->driver_index)) != SR_OK) { + sr_err("session: %s: dev_open failed (%d)", __func__, ret); return ret; } - session->devices = g_slist_append(session->devices, device); + session->devs = g_slist_append(session->devs, dev); return SR_OK; } /** - * Clear all datafeed callbacks in the current session. - * - * TODO. + * 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_clear(void) +SR_API int sr_session_datafeed_callback_remove_all(void) { if (!session) { sr_err("session: %s: session was NULL", __func__); @@ -180,20 +185,25 @@ SR_API int sr_session_datafeed_callback_clear(void) /** * Add a datafeed callback to the current session. * - * @param callback TODO. + * @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 callback) +SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb) { if (!session) { sr_err("session: %s: session was NULL", __func__); return SR_ERR_BUG; } - /* TODO: Is 'callback' allowed to be NULL? */ + if (!cb) { + sr_err("session: %s: cb was NULL", __func__); + return SR_ERR_ARG; + } session->datafeed_callbacks = - g_slist_append(session->datafeed_callbacks, callback); + g_slist_append(session->datafeed_callbacks, cb); return SR_OK; } @@ -203,47 +213,25 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback) */ static int sr_session_run_poll(void) { - GPollFD *fds, my_gpollfd; int ret, i; - fds = NULL; while (session->running) { - /* TODO: Add comment. */ - g_free(fds); - - /* 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); + ret = g_poll(pollfds, num_sources, source_timeout); for (i = 0; i < num_sources; i++) { - if (fds[i].revents > 0 || (ret == 0 + if (pollfds[i].revents > 0 || (ret == 0 && source_timeout == 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].user_data)) - sr_session_source_remove(sources[i].fd); + if (!sources[i].cb(pollfds[i].fd, pollfds[i].revents, + sources[i].cb_data)) + sr_session_source_remove(pollfds[i].fd); } } } - g_free(fds); return SR_OK; } @@ -251,38 +239,38 @@ static int sr_session_run_poll(void) /** * Start a session. * - * There can only be one session at a time. TODO + * 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 *dev; GSList *l; int ret; if (!session) { sr_err("session: %s: session was NULL; a session must be " "created first, before starting it.", __func__); - return SR_ERR; /* TODO: SR_ERR_BUG? */ + return SR_ERR_BUG; } - if (!session->devices) { + if (!session->devs) { /* TODO: Actually the case? */ - sr_err("session: %s: session->devices was NULL; a session " + sr_err("session: %s: session->devs was NULL; a session " "cannot be started without devices.", __func__); - return SR_ERR; /* TODO: SR_ERR_BUG? */ + return SR_ERR_BUG; } - /* TODO: Check plugin_index validity? */ + /* TODO: Check driver_index validity? */ sr_info("session: starting"); - for (l = session->devices; l; l = l->next) { - device = l->data; - /* TODO: Check for device != NULL. */ - if ((ret = device->plugin->start_acquisition( - device->plugin_index, device)) != SR_OK) { + for (l = session->devs; l; l = l->next) { + dev = l->data; + /* TODO: Check for dev != NULL. */ + if ((ret = dev->driver->dev_acquisition_start( + dev->driver_index, dev)) != SR_OK) { sr_err("session: %s: could not start an acquisition " "(%d)", __func__, ret); break; @@ -309,9 +297,9 @@ SR_API int sr_session_run(void) return SR_ERR_BUG; } - if (!session->devices) { + if (!session->devs) { /* TODO: Actually the case? */ - sr_err("session: %s: session->devices was NULL; a session " + sr_err("session: %s: session->devs was NULL; a session " "cannot be run without devices.", __func__); return SR_ERR_BUG; } @@ -320,10 +308,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 (num_sources == 1 && pollfds[0].fd == -1) { /* Dummy source, freewheel over it. */ while (session->running) - sources[0].cb(-1, 0, sources[0].user_data); + sources[0].cb(-1, 0, sources[0].cb_data); } else { /* Real sources, use g_poll() main loop. */ sr_session_run_poll(); @@ -335,7 +323,8 @@ SR_API int sr_session_run(void) /** * Halt the current session. * - * TODO. + * This requests the current session be stopped as soon as possible, for + * example on receiving an SR_DF_END packet. * * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ @@ -355,13 +344,14 @@ SR_API int sr_session_halt(void) /** * Stop the current session. * - * TODO: Difference to halt? + * 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 *dev; GSList *l; if (!session) { @@ -372,14 +362,14 @@ SR_API int sr_session_stop(void) sr_info("session: stopping"); session->running = FALSE; - for (l = session->devices; l; l = l->next) { - device = l->data; - /* Check for device != NULL. */ - if (device->plugin) { - if (device->plugin->stop_acquisition) - device->plugin->stop_acquisition(device->plugin_index, device); - if (device->plugin->cleanup) - device->plugin->cleanup(); + for (l = session->devs; l; l = l->next) { + dev = l->data; + /* Check for dev != NULL. */ + 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(); } } @@ -387,14 +377,14 @@ SR_API int sr_session_stop(void) } /** - * @brief debug helper + * 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: @@ -403,41 +393,55 @@ static void datafeed_dump(struct sr_datafeed_packet *packet) 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_LOGIC"); + 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; } - } /** - * TODO. + * 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. * - * @param device TODO. - * @param packet TODO. * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. */ -SR_API int sr_session_bus(struct sr_device *device, - struct sr_datafeed_packet *packet) +SR_PRIV int sr_session_send(struct sr_dev *dev, + struct sr_datafeed_packet *packet) { GSList *l; - sr_datafeed_callback cb; - - if (!device) { - sr_err("session: %s: device was NULL", __func__); - return SR_ERR_ARG; - } + sr_datafeed_callback_t cb; - if (!device->plugin) { - sr_err("session: %s: device->plugin was NULL", __func__); + if (!dev) { + sr_err("session: %s: dev was NULL", __func__); return SR_ERR_ARG; } @@ -446,64 +450,49 @@ SR_API int sr_session_bus(struct sr_device *device, 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; /* TODO: Check for cb != NULL. */ - cb(device, packet); + cb(dev, packet); } return SR_OK; } -/** - * TODO. - * - * TODO: More error checks etc. - * - * @param fd TODO. - * @param events TODO. - * @param timeout TODO. - * @param callback TODO. - * @param user_data 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 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; - if (!callback) { - sr_err("session: %s: callback was NULL", __func__); + if (!cb) { + sr_err("session: %s: cb was NULL", __func__); return SR_ERR_ARG; } - /* Note: user_data can be NULL, that's not a bug. */ + /* 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(pollfds, sizeof(GPollFD) * (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(sources, sizeof(struct source) * (num_sources + 1)); + if (!new_sources) { + sr_err("session: %s: new_sources malloc failed", __func__); + return SR_ERR_MALLOC; } + new_pollfds[num_sources] = *pollfd; s = &new_sources[num_sources++]; - s->fd = fd; - s->events = events; s->timeout = timeout; - s->cb = callback; - s->user_data = user_data; + s->cb = cb; + s->cb_data = cb_data; + s->poll_object = poll_object; + pollfds = new_pollfds; sources = new_sources; if (timeout != source_timeout && timeout > 0 @@ -514,47 +503,170 @@ SR_API int sr_session_source_add(int fd, int events, int timeout, } /** - * 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_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(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); +} + +/** + * 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; + int old; if (!sources) { sr_err("session: %s: sources was NULL", __func__); - return SR_ERR_BUG; /* TODO: Other? */ + return SR_ERR_BUG; } - /* TODO: Check if 'fd' valid. */ + for (old = 0; old < num_sources; old++) { + if (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 == num_sources) + return SR_OK; + + num_sources -= 1; + + if (old != num_sources) { + memmove(&pollfds[old], &pollfds[old+1], + (num_sources - old) * sizeof(GPollFD)); + memmove(&sources[old], &sources[old+1], + (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(sources, sizeof(GPollFD) * num_sources); + if (!new_pollfds && 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(sources, sizeof(struct source) * num_sources); + if (!new_sources && num_sources > 0) { + sr_err("session: %s: new_sources malloc failed", __func__); + return SR_ERR_MALLOC; } + pollfds = new_pollfds; + 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); +}