X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=8a01d32e6d570968fff5177c012a3ab481830c0f;hp=07016740a9cab4afe054ebe8272c1b352c78c7cf;hb=4b442477602ef5938c4826925e21f38c8f1e13a9;hpb=ee4ed2279e3d3d4b2911aa2a1ed4effcbd1bbe60 diff --git a/controller.c b/controller.c index 0701674..8a01d32 100644 --- a/controller.c +++ b/controller.c @@ -28,7 +28,7 @@ /* 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; /* decoder.c */ @@ -44,12 +44,12 @@ 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. @@ -58,14 +58,14 @@ extern SRD_PRIV PyTypeObject srd_logic_type; * 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, 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. */ -SRD_API int srd_init(char *path) +SRD_API int srd_init(const char *path) { int ret; char *env_path; @@ -79,14 +79,14 @@ SRD_API int srd_init(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,17 +94,12 @@ SRD_API int srd_init(char *path) /* Environment variable overrides everything, for debugging. */ if ((env_path = getenv("SIGROKDECODE_DIR"))) { - if ((ret = add_modulepath(path)) != SRD_OK) { + if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { Py_Finalize(); return ret; } } - if ((ret = srd_load_all_decoders()) != SRD_OK) { - Py_Finalize(); - return ret; - } - return SRD_OK; } @@ -124,8 +119,9 @@ 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(); @@ -143,12 +139,12 @@ SRD_API 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. * - * @param path Path to an extra directory containing protocol decoders - * which will be added to the python sys.path, or NULL. + * @param path Path to the directory containing protocol decoders which shall + * be added to the Python sys.path, or NULL. * * @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; @@ -156,7 +152,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)); @@ -202,17 +198,17 @@ 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. * * @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. */ -SRD_API int srd_inst_set_options(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; @@ -298,7 +294,8 @@ SRD_API int srd_inst_set_options(struct srd_decoder_inst *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) @@ -314,28 +311,32 @@ 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_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. + * * @return SRD_OK upon success, a (negative) error code otherwise. */ -SRD_API int srd_inst_set_probes(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; @@ -403,11 +404,12 @@ SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di, * @param 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_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; @@ -416,7 +418,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_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; } @@ -431,7 +433,8 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *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) + @@ -450,14 +453,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_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; @@ -469,8 +472,16 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, return di; } +/** + * 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) + struct srd_decoder_inst *di_to) { if (!di_from || !di_to) { srd_err("Invalid from/to instance pair."); @@ -489,15 +500,16 @@ SRD_API int srd_inst_stack(struct srd_decoder_inst *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 inst_id The instance id to be found. + * @param inst_id The instance ID to be found. * * @return Pointer to struct srd_decoder_inst, or NULL if not found. */ -SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id) +SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) { GSList *l; struct srd_decoder_inst *tmp, *di; @@ -515,21 +527,23 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_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_inst, - * indicating the stack to search. To start searching at the bottom - * level of decoder instances, pass NULL. + * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. + * This will recurse to find the instance anywhere in the stack tree. + * + * @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. */ -SRD_PRIV struct srd_decoder_inst *srd_inst_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; +// TODO? + const GSList *l; struct srd_decoder_inst *tmp, *di; di = NULL; @@ -555,22 +569,23 @@ 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; } 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. */ @@ -593,9 +608,9 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -SRD_API int srd_inst_decode(uint64_t start_samplenum, - struct srd_decoder_inst *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; @@ -618,15 +633,16 @@ SRD_API int srd_inst_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); @@ -636,8 +652,8 @@ SRD_API 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); @@ -645,7 +661,7 @@ SRD_API int srd_inst_decode(uint64_t start_samplenum, return SRD_OK; } -SRD_API void srd_inst_free(struct srd_decoder_inst *di) +SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) { GSList *l; struct srd_pd_output *pdo; @@ -664,7 +680,7 @@ SRD_API void srd_inst_free(struct srd_decoder_inst *di) g_slist_free(di->pd_output); } -SRD_API void srd_inst_free_all(GSList *stack) +SRD_PRIV void srd_inst_free_all(GSList *stack) { GSList *l; struct srd_decoder_inst *di; @@ -682,6 +698,17 @@ SRD_API void srd_inst_free_all(GSList *stack) } } +/** + * 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; @@ -692,7 +719,8 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) 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))) { @@ -715,8 +743,16 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) return ret; } -/* Feed logic samples to decoder session. */ -SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf, +/** + * 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. + * + * @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; @@ -728,15 +764,27 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf, for (d = di_list; d; d = d->next) { if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, - inbuflen)) != SRD_OK) + inbuflen)) != SRD_OK) return ret; } return SRD_OK; } -SRD_API int srd_register_callback(int output_type, - srd_pd_output_callback_t cb, void *user_data) +/** + * 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; @@ -748,14 +796,14 @@ SRD_API int srd_register_callback(int output_type, } pd_cb->output_type = output_type; - pd_cb->callback = cb; - pd_cb->user_data = user_data; + pd_cb->cb = cb; + pd_cb->cb_data = cb_data; callbacks = g_slist_append(callbacks, pd_cb); return SRD_OK; } -SRD_API 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; @@ -765,7 +813,7 @@ SRD_API 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; } } @@ -774,8 +822,8 @@ SRD_API 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, - 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;