* It is the caller's responsibility to free the allocated memory of the
* datastore via the sr_datastore_destroy() function, if no longer needed.
*
- * TODO: Unitsize should probably be unsigned int or uint32_t or similar.
- * TODO: This function should have a 'chunksize' parameter, and
+ * @todo Unitsize should probably be unsigned int or uint32_t or similar.
+ * @todo This function should have a 'chunksize' parameter, and
* struct sr_datastore a 'chunksize' field.
*
* @param unitsize The unit size (>= 1) to be used for this datastore.
/**
* Append some data to the specified datastore.
*
- * TODO: More elaborate function description.
- *
- * TODO: This function should use the (not yet available) 'chunksize' field
+ * @todo More elaborate function description.
+ * @todo This function should use the (not yet available) 'chunksize' field
* of struct sr_datastore (instead of hardcoding DATASTORE_CHUNKSIZE).
- * TODO: in_unitsize and probelist are unused?
- * TODO: A few of the parameters can be const.
- * TODO: Ideally, 'ds' should be unmodified upon errors.
+ * @todo in_unitsize and probelist are unused?
+ * @todo A few of the parameters can be const.
+ * @todo Ideally, 'ds' should be unmodified upon errors.
+ * @todo Should 0 be allowed as length?
+ * @todo Specify/document the data format of the 'data' parameter.
*
* @param ds Pointer to the datastore which shall receive the data.
* Must not be NULL.
* @param data Pointer to the memory buffer containing the data to add.
- * Must not be NULL. TODO: Data format?
+ * Must not be NULL.
* @param length Length of the data to add (in number of bytes).
- * TODO: Should 0 be allowed as length?
* @param in_unitsize The unit size (>= 1) of the input data.
* @param probelist Pointer to a list of integers (probe numbers). The probe
* numbers in this list are 1-based, i.e. the first probe
*
* The allocated memory is guaranteed to be cleared.
*
- * TODO: This function should use the datastore's 'chunksize' field instead
+ * @todo This function should use the datastore's 'chunksize' field instead
* of hardcoding DATASTORE_CHUNKSIZE.
- * TODO: Return int, so we can return SR_OK / SR_ERR_ARG / SR_ERR_MALLOC?
+ * @todo Return int, so we can return SR_OK / SR_ERR_ARG / SR_ERR_MALLOC?
*
* @param ds Pointer to a variable which holds the datastore structure.
* Must not be NULL. The contents of 'ds' are modified in-place.
/**
* Create a new session.
*
- * TODO: Should it use the file-global "session" variable or take an argument?
+ * @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.
/* TODO: Error checks needed? */
- /* TODO: Loop over protocol decoders and free them. */
-
g_free(session);
session = NULL;
}
/**
- * Remove all the devices from the current session. TODO?
+ * Remove all the devices from the current session.
*
* The session itself (i.e., the struct sr_session) is not free'd and still
* exists after this function returns.
/**
* Run the session.
*
- * TODO: Various error checks etc.
- *
* @return SR_OK upon success, SR_ERR_BUG upon errors.
*/
SR_API int sr_session_run(void)
*
* Hardware drivers use this to send a data packet to the frontend.
*
- * @param dev TODO.
+ * @param sdi TODO.
* @param packet The datafeed packet to send to the session bus.
*
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
return SR_OK;
}
+/**
+ * Add an event source for a file descriptor.
+ *
+ * @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.
+ * @param poll_object TODO.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
+ * SR_ERR_MALLOC upon memory allocation errors.
+ */
static int _sr_session_source_add(GPollFD *pollfd, int timeout,
sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
{
}
/**
- * Add a event source for a file descriptor.
+ * Add an event source for a file descriptor.
*
* @param fd The file descriptor.
* @param events Events to check for.
/**
* 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.
/**
* 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.
GPollFD p;
#ifdef _WIN32
- g_io_channel_win32_make_pollfd(channel,
- events, &p);
+ g_io_channel_win32_make_pollfd(channel, events, &p);
#else
p.fd = g_io_channel_unix_get_fd(channel);
p.events = events;
return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
}
-
+/**
+ * Remove the source belonging to the specified channel.
+ *
+ * @todo Add more error checks and logging.
+ *
+ * @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.
+ */
static int _sr_session_source_remove(gintptr poll_object)
{
struct source *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
/**
* 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
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
projects / libsigrok.git / commitdiff