]>
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> |
32cfb920 | 27 | #include <stdint.h> |
b2c19614 | 28 | |
d7dae84b UH |
29 | /** |
30 | * @mainpage libsigrokdecode API | |
31 | * | |
32 | * @section sec_intro Introduction | |
33 | * | |
34 | * The <a href="http://sigrok.org">sigrok</a> project aims at creating a | |
35 | * portable, cross-platform, Free/Libre/Open-Source signal analysis software | |
36 | * suite that supports various device types (such as logic analyzers, | |
37 | * oscilloscopes, multimeters, and more). | |
38 | * | |
39 | * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a | |
40 | * shared library written in C which provides the basic API for (streaming) | |
41 | * protocol decoding functionality. | |
42 | * | |
43 | * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a> | |
44 | * are written in Python (>= 3.0). | |
45 | * | |
46 | * @section sec_api API reference | |
47 | * | |
48 | * See the "Modules" page for an introduction to various libsigrokdecode | |
49 | * related topics and the detailed API documentation of the respective | |
50 | * functions. | |
51 | * | |
52 | * You can also browse the API documentation by file, or review all | |
53 | * data structures. | |
54 | * | |
55 | * @section sec_mailinglists Mailing lists | |
56 | * | |
57 | * 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>. | |
58 | * | |
59 | * @section sec_irc IRC | |
60 | * | |
61 | * You can find the sigrok developers in the | |
62 | * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a> | |
63 | * IRC channel on Freenode. | |
64 | * | |
65 | * @section sec_website Website | |
66 | * | |
67 | * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a> | |
68 | */ | |
69 | ||
70 | /** | |
71 | * @file | |
72 | * | |
73 | * Initializing and shutting down libsigrokdecode. | |
74 | */ | |
75 | ||
76 | /** | |
77 | * @defgroup grp_init Initialization | |
78 | * | |
79 | * Initializing and shutting down libsigrokdecode. | |
80 | * | |
81 | * Before using any of the libsigrokdecode functionality, srd_init() must | |
82 | * be called to initialize the library. | |
83 | * | |
84 | * When libsigrokdecode functionality is no longer needed, srd_exit() should | |
85 | * be called. | |
86 | * | |
87 | * @{ | |
88 | */ | |
89 | ||
32cfb920 | 90 | /** @cond PRIVATE */ |
d906d3f9 | 91 | |
32cfb920 BV |
92 | SRD_PRIV GSList *sessions = NULL; |
93 | static int max_session_id = -1; | |
983cb0f5 | 94 | |
32cfb920 | 95 | static int session_is_valid(struct srd_session *sess); |
57790bc8 | 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 | |
32cfb920 BV |
140 | if (max_session_id != -1) { |
141 | srd_err("libsigrokdecode is already initialized."); | |
142 | return SRD_ERR; | |
143 | } | |
144 | ||
7a1712c4 | 145 | srd_dbg("Initializing libsigrokdecode."); |
d906d3f9 BV |
146 | |
147 | /* Add our own module to the list of built-in modules. */ | |
bc5f5a43 | 148 | PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); |
5f802ec6 | 149 | |
511e2123 | 150 | /* Initialize the Python interpreter. */ |
b2c19614 BV |
151 | Py_Initialize(); |
152 | ||
65e1c7d0 | 153 | /* Installed decoders. */ |
aafeeaea | 154 | if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { |
b2c19614 BV |
155 | Py_Finalize(); |
156 | return ret; | |
157 | } | |
158 | ||
65e1c7d0 BV |
159 | /* Path specified by the user. */ |
160 | if (path) { | |
aafeeaea | 161 | if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { |
65e1c7d0 BV |
162 | Py_Finalize(); |
163 | return ret; | |
164 | } | |
165 | } | |
166 | ||
167 | /* Environment variable overrides everything, for debugging. */ | |
168 | if ((env_path = getenv("SIGROKDECODE_DIR"))) { | |
aafeeaea | 169 | if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { |
65e1c7d0 BV |
170 | Py_Finalize(); |
171 | return ret; | |
172 | } | |
173 | } | |
174 | ||
32cfb920 BV |
175 | max_session_id = 0; |
176 | ||
b2c19614 BV |
177 | return SRD_OK; |
178 | } | |
179 | ||
b2c19614 BV |
180 | /** |
181 | * Shutdown libsigrokdecode. | |
182 | * | |
183 | * This frees all the memory allocated for protocol decoders and shuts down | |
184 | * the Python interpreter. | |
185 | * | |
186 | * This function should only be called if there was a (successful!) invocation | |
187 | * of srd_init() before. Calling this function multiple times in a row, without | |
7ce7775c | 188 | * any successful srd_init() calls in between, is not allowed. |
b2c19614 BV |
189 | * |
190 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
191 | * |
192 | * @since 0.1.0 | |
b2c19614 | 193 | */ |
55c3c5f4 | 194 | SRD_API int srd_exit(void) |
b2c19614 | 195 | { |
32cfb920 BV |
196 | GSList *l; |
197 | ||
7a1712c4 | 198 | srd_dbg("Exiting libsigrokdecode."); |
d906d3f9 | 199 | |
32cfb920 BV |
200 | for (l = sessions; l; l = l->next) |
201 | srd_session_destroy((struct srd_session *)l->data); | |
202 | ||
8ad6e500 | 203 | srd_decoder_unload_all(); |
e5080882 | 204 | g_slist_free(pd_list); |
96c52595 | 205 | pd_list = NULL; |
b2c19614 BV |
206 | |
207 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
208 | Py_Finalize(); | |
209 | ||
32cfb920 BV |
210 | max_session_id = -1; |
211 | ||
b2c19614 BV |
212 | return SRD_OK; |
213 | } | |
214 | ||
b2c19614 | 215 | /** |
9d9fcb37 UH |
216 | * Add an additional search directory for the protocol decoders. |
217 | * | |
218 | * The specified directory is prepended (not appended!) to Python's sys.path, | |
219 | * in order to search for sigrok protocol decoders in the specified | |
220 | * directories first, and in the generic Python module directories (and in | |
221 | * the current working directory) last. This avoids conflicts if there are | |
222 | * Python modules which have the same name as a sigrok protocol decoder in | |
223 | * sys.path or in the current working directory. | |
b2c19614 | 224 | * |
361fdcaa UH |
225 | * @param path Path to the directory containing protocol decoders which shall |
226 | * be added to the Python sys.path, or NULL. | |
9d9fcb37 | 227 | * |
65e1c7d0 | 228 | * @return SRD_OK upon success, a (negative) error code otherwise. |
57790bc8 UH |
229 | * |
230 | * @private | |
8c664ca2 UH |
231 | * |
232 | * @since 0.1.0 | |
b2c19614 | 233 | */ |
aafeeaea | 234 | SRD_PRIV int srd_decoder_searchpath_add(const char *path) |
b2c19614 | 235 | { |
65e1c7d0 BV |
236 | PyObject *py_cur_path, *py_item; |
237 | GString *new_path; | |
238 | int wc_len, i; | |
239 | wchar_t *wc_new_path; | |
240 | char *item; | |
241 | ||
8ad6e500 | 242 | srd_dbg("Adding '%s' to module path.", path); |
65e1c7d0 BV |
243 | |
244 | new_path = g_string_sized_new(256); | |
e592ac89 | 245 | g_string_assign(new_path, path); |
65e1c7d0 BV |
246 | py_cur_path = PySys_GetObject("path"); |
247 | for (i = 0; i < PyList_Size(py_cur_path); i++) { | |
e592ac89 | 248 | g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S); |
65e1c7d0 BV |
249 | py_item = PyList_GetItem(py_cur_path, i); |
250 | if (!PyUnicode_Check(py_item)) | |
251 | /* Shouldn't happen. */ | |
252 | continue; | |
253 | if (py_str_as_str(py_item, &item) != SRD_OK) | |
254 | continue; | |
255 | g_string_append(new_path, item); | |
e592ac89 | 256 | g_free(item); |
65e1c7d0 | 257 | } |
639c5689 | 258 | |
65e1c7d0 BV |
259 | /* Convert to wide chars. */ |
260 | wc_len = sizeof(wchar_t) * (new_path->len + 1); | |
261 | if (!(wc_new_path = g_try_malloc(wc_len))) { | |
262 | srd_dbg("malloc failed"); | |
263 | return SRD_ERR_MALLOC; | |
264 | } | |
265 | mbstowcs(wc_new_path, new_path->str, wc_len); | |
266 | PySys_SetPath(wc_new_path); | |
267 | g_string_free(new_path, TRUE); | |
268 | g_free(wc_new_path); | |
269 | ||
65e1c7d0 | 270 | return SRD_OK; |
b2c19614 BV |
271 | } |
272 | ||
4895418c UH |
273 | /** @} */ |
274 | ||
275 | /** | |
276 | * @defgroup grp_instances Decoder instances | |
277 | * | |
278 | * Decoder instance handling. | |
279 | * | |
280 | * @{ | |
281 | */ | |
282 | ||
7ce7775c | 283 | /** |
b33b8aa5 | 284 | * Set one or more options in a decoder instance. |
0bdadba2 | 285 | * |
361fdcaa UH |
286 | * Handled options are removed from the hash. |
287 | * | |
0bdadba2 BV |
288 | * @param di Decoder instance. |
289 | * @param options A GHashTable of options to set. | |
7ce7775c | 290 | * |
0bdadba2 | 291 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
292 | * |
293 | * @since 0.1.0 | |
0bdadba2 | 294 | */ |
b33b8aa5 | 295 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 296 | GHashTable *options) |
0bdadba2 BV |
297 | { |
298 | PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; | |
299 | PyObject *py_optlist, *py_classval; | |
300 | Py_UNICODE *py_ustr; | |
2f395bff | 301 | GVariant *value; |
0bdadba2 | 302 | unsigned long long int val_ull; |
2f395bff | 303 | gint64 val_int; |
0bdadba2 | 304 | int num_optkeys, ret, size, i; |
2f395bff BV |
305 | const char *val_str; |
306 | char *dbg, *key; | |
0bdadba2 | 307 | |
3af0e345 UH |
308 | if (!di) { |
309 | srd_err("Invalid decoder instance."); | |
310 | return SRD_ERR_ARG; | |
311 | } | |
312 | ||
313 | if (!options) { | |
314 | srd_err("Invalid options GHashTable."); | |
315 | return SRD_ERR_ARG; | |
316 | } | |
317 | ||
c9bfccc6 | 318 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 319 | /* Decoder has no options. */ |
e431d9cc BV |
320 | if (g_hash_table_size(options) == 0) { |
321 | /* No options provided. */ | |
322 | return SRD_OK; | |
323 | } else { | |
324 | srd_err("Protocol decoder has no options."); | |
325 | return SRD_ERR_ARG; | |
326 | } | |
0bdadba2 | 327 | return SRD_OK; |
e431d9cc | 328 | } |
0bdadba2 BV |
329 | |
330 | ret = SRD_ERR_PYTHON; | |
331 | key = NULL; | |
332 | py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; | |
333 | py_optlist = py_classval = NULL; | |
334 | py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); | |
0bdadba2 BV |
335 | |
336 | /* All of these are synthesized objects, so they're good. */ | |
337 | py_dec_optkeys = PyDict_Keys(py_dec_options); | |
338 | num_optkeys = PyList_Size(py_dec_optkeys); | |
119d6258 BV |
339 | |
340 | /* | |
341 | * The 'options' dictionary is a class variable, but we need to | |
342 | * change it. Changing it directly will affect the entire class, | |
343 | * so we need to create a new object for it, and populate that | |
344 | * instead. | |
345 | */ | |
a8b72b05 | 346 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 | 347 | goto err_out; |
119d6258 BV |
348 | Py_DECREF(py_di_options); |
349 | py_di_options = PyDict_New(); | |
350 | PyObject_SetAttrString(di->py_inst, "options", py_di_options); | |
0bdadba2 BV |
351 | for (i = 0; i < num_optkeys; i++) { |
352 | /* Get the default class value for this option. */ | |
353 | py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); | |
354 | if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) | |
355 | goto err_out; | |
356 | if (!(py_classval = PyList_GetItem(py_optlist, 1))) | |
357 | goto err_out; | |
130ef08a | 358 | if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { |
c9bfccc6 UH |
359 | srd_err("Options of type %s are not yet supported.", |
360 | Py_TYPE(py_classval)->tp_name); | |
130ef08a BV |
361 | goto err_out; |
362 | } | |
0bdadba2 BV |
363 | |
364 | if ((value = g_hash_table_lookup(options, key))) { | |
2f395bff BV |
365 | dbg = g_variant_print(value, TRUE); |
366 | srd_dbg("got option '%s' = %s", key, dbg); | |
367 | g_free(dbg); | |
0bdadba2 BV |
368 | /* An override for this option was provided. */ |
369 | if (PyUnicode_Check(py_classval)) { | |
2f395bff BV |
370 | if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { |
371 | srd_err("Option '%s' requires a string value.", key); | |
372 | goto err_out; | |
373 | } | |
374 | val_str = g_variant_get_string(value, NULL); | |
375 | if (!(py_optval = PyUnicode_FromString(val_str))) { | |
0bdadba2 BV |
376 | /* Some UTF-8 encoding error. */ |
377 | PyErr_Clear(); | |
2f395bff | 378 | srd_err("Option '%s' requires a UTF-8 string value.", key); |
0bdadba2 BV |
379 | goto err_out; |
380 | } | |
381 | } else if (PyLong_Check(py_classval)) { | |
2f395bff BV |
382 | if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { |
383 | srd_err("Option '%s' requires an integer value.", key); | |
384 | goto err_out; | |
385 | } | |
386 | val_int = g_variant_get_int64(value); | |
387 | if (!(py_optval = PyLong_FromLong(val_int))) { | |
0bdadba2 BV |
388 | /* ValueError Exception */ |
389 | PyErr_Clear(); | |
2f395bff | 390 | srd_err("Option '%s' has invalid integer value.", key); |
0bdadba2 BV |
391 | goto err_out; |
392 | } | |
393 | } | |
394 | g_hash_table_remove(options, key); | |
395 | } else { | |
396 | /* Use the class default for this option. */ | |
397 | if (PyUnicode_Check(py_classval)) { | |
398 | /* Make a brand new copy of the string. */ | |
399 | py_ustr = PyUnicode_AS_UNICODE(py_classval); | |
400 | size = PyUnicode_GET_SIZE(py_classval); | |
401 | py_optval = PyUnicode_FromUnicode(py_ustr, size); | |
402 | } else if (PyLong_Check(py_classval)) { | |
403 | /* Make a brand new copy of the integer. */ | |
404 | val_ull = PyLong_AsUnsignedLongLong(py_classval); | |
405 | if (val_ull == (unsigned long long)-1) { | |
406 | /* OverFlowError exception */ | |
407 | PyErr_Clear(); | |
c9bfccc6 UH |
408 | srd_err("Invalid integer value for %s: " |
409 | "expected integer.", key); | |
0bdadba2 BV |
410 | goto err_out; |
411 | } | |
412 | if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) | |
413 | goto err_out; | |
414 | } | |
415 | } | |
416 | ||
361fdcaa UH |
417 | /* |
418 | * If we got here, py_optval holds a known good new reference | |
0bdadba2 BV |
419 | * to the instance option to set. |
420 | */ | |
421 | if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) | |
422 | goto err_out; | |
e592ac89 | 423 | g_free(key); |
b88e336b | 424 | key = NULL; |
0bdadba2 BV |
425 | } |
426 | ||
427 | ret = SRD_OK; | |
428 | ||
429 | err_out: | |
0bdadba2 BV |
430 | Py_XDECREF(py_di_options); |
431 | Py_XDECREF(py_dec_optkeys); | |
432 | Py_XDECREF(py_dec_options); | |
6f858319 | 433 | g_free(key); |
7fc7bde6 | 434 | if (PyErr_Occurred()) { |
aafeeaea | 435 | srd_exception_catch("Stray exception in srd_inst_option_set()."); |
7fc7bde6 BV |
436 | ret = SRD_ERR_PYTHON; |
437 | } | |
0bdadba2 BV |
438 | |
439 | return ret; | |
440 | } | |
441 | ||
b33b8aa5 | 442 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ |
abeeed8b | 443 | static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) |
f38ec285 | 444 | { |
f38ec285 BV |
445 | return strcmp(a->id, probe_id); |
446 | } | |
447 | ||
0bdadba2 | 448 | /** |
b33b8aa5 UH |
449 | * Set all probes in a decoder instance. |
450 | * | |
451 | * This function sets _all_ probes for the specified decoder instance, i.e., | |
452 | * it overwrites any probes that were already defined (if any). | |
0bdadba2 BV |
453 | * |
454 | * @param di Decoder instance. | |
38ff5046 UH |
455 | * @param new_probes A GHashTable of probes to set. Key is probe name, value is |
456 | * the probe number. Samples passed to this instance will be | |
457 | * arranged in this order. | |
12243c22 | 458 | * |
0bdadba2 | 459 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
460 | * |
461 | * @since 0.1.0 | |
0bdadba2 | 462 | */ |
b33b8aa5 | 463 | SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, |
0ff2d191 | 464 | GHashTable *new_probes) |
0bdadba2 | 465 | { |
2f395bff | 466 | GVariant *probe_val; |
f38ec285 BV |
467 | GList *l; |
468 | GSList *sl; | |
469 | struct srd_probe *p; | |
ed416497 | 470 | int *new_probemap, new_probenum, num_required_probes, num_probes, i; |
2f395bff | 471 | char *probe_id; |
0bdadba2 | 472 | |
ce46beed | 473 | srd_dbg("set probes called for instance %s with list of %d probes", |
a8b72b05 | 474 | di->inst_id, g_hash_table_size(new_probes)); |
ce46beed | 475 | |
f38ec285 | 476 | if (g_hash_table_size(new_probes) == 0) |
0bdadba2 BV |
477 | /* No probes provided. */ |
478 | return SRD_OK; | |
479 | ||
c9bfccc6 | 480 | if (di->dec_num_probes == 0) { |
0bdadba2 | 481 | /* Decoder has no probes. */ |
f38ec285 | 482 | srd_err("Protocol decoder %s has no probes to define.", |
c9bfccc6 | 483 | di->decoder->name); |
f38ec285 BV |
484 | return SRD_ERR_ARG; |
485 | } | |
0bdadba2 | 486 | |
f38ec285 | 487 | new_probemap = NULL; |
0bdadba2 | 488 | |
f38ec285 | 489 | if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { |
a61ece20 | 490 | srd_err("Failed to g_malloc() new probe map."); |
f38ec285 | 491 | return SRD_ERR_MALLOC; |
0bdadba2 BV |
492 | } |
493 | ||
38ff5046 UH |
494 | /* |
495 | * For now, map all indexes to probe -1 (can be overridden later). | |
496 | * This -1 is interpreted as an unspecified probe later. | |
497 | */ | |
498 | for (i = 0; i < di->dec_num_probes; i++) | |
499 | new_probemap[i] = -1; | |
500 | ||
ed416497 | 501 | num_probes = 0; |
f38ec285 BV |
502 | for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { |
503 | probe_id = l->data; | |
69075817 | 504 | probe_val = g_hash_table_lookup(new_probes, probe_id); |
2f395bff | 505 | if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) { |
be873260 | 506 | /* Probe name was specified without a value. */ |
c9bfccc6 | 507 | srd_err("No probe number was specified for %s.", |
2f395bff | 508 | probe_id); |
be873260 BV |
509 | g_free(new_probemap); |
510 | return SRD_ERR_ARG; | |
511 | } | |
2f395bff | 512 | new_probenum = g_variant_get_int32(probe_val); |
f38ec285 BV |
513 | if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, |
514 | (GCompareFunc)compare_probe_id))) { | |
515 | /* Fall back on optional probes. */ | |
dcdf4883 | 516 | if (!(sl = g_slist_find_custom(di->decoder->opt_probes, |
c9bfccc6 UH |
517 | probe_id, (GCompareFunc) compare_probe_id))) { |
518 | srd_err("Protocol decoder %s has no probe " | |
2f395bff | 519 | "'%s'.", di->decoder->name, probe_id); |
f38ec285 BV |
520 | g_free(new_probemap); |
521 | return SRD_ERR_ARG; | |
522 | } | |
523 | } | |
524 | p = sl->data; | |
525 | new_probemap[p->order] = new_probenum; | |
38ff5046 UH |
526 | srd_dbg("Setting probe mapping: %s (index %d) = probe %d.", |
527 | p->id, p->order, new_probenum); | |
ed416497 | 528 | num_probes++; |
38ff5046 | 529 | } |
ed416497 | 530 | di->data_unitsize = (num_probes + 7) / 8; |
38ff5046 UH |
531 | |
532 | srd_dbg("Final probe map:"); | |
533 | num_required_probes = g_slist_length(di->decoder->probes); | |
534 | for (i = 0; i < di->dec_num_probes; i++) { | |
535 | srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i], | |
536 | (i < num_required_probes) ? "required" : "optional"); | |
f38ec285 | 537 | } |
38ff5046 | 538 | |
f38ec285 BV |
539 | g_free(di->dec_probemap); |
540 | di->dec_probemap = new_probemap; | |
0bdadba2 | 541 | |
f38ec285 | 542 | return SRD_OK; |
0bdadba2 BV |
543 | } |
544 | ||
545 | /** | |
546 | * Create a new protocol decoder instance. | |
7ce7775c | 547 | * |
32cfb920 | 548 | * @param sess The session holding the protocol decoder instance. |
38ff5046 | 549 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 550 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 551 | * the decoder class. May be NULL. |
12243c22 | 552 | * |
a8b72b05 | 553 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 554 | * NULL in case of failure. |
8c664ca2 | 555 | * |
69075817 | 556 | * @since 0.3.0 |
7ce7775c | 557 | */ |
32cfb920 BV |
558 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
559 | const char *decoder_id, GHashTable *options) | |
b2c19614 | 560 | { |
c9bfccc6 | 561 | int i; |
b2c19614 | 562 | struct srd_decoder *dec; |
a8b72b05 BV |
563 | struct srd_decoder_inst *di; |
564 | char *inst_id; | |
b2c19614 | 565 | |
7a1712c4 | 566 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 567 | |
32cfb920 BV |
568 | if (session_is_valid(sess) != SRD_OK) { |
569 | srd_err("Invalid session."); | |
570 | return NULL; | |
571 | } | |
572 | ||
9d122fd5 | 573 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 574 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 575 | return NULL; |
0bdadba2 | 576 | } |
b2c19614 | 577 | |
a8b72b05 | 578 | if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { |
a61ece20 | 579 | srd_err("Failed to g_malloc() instance."); |
7ce7775c BV |
580 | return NULL; |
581 | } | |
0bdadba2 | 582 | |
b2c19614 | 583 | di->decoder = dec; |
32cfb920 | 584 | di->sess = sess; |
38ff5046 UH |
585 | if (options) { |
586 | inst_id = g_hash_table_lookup(options, "id"); | |
587 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
588 | g_hash_table_remove(options, "id"); | |
589 | } else | |
590 | di->inst_id = g_strdup(decoder_id); | |
b2c19614 | 591 | |
361fdcaa UH |
592 | /* |
593 | * Prepare a default probe map, where samples come in the | |
f38ec285 BV |
594 | * order in which the decoder class defined them. |
595 | */ | |
596 | di->dec_num_probes = g_slist_length(di->decoder->probes) + | |
69075817 | 597 | g_slist_length(di->decoder->opt_probes); |
19a90bab | 598 | if (di->dec_num_probes) { |
c9bfccc6 | 599 | if (!(di->dec_probemap = |
69075817 | 600 | g_try_malloc(sizeof(int) * di->dec_num_probes))) { |
a61ece20 | 601 | srd_err("Failed to g_malloc() probe map."); |
19a90bab BV |
602 | g_free(di); |
603 | return NULL; | |
604 | } | |
605 | for (i = 0; i < di->dec_num_probes; i++) | |
606 | di->dec_probemap[i] = i; | |
f38ec285 | 607 | } |
ed416497 | 608 | di->data_unitsize = (di->dec_num_probes + 7) / 8; |
f38ec285 | 609 | |
0bdadba2 | 610 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 611 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 612 | if (PyErr_Occurred()) |
aafeeaea | 613 | srd_exception_catch("failed to create %s instance: ", |
69075817 | 614 | decoder_id); |
f38ec285 | 615 | g_free(di->dec_probemap); |
0bdadba2 | 616 | g_free(di); |
7ce7775c | 617 | return NULL; |
b2c19614 | 618 | } |
7ce7775c | 619 | |
38ff5046 | 620 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
f38ec285 | 621 | g_free(di->dec_probemap); |
0bdadba2 BV |
622 | g_free(di); |
623 | return NULL; | |
624 | } | |
b2c19614 | 625 | |
f38ec285 | 626 | /* Instance takes input from a frontend by default. */ |
32cfb920 | 627 | sess->di_list = g_slist_append(sess->di_list, di); |
f38ec285 | 628 | |
b2c19614 BV |
629 | return di; |
630 | } | |
631 | ||
582c8473 BV |
632 | /** |
633 | * Stack a decoder instance on top of another. | |
634 | * | |
32cfb920 | 635 | * @param sess The session holding the protocol decoder instances. |
582c8473 BV |
636 | * @param di_from The instance to move. |
637 | * @param di_to The instance on top of which di_from will be stacked. | |
638 | * | |
639 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 640 | * |
69075817 | 641 | * @since 0.3.0 |
582c8473 | 642 | */ |
32cfb920 BV |
643 | SRD_API int srd_inst_stack(struct srd_session *sess, |
644 | struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to) | |
7ce7775c | 645 | { |
32cfb920 BV |
646 | |
647 | if (session_is_valid(sess) != SRD_OK) { | |
648 | srd_err("Invalid session."); | |
649 | return SRD_ERR_ARG; | |
650 | } | |
651 | ||
7ce7775c | 652 | if (!di_from || !di_to) { |
d906d3f9 | 653 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
654 | return SRD_ERR_ARG; |
655 | } | |
656 | ||
32cfb920 | 657 | if (g_slist_find(sess->di_list, di_to)) { |
2072ae0c | 658 | /* Remove from the unstacked list. */ |
32cfb920 | 659 | sess->di_list = g_slist_remove(sess->di_list, di_to); |
7ce7775c BV |
660 | } |
661 | ||
7ce7775c BV |
662 | /* Stack on top of source di. */ |
663 | di_from->next_di = g_slist_append(di_from->next_di, di_to); | |
664 | ||
665 | return SRD_OK; | |
666 | } | |
667 | ||
2072ae0c | 668 | /** |
361fdcaa UH |
669 | * Find a decoder instance by its instance ID. |
670 | * | |
671 | * Only the bottom level of instances are searched -- instances already stacked | |
672 | * on top of another one will not be found. | |
2072ae0c | 673 | * |
32cfb920 | 674 | * @param sess The session holding the protocol decoder instance. |
ed2306a6 | 675 | * @param inst_id The instance ID to be found. |
2072ae0c | 676 | * |
a8b72b05 | 677 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 | 678 | * |
69075817 | 679 | * @since 0.3.0 |
2072ae0c | 680 | */ |
32cfb920 BV |
681 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, |
682 | const char *inst_id) | |
7ce7775c BV |
683 | { |
684 | GSList *l; | |
a8b72b05 | 685 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 686 | |
32cfb920 BV |
687 | if (session_is_valid(sess) != SRD_OK) { |
688 | srd_err("Invalid session."); | |
689 | return NULL; | |
690 | } | |
691 | ||
7ce7775c | 692 | di = NULL; |
32cfb920 | 693 | for (l = sess->di_list; l; l = l->next) { |
7ce7775c | 694 | tmp = l->data; |
a8b72b05 | 695 | if (!strcmp(tmp->inst_id, inst_id)) { |
7ce7775c BV |
696 | di = tmp; |
697 | break; | |
698 | } | |
699 | } | |
700 | ||
701 | return di; | |
702 | } | |
703 | ||
32cfb920 BV |
704 | static struct srd_decoder_inst *srd_sess_inst_find_by_obj( |
705 | struct srd_session *sess, const GSList *stack, | |
706 | const PyObject *obj) | |
707 | { | |
708 | const GSList *l; | |
709 | struct srd_decoder_inst *tmp, *di; | |
710 | ||
711 | if (session_is_valid(sess) != SRD_OK) { | |
712 | srd_err("Invalid session."); | |
713 | return NULL; | |
714 | } | |
715 | ||
716 | di = NULL; | |
717 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
718 | tmp = l->data; | |
719 | if (tmp->py_inst == obj) | |
720 | di = tmp; | |
721 | else if (tmp->next_di) | |
722 | di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); | |
723 | } | |
724 | ||
725 | return di; | |
726 | } | |
727 | ||
2072ae0c | 728 | /** |
361fdcaa UH |
729 | * Find a decoder instance by its Python object. |
730 | * | |
731 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
32cfb920 BV |
732 | * This will recurse to find the instance anywhere in the stack tree of all |
733 | * sessions. | |
2072ae0c | 734 | * |
361fdcaa UH |
735 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the |
736 | * stack to search. To start searching at the bottom level of | |
737 | * decoder instances, pass NULL. | |
511e2123 | 738 | * @param obj The Python class instantiation. |
2072ae0c | 739 | * |
a8b72b05 | 740 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
57790bc8 UH |
741 | * |
742 | * @private | |
8c664ca2 UH |
743 | * |
744 | * @since 0.1.0 | |
2072ae0c | 745 | */ |
abeeed8b | 746 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
0ff2d191 | 747 | const PyObject *obj) |
2072ae0c | 748 | { |
32cfb920 BV |
749 | struct srd_decoder_inst *di; |
750 | struct srd_session *sess; | |
751 | GSList *l; | |
2072ae0c BV |
752 | |
753 | di = NULL; | |
32cfb920 BV |
754 | for (l = sessions; di == NULL && l != NULL; l = l->next) { |
755 | sess = l->data; | |
756 | di = srd_sess_inst_find_by_obj(sess, stack, obj); | |
2072ae0c BV |
757 | } |
758 | ||
759 | return di; | |
760 | } | |
761 | ||
57790bc8 | 762 | /** @private */ |
ed416497 | 763 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) |
b2c19614 | 764 | { |
ed416497 | 765 | PyObject *py_res; |
2072ae0c | 766 | GSList *l; |
a8b72b05 | 767 | struct srd_decoder_inst *next_di; |
ed416497 | 768 | int ret; |
b2c19614 | 769 | |
7a1712c4 | 770 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
ed416497 | 771 | di->inst_id); |
b2c19614 | 772 | |
ed416497 | 773 | if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { |
aafeeaea | 774 | srd_exception_catch("Protocol decoder instance %s: ", |
ed416497 | 775 | di->inst_id); |
7ce7775c BV |
776 | return SRD_ERR_PYTHON; |
777 | } | |
f38ec285 | 778 | Py_DecRef(py_res); |
7ce7775c | 779 | |
ed416497 | 780 | /* Start all the PDs stacked on top of this one. */ |
2072ae0c BV |
781 | for (l = di->next_di; l; l = l->next) { |
782 | next_di = l->data; | |
ed416497 BV |
783 | if ((ret = srd_inst_start(next_di)) != SRD_OK) |
784 | return ret; | |
2072ae0c BV |
785 | } |
786 | ||
b2c19614 BV |
787 | return SRD_OK; |
788 | } | |
789 | ||
b2c19614 BV |
790 | /** |
791 | * Run the specified decoder function. | |
792 | * | |
ed416497 | 793 | * @param di The decoder instance to call. Must not be NULL. |
d906d3f9 | 794 | * @param start_samplenum The starting sample number for the buffer's sample |
7a1712c4 | 795 | * set, relative to the start of capture. |
ed416497 BV |
796 | * @param end_samplenum The ending sample number for the buffer's sample |
797 | * set, relative to the start of capture. | |
7a1712c4 UH |
798 | * @param inbuf The buffer to decode. Must not be NULL. |
799 | * @param inbuflen Length of the buffer. Must be > 0. | |
b2c19614 BV |
800 | * |
801 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
802 | * |
803 | * @private | |
8c664ca2 UH |
804 | * |
805 | * @since 0.1.0 | |
b2c19614 | 806 | */ |
ed416497 BV |
807 | SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, |
808 | uint64_t start_samplenum, uint64_t end_samplenum, | |
809 | const uint8_t *inbuf, uint64_t inbuflen) | |
b2c19614 | 810 | { |
d906d3f9 | 811 | PyObject *py_res; |
bc5f5a43 | 812 | srd_logic *logic; |
b2c19614 | 813 | |
74bb0af5 UH |
814 | srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes " |
815 | "starting at sample %" PRIu64 ".", di->inst_id, inbuflen, | |
816 | start_samplenum); | |
b2c19614 | 817 | |
d906d3f9 | 818 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
819 | if (!di) { |
820 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
821 | return SRD_ERR_ARG; |
822 | } | |
7a1712c4 UH |
823 | if (!inbuf) { |
824 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
825 | return SRD_ERR_ARG; |
826 | } | |
827 | if (inbuflen == 0) { | |
7a1712c4 | 828 | srd_dbg("empty buffer"); |
d906d3f9 BV |
829 | return SRD_ERR_ARG; |
830 | } | |
b2c19614 | 831 | |
361fdcaa UH |
832 | /* |
833 | * Create new srd_logic object. Each iteration around the PD's loop | |
d906d3f9 BV |
834 | * will fill one sample into this object. |
835 | */ | |
bc5f5a43 BV |
836 | logic = PyObject_New(srd_logic, &srd_logic_type); |
837 | Py_INCREF(logic); | |
abeeed8b | 838 | logic->di = (struct srd_decoder_inst *)di; |
86528298 | 839 | logic->start_samplenum = start_samplenum; |
bc5f5a43 | 840 | logic->itercnt = 0; |
abeeed8b | 841 | logic->inbuf = (uint8_t *)inbuf; |
bc5f5a43 BV |
842 | logic->inbuflen = inbuflen; |
843 | logic->sample = PyList_New(2); | |
844 | Py_INCREF(logic->sample); | |
845 | ||
a8b72b05 | 846 | Py_IncRef(di->py_inst); |
a8b72b05 | 847 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", |
ed416497 BV |
848 | "KKO", start_samplenum, end_samplenum, logic))) { |
849 | srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); | |
0ff2d191 | 850 | return SRD_ERR_PYTHON; |
b2c19614 | 851 | } |
d906d3f9 | 852 | Py_DecRef(py_res); |
bc5f5a43 | 853 | |
b2c19614 BV |
854 | return SRD_OK; |
855 | } | |
856 | ||
57790bc8 | 857 | /** @private */ |
12243c22 | 858 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
859 | { |
860 | GSList *l; | |
861 | struct srd_pd_output *pdo; | |
862 | ||
a8b72b05 | 863 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 864 | |
a8b72b05 BV |
865 | Py_DecRef(di->py_inst); |
866 | g_free(di->inst_id); | |
fa12a21e BV |
867 | g_free(di->dec_probemap); |
868 | g_slist_free(di->next_di); | |
869 | for (l = di->pd_output; l; l = l->next) { | |
870 | pdo = l->data; | |
871 | g_free(pdo->proto_id); | |
872 | g_free(pdo); | |
873 | } | |
874 | g_slist_free(di->pd_output); | |
e592ac89 | 875 | g_free(di); |
fa12a21e BV |
876 | } |
877 | ||
57790bc8 | 878 | /** @private */ |
32cfb920 | 879 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) |
fa12a21e BV |
880 | { |
881 | GSList *l; | |
a8b72b05 | 882 | struct srd_decoder_inst *di; |
fa12a21e | 883 | |
32cfb920 BV |
884 | if (session_is_valid(sess) != SRD_OK) { |
885 | srd_err("Invalid session."); | |
886 | return; | |
887 | } | |
888 | ||
fa12a21e | 889 | di = NULL; |
32cfb920 | 890 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { |
fa12a21e BV |
891 | di = l->data; |
892 | if (di->next_di) | |
32cfb920 | 893 | srd_inst_free_all(sess, di->next_di); |
a8b72b05 | 894 | srd_inst_free(di); |
fa12a21e BV |
895 | } |
896 | if (!stack) { | |
32cfb920 BV |
897 | g_slist_free(sess->di_list); |
898 | sess->di_list = NULL; | |
fa12a21e | 899 | } |
fa12a21e | 900 | } |
b2c19614 | 901 | |
4895418c UH |
902 | /** @} */ |
903 | ||
904 | /** | |
905 | * @defgroup grp_session Session handling | |
906 | * | |
907 | * Starting and handling decoding sessions. | |
908 | * | |
909 | * @{ | |
910 | */ | |
911 | ||
32cfb920 BV |
912 | static int session_is_valid(struct srd_session *sess) |
913 | { | |
914 | ||
915 | if (!sess || sess->session_id < 1) | |
916 | return SRD_ERR; | |
917 | ||
918 | return SRD_OK; | |
919 | } | |
920 | ||
921 | /** | |
922 | * Create a decoding session. | |
923 | * | |
924 | * A session holds all decoder instances, their stack relationships and | |
925 | * output callbacks. | |
926 | * | |
94bc9a83 UH |
927 | * @param sess A pointer which will hold a pointer to a newly |
928 | * initialized session on return. | |
32cfb920 BV |
929 | * |
930 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
931 | * | |
932 | * @since 0.3.0 | |
933 | */ | |
934 | SRD_API int srd_session_new(struct srd_session **sess) | |
935 | { | |
936 | ||
937 | if (!sess) { | |
938 | srd_err("Invalid session pointer."); | |
74bb0af5 | 939 | return SRD_ERR_ARG; |
32cfb920 BV |
940 | } |
941 | ||
942 | if (!(*sess = g_try_malloc(sizeof(struct srd_session)))) | |
943 | return SRD_ERR_MALLOC; | |
944 | (*sess)->session_id = ++max_session_id; | |
32cfb920 BV |
945 | (*sess)->di_list = (*sess)->callbacks = NULL; |
946 | ||
947 | /* Keep a list of all sessions, so we can clean up as needed. */ | |
948 | sessions = g_slist_append(sessions, *sess); | |
949 | ||
950 | srd_dbg("Created session %d.", (*sess)->session_id); | |
951 | ||
952 | return SRD_OK; | |
953 | } | |
954 | ||
582c8473 BV |
955 | /** |
956 | * Start a decoding session. | |
957 | * | |
32cfb920 BV |
958 | * Decoders, instances and stack must have been prepared beforehand, |
959 | * and all SRD_CONF parameters set. | |
582c8473 | 960 | * |
32cfb920 | 961 | * @param sess The session to start. |
582c8473 BV |
962 | * |
963 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 964 | * |
69075817 | 965 | * @since 0.3.0 |
582c8473 | 966 | */ |
32cfb920 | 967 | SRD_API int srd_session_start(struct srd_session *sess) |
7ce7775c | 968 | { |
2072ae0c | 969 | GSList *d; |
a8b72b05 | 970 | struct srd_decoder_inst *di; |
7ce7775c BV |
971 | int ret; |
972 | ||
32cfb920 BV |
973 | if (session_is_valid(sess) != SRD_OK) { |
974 | srd_err("Invalid session pointer."); | |
975 | return SRD_ERR; | |
976 | } | |
32cfb920 | 977 | |
ed416497 | 978 | srd_dbg("Calling start() on all instances in session %d.", sess->session_id); |
7ce7775c BV |
979 | |
980 | /* Run the start() method on all decoders receiving frontend data. */ | |
ed416497 | 981 | ret = SRD_OK; |
32cfb920 | 982 | for (d = sess->di_list; d; d = d->next) { |
7ce7775c | 983 | di = d->data; |
ed416497 | 984 | if ((ret = srd_inst_start(di)) != SRD_OK) |
2072ae0c | 985 | break; |
7ce7775c BV |
986 | } |
987 | ||
2072ae0c | 988 | return ret; |
7ce7775c BV |
989 | } |
990 | ||
ed416497 BV |
991 | SRD_PRIV int srd_inst_send_meta(struct srd_decoder_inst *di, int key, |
992 | GVariant *data) | |
993 | { | |
994 | PyObject *py_ret; | |
995 | ||
996 | if (key != SRD_CONF_SAMPLERATE) | |
997 | /* This is the only key we pass on to the decoder for now. */ | |
998 | return SRD_OK; | |
999 | ||
1000 | if (!PyObject_HasAttrString(di->py_inst, "metadata")) | |
1001 | /* This decoder doesn't want metadata, that's fine. */ | |
1002 | return SRD_OK; | |
1003 | ||
1004 | py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK", | |
1005 | (long)SRD_CONF_SAMPLERATE, | |
1006 | (unsigned long long)g_variant_get_uint64(data)); | |
1007 | Py_XDECREF(py_ret); | |
1008 | ||
1009 | return SRD_OK; | |
1010 | } | |
1011 | ||
32cfb920 | 1012 | /** |
ed416497 | 1013 | * Set a metadata configuration key in a session. |
32cfb920 BV |
1014 | * |
1015 | * @param sess The session to configure. | |
1016 | * @param key The configuration key (SRD_CONF_*). | |
1017 | * @param data The new value for the key, as a GVariant with GVariantType | |
1018 | * appropriate to that key. A floating reference can be passed | |
1019 | * in; its refcount will be sunk and unreferenced after use. | |
1020 | * | |
1021 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
1022 | * | |
1023 | * @since 0.3.0 | |
1024 | */ | |
ed416497 | 1025 | SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, |
32cfb920 BV |
1026 | GVariant *data) |
1027 | { | |
ed416497 BV |
1028 | GSList *l; |
1029 | int ret; | |
32cfb920 BV |
1030 | |
1031 | if (session_is_valid(sess) != SRD_OK) { | |
1032 | srd_err("Invalid session."); | |
1033 | return SRD_ERR_ARG; | |
1034 | } | |
1035 | ||
ed416497 BV |
1036 | if (key != SRD_CONF_SAMPLERATE) { |
1037 | srd_err("Unknown config key %d.", key); | |
74bb0af5 UH |
1038 | return SRD_ERR_ARG; |
1039 | } | |
1040 | ||
ed416497 BV |
1041 | srd_dbg("Setting session %d samplerate to %"PRIu64".", |
1042 | sess->session_id, g_variant_get_uint64(data)); | |
32cfb920 | 1043 | |
ed416497 BV |
1044 | ret = SRD_OK; |
1045 | for (l = sess->di_list; l; l = l->next) { | |
1046 | if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK) | |
1047 | break; | |
32cfb920 BV |
1048 | } |
1049 | ||
1050 | g_variant_unref(data); | |
1051 | ||
ed416497 | 1052 | return ret; |
32cfb920 BV |
1053 | } |
1054 | ||
582c8473 | 1055 | /** |
29dad0ac | 1056 | * Send a chunk of logic sample data to a running decoder session. |
582c8473 | 1057 | * |
ed416497 BV |
1058 | * The logic samples must be arranged in probe order, in the least |
1059 | * amount of space possible. If no probes were configured, the default | |
1060 | * probe set consists of all required probes + all optional probes. | |
1061 | * | |
1062 | * The size of a sample in inbuf is the minimum number of bytes needed | |
1063 | * to store the configured (or default) probes. | |
1064 | * | |
32cfb920 | 1065 | * @param sess The session to use. |
582c8473 | 1066 | * @param start_samplenum The sample number of the first sample in this chunk. |
ed416497 | 1067 | * @param end_samplenum The sample number of the last sample in this chunk. |
582c8473 | 1068 | * @param inbuf Pointer to sample data. |
38ff5046 | 1069 | * @param inbuflen Length in bytes of the buffer. |
582c8473 BV |
1070 | * |
1071 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 1072 | * |
69075817 | 1073 | * @since 0.3.0 |
582c8473 | 1074 | */ |
ed416497 BV |
1075 | SRD_API int srd_session_send(struct srd_session *sess, |
1076 | uint64_t start_samplenum, uint64_t end_samplenum, | |
32cfb920 | 1077 | const uint8_t *inbuf, uint64_t inbuflen) |
b2c19614 BV |
1078 | { |
1079 | GSList *d; | |
1080 | int ret; | |
1081 | ||
32cfb920 BV |
1082 | if (session_is_valid(sess) != SRD_OK) { |
1083 | srd_err("Invalid session."); | |
1084 | return SRD_ERR_ARG; | |
1085 | } | |
1086 | ||
7a1712c4 | 1087 | srd_dbg("Calling decode() on all instances with starting sample " |
69075817 BV |
1088 | "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", |
1089 | start_samplenum, inbuflen, inbuf); | |
d906d3f9 | 1090 | |
32cfb920 | 1091 | for (d = sess->di_list; d; d = d->next) { |
ed416497 BV |
1092 | if ((ret = srd_inst_decode(d->data, start_samplenum, |
1093 | end_samplenum, inbuf, inbuflen)) != SRD_OK) | |
b2c19614 BV |
1094 | return ret; |
1095 | } | |
1096 | ||
1097 | return SRD_OK; | |
1098 | } | |
1099 | ||
32cfb920 BV |
1100 | /** |
1101 | * Destroy a decoding session. | |
1102 | * | |
1103 | * All decoder instances and output callbacks are properly released. | |
1104 | * | |
94bc9a83 | 1105 | * @param sess The session to be destroyed. |
32cfb920 BV |
1106 | * |
1107 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
1108 | * | |
94bc9a83 | 1109 | * @since 0.3.0 |
32cfb920 BV |
1110 | */ |
1111 | SRD_API int srd_session_destroy(struct srd_session *sess) | |
1112 | { | |
1113 | int session_id; | |
1114 | ||
74bb0af5 UH |
1115 | if (!sess) { |
1116 | srd_err("Invalid session."); | |
1117 | return SRD_ERR_ARG; | |
1118 | } | |
1119 | ||
32cfb920 BV |
1120 | session_id = sess->session_id; |
1121 | if (sess->di_list) | |
1122 | srd_inst_free_all(sess, NULL); | |
1123 | if (sess->callbacks) | |
1124 | g_slist_free_full(sess->callbacks, g_free); | |
1125 | sessions = g_slist_remove(sessions, sess); | |
1126 | g_free(sess); | |
1127 | ||
1128 | srd_dbg("Destroyed session %d.", session_id); | |
1129 | ||
1130 | return SRD_OK; | |
1131 | } | |
1132 | ||
582c8473 | 1133 | /** |
b33b8aa5 | 1134 | * Register/add a decoder output callback function. |
582c8473 BV |
1135 | * |
1136 | * The function will be called when a protocol decoder sends output back | |
1137 | * to the PD controller (except for Python objects, which only go up the | |
1138 | * stack). | |
1139 | * | |
32cfb920 | 1140 | * @param sess The output session in which to register the callback. |
582c8473 | 1141 | * @param output_type The output type this callback will receive. Only one |
4c1d0670 | 1142 | * callback per output type can be registered. |
361fdcaa UH |
1143 | * @param cb The function to call. Must not be NULL. |
1144 | * @param cb_data Private data for the callback function. Can be NULL. | |
8c664ca2 | 1145 | * |
69075817 | 1146 | * @since 0.3.0 |
582c8473 | 1147 | */ |
32cfb920 BV |
1148 | SRD_API int srd_pd_output_callback_add(struct srd_session *sess, |
1149 | int output_type, srd_pd_output_callback_t cb, void *cb_data) | |
4fadb128 BV |
1150 | { |
1151 | struct srd_pd_callback *pd_cb; | |
1152 | ||
32cfb920 BV |
1153 | if (session_is_valid(sess) != SRD_OK) { |
1154 | srd_err("Invalid session."); | |
1155 | return SRD_ERR_ARG; | |
1156 | } | |
1157 | ||
7a1712c4 | 1158 | srd_dbg("Registering new callback for output type %d.", output_type); |
4fadb128 | 1159 | |
a61ece20 UH |
1160 | if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { |
1161 | srd_err("Failed to g_malloc() struct srd_pd_callback."); | |
4fadb128 | 1162 | return SRD_ERR_MALLOC; |
a61ece20 | 1163 | } |
4fadb128 BV |
1164 | |
1165 | pd_cb->output_type = output_type; | |
4c1d0670 | 1166 | pd_cb->cb = cb; |
41a5d962 | 1167 | pd_cb->cb_data = cb_data; |
32cfb920 | 1168 | sess->callbacks = g_slist_append(sess->callbacks, pd_cb); |
4fadb128 BV |
1169 | |
1170 | return SRD_OK; | |
1171 | } | |
1172 | ||
57790bc8 | 1173 | /** @private */ |
32cfb920 BV |
1174 | SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find( |
1175 | struct srd_session *sess, int output_type) | |
4fadb128 BV |
1176 | { |
1177 | GSList *l; | |
2994587f | 1178 | struct srd_pd_callback *tmp, *pd_cb; |
4fadb128 | 1179 | |
32cfb920 BV |
1180 | if (session_is_valid(sess) != SRD_OK) { |
1181 | srd_err("Invalid session."); | |
1182 | return NULL; | |
1183 | } | |
1184 | ||
2994587f | 1185 | pd_cb = NULL; |
32cfb920 | 1186 | for (l = sess->callbacks; l; l = l->next) { |
2994587f BV |
1187 | tmp = l->data; |
1188 | if (tmp->output_type == output_type) { | |
1189 | pd_cb = tmp; | |
4fadb128 BV |
1190 | break; |
1191 | } | |
1192 | } | |
1193 | ||
2994587f | 1194 | return pd_cb; |
4fadb128 BV |
1195 | } |
1196 | ||
511e2123 | 1197 | /* This is the backend function to Python sigrokdecode.add() call. */ |
57790bc8 | 1198 | /** @private */ |
aafeeaea UH |
1199 | SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, |
1200 | int output_type, const char *proto_id) | |
e5080882 | 1201 | { |
e5080882 | 1202 | struct srd_pd_output *pdo; |
e5080882 | 1203 | |
7a1712c4 | 1204 | srd_dbg("Instance %s creating new output type %d for %s.", |
a8b72b05 | 1205 | di->inst_id, output_type, proto_id); |
d906d3f9 | 1206 | |
a61ece20 UH |
1207 | if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { |
1208 | srd_err("Failed to g_malloc() struct srd_pd_output."); | |
e5080882 | 1209 | return -1; |
a61ece20 | 1210 | } |
e5080882 | 1211 | |
b231546d | 1212 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ |
15969949 | 1213 | pdo->pdo_id = g_slist_length(di->pd_output); |
e5080882 | 1214 | pdo->output_type = output_type; |
b3b2cae8 | 1215 | pdo->di = di; |
94d43b37 | 1216 | pdo->proto_id = g_strdup(proto_id); |
e5080882 BV |
1217 | di->pd_output = g_slist_append(di->pd_output, pdo); |
1218 | ||
15969949 | 1219 | return pdo->pdo_id; |
e5080882 | 1220 | } |
d7dae84b UH |
1221 | |
1222 | /** @} */ |