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