X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=995ddd7f13667302a2c7cc271829aafb2148d9cb;hp=d5bab5bc032562f07ae66262b680886480c295a5;hb=41e5c645a828eec6d1df30cc1e5840027cf787b2;hpb=bb590e071c0f6554695334b5da804c75267541fb diff --git a/controller.c b/controller.c index d5bab5b..995ddd7 100644 --- a/controller.c +++ b/controller.c @@ -25,33 +25,32 @@ #include #include - /* List of decoder instances. */ static GSList *di_list = NULL; -/* List of frontend callbacks to receive PD output. */ +/* List of frontend callbacks to receive decoder output. */ static GSList *callbacks = NULL; -/* lives in decoder.c */ -extern GSList *pd_list; +/* decoder.c */ +extern SRD_PRIV GSList *pd_list; -/* lives in module_sigrokdecode.c */ +/* module_sigrokdecode.c */ +/* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */ extern PyMODINIT_FUNC PyInit_sigrokdecode(void); -/* lives in type_logic.c */ -extern PyTypeObject srd_logic_type; - +/* type_logic.c */ +extern SRD_PRIV PyTypeObject srd_logic_type; /** * Initialize libsigrokdecode. * * This initializes the Python interpreter, and creates and initializes - * a "sigrok" Python module with a single put() method. + * a "sigrokdecode" Python module. * * Then, it searches for sigrok protocol decoder files (*.py) in the * "decoders" subdirectory of the the sigrok 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_list_decoders(). + * internal list of decoders, which can be queried via srd_decoders_list(). * * The caller is responsible for calling the clean-up function srd_exit(), * which will properly shut down libsigrokdecode and free its allocated memory. @@ -59,37 +58,52 @@ extern PyTypeObject srd_logic_type; * Multiple calls to srd_init(), without calling srd_exit() in between, * are not allowed. * + * @param path Path to an extra directory containing protocol decoders + * which will be added to the Python sys.path, or 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. */ -int srd_init(void) +SRD_API int srd_init(const char *path) { int ret; + char *env_path; srd_dbg("Initializing libsigrokdecode."); /* Add our own module to the list of built-in modules. */ PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); - /* Initialize the python interpreter. */ + /* Initialize the Python interpreter. */ Py_Initialize(); - if ((ret = set_modulepath()) != SRD_OK) { + /* Installed decoders. */ + if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { Py_Finalize(); return ret; } - if ((ret = srd_load_all_decoders()) != SRD_OK) { - Py_Finalize(); - return ret; + /* Path specified by the user. */ + if (path) { + if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { + Py_Finalize(); + return ret; + } + } + + /* Environment variable overrides everything, for debugging. */ + if ((env_path = getenv("SIGROKDECODE_DIR"))) { + if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { + Py_Finalize(); + return ret; + } } return SRD_OK; } - /** * Shutdown libsigrokdecode. * @@ -102,13 +116,13 @@ int srd_init(void) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_exit(void) +SRD_API int srd_exit(void) { - srd_dbg("Exiting libsigrokdecode."); - srd_unload_all_decoders(); + srd_decoder_unload_all(); g_slist_free(pd_list); + pd_list = NULL; /* Py_Finalize() returns void, any finalization errors are ignored. */ Py_Finalize(); @@ -116,7 +130,6 @@ int srd_exit(void) return SRD_OK; } - /** * Add an additional search directory for the protocol decoders. * @@ -127,55 +140,76 @@ int srd_exit(void) * Python modules which have the same name as a sigrok protocol decoder in * sys.path or in the current working directory. * - * TODO: add path from env var SIGROKDECODE_PATH, config etc - * TODO: Should take directoryname/path as input. + * @param path Path to the directory containing protocol decoders which shall + * be added to the Python sys.path, or NULL. * - * @return TODO. + * @return SRD_OK upon success, a (negative) error code otherwise. */ -int set_modulepath(void) +SRD_PRIV int srd_decoder_searchpath_add(const char *path) { - int ret; - gchar *path, *s; - -#ifdef _WIN32 - gchar **splitted; - - /* - * On Windows/MinGW, Python's sys.path needs entries of the form - * 'C:\\foo\\bar' instead of '/foo/bar'. - */ - - splitted = g_strsplit(DECODERS_DIR, "/", 0); - path = g_build_pathv("\\\\", splitted); - g_strfreev(splitted); -#else - path = g_strdup(DECODERS_DIR); -#endif - - /* TODO: Sanity check on 'path' (length, escape special chars, ...). */ - s = g_strdup_printf("import sys; sys.path.insert(0, r'%s')", path); - - ret = PyRun_SimpleString(s); + PyObject *py_cur_path, *py_item; + GString *new_path; + int wc_len, i; + wchar_t *wc_new_path; + char *item; + + srd_dbg("Adding '%s' to module path.", path); + + new_path = g_string_sized_new(256); + g_string_assign(new_path, g_strdup(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)); + py_item = PyList_GetItem(py_cur_path, i); + if (!PyUnicode_Check(py_item)) + /* Shouldn't happen. */ + continue; + if (py_str_as_str(py_item, &item) != SRD_OK) + continue; + g_string_append(new_path, item); + } - g_free(path); - g_free(s); + /* Convert to wide chars. */ + wc_len = sizeof(wchar_t) * (new_path->len + 1); + if (!(wc_new_path = g_try_malloc(wc_len))) { + srd_dbg("malloc failed"); + return SRD_ERR_MALLOC; + } + mbstowcs(wc_new_path, new_path->str, wc_len); + PySys_SetPath(wc_new_path); + g_string_free(new_path, TRUE); + g_free(wc_new_path); + +//#ifdef _WIN32 +// gchar **splitted; +// +// /* +// * On Windows/MinGW, Python's sys.path needs entries of the form +// * 'C:\\foo\\bar' instead of '/foo/bar'. +// */ +// +// splitted = g_strsplit(DECODERS_DIR, "/", 0); +// path = g_build_pathv("\\\\", splitted); +// g_strfreev(splitted); +//#else +// path = g_strdup(DECODERS_DIR); +//#endif - return ret; + return SRD_OK; } - /** - * Set options in a decoder instance. + * Set one or more options in a decoder instance. + * + * Handled options are removed from the hash. * * @param di Decoder instance. * @param options A GHashTable of options to set. * - * Handled options are removed from the hash. - * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_instance_set_options(struct srd_decoder_instance *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; @@ -184,7 +218,7 @@ int srd_instance_set_options(struct srd_decoder_instance *di, int num_optkeys, ret, size, i; char *key, *value; - if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) { + if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { /* Decoder has no options. */ if (g_hash_table_size(options) == 0) { /* No options provided. */ @@ -205,7 +239,7 @@ int srd_instance_set_options(struct srd_decoder_instance *di, /* All of these are synthesized objects, so they're good. */ py_dec_optkeys = PyDict_Keys(py_dec_options); num_optkeys = PyList_Size(py_dec_optkeys); - if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options"))) + if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) goto err_out; for (i = 0; i < num_optkeys; i++) { /* Get the default class value for this option. */ @@ -215,7 +249,8 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (!(py_classval = PyList_GetItem(py_optlist, 1))) goto err_out; if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { - srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name); + srd_err("Options of type %s are not yet supported.", + Py_TYPE(py_classval)->tp_name); goto err_out; } @@ -231,8 +266,9 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (!(py_optval = PyLong_FromString(value, NULL, 0))) { /* ValueError Exception */ PyErr_Clear(); - srd_err("Option %s has invalid value %s: expected integer.", - key, value); + srd_err("Option %s has invalid value " + "%s: expected integer.", + key, value); goto err_out; } } @@ -250,7 +286,8 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (val_ull == (unsigned long long)-1) { /* OverFlowError exception */ PyErr_Clear(); - srd_err("Invalid integer value for %s: expected integer.", key); + srd_err("Invalid integer value for %s: " + "expected integer.", key); goto err_out; } if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) @@ -258,7 +295,8 @@ int srd_instance_set_options(struct srd_decoder_instance *di, } } - /* If we got here, py_optval holds a known good new reference + /* + * If we got here, py_optval holds a known good new reference * to the instance option to set. */ if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) @@ -274,64 +312,75 @@ err_out: Py_XDECREF(py_dec_options); g_free(key); if (PyErr_Occurred()) - catch_exception("Stray exception in srd_instance_set_options()."); + srd_exception_catch("Stray exception in srd_inst_option_set()."); return ret; } -/* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */ -static gint compare_probe_id(struct srd_probe *a, char *probe_id) +/* 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. */ -int srd_instance_set_probes(struct srd_decoder_instance *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->instance_id, g_hash_table_size(new_probes)); + di->inst_id, g_hash_table_size(new_probes)); if (g_hash_table_size(new_probes) == 0) /* No probes provided. */ return SRD_OK; - if(di->dec_num_probes == 0) { + if (di->dec_num_probes == 0) { /* Decoder has no probes. */ srd_err("Protocol decoder %s has no probes to define.", - di->decoder->name); + di->decoder->name); return SRD_ERR_ARG; } new_probemap = NULL; if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { - srd_err("Failed to malloc new probe map."); + srd_err("Failed to g_malloc() new probe map."); 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 name was specified without a value. */ - srd_err("No probe number was specified for %s.", probe_id); + srd_err("No probe number was specified for %s.", + probe_id); g_free(new_probemap); return SRD_ERR_ARG; } @@ -340,17 +389,26 @@ int srd_instance_set_probes(struct srd_decoder_instance *di, (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); + probe_id, (GCompareFunc) compare_probe_id))) { + srd_err("Protocol decoder %s has no probe " + "'%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; @@ -360,45 +418,48 @@ int srd_instance_set_probes(struct srd_decoder_instance *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. - * @return Pointer to a newly allocated struct srd_decoder_instance, or - * NULL in case of failure. + * the decoder class. + * + * @return Pointer to a newly allocated struct srd_decoder_inst, or + * NULL in case of failure. */ -struct srd_decoder_instance *srd_instance_new(const char *decoder_id, - GHashTable *options) +SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, + GHashTable *options) { - struct srd_decoder *dec; - struct srd_decoder_instance *di; int i; - char *instance_id; + struct srd_decoder *dec; + struct srd_decoder_inst *di; + char *inst_id; srd_dbg("Creating new %s instance.", decoder_id); - if (!(dec = srd_get_decoder_by_id(decoder_id))) { + if (!(dec = srd_decoder_get_by_id(decoder_id))) { srd_err("Protocol decoder %s not found.", decoder_id); return NULL; } - if (!(di = g_try_malloc0(sizeof(*di)))) { - srd_err("Failed to malloc instance."); + if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { + srd_err("Failed to g_malloc() instance."); return NULL; } - instance_id = g_hash_table_lookup(options, "id"); + inst_id = g_hash_table_lookup(options, "id"); di->decoder = dec; - di->instance_id = g_strdup(instance_id ? instance_id : decoder_id); + di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); g_hash_table_remove(options, "id"); - /* Prepare a default probe map, where samples come in the + /* + * Prepare a default probe map, where samples come in the * order in which the decoder class defined them. */ di->dec_num_probes = g_slist_length(di->decoder->probes) + - g_slist_length(di->decoder->opt_probes); + g_slist_length(di->decoder->opt_probes); if (di->dec_num_probes) { - if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { - srd_err("Failed to malloc probe map."); + if (!(di->dec_probemap = + g_try_malloc(sizeof(int) * di->dec_num_probes))) { + srd_err("Failed to g_malloc() probe map."); g_free(di); return NULL; } @@ -407,15 +468,16 @@ struct srd_decoder_instance *srd_instance_new(const char *decoder_id, } /* Create a new instance of this decoder class. */ - if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) { + 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_instance_set_options(di, options) != SRD_OK) { + if (srd_inst_option_set(di, options) != SRD_OK) { g_free(di->dec_probemap); g_free(di); return NULL; @@ -427,10 +489,17 @@ struct srd_decoder_instance *srd_instance_new(const char *decoder_id, return di; } -int srd_instance_stack(struct srd_decoder_instance *di_from, - struct srd_decoder_instance *di_to) +/** + * Stack a decoder instance on top of another. + * + * @param di_from The instance to move. + * @param di_to The instance on top of which di_from will be stacked. + * + * @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) { - if (!di_from || !di_to) { srd_err("Invalid from/to instance pair."); return SRD_ERR_ARG; @@ -448,23 +517,24 @@ int srd_instance_stack(struct srd_decoder_instance *di_from, } /** - * Finds a decoder instance by its instance id, but only in the bottom - * level of instances -- instances already stacked on top of another one - * will not be found. + * Find a decoder instance by its instance ID. + * + * Only the bottom level of instances are searched -- instances already stacked + * on top of another one will not be found. * - * @param instance_id The instance id to be found. + * @param inst_id The instance ID to be found. * - * @return Pointer to struct srd_decoder_instance, or NULL if not found. + * @return Pointer to struct srd_decoder_inst, or NULL if not found. */ -struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id) +SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) { GSList *l; - struct srd_decoder_instance *tmp, *di; + struct srd_decoder_inst *tmp, *di; di = NULL; for (l = di_list; l; l = l->next) { tmp = l->data; - if (!strcmp(tmp->instance_id, instance_id)) { + if (!strcmp(tmp->inst_id, inst_id)) { di = tmp; break; } @@ -474,66 +544,71 @@ struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id) } /** - * Finds a decoder instance by its python object, i.e. that instance's - * instantiation of the sigrokdecode.Decoder class. This will recurse - * to find the instance anywhere in the stack tree. + * Find a decoder instance by its Python object. * - * @param stack Pointer to a GSList of struct srd_decoder_instance, - * indicating the stack to search. To start searching at the bottom - * level of decoder instances, pass NULL. - * @param obj The python class instantiation. + * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. + * This will recurse to find the instance anywhere in the stack tree. * - * @return Pointer to struct srd_decoder_instance, or NULL if not found. + * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the + * stack to search. To start searching at the bottom level of + * decoder instances, pass NULL. + * @param obj The Python class instantiation. + * + * @return Pointer to struct srd_decoder_inst, or NULL if not found. */ -struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack, - PyObject *obj) +SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, + const PyObject *obj) { - GSList *l; - struct srd_decoder_instance *tmp, *di; +// TODO? + const GSList *l; + struct srd_decoder_inst *tmp, *di; di = NULL; for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { tmp = l->data; - if (tmp->py_instance == obj) + if (tmp->py_inst == obj) di = tmp; else if (tmp->next_di) - di = srd_instance_find_by_obj(tmp->next_di, obj); + di = srd_inst_find_by_obj(tmp->next_di, obj); } return di; } -int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) +SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) { PyObject *py_name, *py_res; GSList *l; - struct srd_decoder_instance *next_di; + struct srd_decoder_inst *next_di; srd_dbg("Calling start() method on protocol decoder instance %s.", - di->instance_id); + di->inst_id); if (!(py_name = PyUnicode_FromString("start"))) { - srd_err("Unable to build python object for 'start'."); - catch_exception("Protocol decoder instance %s: ", di->instance_id); + srd_err("Unable to build Python object for 'start'."); + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; } - if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance, - py_name, args, NULL))) { - catch_exception("Protocol decoder instance %s: ", di->instance_id); + if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, + py_name, args, NULL))) { + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; } Py_DecRef(py_res); Py_DecRef(py_name); - /* Start all the PDs stacked on top of this one. Pass along the + /* + * Start all the PDs stacked on top of this one. Pass along the * metadata all the way from the bottom PD, even though it's only * applicable to logic data for now. */ for (l = di->next_di; l; l = l->next) { next_di = l->data; - srd_instance_start(next_di, args); + srd_inst_start(next_di, args); } return SRD_OK; @@ -550,15 +625,16 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_instance_decode(uint64_t start_samplenum, - struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen) +SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, + const struct srd_decoder_inst *di, + const uint8_t *inbuf, uint64_t inbuflen) { PyObject *py_res; srd_logic *logic; uint64_t end_samplenum; srd_dbg("Calling decode() on instance %s with %d bytes starting " - "at sample %d.", di->instance_id, inbuflen, start_samplenum); + "at sample %d.", di->inst_id, inbuflen, start_samplenum); /* Return an error upon unusable input. */ if (!di) { @@ -574,24 +650,27 @@ int srd_instance_decode(uint64_t start_samplenum, return SRD_ERR_ARG; } - /* Create new srd_logic object. Each iteration around the PD's loop + /* + * Create new srd_logic object. Each iteration around the PD's loop * will fill one sample into this object. */ logic = PyObject_New(srd_logic, &srd_logic_type); Py_INCREF(logic); - logic->di = di; + logic->di = (struct srd_decoder_inst *)di; logic->start_samplenum = start_samplenum; logic->itercnt = 0; - logic->inbuf = inbuf; + logic->inbuf = (uint8_t *)inbuf; logic->inbuflen = inbuflen; logic->sample = PyList_New(2); Py_INCREF(logic->sample); - Py_IncRef(di->py_instance); + Py_IncRef(di->py_inst); end_samplenum = start_samplenum + inbuflen / di->data_unitsize; - if (!(py_res = PyObject_CallMethod(di->py_instance, "decode", - "KKO", logic->start_samplenum, end_samplenum, logic))) { - catch_exception("Protocol decoder instance %s: ", di->instance_id); + if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", + "KKO", logic->start_samplenum, + end_samplenum, logic))) { + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; /* TODO: More specific error? */ } Py_DecRef(py_res); @@ -599,15 +678,15 @@ int srd_instance_decode(uint64_t start_samplenum, return SRD_OK; } -void srd_instance_free(struct srd_decoder_instance *di) +SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) { GSList *l; struct srd_pd_output *pdo; - srd_dbg("Freeing instance %s", di->instance_id); + srd_dbg("Freeing instance %s", di->inst_id); - Py_DecRef(di->py_instance); - g_free(di->instance_id); + Py_DecRef(di->py_inst); + g_free(di->inst_id); g_free(di->dec_probemap); g_slist_free(di->next_di); for (l = di->pd_output; l; l = l->next) { @@ -616,43 +695,53 @@ void srd_instance_free(struct srd_decoder_instance *di) g_free(pdo); } g_slist_free(di->pd_output); - } -void srd_instance_free_all(GSList *stack) +SRD_PRIV void srd_inst_free_all(GSList *stack) { GSList *l; - struct srd_decoder_instance *di; + struct srd_decoder_inst *di; di = NULL; for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { di = l->data; if (di->next_di) - srd_instance_free_all(di->next_di); - srd_instance_free(di); + srd_inst_free_all(di->next_di); + srd_inst_free(di); } if (!stack) { g_slist_free(di_list); di_list = NULL; } - } -int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) +/** + * Start a decoding session. + * + * Decoders, instances and stack must have been prepared beforehand. + * + * @param num_probes The number of probes which the incoming feed will contain. + * @param unitsize The number of bytes per sample in the incoming feed. + * @param samplerate The samplerate of the incoming feed. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + */ +SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) { PyObject *args; GSList *d; - struct srd_decoder_instance *di; + struct srd_decoder_inst *di; int ret; srd_dbg("Calling start() on all instances with %d probes, " "unitsize %d samplerate %d.", num_probes, unitsize, samplerate); - /* Currently only one item of metadata is passed along to decoders, + /* + * Currently only one item of metadata is passed along to decoders, * samplerate. This can be extended as needed. */ if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { - srd_err("Unable to build python object for metadata."); + srd_err("Unable to build Python object for metadata."); return SRD_ERR_PYTHON; } @@ -662,7 +751,7 @@ 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_instance_start(di, args) != SRD_OK)) + if ((ret = srd_inst_start(di, args)) != SRD_OK) break; } @@ -671,42 +760,67 @@ int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) return ret; } -/* Feed logic samples to decoder session. */ -int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen) +/** + * 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 inbuflen Length in bytes of the buffer. + * + * @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) { GSList *d; int ret; srd_dbg("Calling decode() on all instances with starting sample " - "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum, - inbuflen, inbuf); + "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", + start_samplenum, inbuflen, inbuf); for (d = di_list; d; d = d->next) { - if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf, - inbuflen)) != SRD_OK) + if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, + inbuflen)) != SRD_OK) return ret; } return SRD_OK; } -int srd_register_callback(int output_type, srd_pd_output_callback_t cb) +/** + * 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 + * stack). + * + * @param output_type The output type this callback will receive. Only one + * 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. + */ +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; srd_dbg("Registering new callback for output type %d.", output_type); - if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) + if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { + srd_err("Failed to g_malloc() struct srd_pd_callback."); return SRD_ERR_MALLOC; + } pd_cb->output_type = output_type; - pd_cb->callback = cb; + pd_cb->cb = cb; + pd_cb->cb_data = cb_data; callbacks = g_slist_append(callbacks, pd_cb); return SRD_OK; } -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; @@ -716,7 +830,7 @@ void *srd_find_callback(int output_type) for (l = callbacks; l; l = l->next) { pd_cb = l->data; if (pd_cb->output_type == output_type) { - cb = pd_cb->callback; + cb = pd_cb->cb; break; } } @@ -724,17 +838,19 @@ void *srd_find_callback(int output_type) return cb; } - -/* This is the backend function to python sigrokdecode.add() call. */ -int pd_add(struct srd_decoder_instance *di, int output_type, char *proto_id) +/* This is the backend function to Python sigrokdecode.add() call. */ +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; srd_dbg("Instance %s creating new output type %d for %s.", - di->instance_id, output_type, proto_id); + di->inst_id, output_type, proto_id); - if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) + if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { + srd_err("Failed to g_malloc() struct srd_pd_output."); return -1; + } /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ pdo->pdo_id = g_slist_length(di->pd_output); @@ -745,4 +861,3 @@ int pd_add(struct srd_decoder_instance *di, int output_type, char *proto_id) return pdo->pdo_id; } -