X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=995ddd7f13667302a2c7cc271829aafb2148d9cb;hp=4db4ee8543c174b4e09a85e5d577978fed599906;hb=f4d0363dc492cebc3bc37adfbffaff6fafd55ff4;hpb=abeeed8b6da45e1854bc151a8175836b5ca38e34 diff --git a/controller.c b/controller.c index 4db4ee8..995ddd7 100644 --- a/controller.c +++ b/controller.c @@ -35,7 +35,8 @@ static GSList *callbacks = NULL; 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; @@ -79,14 +80,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 +95,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; } @@ -119,8 +120,9 @@ SRD_API int srd_exit(void) { srd_dbg("Exiting libsigrokdecode."); - srd_decoders_unload_all(); + srd_decoder_unload_all(); g_slist_free(pd_list); + pd_list = NULL; /* Py_Finalize() returns void, any finalization errors are ignored. */ Py_Finalize(); @@ -143,7 +145,7 @@ SRD_API int srd_exit(void) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -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; @@ -151,7 +153,7 @@ SRD_PRIV int add_modulepath(const char *path) wchar_t *wc_new_path; char *item; - srd_dbg("adding %s to module path", path); + srd_dbg("Adding '%s' to module path.", path); new_path = g_string_sized_new(256); g_string_assign(new_path, g_strdup(path)); @@ -197,7 +199,7 @@ SRD_PRIV int add_modulepath(const char *path) } /** - * Set options in a decoder instance. + * Set one or more options in a decoder instance. * * Handled options are removed from the hash. * @@ -206,8 +208,8 @@ SRD_PRIV int add_modulepath(const char *path) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -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; @@ -310,35 +312,39 @@ 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. */ -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) { GList *l; GSList *sl; struct srd_probe *p; int *new_probemap, new_probenum; char *probe_id, *probenum_str; + 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,6 +367,13 @@ 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); @@ -385,9 +398,17 @@ SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di, } 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,7 +418,7 @@ 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. * @@ -449,14 +470,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 (srd_inst_option_set(di, options) != SRD_OK) { g_free(di->dec_probemap); g_free(di); return NULL; @@ -565,15 +586,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; } @@ -648,8 +669,8 @@ 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); + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; /* TODO: More specific error? */ } Py_DecRef(py_res); @@ -730,7 +751,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; } @@ -740,15 +761,15 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) } /** - * Feed a chunk of logic sample data to a running decoder session. + * Send a chunk of logic sample data to a running decoder session. * * @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. */ -SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf, +SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, uint64_t inbuflen) { GSList *d; @@ -768,7 +789,7 @@ SRD_API int srd_session_feed(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 @@ -779,8 +800,8 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf, * @param cb The function to call. Must not be NULL. * @param cb_data Private data for the callback function. Can be NULL. */ -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 +820,7 @@ SRD_API int srd_register_callback(int output_type, return SRD_OK; } -SRD_PRIV void *srd_find_callback(int output_type) +SRD_PRIV void *srd_pd_output_callback_find(int output_type) { GSList *l; struct srd_pd_callback *pd_cb; @@ -818,8 +839,8 @@ 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) +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;