/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2012 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 "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;
/**
* 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? */
}
*
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-int sr_session_destroy(void)
+SR_API int sr_session_destroy(void)
{
if (!session) {
- sr_warn("session: %s: session was NULL", __func__);
+ 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;
/* TODO: Error checks needed? */
*
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-int sr_session_device_clear(void)
+SR_API int sr_session_dev_clear(void)
{
if (!session) {
- sr_warn("session: %s: session was NULL", __func__);
+ 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;
}
/**
* 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->plugin and dev->plugin->dev_open must not be NULL.
*
* @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_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__);
+ if (!dev->plugin) {
+ sr_err("session: %s: dev->plugin was NULL", __func__);
return SR_ERR_ARG;
}
- if (!device->plugin->opendev) {
- sr_err("session: %s: device->plugin->opendev was NULL",
+ if (!dev->plugin->dev_open) {
+ sr_err("session: %s: dev->plugin->dev_open was NULL",
__func__);
return SR_ERR_ARG;
}
return SR_ERR; /* TODO: 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->plugin->dev_open(dev->plugin_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.
- *
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-int 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__);
/**
* Add a datafeed callback to the current session.
*
- * @param callback TODO.
+ * @param callback Function to call when a chunk of data is received.
+ *
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-int 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__);
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) {
+ if (!(fds = g_try_malloc(sizeof(GPollFD) * num_sources))) {
sr_err("session: %s: fds malloc failed", __func__);
return SR_ERR_MALLOC;
}
}
}
}
- 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;
+ struct sr_dev *dev;
GSList *l;
int ret;
return SR_ERR; /* TODO: 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? */
}
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->plugin->dev_acquisition_start(
+ dev->plugin_index, dev)) != SR_OK) {
sr_err("session: %s: could not start an acquisition "
"(%d)", __func__, ret);
break;
*
* @return SR_OK upon success, SR_ERR_BUG upon errors.
*/
-int sr_session_run(void)
+SR_API int sr_session_run(void)
{
if (!session) {
sr_err("session: %s: session was NULL; a session must be "
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;
}
/**
* 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.
*/
-int sr_session_halt(void)
+SR_API int sr_session_halt(void)
{
if (!session) {
sr_err("session: %s: session was NULL", __func__);
/**
* 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.
*
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
-int sr_session_stop(void)
+SR_API int sr_session_stop(void)
{
- struct sr_device *device;
+ struct sr_dev *dev;
GSList *l;
if (!session) {
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->plugin) {
+ if (dev->plugin->dev_acquisition_stop)
+ dev->plugin->dev_acquisition_stop(dev->plugin_index, dev);
+ if (dev->plugin->cleanup)
+ dev->plugin->cleanup();
}
}
}
/**
- * TODO.
+ * Debug helper.
*
- * TODO: Various error checks.
- *
- * @param packet TODO.
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ * @param packet The packet to show debugging information for.
*/
-static int datafeed_dump(struct sr_datafeed_packet *packet)
+static void datafeed_dump(struct sr_datafeed_packet *packet)
{
struct sr_datafeed_logic *logic;
- if (!packet) {
- sr_err("session: %s: packet was NULL", __func__);
- return SR_ERR_ARG;
- }
-
- /* TODO: Validity checks for packet contents. */
-
switch (packet->type) {
case SR_DF_HEADER:
sr_dbg("bus: received SR_DF_HEADER");
sr_dbg("bus: received SR_DF_END");
break;
default:
- /* TODO: Abort? */
- sr_err("bus: received unknown packet type %d", packet->type);
+ sr_dbg("bus: received unknown packet type %d", packet->type);
break;
}
-
- return SR_OK;
}
/**
- * 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 device TODO.
+ * @param dev TODO.
* @param packet TODO.
+ *
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
*/
-int sr_session_bus(struct sr_device *device, struct sr_datafeed_packet *packet)
+SR_PRIV int sr_session_bus(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__);
+ 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__);
+ if (!dev->plugin) {
+ sr_err("session: %s: dev->plugin was NULL", __func__);
return SR_ERR_ARG;
}
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);
+ cb(dev, packet);
}
return SR_OK;
/**
* TODO.
*
- * TODO: Switch to g_try_malloc0() / g_free().
* TODO: More error checks etc.
*
* @param fd 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.
*/
-int 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;
/* 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 SR_ERR_MALLOC;
if (sources) {
memcpy(new_sources, sources,
sizeof(struct source) * num_sources);
- free(sources);
+ g_free(sources);
}
s = &new_sources[num_sources++];
* Remove the source belonging to the specified file descriptor.
*
* 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.
*/
-int sr_session_source_remove(int fd)
+SR_API int sr_session_source_remove(int fd)
{
struct source *new_sources;
int old, new;
/* 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 SR_ERR_MALLOC;
}
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;
projects / libsigrok.git / blobdiff