/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrokdecode project.
*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
#include "config.h"
#include <glib.h>
#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.
*
* This initializes the Python interpreter, and creates and initializes
* a "sigrokdecode" Python module.
*
- * Then, it searches for sigrok protocol decoder files (*.py) in the
- * "decoders" subdirectory of the the sigrok installation directory.
+ * Then, it searches for sigrok protocol decoders in the "decoders"
+ * subdirectory of the the libsigrokdecode installation directory.
* All decoders that are found are loaded into memory and added to an
- * internal list of decoders, which can be queried via srd_decoders_list().
+ * internal list of decoders, which can be queried via srd_decoder_list().
*
* The caller is responsible for calling the clean-up function srd_exit(),
* which will properly shut down libsigrokdecode and free its allocated memory.
* are not allowed.
*
* @param path Path to an extra directory containing protocol decoders
- * which will be added to the Python sys.path, or NULL.
+ * which will be added to the Python sys.path. May be NULL.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
- * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
- * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
- * If not enough memory could be allocated, return SRD_ERR_MALLOC.
+ * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
+ * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
+ * If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_init(const char *path)
{
* any successful srd_init() calls in between, is not allowed.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_exit(void)
{
* be added to the Python sys.path, or NULL.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
+ *
+ * @since 0.1.0
*/
SRD_PRIV int srd_decoder_searchpath_add(const char *path)
{
srd_dbg("Adding '%s' to module path.", path);
new_path = g_string_sized_new(256);
- g_string_assign(new_path, g_strdup(path));
+ g_string_assign(new_path, path);
py_cur_path = PySys_GetObject("path");
for (i = 0; i < PyList_Size(py_cur_path); i++) {
- g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S));
+ g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S);
py_item = PyList_GetItem(py_cur_path, i);
if (!PyUnicode_Check(py_item))
/* Shouldn't happen. */
if (py_str_as_str(py_item, &item) != SRD_OK)
continue;
g_string_append(new_path, item);
+ g_free(item);
}
/* Convert to wide chars. */
return SRD_OK;
}
+/** @} */
+
+/**
+ * @defgroup grp_instances Decoder instances
+ *
+ * Decoder instance handling.
+ *
+ * @{
+ */
+
/**
* Set one or more options in a decoder instance.
*
* @param options A GHashTable of options to set.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
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;
Py_UNICODE *py_ustr;
+ GVariant *value;
unsigned long long int val_ull;
+ gint64 val_int;
int num_optkeys, ret, size, i;
- char *key, *value;
+ const char *val_str;
+ char *dbg, *key;
if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
/* Decoder has no options. */
}
if ((value = g_hash_table_lookup(options, key))) {
+ dbg = g_variant_print(value, TRUE);
+ srd_dbg("got option '%s' = %s", key, dbg);
+ g_free(dbg);
/* An override for this option was provided. */
if (PyUnicode_Check(py_classval)) {
- if (!(py_optval = PyUnicode_FromString(value))) {
+ if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
+ srd_err("Option '%s' requires a string value.", key);
+ goto err_out;
+ }
+ val_str = g_variant_get_string(value, NULL);
+ if (!(py_optval = PyUnicode_FromString(val_str))) {
/* Some UTF-8 encoding error. */
PyErr_Clear();
+ srd_err("Option '%s' requires a UTF-8 string value.", key);
goto err_out;
}
} else if (PyLong_Check(py_classval)) {
- if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
+ if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
+ srd_err("Option '%s' requires an integer value.", key);
+ goto err_out;
+ }
+ val_int = g_variant_get_int64(value);
+ if (!(py_optval = PyLong_FromLong(val_int))) {
/* ValueError Exception */
PyErr_Clear();
- srd_err("Option %s has invalid value "
- "%s: expected integer.",
- key, value);
+ srd_err("Option '%s' has invalid integer value.", key);
goto err_out;
}
}
*/
if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
goto err_out;
+ g_free(key);
}
ret = SRD_OK;
* arranged in this order.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
- GHashTable *new_probes)
+ GHashTable *new_probes)
{
+ GVariant *probe_val;
GList *l;
GSList *sl;
struct srd_probe *p;
int *new_probemap, new_probenum;
- char *probe_id, *probenum_str;
+ char *probe_id;
+ int i, num_required_probes;
srd_dbg("set probes called for instance %s with list of %d probes",
di->inst_id, g_hash_table_size(new_probes));
return SRD_ERR_MALLOC;
}
+ /*
+ * For now, map all indexes to probe -1 (can be overridden later).
+ * This -1 is interpreted as an unspecified probe later.
+ */
+ for (i = 0; i < di->dec_num_probes; i++)
+ new_probemap[i] = -1;
+
for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
probe_id = l->data;
- probenum_str = g_hash_table_lookup(new_probes, probe_id);
- if (!probenum_str) {
+ probe_val= g_hash_table_lookup(new_probes, probe_id);
+ if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
/* Probe name was specified without a value. */
srd_err("No probe number was specified for %s.",
- probe_id);
+ probe_id);
g_free(new_probemap);
return SRD_ERR_ARG;
}
- new_probenum = strtol(probenum_str, NULL, 10);
+ new_probenum = g_variant_get_int32(probe_val);
if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
(GCompareFunc)compare_probe_id))) {
/* Fall back on optional probes. */
if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
probe_id, (GCompareFunc) compare_probe_id))) {
srd_err("Protocol decoder %s has no probe "
- "'%s'.", di->decoder->name, probe_id);
+ "'%s'.", di->decoder->name, probe_id);
g_free(new_probemap);
return SRD_ERR_ARG;
}
}
p = sl->data;
new_probemap[p->order] = new_probenum;
- srd_dbg("setting probe mapping for %d = probe %d", p->order,
- new_probenum);
+ srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
+ p->id, p->order, new_probenum);
+ }
+
+ srd_dbg("Final probe map:");
+ num_required_probes = g_slist_length(di->decoder->probes);
+ for (i = 0; i < di->dec_num_probes; i++) {
+ srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
+ (i < num_required_probes) ? "required" : "optional");
}
+
g_free(di->dec_probemap);
di->dec_probemap = new_probemap;
*
* @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.
+ *
+ * @since 0.1.0
*/
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;
* @param di_to The instance on top of which di_from will be stacked.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
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 inst_id The instance ID to be found.
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
+ *
+ * @since 0.1.0
*/
SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id)
{
* @param obj The Python class instantiation.
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
+ *
+ * @private
+ *
+ * @since 0.1.0
*/
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
+ *
+ * @since 0.1.0
*/
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_free(pdo);
}
g_slist_free(di->pd_output);
+ g_free(di);
}
+/** @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.
*
* @param samplerate The samplerate of the incoming feed.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
{
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);
* @param inbuflen Length in bytes of the buffer.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
- uint64_t inbuflen)
+ uint64_t inbuflen)
{
GSList *d;
int ret;
* callback per output type can be registered.
* @param cb The function to call. Must not be NULL.
* @param cb_data Private data for the callback function. Can be NULL.
+ *
+ * @since 0.1.0
*/
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;
}
+
+/** @} */
projects / libsigrokdecode.git / blobdiff