#include <inttypes.h>
#include <stdlib.h>
+/**
+ * @mainpage libsigrokdecode API
+ *
+ * @section sec_intro Introduction
+ *
+ * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
+ * portable, cross-platform, Free/Libre/Open-Source signal analysis software
+ * suite that supports various device types (such as logic analyzers,
+ * oscilloscopes, multimeters, and more).
+ *
+ * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a
+ * shared library written in C which provides the basic API for (streaming)
+ * protocol decoding functionality.
+ *
+ * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
+ * are written in Python (>= 3.0).
+ *
+ * @section sec_api API reference
+ *
+ * See the "Modules" page for an introduction to various libsigrokdecode
+ * related topics and the detailed API documentation of the respective
+ * functions.
+ *
+ * You can also browse the API documentation by file, or review all
+ * data structures.
+ *
+ * @section sec_mailinglists Mailing lists
+ *
+ * There are two mailing lists for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
+ *
+ * @section sec_irc IRC
+ *
+ * You can find the sigrok developers in the
+ * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
+ * IRC channel on Freenode.
+ *
+ * @section sec_website Website
+ *
+ * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
+ */
+
+/**
+ * @file
+ *
+ * Initializing and shutting down libsigrokdecode.
+ */
+
+/**
+ * @defgroup grp_init Initialization
+ *
+ * Initializing and shutting down libsigrokdecode.
+ *
+ * Before using any of the libsigrokdecode functionality, srd_init() must
+ * be called to initialize the library.
+ *
+ * When libsigrokdecode functionality is no longer needed, srd_exit() should
+ * be called.
+ *
+ * @{
+ */
+
/* List of decoder instances. */
static GSList *di_list = NULL;
/* List of frontend callbacks to receive decoder output. */
static GSList *callbacks = NULL;
+/** @cond PRIVATE */
+
/* decoder.c */
extern SRD_PRIV GSList *pd_list;
/* type_logic.c */
extern SRD_PRIV PyTypeObject srd_logic_type;
+/** @endcond */
+
/**
* Initialize libsigrokdecode.
*
* be added to the Python sys.path, or NULL.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
*/
SRD_PRIV int srd_decoder_searchpath_add(const char *path)
{
return SRD_OK;
}
+/** @} */
+
+/**
+ * @defgroup grp_instances Decoder instances
+ *
+ * Decoder instance handling.
+ *
+ * @{
+ */
+
/**
* Set one or more options in a decoder instance.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
- GHashTable *options)
+ GHashTable *options)
{
PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
PyObject *py_optlist, *py_classval;
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
- GHashTable *new_probes)
+ GHashTable *new_probes)
{
GList *l;
GSList *sl;
*
* @param decoder_id Decoder 'id' field.
* @param options GHashtable of options which override the defaults set in
- * the decoder class.
+ * the decoder class. May be NULL.
*
* @return Pointer to a newly allocated struct srd_decoder_inst, or
* NULL in case of failure.
*/
SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
- GHashTable *options)
+ GHashTable *options)
{
int i;
struct srd_decoder *dec;
return NULL;
}
- inst_id = g_hash_table_lookup(options, "id");
di->decoder = dec;
- di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
- g_hash_table_remove(options, "id");
+ if (options) {
+ inst_id = g_hash_table_lookup(options, "id");
+ di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
+ g_hash_table_remove(options, "id");
+ } else
+ di->inst_id = g_strdup(decoder_id);
/*
* Prepare a default probe map, where samples come in the
return NULL;
}
- if (srd_inst_option_set(di, options) != SRD_OK) {
+ if (options && srd_inst_option_set(di, options) != SRD_OK) {
g_free(di->dec_probemap);
g_free(di);
return NULL;
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
- struct srd_decoder_inst *di_to)
+ struct srd_decoder_inst *di_to)
{
if (!di_from || !di_to) {
srd_err("Invalid from/to instance pair.");
* @param obj The Python class instantiation.
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
+ *
+ * @private
*/
SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
- const PyObject *obj)
+ const PyObject *obj)
{
-// TODO?
const GSList *l;
struct srd_decoder_inst *tmp, *di;
return di;
}
+/** @private */
SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
{
PyObject *py_name, *py_res;
* @param inbuflen Length of the buffer. Must be > 0.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
*/
SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
- const struct srd_decoder_inst *di,
- const uint8_t *inbuf, uint64_t inbuflen)
+ const struct srd_decoder_inst *di, const uint8_t *inbuf,
+ uint64_t inbuflen)
{
PyObject *py_res;
srd_logic *logic;
end_samplenum, logic))) {
srd_exception_catch("Protocol decoder instance %s: ",
di->inst_id);
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
+ return SRD_ERR_PYTHON;
}
Py_DecRef(py_res);
return SRD_OK;
}
+/** @private */
SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
{
GSList *l;
g_slist_free(di->pd_output);
}
+/** @private */
SRD_PRIV void srd_inst_free_all(GSList *stack)
{
GSList *l;
}
}
+/** @} */
+
+/**
+ * @defgroup grp_session Session handling
+ *
+ * Starting and handling decoding sessions.
+ *
+ * @{
+ */
+
/**
* Start a decoding session.
*
struct srd_decoder_inst *di;
int ret;
+ ret = SRD_OK;
+
srd_dbg("Calling start() on all instances with %d probes, "
"unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
- uint64_t inbuflen)
+ uint64_t inbuflen)
{
GSList *d;
int ret;
* @param cb_data Private data for the callback function. Can be NULL.
*/
SRD_API int srd_pd_output_callback_add(int output_type,
- srd_pd_output_callback_t cb, void *cb_data)
+ srd_pd_output_callback_t cb, void *cb_data)
{
struct srd_pd_callback *pd_cb;
return SRD_OK;
}
+/** @private */
SRD_PRIV void *srd_pd_output_callback_find(int output_type)
{
GSList *l;
}
/* This is the backend function to Python sigrokdecode.add() call. */
+/** @private */
SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
int output_type, const char *proto_id)
{
return pdo->pdo_id;
}
+
+/** @} */