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