/*
* 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
/**
* 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.
*
/**
* Clear all datafeed callbacks in the current session.
*
- * TODO.
- *
* @return SR_OK upon success, SR_ERR_BUG if no session exists.
*/
SR_API int sr_session_datafeed_callback_clear(void)
/**
* 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.
*/
SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback callback)
/**
* 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.
*/
/**
* 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.
*/
/**
* 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.
*/
}
/**
- * @brief debug helper
- *
- * @param packet TODO.
+ * Debug helper.
*
+ * @param packet The packet to show debugging information for.
*/
static void datafeed_dump(struct sr_datafeed_packet *packet)
{
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 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_bus(struct sr_device *device,
+ struct sr_datafeed_packet *packet)
{
GSList *l;
sr_datafeed_callback cb;
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);
* @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.
*/
* TODO: More error checks.
*
* @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.