blob: 07016740a9cab4afe054ebe8272c1b352c78c7cf [file] [log] [blame]
Bert Vermeulenb2c19612011-12-04 10:33:02 +01001/*
2 * This file is part of the sigrok project.
3 *
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +01005 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
Bert Vermeulenb2c19612011-12-04 10:33:02 +01006 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
Uwe Hermann73191412012-01-03 19:56:01 +010021#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
Bert Vermeulen7ce77752012-01-10 00:25:16 +010022#include "sigrokdecode-internal.h"
23#include "config.h"
Bert Vermeulenb2c19612011-12-04 10:33:02 +010024#include <glib.h>
Bert Vermeulen1aef2f92011-12-15 03:31:31 +010025#include <inttypes.h>
Bert Vermeulen0bdadba2012-01-17 03:37:34 +010026#include <stdlib.h>
Bert Vermeulenb2c19612011-12-04 10:33:02 +010027
Bert Vermeulend906d3f2012-01-22 02:51:49 +010028/* List of decoder instances. */
Bert Vermeulen7ce77752012-01-10 00:25:16 +010029static GSList *di_list = NULL;
Bert Vermeulend906d3f2012-01-22 02:51:49 +010030
31/* List of frontend callbacks to receive PD output. */
Bert Vermeulen983cb0f2012-01-08 03:20:12 +010032static GSList *callbacks = NULL;
33
Uwe Hermannc9bfccc2012-02-08 22:39:30 +010034/* decoder.c */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +010035extern SRD_PRIV GSList *pd_list;
Bert Vermeulenb2c19612011-12-04 10:33:02 +010036
Uwe Hermannc9bfccc2012-02-08 22:39:30 +010037/* module_sigrokdecode.c */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +010038extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void);
Bert Vermeulenb2c19612011-12-04 10:33:02 +010039
Uwe Hermannc9bfccc2012-02-08 22:39:30 +010040/* type_logic.c */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +010041extern SRD_PRIV PyTypeObject srd_logic_type;
Bert Vermeulenb2c19612011-12-04 10:33:02 +010042
Bert Vermeulenb2c19612011-12-04 10:33:02 +010043/**
44 * Initialize libsigrokdecode.
45 *
46 * This initializes the Python interpreter, and creates and initializes
47 * a "sigrok" Python module with a single put() method.
48 *
49 * Then, it searches for sigrok protocol decoder files (*.py) in the
50 * "decoders" subdirectory of the the sigrok installation directory.
51 * All decoders that are found are loaded into memory and added to an
52 * internal list of decoders, which can be queried via srd_list_decoders().
53 *
54 * The caller is responsible for calling the clean-up function srd_exit(),
55 * which will properly shut down libsigrokdecode and free its allocated memory.
56 *
Bert Vermeulen7ce77752012-01-10 00:25:16 +010057 * Multiple calls to srd_init(), without calling srd_exit() in between,
Bert Vermeulenb2c19612011-12-04 10:33:02 +010058 * are not allowed.
59 *
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +010060 * @param path Path to an extra directory containing protocol decoders
61 * which will be added to the python sys.path, or NULL.
62 *
Bert Vermeulenb2c19612011-12-04 10:33:02 +010063 * @return SRD_OK upon success, a (negative) error code otherwise.
64 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
65 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
66 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
67 */
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +010068SRD_API int srd_init(char *path)
Bert Vermeulenb2c19612011-12-04 10:33:02 +010069{
70 int ret;
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +010071 char *env_path;
Bert Vermeulenb2c19612011-12-04 10:33:02 +010072
Uwe Hermann7a1712c2012-01-26 01:15:10 +010073 srd_dbg("Initializing libsigrokdecode.");
Bert Vermeulend906d3f2012-01-22 02:51:49 +010074
75 /* Add our own module to the list of built-in modules. */
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +010076 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
Bert Vermeulen5f802ec2011-12-27 22:15:53 +010077
Uwe Hermann511e2122012-02-10 09:29:38 +010078 /* Initialize the Python interpreter. */
Bert Vermeulenb2c19612011-12-04 10:33:02 +010079 Py_Initialize();
80
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +010081 /* Installed decoders. */
82 if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) {
Bert Vermeulenb2c19612011-12-04 10:33:02 +010083 Py_Finalize();
84 return ret;
85 }
86
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +010087 /* Path specified by the user. */
88 if (path) {
89 if ((ret = add_modulepath(path)) != SRD_OK) {
90 Py_Finalize();
91 return ret;
92 }
93 }
94
95 /* Environment variable overrides everything, for debugging. */
96 if ((env_path = getenv("SIGROKDECODE_DIR"))) {
97 if ((ret = add_modulepath(path)) != SRD_OK) {
98 Py_Finalize();
99 return ret;
100 }
101 }
102
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100103 if ((ret = srd_load_all_decoders()) != SRD_OK) {
104 Py_Finalize();
105 return ret;
106 }
107
108 return SRD_OK;
109}
110
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100111/**
112 * Shutdown libsigrokdecode.
113 *
114 * This frees all the memory allocated for protocol decoders and shuts down
115 * the Python interpreter.
116 *
117 * This function should only be called if there was a (successful!) invocation
118 * of srd_init() before. Calling this function multiple times in a row, without
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100119 * any successful srd_init() calls in between, is not allowed.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100120 *
121 * @return SRD_OK upon success, a (negative) error code otherwise.
122 */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100123SRD_API int srd_exit(void)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100124{
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100125 srd_dbg("Exiting libsigrokdecode.");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100126
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100127 srd_unload_all_decoders();
Bert Vermeulene5080882011-12-07 09:56:49 +0100128 g_slist_free(pd_list);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100129
130 /* Py_Finalize() returns void, any finalization errors are ignored. */
131 Py_Finalize();
132
133 return SRD_OK;
134}
135
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100136/**
Uwe Hermann9d9fcb32012-01-23 19:58:06 +0100137 * Add an additional search directory for the protocol decoders.
138 *
139 * The specified directory is prepended (not appended!) to Python's sys.path,
140 * in order to search for sigrok protocol decoders in the specified
141 * directories first, and in the generic Python module directories (and in
142 * the current working directory) last. This avoids conflicts if there are
143 * Python modules which have the same name as a sigrok protocol decoder in
144 * sys.path or in the current working directory.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100145 *
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100146 * @param path Path to an extra directory containing protocol decoders
147 * which will be added to the python sys.path, or NULL.
Uwe Hermann9d9fcb32012-01-23 19:58:06 +0100148 *
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100149 * @return SRD_OK upon success, a (negative) error code otherwise.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100150 */
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100151SRD_PRIV int add_modulepath(const char *path)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100152{
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100153 PyObject *py_cur_path, *py_item;
154 GString *new_path;
155 int wc_len, i;
156 wchar_t *wc_new_path;
157 char *item;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100158
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100159 srd_dbg("adding %s to module path", path);
Uwe Hermann639c5682012-01-19 00:21:00 +0100160
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100161 new_path = g_string_sized_new(256);
162 g_string_assign(new_path, g_strdup(path));
163 py_cur_path = PySys_GetObject("path");
164 for (i = 0; i < PyList_Size(py_cur_path); i++) {
165 g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S));
166 py_item = PyList_GetItem(py_cur_path, i);
167 if (!PyUnicode_Check(py_item))
168 /* Shouldn't happen. */
169 continue;
170 if (py_str_as_str(py_item, &item) != SRD_OK)
171 continue;
172 g_string_append(new_path, item);
173 }
Uwe Hermann639c5682012-01-19 00:21:00 +0100174
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100175 /* Convert to wide chars. */
176 wc_len = sizeof(wchar_t) * (new_path->len + 1);
177 if (!(wc_new_path = g_try_malloc(wc_len))) {
178 srd_dbg("malloc failed");
179 return SRD_ERR_MALLOC;
180 }
181 mbstowcs(wc_new_path, new_path->str, wc_len);
182 PySys_SetPath(wc_new_path);
183 g_string_free(new_path, TRUE);
184 g_free(wc_new_path);
Uwe Hermann639c5682012-01-19 00:21:00 +0100185
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100186//#ifdef _WIN32
187// gchar **splitted;
188//
189// /*
190// * On Windows/MinGW, Python's sys.path needs entries of the form
191// * 'C:\\foo\\bar' instead of '/foo/bar'.
192// */
193//
194// splitted = g_strsplit(DECODERS_DIR, "/", 0);
195// path = g_build_pathv("\\\\", splitted);
196// g_strfreev(splitted);
197//#else
198// path = g_strdup(DECODERS_DIR);
199//#endif
Uwe Hermann639c5682012-01-19 00:21:00 +0100200
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100201 return SRD_OK;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100202}
203
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100204/**
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100205 * Set options in a decoder instance.
206 *
207 * @param di Decoder instance.
208 * @param options A GHashTable of options to set.
209 *
210 * Handled options are removed from the hash.
211 *
212 * @return SRD_OK upon success, a (negative) error code otherwise.
213 */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100214SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100215 GHashTable *options)
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100216{
217 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
218 PyObject *py_optlist, *py_classval;
219 Py_UNICODE *py_ustr;
220 unsigned long long int val_ull;
221 int num_optkeys, ret, size, i;
222 char *key, *value;
223
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100224 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100225 /* Decoder has no options. */
Bert Vermeulene431d9c2012-01-18 22:59:14 +0100226 if (g_hash_table_size(options) == 0) {
227 /* No options provided. */
228 return SRD_OK;
229 } else {
230 srd_err("Protocol decoder has no options.");
231 return SRD_ERR_ARG;
232 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100233 return SRD_OK;
Bert Vermeulene431d9c2012-01-18 22:59:14 +0100234 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100235
236 ret = SRD_ERR_PYTHON;
237 key = NULL;
238 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
239 py_optlist = py_classval = NULL;
240 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100241
242 /* All of these are synthesized objects, so they're good. */
243 py_dec_optkeys = PyDict_Keys(py_dec_options);
244 num_optkeys = PyList_Size(py_dec_optkeys);
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100245 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100246 goto err_out;
247 for (i = 0; i < num_optkeys; i++) {
248 /* Get the default class value for this option. */
249 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
250 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
251 goto err_out;
252 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
253 goto err_out;
Bert Vermeulen130ef082012-01-19 00:00:02 +0100254 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100255 srd_err("Options of type %s are not yet supported.",
256 Py_TYPE(py_classval)->tp_name);
Bert Vermeulen130ef082012-01-19 00:00:02 +0100257 goto err_out;
258 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100259
260 if ((value = g_hash_table_lookup(options, key))) {
261 /* An override for this option was provided. */
262 if (PyUnicode_Check(py_classval)) {
263 if (!(py_optval = PyUnicode_FromString(value))) {
264 /* Some UTF-8 encoding error. */
265 PyErr_Clear();
266 goto err_out;
267 }
268 } else if (PyLong_Check(py_classval)) {
269 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
270 /* ValueError Exception */
271 PyErr_Clear();
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100272 srd_err("Option %s has invalid value "
273 "%s: expected integer.",
274 key, value);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100275 goto err_out;
276 }
277 }
278 g_hash_table_remove(options, key);
279 } else {
280 /* Use the class default for this option. */
281 if (PyUnicode_Check(py_classval)) {
282 /* Make a brand new copy of the string. */
283 py_ustr = PyUnicode_AS_UNICODE(py_classval);
284 size = PyUnicode_GET_SIZE(py_classval);
285 py_optval = PyUnicode_FromUnicode(py_ustr, size);
286 } else if (PyLong_Check(py_classval)) {
287 /* Make a brand new copy of the integer. */
288 val_ull = PyLong_AsUnsignedLongLong(py_classval);
289 if (val_ull == (unsigned long long)-1) {
290 /* OverFlowError exception */
291 PyErr_Clear();
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100292 srd_err("Invalid integer value for %s: "
293 "expected integer.", key);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100294 goto err_out;
295 }
296 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
297 goto err_out;
298 }
299 }
300
301 /* If we got here, py_optval holds a known good new reference
302 * to the instance option to set.
303 */
304 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
305 goto err_out;
306 }
307
308 ret = SRD_OK;
309
310err_out:
311 Py_XDECREF(py_optlist);
312 Py_XDECREF(py_di_options);
313 Py_XDECREF(py_dec_optkeys);
314 Py_XDECREF(py_dec_options);
Uwe Hermann6f858312012-01-28 21:26:26 +0100315 g_free(key);
Bert Vermeulen2086c682012-01-23 04:51:33 +0100316 if (PyErr_Occurred())
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100317 catch_exception("Stray exception in srd_inst_set_options().");
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100318
319 return ret;
320}
321
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100322/* Helper GComparefunc for g_slist_find_custom() in srd_inst_set_probes() */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100323static gint compare_probe_id(struct srd_probe *a, char *probe_id)
324{
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100325 return strcmp(a->id, probe_id);
326}
327
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100328/**
329 * Set probes in a decoder instance.
330 *
331 * @param di Decoder instance.
332 * @param probes A GHashTable of probes to set. Key is probe name, value is
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100333 * the probe number. Samples passed to this instance will be
334 * arranged in this order.
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100335 * @return SRD_OK upon success, a (negative) error code otherwise.
336 */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100337SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100338 GHashTable *new_probes)
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100339{
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100340 GList *l;
341 GSList *sl;
342 struct srd_probe *p;
343 int *new_probemap, new_probenum;
Bert Vermeulenbe873262012-01-23 19:34:23 +0100344 char *probe_id, *probenum_str;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100345
Bert Vermeulence46bee2012-01-27 08:21:58 +0100346 srd_dbg("set probes called for instance %s with list of %d probes",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100347 di->inst_id, g_hash_table_size(new_probes));
Bert Vermeulence46bee2012-01-27 08:21:58 +0100348
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100349 if (g_hash_table_size(new_probes) == 0)
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100350 /* No probes provided. */
351 return SRD_OK;
352
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100353 if (di->dec_num_probes == 0) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100354 /* Decoder has no probes. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100355 srd_err("Protocol decoder %s has no probes to define.",
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100356 di->decoder->name);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100357 return SRD_ERR_ARG;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100358 }
359
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100360 new_probemap = NULL;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100361
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100362 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
Uwe Hermanna61ece22012-02-10 00:06:58 +0100363 srd_err("Failed to g_malloc() new probe map.");
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100364 return SRD_ERR_MALLOC;
365 }
366
367 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
368 probe_id = l->data;
Bert Vermeulenbe873262012-01-23 19:34:23 +0100369 probenum_str = g_hash_table_lookup(new_probes, probe_id);
370 if (!probenum_str) {
371 /* Probe name was specified without a value. */
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100372 srd_err("No probe number was specified for %s.",
373 probe_id);
Bert Vermeulenbe873262012-01-23 19:34:23 +0100374 g_free(new_probemap);
375 return SRD_ERR_ARG;
376 }
377 new_probenum = strtol(probenum_str, NULL, 10);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100378 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
379 (GCompareFunc)compare_probe_id))) {
380 /* Fall back on optional probes. */
Bert Vermeulendcdf4882012-02-01 00:07:55 +0100381 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100382 probe_id, (GCompareFunc) compare_probe_id))) {
383 srd_err("Protocol decoder %s has no probe "
384 "'%s'.", di->decoder->name, probe_id);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100385 g_free(new_probemap);
386 return SRD_ERR_ARG;
387 }
388 }
389 p = sl->data;
390 new_probemap[p->order] = new_probenum;
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100391 srd_dbg("setting probe mapping for %d = probe %d", p->order,
392 new_probenum);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100393 }
394 g_free(di->dec_probemap);
395 di->dec_probemap = new_probemap;
396
397 return SRD_OK;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100398}
399
400/**
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100401 * Create a new protocol decoder instance.
402 *
Uwe Hermann42a85ed2012-01-10 20:00:25 +0100403 * @param id Decoder 'id' field.
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100404 * @param options GHashtable of options which override the defaults set in
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100405 * the decoder class.
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100406 * @return Pointer to a newly allocated struct srd_decoder_inst, or
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100407 * NULL in case of failure.
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100408 */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100409SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100410 GHashTable *options)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100411{
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100412 int i;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100413 struct srd_decoder *dec;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100414 struct srd_decoder_inst *di;
415 char *inst_id;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100416
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100417 srd_dbg("Creating new %s instance.", decoder_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100418
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100419 if (!(dec = srd_get_decoder_by_id(decoder_id))) {
420 srd_err("Protocol decoder %s not found.", decoder_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100421 return NULL;
422 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100423
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100424 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
Uwe Hermanna61ece22012-02-10 00:06:58 +0100425 srd_err("Failed to g_malloc() instance.");
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100426 return NULL;
427 }
428
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100429 inst_id = g_hash_table_lookup(options, "id");
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100430 di->decoder = dec;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100431 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100432 g_hash_table_remove(options, "id");
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100433
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100434 /* Prepare a default probe map, where samples come in the
435 * order in which the decoder class defined them.
436 */
437 di->dec_num_probes = g_slist_length(di->decoder->probes) +
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100438 g_slist_length(di->decoder->opt_probes);
Bert Vermeulen19a90ba2012-01-21 19:45:04 +0100439 if (di->dec_num_probes) {
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100440 if (!(di->dec_probemap =
441 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
Uwe Hermanna61ece22012-02-10 00:06:58 +0100442 srd_err("Failed to g_malloc() probe map.");
Bert Vermeulen19a90ba2012-01-21 19:45:04 +0100443 g_free(di);
444 return NULL;
445 }
446 for (i = 0; i < di->dec_num_probes; i++)
447 di->dec_probemap[i] = i;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100448 }
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100449
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100450 /* Create a new instance of this decoder class. */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100451 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100452 if (PyErr_Occurred())
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100453 catch_exception("failed to create %s instance: ",
454 decoder_id);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100455 g_free(di->dec_probemap);
456 g_free(di);
457 return NULL;
458 }
459
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100460 if (srd_inst_set_options(di, options) != SRD_OK) {
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100461 g_free(di->dec_probemap);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100462 g_free(di);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100463 return NULL;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100464 }
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100465
466 /* Instance takes input from a frontend by default. */
Bert Vermeulene5080882011-12-07 09:56:49 +0100467 di_list = g_slist_append(di_list, di);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100468
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100469 return di;
470}
471
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100472SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
473 struct srd_decoder_inst *di_to)
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100474{
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100475 if (!di_from || !di_to) {
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100476 srd_err("Invalid from/to instance pair.");
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100477 return SRD_ERR_ARG;
478 }
479
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100480 if (g_slist_find(di_list, di_to)) {
481 /* Remove from the unstacked list. */
482 di_list = g_slist_remove(di_list, di_to);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100483 }
484
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100485 /* Stack on top of source di. */
486 di_from->next_di = g_slist_append(di_from->next_di, di_to);
487
488 return SRD_OK;
489}
490
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100491/**
492 * Finds a decoder instance by its instance id, but only in the bottom
493 * level of instances -- instances already stacked on top of another one
494 * will not be found.
495 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100496 * @param inst_id The instance id to be found.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100497 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100498 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100499 */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100500SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100501{
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100502 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100503 struct srd_decoder_inst *tmp, *di;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100504
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100505 di = NULL;
506 for (l = di_list; l; l = l->next) {
507 tmp = l->data;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100508 if (!strcmp(tmp->inst_id, inst_id)) {
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100509 di = tmp;
510 break;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100511 }
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100512 }
513
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100514 return di;
515}
516
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100517/**
Uwe Hermann511e2122012-02-10 09:29:38 +0100518 * Finds a decoder instance by its Python object, i.e. that instance's
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100519 * instantiation of the sigrokdecode.Decoder class. This will recurse
520 * to find the instance anywhere in the stack tree.
521 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100522 * @param stack Pointer to a GSList of struct srd_decoder_inst,
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100523 * indicating the stack to search. To start searching at the bottom
524 * level of decoder instances, pass NULL.
Uwe Hermann511e2122012-02-10 09:29:38 +0100525 * @param obj The Python class instantiation.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100526 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100527 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100528 */
Bert Vermeulenee4ed222012-02-12 13:47:07 +0100529SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100530 PyObject *obj)
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100531{
532 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100533 struct srd_decoder_inst *tmp, *di;
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100534
535 di = NULL;
536 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
537 tmp = l->data;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100538 if (tmp->py_inst == obj)
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100539 di = tmp;
540 else if (tmp->next_di)
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100541 di = srd_inst_find_by_obj(tmp->next_di, obj);
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100542 }
543
544 return di;
545}
546
Bert Vermeulenee4ed222012-02-12 13:47:07 +0100547SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100548{
549 PyObject *py_name, *py_res;
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100550 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100551 struct srd_decoder_inst *next_di;
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100552
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100553 srd_dbg("Calling start() method on protocol decoder instance %s.",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100554 di->inst_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100555
556 if (!(py_name = PyUnicode_FromString("start"))) {
Uwe Hermann511e2122012-02-10 09:29:38 +0100557 srd_err("Unable to build Python object for 'start'.");
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100558 catch_exception("Protocol decoder instance %s: ",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100559 di->inst_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100560 return SRD_ERR_PYTHON;
561 }
562
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100563 if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100564 py_name, args, NULL))) {
565 catch_exception("Protocol decoder instance %s: ",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100566 di->inst_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100567 return SRD_ERR_PYTHON;
568 }
569
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100570 Py_DecRef(py_res);
571 Py_DecRef(py_name);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100572
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100573 /* Start all the PDs stacked on top of this one. Pass along the
574 * metadata all the way from the bottom PD, even though it's only
575 * applicable to logic data for now.
576 */
577 for (l = di->next_di; l; l = l->next) {
578 next_di = l->data;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100579 srd_inst_start(next_di, args);
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100580 }
581
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100582 return SRD_OK;
583}
584
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100585/**
586 * Run the specified decoder function.
587 *
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100588 * @param start_samplenum The starting sample number for the buffer's sample
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100589 * set, relative to the start of capture.
590 * @param di The decoder instance to call. Must not be NULL.
591 * @param inbuf The buffer to decode. Must not be NULL.
592 * @param inbuflen Length of the buffer. Must be > 0.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100593 *
594 * @return SRD_OK upon success, a (negative) error code otherwise.
595 */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100596SRD_API int srd_inst_decode(uint64_t start_samplenum,
597 struct srd_decoder_inst *di,
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100598 uint8_t *inbuf, uint64_t inbuflen)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100599{
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100600 PyObject *py_res;
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100601 srd_logic *logic;
Bert Vermeulen86528292012-01-15 23:20:39 +0100602 uint64_t end_samplenum;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100603
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100604 srd_dbg("Calling decode() on instance %s with %d bytes starting "
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100605 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100606
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100607 /* Return an error upon unusable input. */
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100608 if (!di) {
609 srd_dbg("empty decoder instance");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100610 return SRD_ERR_ARG;
611 }
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100612 if (!inbuf) {
613 srd_dbg("NULL buffer pointer");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100614 return SRD_ERR_ARG;
615 }
616 if (inbuflen == 0) {
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100617 srd_dbg("empty buffer");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100618 return SRD_ERR_ARG;
619 }
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100620
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100621 /* Create new srd_logic object. Each iteration around the PD's loop
622 * will fill one sample into this object.
623 */
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100624 logic = PyObject_New(srd_logic, &srd_logic_type);
625 Py_INCREF(logic);
626 logic->di = di;
Bert Vermeulen86528292012-01-15 23:20:39 +0100627 logic->start_samplenum = start_samplenum;
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100628 logic->itercnt = 0;
629 logic->inbuf = inbuf;
630 logic->inbuflen = inbuflen;
631 logic->sample = PyList_New(2);
632 Py_INCREF(logic->sample);
633
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100634 Py_IncRef(di->py_inst);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100635 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100636 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100637 "KKO", logic->start_samplenum,
638 end_samplenum, logic))) {
639 catch_exception("Protocol decoder instance %s: ",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100640 di->inst_id);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100641 return SRD_ERR_PYTHON; /* TODO: More specific error? */
642 }
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100643 Py_DecRef(py_res);
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100644
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100645 return SRD_OK;
646}
647
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100648SRD_API void srd_inst_free(struct srd_decoder_inst *di)
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100649{
650 GSList *l;
651 struct srd_pd_output *pdo;
652
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100653 srd_dbg("Freeing instance %s", di->inst_id);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100654
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100655 Py_DecRef(di->py_inst);
656 g_free(di->inst_id);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100657 g_free(di->dec_probemap);
658 g_slist_free(di->next_di);
659 for (l = di->pd_output; l; l = l->next) {
660 pdo = l->data;
661 g_free(pdo->proto_id);
662 g_free(pdo);
663 }
664 g_slist_free(di->pd_output);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100665}
666
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100667SRD_API void srd_inst_free_all(GSList *stack)
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100668{
669 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100670 struct srd_decoder_inst *di;
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100671
672 di = NULL;
673 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
674 di = l->data;
675 if (di->next_di)
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100676 srd_inst_free_all(di->next_di);
677 srd_inst_free(di);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100678 }
679 if (!stack) {
680 g_slist_free(di_list);
681 di_list = NULL;
682 }
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100683}
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100684
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100685SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100686{
687 PyObject *args;
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100688 GSList *d;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100689 struct srd_decoder_inst *di;
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100690 int ret;
691
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100692 srd_dbg("Calling start() on all instances with %d probes, "
693 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100694
695 /* Currently only one item of metadata is passed along to decoders,
696 * samplerate. This can be extended as needed.
697 */
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100698 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
Uwe Hermann511e2122012-02-10 09:29:38 +0100699 srd_err("Unable to build Python object for metadata.");
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100700 return SRD_ERR_PYTHON;
701 }
702
703 /* Run the start() method on all decoders receiving frontend data. */
704 for (d = di_list; d; d = d->next) {
705 di = d->data;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100706 di->data_num_probes = num_probes;
707 di->data_unitsize = unitsize;
708 di->data_samplerate = samplerate;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100709 if ((ret = srd_inst_start(di, args) != SRD_OK))
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100710 break;
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100711 }
712
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100713 Py_DecRef(args);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100714
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100715 return ret;
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100716}
717
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100718/* Feed logic samples to decoder session. */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100719SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
720 uint64_t inbuflen)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100721{
722 GSList *d;
723 int ret;
724
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100725 srd_dbg("Calling decode() on all instances with starting sample "
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100726 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
727 start_samplenum, inbuflen, inbuf);
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100728
Bert Vermeulene5080882011-12-07 09:56:49 +0100729 for (d = di_list; d; d = d->next) {
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100730 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100731 inbuflen)) != SRD_OK)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100732 return ret;
733 }
734
735 return SRD_OK;
736}
737
Uwe Hermannae53d0a2012-02-11 22:38:17 +0100738SRD_API int srd_register_callback(int output_type,
Uwe Hermanne09023b2012-02-11 22:09:18 +0100739 srd_pd_output_callback_t cb, void *user_data)
Bert Vermeulen4fadb122012-01-22 03:29:22 +0100740{
741 struct srd_pd_callback *pd_cb;
742
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100743 srd_dbg("Registering new callback for output type %d.", output_type);
Bert Vermeulen4fadb122012-01-22 03:29:22 +0100744
Uwe Hermanna61ece22012-02-10 00:06:58 +0100745 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
746 srd_err("Failed to g_malloc() struct srd_pd_callback.");
Bert Vermeulen4fadb122012-01-22 03:29:22 +0100747 return SRD_ERR_MALLOC;
Uwe Hermanna61ece22012-02-10 00:06:58 +0100748 }
Bert Vermeulen4fadb122012-01-22 03:29:22 +0100749
750 pd_cb->output_type = output_type;
751 pd_cb->callback = cb;
Uwe Hermanne09023b2012-02-11 22:09:18 +0100752 pd_cb->user_data = user_data;
Bert Vermeulen4fadb122012-01-22 03:29:22 +0100753 callbacks = g_slist_append(callbacks, pd_cb);
754
755 return SRD_OK;
756}
757
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100758SRD_API void *srd_find_callback(int output_type)
Bert Vermeulen4fadb122012-01-22 03:29:22 +0100759{
760 GSList *l;
761 struct srd_pd_callback *pd_cb;
762 void *(cb);
763
764 cb = NULL;
765 for (l = callbacks; l; l = l->next) {
766 pd_cb = l->data;
767 if (pd_cb->output_type == output_type) {
768 cb = pd_cb->callback;
769 break;
770 }
771 }
772
773 return cb;
774}
775
Uwe Hermann511e2122012-02-10 09:29:38 +0100776/* This is the backend function to Python sigrokdecode.add() call. */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100777SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100778 char *proto_id)
Bert Vermeulene5080882011-12-07 09:56:49 +0100779{
Bert Vermeulene5080882011-12-07 09:56:49 +0100780 struct srd_pd_output *pdo;
Bert Vermeulene5080882011-12-07 09:56:49 +0100781
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100782 srd_dbg("Instance %s creating new output type %d for %s.",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100783 di->inst_id, output_type, proto_id);
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100784
Uwe Hermanna61ece22012-02-10 00:06:58 +0100785 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
786 srd_err("Failed to g_malloc() struct srd_pd_output.");
Bert Vermeulene5080882011-12-07 09:56:49 +0100787 return -1;
Uwe Hermanna61ece22012-02-10 00:06:58 +0100788 }
Bert Vermeulene5080882011-12-07 09:56:49 +0100789
Bert Vermeulenb2315462012-01-09 00:13:03 +0100790 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
Bert Vermeulen15969942012-01-07 02:50:14 +0100791 pdo->pdo_id = g_slist_length(di->pd_output);
Bert Vermeulene5080882011-12-07 09:56:49 +0100792 pdo->output_type = output_type;
Bert Vermeulenb3b2cae2012-01-24 02:02:03 +0100793 pdo->di = di;
Uwe Hermann94d43b32012-01-10 20:44:22 +0100794 pdo->proto_id = g_strdup(proto_id);
Bert Vermeulene5080882011-12-07 09:56:49 +0100795 di->pd_output = g_slist_append(di->pd_output, pdo);
796
Bert Vermeulen15969942012-01-07 02:50:14 +0100797 return pdo->pdo_id;
Bert Vermeulene5080882011-12-07 09:56:49 +0100798}