X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=39f47ae70d24a5fbb525729c783aa840e068853a;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=6472f06a0fb589617e01d8c3cdea1c1c944e722f;hpb=3b7c8f54fcf4c6de1ec67d11a9ec8975a2ddbb57;p=libsigrok.git diff --git a/session.c b/session.c index 6472f06a..39f47ae7 100644 --- a/session.c +++ b/session.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010 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 @@ -17,7 +17,6 @@ * along with this program. If not, see . */ -#include "config.h" #include #include #include @@ -26,8 +25,8 @@ #include "sigrok.h" #include "sigrok-internal.h" -/* demo.c */ -extern GIOChannel channels[2]; +/* demo.c. TODO: Should not be global! */ +extern SR_PRIV GIOChannel channels[2]; struct source { int fd; @@ -48,17 +47,14 @@ 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. * * @return A pointer to the newly allocated session, or NULL upon errors. */ -struct sr_session *sr_session_new(void) +SR_API struct sr_session *sr_session_new(void) { - if (!(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? */ } @@ -71,24 +67,26 @@ struct sr_session *sr_session_new(void) * * This frees up all memory used by the session. * - * TODO: Should return int? + * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -void sr_session_destroy(void) +SR_API int sr_session_destroy(void) { if (!session) { - sr_warn("session: %s: session was NULL", __func__); - return; /* TODO: SR_ERR_BUG? */ + sr_err("session: %s: session was NULL", __func__); + return SR_ERR_BUG; } g_slist_free(session->devices); + session->devices = NULL; /* TODO: Error checks needed? */ /* TODO: Loop over protocol decoders and free them. */ g_free(session); - session = NULL; + + return SR_OK; } /** @@ -97,17 +95,19 @@ void sr_session_destroy(void) * The session itself (i.e., the struct sr_session) is not free'd and still * exists after this function returns. * - * TODO: Return int? + * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -void sr_session_device_clear(void) +SR_API int sr_session_device_clear(void) { if (!session) { - sr_warn("session: %s: session was NULL", __func__); - return; /* TODO: SR_ERR_BUG? */ + sr_err("session: %s: session was NULL", __func__); + return SR_ERR_BUG; } g_slist_free(session->devices); session->devices = NULL; + + return SR_OK; } /** @@ -119,7 +119,7 @@ void sr_session_device_clear(void) * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. */ -int sr_session_device_add(struct sr_device *device) +SR_API int sr_session_device_add(struct sr_device *device) { int ret; @@ -157,57 +157,61 @@ int sr_session_device_add(struct sr_device *device) /** * Clear all datafeed callbacks in the current session. * - * TODO: Should return int? - * - * TODO + * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -void sr_session_datafeed_callback_clear(void) +SR_API int sr_session_datafeed_callback_clear(void) { if (!session) { sr_err("session: %s: session was NULL", __func__); - return; /* TODO: SR_ERR_BUG? */ + return SR_ERR_BUG; } g_slist_free(session->datafeed_callbacks); session->datafeed_callbacks = NULL; + + return SR_OK; } /** * Add a datafeed callback to the current session. * - * TODO: Should return int? + * @param callback Function to call when a chunk of data is received. * - * @param callback TODO + * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -void sr_session_datafeed_callback_add(sr_datafeed_callback callback) +SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback) { if (!session) { sr_err("session: %s: session was NULL", __func__); - return; /* TODO: SR_ERR_BUG? */ + return SR_ERR_BUG; } /* TODO: Is 'callback' allowed to be NULL? */ session->datafeed_callbacks = g_slist_append(session->datafeed_callbacks, callback); + + return SR_OK; } /** * TODO. */ -static void sr_session_run_poll(void) +static int sr_session_run_poll(void) { GPollFD *fds, my_gpollfd; int ret, i; fds = NULL; while (session->running) { - if (fds) - free(fds); + /* TODO: Add comment. */ + g_free(fds); /* Construct g_poll()'s array. */ - /* TODO: Check malloc return value. */ - fds = malloc(sizeof(GPollFD) * num_sources); + 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], @@ -235,17 +239,19 @@ static void sr_session_run_poll(void) } } } - free(fds); + g_free(fds); + + return SR_OK; } /** * 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. */ -int sr_session_start(void) +SR_API int sr_session_start(void) { struct sr_device *device; GSList *l; @@ -273,7 +279,7 @@ int sr_session_start(void) /* TODO: Check for device != NULL. */ if ((ret = device->plugin->start_acquisition( device->plugin_index, device)) != SR_OK) { - sr_err("session: %s: could not start an acquisition ", + sr_err("session: %s: could not start an acquisition " "(%d)", __func__, ret); break; } @@ -287,24 +293,23 @@ int sr_session_start(void) /** * Run the session. * - * TODO: Should return int. * TODO: Various error checks etc. * - * TODO. + * @return SR_OK upon success, SR_ERR_BUG upon errors. */ -void sr_session_run(void) +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; /* TODO: SR_ERR or SR_ERR_BUG? */ + return SR_ERR_BUG; } if (!session->devices) { /* TODO: Actually the case? */ sr_err("session: %s: session->devices was NULL; a session " "cannot be run without devices.", __func__); - return; /* TODO: SR_ERR or SR_ERR_BUG? */ + return SR_ERR_BUG; } sr_info("session: running"); @@ -320,64 +325,70 @@ void sr_session_run(void) sr_session_run_poll(); } - /* TODO: return SR_OK; */ + return SR_OK; } /** * Halt the current session. * - * TODO: Return int. + * This requests the current session be stopped as soon as possible, for example + * on receiving an SR_DF_END packet. * - * TODO. + * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -void sr_session_halt(void) +SR_API int sr_session_halt(void) { if (!session) { sr_err("session: %s: session was NULL", __func__); - return; /* TODO: SR_ERR; or SR_ERR_BUG? */ + return SR_ERR_BUG; } sr_info("session: halting"); session->running = FALSE; - /* TODO: return SR_OK; */ + return SR_OK; } /** * Stop the current session. * - * TODO: Difference to halt? + * The current session is stopped immediately, with all acquisition sessions + * being stopped and hardware plugins cleaned up. * - * TODO. + * @return SR_OK upon success, SR_ERR_BUG if no session exists. */ -void sr_session_stop(void) +SR_API int sr_session_stop(void) { struct sr_device *device; GSList *l; if (!session) { sr_err("session: %s: session was NULL", __func__); - return; /* TODO: SR_ERR or SR_ERR_BUG? */ + return SR_ERR_BUG; } sr_info("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); + /* 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(); + } } - /* TODO: return SR_OK; */ + return SR_OK; } /** - * TODO. + * Debug helper. * - * TODO: Should return int? - * TODO: Various error checks. + * @param packet The packet to show debugging information for. * - * @param packet TODO. */ static void datafeed_dump(struct sr_datafeed_packet *packet) { @@ -388,67 +399,67 @@ static void datafeed_dump(struct sr_datafeed_packet *packet) sr_dbg("bus: received SR_DF_HEADER"); break; case SR_DF_TRIGGER: - sr_dbg("bus: received SR_DF_TRIGGER at %lu ms", - packet->timeoffset / 1000000); + sr_dbg("bus: received SR_DF_TRIGGER"); break; case SR_DF_LOGIC: logic = packet->payload; - sr_dbg("bus: received SR_DF_LOGIC at %f ms duration %f ms, " - "%" PRIu64 " bytes", packet->timeoffset / 1000000.0, - packet->duration / 1000000.0, logic->length); + /* TODO: Check for logic != NULL. */ + sr_dbg("bus: received SR_DF_LOGIC %" PRIu64 " bytes", logic->length); break; case SR_DF_END: sr_dbg("bus: received SR_DF_END"); break; default: - /* TODO: sr_err() and abort? */ sr_dbg("bus: received unknown packet type %d", packet->type); break; } + } /** - * TODO. + * Send a packet to whatever is listening on the datafeed bus. * - * TODO: Should return int? + * Hardware drivers use this to send a data packet to the frontend. * * @param device TODO. * @param packet TODO. + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. */ -void sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet) +SR_PRIV int sr_session_bus(struct sr_device *device, + struct sr_datafeed_packet *packet) { GSList *l; sr_datafeed_callback cb; if (!device) { sr_err("session: %s: device was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + return SR_ERR_ARG; } if (!device->plugin) { sr_err("session: %s: device->plugin was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + 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; /* TODO: Check for cb != NULL. */ - datafeed_dump(packet); cb(device, packet); } - /* TODO: return SR_OK; */ + return SR_OK; } /** * TODO. * - * TODO: Should return int? - * TODO: Switch to g_try_malloc0() / g_free(). * TODO: More error checks etc. * * @param fd TODO. @@ -456,29 +467,31 @@ void sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet) * @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. */ -void sr_session_source_add(int fd, int events, int timeout, - sr_receive_data_callback callback, void *user_data) +SR_API int sr_session_source_add(int fd, int events, int timeout, + sr_receive_data_callback callback, void *user_data) { struct source *new_sources, *s; if (!callback) { sr_err("session: %s: callback was NULL", __func__); - return; /* TODO: SR_ERR_ARG */ + return SR_ERR_ARG; } /* Note: user_data can be NULL, that's not a bug. */ - new_sources = calloc(1, sizeof(struct source) * (num_sources + 1)); + new_sources = g_try_malloc0(sizeof(struct source) * (num_sources + 1)); if (!new_sources) { sr_err("session: %s: new_sources malloc failed", __func__); - return; /* TODO: SR_ERR_MALLOC */ + return SR_ERR_MALLOC; } if (sources) { memcpy(new_sources, sources, sizeof(struct source) * num_sources); - free(sources); + g_free(sources); } s = &new_sources[num_sources++]; @@ -493,31 +506,35 @@ void sr_session_source_add(int fd, int events, int timeout, && (source_timeout == -1 || timeout < source_timeout)) source_timeout = timeout; - /* TODO: return SR_OK; */ + return SR_OK; } /** * Remove the source belonging to the specified file descriptor. * - * TODO: Should return int. * TODO: More error checks. - * TODO: Switch to g_try_malloc0() / g_free(). * * @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. */ -void sr_session_source_remove(int fd) +SR_API int sr_session_source_remove(int fd) { struct source *new_sources; int old, new; - /* TODO */ - if (!sources) - return; + if (!sources) { + sr_err("session: %s: sources was NULL", __func__); + return SR_ERR_BUG; /* TODO: Other? */ + } + + /* TODO: Check if 'fd' valid. */ - new_sources = calloc(1, sizeof(struct source) * num_sources); + new_sources = g_try_malloc0(sizeof(struct source) * num_sources); if (!new_sources) { sr_err("session: %s: new_sources malloc failed", __func__); - return; /* TODO: SR_ERR_MALLOC */ + return SR_ERR_MALLOC; } for (old = 0, new = 0; old < num_sources; old++) { @@ -527,11 +544,13 @@ void sr_session_source_remove(int fd) } if (old != new) { - free(sources); + g_free(sources); sources = new_sources; num_sources--; } else { /* Target fd was not found. */ - free(new_sources); + g_free(new_sources); } + + return SR_OK; }