X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=e023b7151dddd07d15f29a42efd10abde0b72ffb;hp=4ba4de1458bc562e89b38551b79209c3e44c4334;hb=8c664ca2d7b4faffa7b3dbeb3b9e491976c24eee;hpb=29dad0ac4acd7174cee00556f6104594497fe970 diff --git a/controller.c b/controller.c index 4ba4de1..e023b71 100644 --- a/controller.c +++ b/controller.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrokdecode project. * * Copyright (C) 2010 Uwe Hermann * Copyright (C) 2012 Bert Vermeulen @@ -25,21 +25,87 @@ #include #include +/** + * @mainpage libsigrokdecode API + * + * @section sec_intro Introduction + * + * The sigrok 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). + * + * libsigrokdecode is a + * shared library written in C which provides the basic API for (streaming) + * protocol decoding functionality. + * + * The protocol decoders + * 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: sigrok-devel and sigrok-commits. + * + * @section sec_irc IRC + * + * You can find the sigrok developers in the + * \#sigrok + * IRC channel on Freenode. + * + * @section sec_website Website + * + * sigrok.org/wiki/Libsigrokdecode + */ + +/** + * @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; /* module_sigrokdecode.c */ -extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void); +/* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */ +extern PyMODINIT_FUNC PyInit_sigrokdecode(void); /* type_logic.c */ extern SRD_PRIV PyTypeObject srd_logic_type; +/** @endcond */ + /** * Initialize libsigrokdecode. * @@ -64,6 +130,8 @@ extern SRD_PRIV PyTypeObject srd_logic_type; * 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. + * + * @since 0.1.0 */ SRD_API int srd_init(const char *path) { @@ -79,14 +147,14 @@ SRD_API int srd_init(const char *path) Py_Initialize(); /* Installed decoders. */ - if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) { + if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { Py_Finalize(); return ret; } /* Path specified by the user. */ if (path) { - if ((ret = add_modulepath(path)) != SRD_OK) { + if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { Py_Finalize(); return ret; } @@ -94,7 +162,7 @@ SRD_API int srd_init(const char *path) /* Environment variable overrides everything, for debugging. */ if ((env_path = getenv("SIGROKDECODE_DIR"))) { - if ((ret = add_modulepath(env_path)) != SRD_OK) { + if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { Py_Finalize(); return ret; } @@ -114,6 +182,8 @@ 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) { @@ -121,6 +191,7 @@ SRD_API int srd_exit(void) srd_decoder_unload_all(); g_slist_free(pd_list); + pd_list = NULL; /* Py_Finalize() returns void, any finalization errors are ignored. */ Py_Finalize(); @@ -142,8 +213,12 @@ 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 add_modulepath(const char *path) +SRD_PRIV int srd_decoder_searchpath_add(const char *path) { PyObject *py_cur_path, *py_item; GString *new_path; @@ -196,8 +271,18 @@ SRD_PRIV int add_modulepath(const char *path) return SRD_OK; } +/** @} */ + +/** + * @defgroup grp_instances Decoder instances + * + * Decoder instance handling. + * + * @{ + */ + /** - * Set options in a decoder instance. + * Set one or more options in a decoder instance. * * Handled options are removed from the hash. * @@ -205,16 +290,21 @@ SRD_PRIV int add_modulepath(const char *path) * @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_options_set(struct srd_decoder_inst *di, - GHashTable *options) +SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, + 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. */ @@ -253,20 +343,32 @@ SRD_API int srd_inst_options_set(struct srd_decoder_inst *di, } 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; } } @@ -310,35 +412,42 @@ err_out: Py_XDECREF(py_dec_options); g_free(key); if (PyErr_Occurred()) - catch_exception("Stray exception in srd_inst_set_options()."); + srd_exception_catch("Stray exception in srd_inst_option_set()."); return ret; } -/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */ +/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) { return strcmp(a->id, probe_id); } /** - * Set probes in a decoder instance. + * Set all probes in a decoder instance. + * + * This function sets _all_ probes for the specified decoder instance, i.e., + * it overwrites any probes that were already defined (if any). * * @param di Decoder instance. - * @param probes A GHashTable of probes to set. Key is probe name, value is - * the probe number. Samples passed to this instance will be - * arranged in this order. + * @param new_probes A GHashTable of probes to set. Key is probe name, value is + * the probe number. Samples passed to this instance will be + * arranged in this order. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ -SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di, - GHashTable *new_probes) +SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, + 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)); @@ -361,33 +470,48 @@ SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di, 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; @@ -397,15 +521,17 @@ SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di, /** * Create a new protocol decoder instance. * - * @param id Decoder 'id' field. + * @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; @@ -424,10 +550,13 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, 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 @@ -449,14 +578,14 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, /* Create a new instance of this decoder class. */ if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { if (PyErr_Occurred()) - catch_exception("failed to create %s instance: ", - decoder_id); + srd_exception_catch("failed to create %s instance: ", + decoder_id); g_free(di->dec_probemap); g_free(di); return NULL; } - if (srd_inst_options_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; @@ -475,9 +604,11 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, * @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."); @@ -504,6 +635,8 @@ SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, * @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) { @@ -534,11 +667,14 @@ 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; @@ -554,6 +690,7 @@ SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, return di; } +/** @private */ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) { PyObject *py_name, *py_res; @@ -565,15 +702,15 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) if (!(py_name = PyUnicode_FromString("start"))) { srd_err("Unable to build Python object for 'start'."); - catch_exception("Protocol decoder instance %s: ", - di->inst_id); + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; } if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, py_name, args, NULL))) { - catch_exception("Protocol decoder instance %s: ", - di->inst_id); + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; } @@ -603,10 +740,14 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) * @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; @@ -648,15 +789,16 @@ SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", "KKO", logic->start_samplenum, end_samplenum, logic))) { - catch_exception("Protocol decoder instance %s: ", - di->inst_id); - return SRD_ERR_PYTHON; /* TODO: More specific error? */ + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); + 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; @@ -676,6 +818,7 @@ SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) g_slist_free(di->pd_output); } +/** @private */ SRD_PRIV void srd_inst_free_all(GSList *stack) { GSList *l; @@ -694,6 +837,16 @@ SRD_PRIV void srd_inst_free_all(GSList *stack) } } +/** @} */ + +/** + * @defgroup grp_session Session handling + * + * Starting and handling decoding sessions. + * + * @{ + */ + /** * Start a decoding session. * @@ -704,6 +857,8 @@ SRD_PRIV void srd_inst_free_all(GSList *stack) * @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) { @@ -712,6 +867,8 @@ 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); @@ -730,7 +887,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) di->data_num_probes = num_probes; di->data_unitsize = unitsize; di->data_samplerate = samplerate; - if ((ret = srd_inst_start(di, args) != SRD_OK)) + if ((ret = srd_inst_start(di, args)) != SRD_OK) break; } @@ -744,12 +901,14 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) * * @param start_samplenum The sample number of the first sample in this chunk. * @param inbuf Pointer to sample data. - * @param inbuf Length in bytes of the buffer. + * @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; @@ -768,7 +927,7 @@ SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, } /** - * Register a decoder output callback function. + * Register/add a decoder output callback function. * * The function will be called when a protocol decoder sends output back * to the PD controller (except for Python objects, which only go up the @@ -778,9 +937,11 @@ SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, * 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_register_callback(int output_type, - srd_pd_output_callback_t cb, void *cb_data) +SRD_API int srd_pd_output_callback_add(int output_type, + srd_pd_output_callback_t cb, void *cb_data) { struct srd_pd_callback *pd_cb; @@ -799,7 +960,8 @@ SRD_API int srd_register_callback(int output_type, return SRD_OK; } -SRD_PRIV void *srd_find_callback(int output_type) +/** @private */ +SRD_PRIV void *srd_pd_output_callback_find(int output_type) { GSList *l; struct srd_pd_callback *pd_cb; @@ -818,8 +980,9 @@ SRD_PRIV void *srd_find_callback(int output_type) } /* This is the backend function to Python sigrokdecode.add() call. */ -SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type, - const char *proto_id) +/** @private */ +SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, + int output_type, const char *proto_id) { struct srd_pd_output *pdo; @@ -840,3 +1003,5 @@ SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type, return pdo->pdo_id; } + +/** @} */