]>
Commit | Line | Data |
---|---|---|
b2c19614 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
b2c19614 BV |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
bc5f5a43 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
b2c19614 BV |
6 | * |
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 | ||
c1f86f02 UH |
21 | #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
22 | #include "libsigrokdecode-internal.h" | |
7ce7775c | 23 | #include "config.h" |
b2c19614 | 24 | #include <glib.h> |
1aef2f93 | 25 | #include <inttypes.h> |
0bdadba2 | 26 | #include <stdlib.h> |
b2c19614 | 27 | |
d7dae84b UH |
28 | /** |
29 | * @mainpage libsigrokdecode API | |
30 | * | |
31 | * @section sec_intro Introduction | |
32 | * | |
33 | * The <a href="http://sigrok.org">sigrok</a> project aims at creating a | |
34 | * portable, cross-platform, Free/Libre/Open-Source signal analysis software | |
35 | * suite that supports various device types (such as logic analyzers, | |
36 | * oscilloscopes, multimeters, and more). | |
37 | * | |
38 | * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a | |
39 | * shared library written in C which provides the basic API for (streaming) | |
40 | * protocol decoding functionality. | |
41 | * | |
42 | * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a> | |
43 | * are written in Python (>= 3.0). | |
44 | * | |
45 | * @section sec_api API reference | |
46 | * | |
47 | * See the "Modules" page for an introduction to various libsigrokdecode | |
48 | * related topics and the detailed API documentation of the respective | |
49 | * functions. | |
50 | * | |
51 | * You can also browse the API documentation by file, or review all | |
52 | * data structures. | |
53 | * | |
54 | * @section sec_mailinglists Mailing lists | |
55 | * | |
56 | * There are two mailing lists for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>. | |
57 | * | |
58 | * @section sec_irc IRC | |
59 | * | |
60 | * You can find the sigrok developers in the | |
61 | * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a> | |
62 | * IRC channel on Freenode. | |
63 | * | |
64 | * @section sec_website Website | |
65 | * | |
66 | * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a> | |
67 | */ | |
68 | ||
69 | /** | |
70 | * @file | |
71 | * | |
72 | * Initializing and shutting down libsigrokdecode. | |
73 | */ | |
74 | ||
75 | /** | |
76 | * @defgroup grp_init Initialization | |
77 | * | |
78 | * Initializing and shutting down libsigrokdecode. | |
79 | * | |
80 | * Before using any of the libsigrokdecode functionality, srd_init() must | |
81 | * be called to initialize the library. | |
82 | * | |
83 | * When libsigrokdecode functionality is no longer needed, srd_exit() should | |
84 | * be called. | |
85 | * | |
86 | * @{ | |
87 | */ | |
88 | ||
d906d3f9 | 89 | /* List of decoder instances. */ |
7ce7775c | 90 | static GSList *di_list = NULL; |
d906d3f9 | 91 | |
361fdcaa | 92 | /* List of frontend callbacks to receive decoder output. */ |
983cb0f5 BV |
93 | static GSList *callbacks = NULL; |
94 | ||
57790bc8 UH |
95 | /** @cond PRIVATE */ |
96 | ||
c9bfccc6 | 97 | /* decoder.c */ |
55c3c5f4 | 98 | extern SRD_PRIV GSList *pd_list; |
b2c19614 | 99 | |
c9bfccc6 | 100 | /* module_sigrokdecode.c */ |
53a07a6d UH |
101 | /* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */ |
102 | extern PyMODINIT_FUNC PyInit_sigrokdecode(void); | |
b2c19614 | 103 | |
c9bfccc6 | 104 | /* type_logic.c */ |
55c3c5f4 | 105 | extern SRD_PRIV PyTypeObject srd_logic_type; |
b2c19614 | 106 | |
57790bc8 UH |
107 | /** @endcond */ |
108 | ||
b2c19614 BV |
109 | /** |
110 | * Initialize libsigrokdecode. | |
111 | * | |
112 | * This initializes the Python interpreter, and creates and initializes | |
361fdcaa | 113 | * a "sigrokdecode" Python module. |
b2c19614 | 114 | * |
4cc0d9fe UH |
115 | * Then, it searches for sigrok protocol decoders in the "decoders" |
116 | * subdirectory of the the libsigrokdecode installation directory. | |
b2c19614 | 117 | * All decoders that are found are loaded into memory and added to an |
4cc0d9fe | 118 | * internal list of decoders, which can be queried via srd_decoder_list(). |
b2c19614 BV |
119 | * |
120 | * The caller is responsible for calling the clean-up function srd_exit(), | |
121 | * which will properly shut down libsigrokdecode and free its allocated memory. | |
122 | * | |
7ce7775c | 123 | * Multiple calls to srd_init(), without calling srd_exit() in between, |
b2c19614 BV |
124 | * are not allowed. |
125 | * | |
65e1c7d0 | 126 | * @param path Path to an extra directory containing protocol decoders |
4cc0d9fe | 127 | * which will be added to the Python sys.path. May be NULL. |
65e1c7d0 | 128 | * |
b2c19614 | 129 | * @return SRD_OK upon success, a (negative) error code otherwise. |
4cc0d9fe UH |
130 | * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders |
131 | * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned. | |
132 | * If not enough memory could be allocated, SRD_ERR_MALLOC is returned. | |
8c664ca2 UH |
133 | * |
134 | * @since 0.1.0 | |
b2c19614 | 135 | */ |
abeeed8b | 136 | SRD_API int srd_init(const char *path) |
b2c19614 BV |
137 | { |
138 | int ret; | |
65e1c7d0 | 139 | char *env_path; |
b2c19614 | 140 | |
7a1712c4 | 141 | srd_dbg("Initializing libsigrokdecode."); |
d906d3f9 BV |
142 | |
143 | /* Add our own module to the list of built-in modules. */ | |
bc5f5a43 | 144 | PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); |
5f802ec6 | 145 | |
511e2123 | 146 | /* Initialize the Python interpreter. */ |
b2c19614 BV |
147 | Py_Initialize(); |
148 | ||
65e1c7d0 | 149 | /* Installed decoders. */ |
aafeeaea | 150 | if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { |
b2c19614 BV |
151 | Py_Finalize(); |
152 | return ret; | |
153 | } | |
154 | ||
65e1c7d0 BV |
155 | /* Path specified by the user. */ |
156 | if (path) { | |
aafeeaea | 157 | if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { |
65e1c7d0 BV |
158 | Py_Finalize(); |
159 | return ret; | |
160 | } | |
161 | } | |
162 | ||
163 | /* Environment variable overrides everything, for debugging. */ | |
164 | if ((env_path = getenv("SIGROKDECODE_DIR"))) { | |
aafeeaea | 165 | if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { |
65e1c7d0 BV |
166 | Py_Finalize(); |
167 | return ret; | |
168 | } | |
169 | } | |
170 | ||
b2c19614 BV |
171 | return SRD_OK; |
172 | } | |
173 | ||
b2c19614 BV |
174 | /** |
175 | * Shutdown libsigrokdecode. | |
176 | * | |
177 | * This frees all the memory allocated for protocol decoders and shuts down | |
178 | * the Python interpreter. | |
179 | * | |
180 | * This function should only be called if there was a (successful!) invocation | |
181 | * of srd_init() before. Calling this function multiple times in a row, without | |
7ce7775c | 182 | * any successful srd_init() calls in between, is not allowed. |
b2c19614 BV |
183 | * |
184 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
185 | * |
186 | * @since 0.1.0 | |
b2c19614 | 187 | */ |
55c3c5f4 | 188 | SRD_API int srd_exit(void) |
b2c19614 | 189 | { |
7a1712c4 | 190 | srd_dbg("Exiting libsigrokdecode."); |
d906d3f9 | 191 | |
8ad6e500 | 192 | srd_decoder_unload_all(); |
e5080882 | 193 | g_slist_free(pd_list); |
96c52595 | 194 | pd_list = NULL; |
b2c19614 BV |
195 | |
196 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
197 | Py_Finalize(); | |
198 | ||
199 | return SRD_OK; | |
200 | } | |
201 | ||
b2c19614 | 202 | /** |
9d9fcb37 UH |
203 | * Add an additional search directory for the protocol decoders. |
204 | * | |
205 | * The specified directory is prepended (not appended!) to Python's sys.path, | |
206 | * in order to search for sigrok protocol decoders in the specified | |
207 | * directories first, and in the generic Python module directories (and in | |
208 | * the current working directory) last. This avoids conflicts if there are | |
209 | * Python modules which have the same name as a sigrok protocol decoder in | |
210 | * sys.path or in the current working directory. | |
b2c19614 | 211 | * |
361fdcaa UH |
212 | * @param path Path to the directory containing protocol decoders which shall |
213 | * be added to the Python sys.path, or NULL. | |
9d9fcb37 | 214 | * |
65e1c7d0 | 215 | * @return SRD_OK upon success, a (negative) error code otherwise. |
57790bc8 UH |
216 | * |
217 | * @private | |
8c664ca2 UH |
218 | * |
219 | * @since 0.1.0 | |
b2c19614 | 220 | */ |
aafeeaea | 221 | SRD_PRIV int srd_decoder_searchpath_add(const char *path) |
b2c19614 | 222 | { |
65e1c7d0 BV |
223 | PyObject *py_cur_path, *py_item; |
224 | GString *new_path; | |
225 | int wc_len, i; | |
226 | wchar_t *wc_new_path; | |
227 | char *item; | |
228 | ||
8ad6e500 | 229 | srd_dbg("Adding '%s' to module path.", path); |
65e1c7d0 BV |
230 | |
231 | new_path = g_string_sized_new(256); | |
e592ac89 | 232 | g_string_assign(new_path, path); |
65e1c7d0 BV |
233 | py_cur_path = PySys_GetObject("path"); |
234 | for (i = 0; i < PyList_Size(py_cur_path); i++) { | |
e592ac89 | 235 | g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S); |
65e1c7d0 BV |
236 | py_item = PyList_GetItem(py_cur_path, i); |
237 | if (!PyUnicode_Check(py_item)) | |
238 | /* Shouldn't happen. */ | |
239 | continue; | |
240 | if (py_str_as_str(py_item, &item) != SRD_OK) | |
241 | continue; | |
242 | g_string_append(new_path, item); | |
e592ac89 | 243 | g_free(item); |
65e1c7d0 | 244 | } |
639c5689 | 245 | |
65e1c7d0 BV |
246 | /* Convert to wide chars. */ |
247 | wc_len = sizeof(wchar_t) * (new_path->len + 1); | |
248 | if (!(wc_new_path = g_try_malloc(wc_len))) { | |
249 | srd_dbg("malloc failed"); | |
250 | return SRD_ERR_MALLOC; | |
251 | } | |
252 | mbstowcs(wc_new_path, new_path->str, wc_len); | |
253 | PySys_SetPath(wc_new_path); | |
254 | g_string_free(new_path, TRUE); | |
255 | g_free(wc_new_path); | |
256 | ||
257 | //#ifdef _WIN32 | |
258 | // gchar **splitted; | |
259 | // | |
260 | // /* | |
261 | // * On Windows/MinGW, Python's sys.path needs entries of the form | |
262 | // * 'C:\\foo\\bar' instead of '/foo/bar'. | |
263 | // */ | |
264 | // | |
265 | // splitted = g_strsplit(DECODERS_DIR, "/", 0); | |
266 | // path = g_build_pathv("\\\\", splitted); | |
267 | // g_strfreev(splitted); | |
268 | //#else | |
269 | // path = g_strdup(DECODERS_DIR); | |
270 | //#endif | |
b2c19614 | 271 | |
65e1c7d0 | 272 | return SRD_OK; |
b2c19614 BV |
273 | } |
274 | ||
4895418c UH |
275 | /** @} */ |
276 | ||
277 | /** | |
278 | * @defgroup grp_instances Decoder instances | |
279 | * | |
280 | * Decoder instance handling. | |
281 | * | |
282 | * @{ | |
283 | */ | |
284 | ||
7ce7775c | 285 | /** |
b33b8aa5 | 286 | * Set one or more options in a decoder instance. |
0bdadba2 | 287 | * |
361fdcaa UH |
288 | * Handled options are removed from the hash. |
289 | * | |
0bdadba2 BV |
290 | * @param di Decoder instance. |
291 | * @param options A GHashTable of options to set. | |
7ce7775c | 292 | * |
0bdadba2 | 293 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
294 | * |
295 | * @since 0.1.0 | |
0bdadba2 | 296 | */ |
b33b8aa5 | 297 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 298 | GHashTable *options) |
0bdadba2 BV |
299 | { |
300 | PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; | |
301 | PyObject *py_optlist, *py_classval; | |
302 | Py_UNICODE *py_ustr; | |
2f395bff | 303 | GVariant *value; |
0bdadba2 | 304 | unsigned long long int val_ull; |
2f395bff | 305 | gint64 val_int; |
0bdadba2 | 306 | int num_optkeys, ret, size, i; |
2f395bff BV |
307 | const char *val_str; |
308 | char *dbg, *key; | |
0bdadba2 | 309 | |
c9bfccc6 | 310 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 311 | /* Decoder has no options. */ |
e431d9cc BV |
312 | if (g_hash_table_size(options) == 0) { |
313 | /* No options provided. */ | |
314 | return SRD_OK; | |
315 | } else { | |
316 | srd_err("Protocol decoder has no options."); | |
317 | return SRD_ERR_ARG; | |
318 | } | |
0bdadba2 | 319 | return SRD_OK; |
e431d9cc | 320 | } |
0bdadba2 BV |
321 | |
322 | ret = SRD_ERR_PYTHON; | |
323 | key = NULL; | |
324 | py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; | |
325 | py_optlist = py_classval = NULL; | |
326 | py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); | |
0bdadba2 BV |
327 | |
328 | /* All of these are synthesized objects, so they're good. */ | |
329 | py_dec_optkeys = PyDict_Keys(py_dec_options); | |
330 | num_optkeys = PyList_Size(py_dec_optkeys); | |
a8b72b05 | 331 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 BV |
332 | goto err_out; |
333 | for (i = 0; i < num_optkeys; i++) { | |
334 | /* Get the default class value for this option. */ | |
335 | py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); | |
336 | if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) | |
337 | goto err_out; | |
338 | if (!(py_classval = PyList_GetItem(py_optlist, 1))) | |
339 | goto err_out; | |
130ef08a | 340 | if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { |
c9bfccc6 UH |
341 | srd_err("Options of type %s are not yet supported.", |
342 | Py_TYPE(py_classval)->tp_name); | |
130ef08a BV |
343 | goto err_out; |
344 | } | |
0bdadba2 BV |
345 | |
346 | if ((value = g_hash_table_lookup(options, key))) { | |
2f395bff BV |
347 | dbg = g_variant_print(value, TRUE); |
348 | srd_dbg("got option '%s' = %s", key, dbg); | |
349 | g_free(dbg); | |
0bdadba2 BV |
350 | /* An override for this option was provided. */ |
351 | if (PyUnicode_Check(py_classval)) { | |
2f395bff BV |
352 | if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { |
353 | srd_err("Option '%s' requires a string value.", key); | |
354 | goto err_out; | |
355 | } | |
356 | val_str = g_variant_get_string(value, NULL); | |
357 | if (!(py_optval = PyUnicode_FromString(val_str))) { | |
0bdadba2 BV |
358 | /* Some UTF-8 encoding error. */ |
359 | PyErr_Clear(); | |
2f395bff | 360 | srd_err("Option '%s' requires a UTF-8 string value.", key); |
0bdadba2 BV |
361 | goto err_out; |
362 | } | |
363 | } else if (PyLong_Check(py_classval)) { | |
2f395bff BV |
364 | if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { |
365 | srd_err("Option '%s' requires an integer value.", key); | |
366 | goto err_out; | |
367 | } | |
368 | val_int = g_variant_get_int64(value); | |
369 | if (!(py_optval = PyLong_FromLong(val_int))) { | |
0bdadba2 BV |
370 | /* ValueError Exception */ |
371 | PyErr_Clear(); | |
2f395bff | 372 | srd_err("Option '%s' has invalid integer value.", key); |
0bdadba2 BV |
373 | goto err_out; |
374 | } | |
375 | } | |
376 | g_hash_table_remove(options, key); | |
377 | } else { | |
378 | /* Use the class default for this option. */ | |
379 | if (PyUnicode_Check(py_classval)) { | |
380 | /* Make a brand new copy of the string. */ | |
381 | py_ustr = PyUnicode_AS_UNICODE(py_classval); | |
382 | size = PyUnicode_GET_SIZE(py_classval); | |
383 | py_optval = PyUnicode_FromUnicode(py_ustr, size); | |
384 | } else if (PyLong_Check(py_classval)) { | |
385 | /* Make a brand new copy of the integer. */ | |
386 | val_ull = PyLong_AsUnsignedLongLong(py_classval); | |
387 | if (val_ull == (unsigned long long)-1) { | |
388 | /* OverFlowError exception */ | |
389 | PyErr_Clear(); | |
c9bfccc6 UH |
390 | srd_err("Invalid integer value for %s: " |
391 | "expected integer.", key); | |
0bdadba2 BV |
392 | goto err_out; |
393 | } | |
394 | if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) | |
395 | goto err_out; | |
396 | } | |
397 | } | |
398 | ||
361fdcaa UH |
399 | /* |
400 | * If we got here, py_optval holds a known good new reference | |
0bdadba2 BV |
401 | * to the instance option to set. |
402 | */ | |
403 | if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) | |
404 | goto err_out; | |
e592ac89 | 405 | g_free(key); |
0bdadba2 BV |
406 | } |
407 | ||
408 | ret = SRD_OK; | |
409 | ||
410 | err_out: | |
411 | Py_XDECREF(py_optlist); | |
412 | Py_XDECREF(py_di_options); | |
413 | Py_XDECREF(py_dec_optkeys); | |
414 | Py_XDECREF(py_dec_options); | |
6f858319 | 415 | g_free(key); |
2086c684 | 416 | if (PyErr_Occurred()) |
aafeeaea | 417 | srd_exception_catch("Stray exception in srd_inst_option_set()."); |
0bdadba2 BV |
418 | |
419 | return ret; | |
420 | } | |
421 | ||
b33b8aa5 | 422 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ |
abeeed8b | 423 | static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) |
f38ec285 | 424 | { |
f38ec285 BV |
425 | return strcmp(a->id, probe_id); |
426 | } | |
427 | ||
0bdadba2 | 428 | /** |
b33b8aa5 UH |
429 | * Set all probes in a decoder instance. |
430 | * | |
431 | * This function sets _all_ probes for the specified decoder instance, i.e., | |
432 | * it overwrites any probes that were already defined (if any). | |
0bdadba2 BV |
433 | * |
434 | * @param di Decoder instance. | |
38ff5046 UH |
435 | * @param new_probes A GHashTable of probes to set. Key is probe name, value is |
436 | * the probe number. Samples passed to this instance will be | |
437 | * arranged in this order. | |
12243c22 | 438 | * |
0bdadba2 | 439 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
440 | * |
441 | * @since 0.1.0 | |
0bdadba2 | 442 | */ |
b33b8aa5 | 443 | SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, |
0ff2d191 | 444 | GHashTable *new_probes) |
0bdadba2 | 445 | { |
2f395bff | 446 | GVariant *probe_val; |
f38ec285 BV |
447 | GList *l; |
448 | GSList *sl; | |
449 | struct srd_probe *p; | |
450 | int *new_probemap, new_probenum; | |
2f395bff | 451 | char *probe_id; |
38ff5046 | 452 | int i, num_required_probes; |
0bdadba2 | 453 | |
ce46beed | 454 | srd_dbg("set probes called for instance %s with list of %d probes", |
a8b72b05 | 455 | di->inst_id, g_hash_table_size(new_probes)); |
ce46beed | 456 | |
f38ec285 | 457 | if (g_hash_table_size(new_probes) == 0) |
0bdadba2 BV |
458 | /* No probes provided. */ |
459 | return SRD_OK; | |
460 | ||
c9bfccc6 | 461 | if (di->dec_num_probes == 0) { |
0bdadba2 | 462 | /* Decoder has no probes. */ |
f38ec285 | 463 | srd_err("Protocol decoder %s has no probes to define.", |
c9bfccc6 | 464 | di->decoder->name); |
f38ec285 BV |
465 | return SRD_ERR_ARG; |
466 | } | |
0bdadba2 | 467 | |
f38ec285 | 468 | new_probemap = NULL; |
0bdadba2 | 469 | |
f38ec285 | 470 | if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { |
a61ece20 | 471 | srd_err("Failed to g_malloc() new probe map."); |
f38ec285 | 472 | return SRD_ERR_MALLOC; |
0bdadba2 BV |
473 | } |
474 | ||
38ff5046 UH |
475 | /* |
476 | * For now, map all indexes to probe -1 (can be overridden later). | |
477 | * This -1 is interpreted as an unspecified probe later. | |
478 | */ | |
479 | for (i = 0; i < di->dec_num_probes; i++) | |
480 | new_probemap[i] = -1; | |
481 | ||
f38ec285 BV |
482 | for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { |
483 | probe_id = l->data; | |
2f395bff BV |
484 | probe_val= g_hash_table_lookup(new_probes, probe_id); |
485 | if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) { | |
be873260 | 486 | /* Probe name was specified without a value. */ |
c9bfccc6 | 487 | srd_err("No probe number was specified for %s.", |
2f395bff | 488 | probe_id); |
be873260 BV |
489 | g_free(new_probemap); |
490 | return SRD_ERR_ARG; | |
491 | } | |
2f395bff | 492 | new_probenum = g_variant_get_int32(probe_val); |
f38ec285 BV |
493 | if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, |
494 | (GCompareFunc)compare_probe_id))) { | |
495 | /* Fall back on optional probes. */ | |
dcdf4883 | 496 | if (!(sl = g_slist_find_custom(di->decoder->opt_probes, |
c9bfccc6 UH |
497 | probe_id, (GCompareFunc) compare_probe_id))) { |
498 | srd_err("Protocol decoder %s has no probe " | |
2f395bff | 499 | "'%s'.", di->decoder->name, probe_id); |
f38ec285 BV |
500 | g_free(new_probemap); |
501 | return SRD_ERR_ARG; | |
502 | } | |
503 | } | |
504 | p = sl->data; | |
505 | new_probemap[p->order] = new_probenum; | |
38ff5046 UH |
506 | srd_dbg("Setting probe mapping: %s (index %d) = probe %d.", |
507 | p->id, p->order, new_probenum); | |
508 | } | |
509 | ||
510 | srd_dbg("Final probe map:"); | |
511 | num_required_probes = g_slist_length(di->decoder->probes); | |
512 | for (i = 0; i < di->dec_num_probes; i++) { | |
513 | srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i], | |
514 | (i < num_required_probes) ? "required" : "optional"); | |
f38ec285 | 515 | } |
38ff5046 | 516 | |
f38ec285 BV |
517 | g_free(di->dec_probemap); |
518 | di->dec_probemap = new_probemap; | |
0bdadba2 | 519 | |
f38ec285 | 520 | return SRD_OK; |
0bdadba2 BV |
521 | } |
522 | ||
523 | /** | |
524 | * Create a new protocol decoder instance. | |
7ce7775c | 525 | * |
38ff5046 | 526 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 527 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 528 | * the decoder class. May be NULL. |
12243c22 | 529 | * |
a8b72b05 | 530 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 531 | * NULL in case of failure. |
8c664ca2 UH |
532 | * |
533 | * @since 0.1.0 | |
7ce7775c | 534 | */ |
a8b72b05 | 535 | SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, |
0ff2d191 | 536 | GHashTable *options) |
b2c19614 | 537 | { |
c9bfccc6 | 538 | int i; |
b2c19614 | 539 | struct srd_decoder *dec; |
a8b72b05 BV |
540 | struct srd_decoder_inst *di; |
541 | char *inst_id; | |
b2c19614 | 542 | |
7a1712c4 | 543 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 544 | |
9d122fd5 | 545 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 546 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 547 | return NULL; |
0bdadba2 | 548 | } |
b2c19614 | 549 | |
a8b72b05 | 550 | if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { |
a61ece20 | 551 | srd_err("Failed to g_malloc() instance."); |
7ce7775c BV |
552 | return NULL; |
553 | } | |
0bdadba2 | 554 | |
b2c19614 | 555 | di->decoder = dec; |
38ff5046 UH |
556 | if (options) { |
557 | inst_id = g_hash_table_lookup(options, "id"); | |
558 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
559 | g_hash_table_remove(options, "id"); | |
560 | } else | |
561 | di->inst_id = g_strdup(decoder_id); | |
b2c19614 | 562 | |
361fdcaa UH |
563 | /* |
564 | * Prepare a default probe map, where samples come in the | |
f38ec285 BV |
565 | * order in which the decoder class defined them. |
566 | */ | |
567 | di->dec_num_probes = g_slist_length(di->decoder->probes) + | |
c9bfccc6 | 568 | g_slist_length(di->decoder->opt_probes); |
19a90bab | 569 | if (di->dec_num_probes) { |
c9bfccc6 UH |
570 | if (!(di->dec_probemap = |
571 | g_try_malloc(sizeof(int) * di->dec_num_probes))) { | |
a61ece20 | 572 | srd_err("Failed to g_malloc() probe map."); |
19a90bab BV |
573 | g_free(di); |
574 | return NULL; | |
575 | } | |
576 | for (i = 0; i < di->dec_num_probes; i++) | |
577 | di->dec_probemap[i] = i; | |
f38ec285 | 578 | } |
f38ec285 | 579 | |
0bdadba2 | 580 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 581 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 582 | if (PyErr_Occurred()) |
aafeeaea UH |
583 | srd_exception_catch("failed to create %s instance: ", |
584 | decoder_id); | |
f38ec285 | 585 | g_free(di->dec_probemap); |
0bdadba2 | 586 | g_free(di); |
7ce7775c | 587 | return NULL; |
b2c19614 | 588 | } |
7ce7775c | 589 | |
38ff5046 | 590 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
f38ec285 | 591 | g_free(di->dec_probemap); |
0bdadba2 BV |
592 | g_free(di); |
593 | return NULL; | |
594 | } | |
b2c19614 | 595 | |
f38ec285 BV |
596 | /* Instance takes input from a frontend by default. */ |
597 | di_list = g_slist_append(di_list, di); | |
598 | ||
b2c19614 BV |
599 | return di; |
600 | } | |
601 | ||
582c8473 BV |
602 | /** |
603 | * Stack a decoder instance on top of another. | |
604 | * | |
605 | * @param di_from The instance to move. | |
606 | * @param di_to The instance on top of which di_from will be stacked. | |
607 | * | |
608 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
609 | * |
610 | * @since 0.1.0 | |
582c8473 | 611 | */ |
a8b72b05 | 612 | SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, |
0ff2d191 | 613 | struct srd_decoder_inst *di_to) |
7ce7775c | 614 | { |
7ce7775c | 615 | if (!di_from || !di_to) { |
d906d3f9 | 616 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
617 | return SRD_ERR_ARG; |
618 | } | |
619 | ||
2072ae0c BV |
620 | if (g_slist_find(di_list, di_to)) { |
621 | /* Remove from the unstacked list. */ | |
622 | di_list = g_slist_remove(di_list, di_to); | |
7ce7775c BV |
623 | } |
624 | ||
7ce7775c BV |
625 | /* Stack on top of source di. */ |
626 | di_from->next_di = g_slist_append(di_from->next_di, di_to); | |
627 | ||
628 | return SRD_OK; | |
629 | } | |
630 | ||
2072ae0c | 631 | /** |
361fdcaa UH |
632 | * Find a decoder instance by its instance ID. |
633 | * | |
634 | * Only the bottom level of instances are searched -- instances already stacked | |
635 | * on top of another one will not be found. | |
2072ae0c | 636 | * |
ed2306a6 | 637 | * @param inst_id The instance ID to be found. |
2072ae0c | 638 | * |
a8b72b05 | 639 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 UH |
640 | * |
641 | * @since 0.1.0 | |
2072ae0c | 642 | */ |
abeeed8b | 643 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) |
7ce7775c BV |
644 | { |
645 | GSList *l; | |
a8b72b05 | 646 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 647 | |
7ce7775c BV |
648 | di = NULL; |
649 | for (l = di_list; l; l = l->next) { | |
650 | tmp = l->data; | |
a8b72b05 | 651 | if (!strcmp(tmp->inst_id, inst_id)) { |
7ce7775c BV |
652 | di = tmp; |
653 | break; | |
654 | } | |
655 | } | |
656 | ||
657 | return di; | |
658 | } | |
659 | ||
2072ae0c | 660 | /** |
361fdcaa UH |
661 | * Find a decoder instance by its Python object. |
662 | * | |
663 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
664 | * This will recurse to find the instance anywhere in the stack tree. | |
2072ae0c | 665 | * |
361fdcaa UH |
666 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the |
667 | * stack to search. To start searching at the bottom level of | |
668 | * decoder instances, pass NULL. | |
511e2123 | 669 | * @param obj The Python class instantiation. |
2072ae0c | 670 | * |
a8b72b05 | 671 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
57790bc8 UH |
672 | * |
673 | * @private | |
8c664ca2 UH |
674 | * |
675 | * @since 0.1.0 | |
2072ae0c | 676 | */ |
abeeed8b | 677 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
0ff2d191 | 678 | const PyObject *obj) |
2072ae0c | 679 | { |
abeeed8b | 680 | const GSList *l; |
a8b72b05 | 681 | struct srd_decoder_inst *tmp, *di; |
2072ae0c BV |
682 | |
683 | di = NULL; | |
684 | for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { | |
685 | tmp = l->data; | |
a8b72b05 | 686 | if (tmp->py_inst == obj) |
2072ae0c BV |
687 | di = tmp; |
688 | else if (tmp->next_di) | |
a8b72b05 | 689 | di = srd_inst_find_by_obj(tmp->next_di, obj); |
2072ae0c BV |
690 | } |
691 | ||
692 | return di; | |
693 | } | |
694 | ||
57790bc8 | 695 | /** @private */ |
ee4ed227 | 696 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) |
b2c19614 | 697 | { |
7ce7775c | 698 | PyObject *py_name, *py_res; |
2072ae0c | 699 | GSList *l; |
a8b72b05 | 700 | struct srd_decoder_inst *next_di; |
b2c19614 | 701 | |
7a1712c4 | 702 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
a8b72b05 | 703 | di->inst_id); |
b2c19614 | 704 | |
7ce7775c | 705 | if (!(py_name = PyUnicode_FromString("start"))) { |
511e2123 | 706 | srd_err("Unable to build Python object for 'start'."); |
aafeeaea UH |
707 | srd_exception_catch("Protocol decoder instance %s: ", |
708 | di->inst_id); | |
7ce7775c BV |
709 | return SRD_ERR_PYTHON; |
710 | } | |
711 | ||
a8b72b05 | 712 | if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, |
c9bfccc6 | 713 | py_name, args, NULL))) { |
aafeeaea UH |
714 | srd_exception_catch("Protocol decoder instance %s: ", |
715 | di->inst_id); | |
7ce7775c | 716 | return SRD_ERR_PYTHON; |
b2c19614 BV |
717 | } |
718 | ||
f38ec285 BV |
719 | Py_DecRef(py_res); |
720 | Py_DecRef(py_name); | |
7ce7775c | 721 | |
361fdcaa UH |
722 | /* |
723 | * Start all the PDs stacked on top of this one. Pass along the | |
2072ae0c BV |
724 | * metadata all the way from the bottom PD, even though it's only |
725 | * applicable to logic data for now. | |
726 | */ | |
727 | for (l = di->next_di; l; l = l->next) { | |
728 | next_di = l->data; | |
a8b72b05 | 729 | srd_inst_start(next_di, args); |
2072ae0c BV |
730 | } |
731 | ||
b2c19614 BV |
732 | return SRD_OK; |
733 | } | |
734 | ||
b2c19614 BV |
735 | /** |
736 | * Run the specified decoder function. | |
737 | * | |
d906d3f9 | 738 | * @param start_samplenum The starting sample number for the buffer's sample |
7a1712c4 UH |
739 | * set, relative to the start of capture. |
740 | * @param di The decoder instance to call. Must not be NULL. | |
741 | * @param inbuf The buffer to decode. Must not be NULL. | |
742 | * @param inbuflen Length of the buffer. Must be > 0. | |
b2c19614 BV |
743 | * |
744 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
745 | * |
746 | * @private | |
8c664ca2 UH |
747 | * |
748 | * @since 0.1.0 | |
b2c19614 | 749 | */ |
12243c22 | 750 | SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, |
0ff2d191 BV |
751 | const struct srd_decoder_inst *di, const uint8_t *inbuf, |
752 | uint64_t inbuflen) | |
b2c19614 | 753 | { |
d906d3f9 | 754 | PyObject *py_res; |
bc5f5a43 | 755 | srd_logic *logic; |
86528298 | 756 | uint64_t end_samplenum; |
b2c19614 | 757 | |
7a1712c4 | 758 | srd_dbg("Calling decode() on instance %s with %d bytes starting " |
a8b72b05 | 759 | "at sample %d.", di->inst_id, inbuflen, start_samplenum); |
b2c19614 | 760 | |
d906d3f9 | 761 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
762 | if (!di) { |
763 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
764 | return SRD_ERR_ARG; |
765 | } | |
7a1712c4 UH |
766 | if (!inbuf) { |
767 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
768 | return SRD_ERR_ARG; |
769 | } | |
770 | if (inbuflen == 0) { | |
7a1712c4 | 771 | srd_dbg("empty buffer"); |
d906d3f9 BV |
772 | return SRD_ERR_ARG; |
773 | } | |
b2c19614 | 774 | |
361fdcaa UH |
775 | /* |
776 | * Create new srd_logic object. Each iteration around the PD's loop | |
d906d3f9 BV |
777 | * will fill one sample into this object. |
778 | */ | |
bc5f5a43 BV |
779 | logic = PyObject_New(srd_logic, &srd_logic_type); |
780 | Py_INCREF(logic); | |
abeeed8b | 781 | logic->di = (struct srd_decoder_inst *)di; |
86528298 | 782 | logic->start_samplenum = start_samplenum; |
bc5f5a43 | 783 | logic->itercnt = 0; |
abeeed8b | 784 | logic->inbuf = (uint8_t *)inbuf; |
bc5f5a43 BV |
785 | logic->inbuflen = inbuflen; |
786 | logic->sample = PyList_New(2); | |
787 | Py_INCREF(logic->sample); | |
788 | ||
a8b72b05 | 789 | Py_IncRef(di->py_inst); |
f38ec285 | 790 | end_samplenum = start_samplenum + inbuflen / di->data_unitsize; |
a8b72b05 | 791 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", |
c9bfccc6 UH |
792 | "KKO", logic->start_samplenum, |
793 | end_samplenum, logic))) { | |
aafeeaea UH |
794 | srd_exception_catch("Protocol decoder instance %s: ", |
795 | di->inst_id); | |
0ff2d191 | 796 | return SRD_ERR_PYTHON; |
b2c19614 | 797 | } |
d906d3f9 | 798 | Py_DecRef(py_res); |
bc5f5a43 | 799 | |
b2c19614 BV |
800 | return SRD_OK; |
801 | } | |
802 | ||
57790bc8 | 803 | /** @private */ |
12243c22 | 804 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
805 | { |
806 | GSList *l; | |
807 | struct srd_pd_output *pdo; | |
808 | ||
a8b72b05 | 809 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 810 | |
a8b72b05 BV |
811 | Py_DecRef(di->py_inst); |
812 | g_free(di->inst_id); | |
fa12a21e BV |
813 | g_free(di->dec_probemap); |
814 | g_slist_free(di->next_di); | |
815 | for (l = di->pd_output; l; l = l->next) { | |
816 | pdo = l->data; | |
817 | g_free(pdo->proto_id); | |
818 | g_free(pdo); | |
819 | } | |
820 | g_slist_free(di->pd_output); | |
e592ac89 | 821 | g_free(di); |
fa12a21e BV |
822 | } |
823 | ||
57790bc8 | 824 | /** @private */ |
12243c22 | 825 | SRD_PRIV void srd_inst_free_all(GSList *stack) |
fa12a21e BV |
826 | { |
827 | GSList *l; | |
a8b72b05 | 828 | struct srd_decoder_inst *di; |
fa12a21e BV |
829 | |
830 | di = NULL; | |
831 | for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { | |
832 | di = l->data; | |
833 | if (di->next_di) | |
a8b72b05 BV |
834 | srd_inst_free_all(di->next_di); |
835 | srd_inst_free(di); | |
fa12a21e BV |
836 | } |
837 | if (!stack) { | |
838 | g_slist_free(di_list); | |
839 | di_list = NULL; | |
840 | } | |
fa12a21e | 841 | } |
b2c19614 | 842 | |
4895418c UH |
843 | /** @} */ |
844 | ||
845 | /** | |
846 | * @defgroup grp_session Session handling | |
847 | * | |
848 | * Starting and handling decoding sessions. | |
849 | * | |
850 | * @{ | |
851 | */ | |
852 | ||
582c8473 BV |
853 | /** |
854 | * Start a decoding session. | |
855 | * | |
856 | * Decoders, instances and stack must have been prepared beforehand. | |
857 | * | |
858 | * @param num_probes The number of probes which the incoming feed will contain. | |
859 | * @param unitsize The number of bytes per sample in the incoming feed. | |
361fdcaa | 860 | * @param samplerate The samplerate of the incoming feed. |
582c8473 BV |
861 | * |
862 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
863 | * |
864 | * @since 0.1.0 | |
582c8473 | 865 | */ |
55c3c5f4 | 866 | SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) |
7ce7775c BV |
867 | { |
868 | PyObject *args; | |
2072ae0c | 869 | GSList *d; |
a8b72b05 | 870 | struct srd_decoder_inst *di; |
7ce7775c BV |
871 | int ret; |
872 | ||
38ff5046 UH |
873 | ret = SRD_OK; |
874 | ||
7a1712c4 UH |
875 | srd_dbg("Calling start() on all instances with %d probes, " |
876 | "unitsize %d samplerate %d.", num_probes, unitsize, samplerate); | |
d906d3f9 | 877 | |
361fdcaa UH |
878 | /* |
879 | * Currently only one item of metadata is passed along to decoders, | |
d906d3f9 BV |
880 | * samplerate. This can be extended as needed. |
881 | */ | |
7ce7775c | 882 | if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { |
511e2123 | 883 | srd_err("Unable to build Python object for metadata."); |
7ce7775c BV |
884 | return SRD_ERR_PYTHON; |
885 | } | |
886 | ||
887 | /* Run the start() method on all decoders receiving frontend data. */ | |
888 | for (d = di_list; d; d = d->next) { | |
889 | di = d->data; | |
f38ec285 BV |
890 | di->data_num_probes = num_probes; |
891 | di->data_unitsize = unitsize; | |
892 | di->data_samplerate = samplerate; | |
38ff5046 | 893 | if ((ret = srd_inst_start(di, args)) != SRD_OK) |
2072ae0c | 894 | break; |
7ce7775c BV |
895 | } |
896 | ||
d906d3f9 | 897 | Py_DecRef(args); |
7ce7775c | 898 | |
2072ae0c | 899 | return ret; |
7ce7775c BV |
900 | } |
901 | ||
582c8473 | 902 | /** |
29dad0ac | 903 | * Send a chunk of logic sample data to a running decoder session. |
582c8473 BV |
904 | * |
905 | * @param start_samplenum The sample number of the first sample in this chunk. | |
906 | * @param inbuf Pointer to sample data. | |
38ff5046 | 907 | * @param inbuflen Length in bytes of the buffer. |
582c8473 BV |
908 | * |
909 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
910 | * |
911 | * @since 0.1.0 | |
582c8473 | 912 | */ |
29dad0ac | 913 | SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, |
0ff2d191 | 914 | uint64_t inbuflen) |
b2c19614 BV |
915 | { |
916 | GSList *d; | |
917 | int ret; | |
918 | ||
7a1712c4 | 919 | srd_dbg("Calling decode() on all instances with starting sample " |
c9bfccc6 UH |
920 | "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", |
921 | start_samplenum, inbuflen, inbuf); | |
d906d3f9 | 922 | |
e5080882 | 923 | for (d = di_list; d; d = d->next) { |
a8b72b05 | 924 | if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, |
361fdcaa | 925 | inbuflen)) != SRD_OK) |
b2c19614 BV |
926 | return ret; |
927 | } | |
928 | ||
929 | return SRD_OK; | |
930 | } | |
931 | ||
582c8473 | 932 | /** |
b33b8aa5 | 933 | * Register/add a decoder output callback function. |
582c8473 BV |
934 | * |
935 | * The function will be called when a protocol decoder sends output back | |
936 | * to the PD controller (except for Python objects, which only go up the | |
937 | * stack). | |
938 | * | |
939 | * @param output_type The output type this callback will receive. Only one | |
4c1d0670 | 940 | * callback per output type can be registered. |
361fdcaa UH |
941 | * @param cb The function to call. Must not be NULL. |
942 | * @param cb_data Private data for the callback function. Can be NULL. | |
8c664ca2 UH |
943 | * |
944 | * @since 0.1.0 | |
582c8473 | 945 | */ |
b33b8aa5 | 946 | SRD_API int srd_pd_output_callback_add(int output_type, |
0ff2d191 | 947 | srd_pd_output_callback_t cb, void *cb_data) |
4fadb128 BV |
948 | { |
949 | struct srd_pd_callback *pd_cb; | |
950 | ||
7a1712c4 | 951 | srd_dbg("Registering new callback for output type %d.", output_type); |
4fadb128 | 952 | |
a61ece20 UH |
953 | if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { |
954 | srd_err("Failed to g_malloc() struct srd_pd_callback."); | |
4fadb128 | 955 | return SRD_ERR_MALLOC; |
a61ece20 | 956 | } |
4fadb128 BV |
957 | |
958 | pd_cb->output_type = output_type; | |
4c1d0670 | 959 | pd_cb->cb = cb; |
41a5d962 | 960 | pd_cb->cb_data = cb_data; |
4fadb128 BV |
961 | callbacks = g_slist_append(callbacks, pd_cb); |
962 | ||
963 | return SRD_OK; | |
964 | } | |
965 | ||
57790bc8 | 966 | /** @private */ |
b33b8aa5 | 967 | SRD_PRIV void *srd_pd_output_callback_find(int output_type) |
4fadb128 BV |
968 | { |
969 | GSList *l; | |
970 | struct srd_pd_callback *pd_cb; | |
971 | void *(cb); | |
972 | ||
973 | cb = NULL; | |
974 | for (l = callbacks; l; l = l->next) { | |
975 | pd_cb = l->data; | |
976 | if (pd_cb->output_type == output_type) { | |
4c1d0670 | 977 | cb = pd_cb->cb; |
4fadb128 BV |
978 | break; |
979 | } | |
980 | } | |
981 | ||
982 | return cb; | |
983 | } | |
984 | ||
511e2123 | 985 | /* This is the backend function to Python sigrokdecode.add() call. */ |
57790bc8 | 986 | /** @private */ |
aafeeaea UH |
987 | SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, |
988 | int output_type, const char *proto_id) | |
e5080882 | 989 | { |
e5080882 | 990 | struct srd_pd_output *pdo; |
e5080882 | 991 | |
7a1712c4 | 992 | srd_dbg("Instance %s creating new output type %d for %s.", |
a8b72b05 | 993 | di->inst_id, output_type, proto_id); |
d906d3f9 | 994 | |
a61ece20 UH |
995 | if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { |
996 | srd_err("Failed to g_malloc() struct srd_pd_output."); | |
e5080882 | 997 | return -1; |
a61ece20 | 998 | } |
e5080882 | 999 | |
b231546d | 1000 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ |
15969949 | 1001 | pdo->pdo_id = g_slist_length(di->pd_output); |
e5080882 | 1002 | pdo->output_type = output_type; |
b3b2cae8 | 1003 | pdo->di = di; |
94d43b37 | 1004 | pdo->proto_id = g_strdup(proto_id); |
e5080882 BV |
1005 | di->pd_output = g_slist_append(di->pd_output, pdo); |
1006 | ||
15969949 | 1007 | return pdo->pdo_id; |
e5080882 | 1008 | } |
d7dae84b UH |
1009 | |
1010 | /** @} */ |