]>
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 | ||
f6c7eade MC |
21 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
22 | #include "libsigrokdecode.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 | |
32cfb920 | 29 | /** @cond PRIVATE */ |
d906d3f9 | 30 | |
23a29d24 | 31 | extern SRD_PRIV GSList *sessions; |
b2c19614 | 32 | |
c9bfccc6 | 33 | /* type_logic.c */ |
55c3c5f4 | 34 | extern SRD_PRIV PyTypeObject srd_logic_type; |
b2c19614 | 35 | |
57790bc8 UH |
36 | /** @endcond */ |
37 | ||
b2c19614 | 38 | /** |
190b71cf | 39 | * @file |
8c664ca2 | 40 | * |
190b71cf | 41 | * Decoder instance handling. |
b2c19614 | 42 | */ |
4895418c UH |
43 | |
44 | /** | |
45 | * @defgroup grp_instances Decoder instances | |
46 | * | |
47 | * Decoder instance handling. | |
48 | * | |
49 | * @{ | |
50 | */ | |
51 | ||
7ce7775c | 52 | /** |
b33b8aa5 | 53 | * Set one or more options in a decoder instance. |
0bdadba2 | 54 | * |
361fdcaa UH |
55 | * Handled options are removed from the hash. |
56 | * | |
0bdadba2 BV |
57 | * @param di Decoder instance. |
58 | * @param options A GHashTable of options to set. | |
7ce7775c | 59 | * |
0bdadba2 | 60 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
61 | * |
62 | * @since 0.1.0 | |
0bdadba2 | 63 | */ |
b33b8aa5 | 64 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 65 | GHashTable *options) |
0bdadba2 | 66 | { |
84c1c0b5 BV |
67 | struct srd_decoder_option *sdo; |
68 | PyObject *py_di_options, *py_optval; | |
2f395bff | 69 | GVariant *value; |
84c1c0b5 BV |
70 | GSList *l; |
71 | double val_double; | |
2f395bff | 72 | gint64 val_int; |
84c1c0b5 | 73 | int ret; |
2f395bff | 74 | const char *val_str; |
0bdadba2 | 75 | |
3af0e345 UH |
76 | if (!di) { |
77 | srd_err("Invalid decoder instance."); | |
78 | return SRD_ERR_ARG; | |
79 | } | |
80 | ||
81 | if (!options) { | |
82 | srd_err("Invalid options GHashTable."); | |
83 | return SRD_ERR_ARG; | |
84 | } | |
85 | ||
c9bfccc6 | 86 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 87 | /* Decoder has no options. */ |
e431d9cc BV |
88 | if (g_hash_table_size(options) == 0) { |
89 | /* No options provided. */ | |
90 | return SRD_OK; | |
91 | } else { | |
92 | srd_err("Protocol decoder has no options."); | |
93 | return SRD_ERR_ARG; | |
94 | } | |
0bdadba2 | 95 | return SRD_OK; |
e431d9cc | 96 | } |
0bdadba2 BV |
97 | |
98 | ret = SRD_ERR_PYTHON; | |
84c1c0b5 | 99 | py_optval = NULL; |
119d6258 BV |
100 | |
101 | /* | |
84c1c0b5 | 102 | * The 'options' tuple is a class variable, but we need to |
119d6258 BV |
103 | * change it. Changing it directly will affect the entire class, |
104 | * so we need to create a new object for it, and populate that | |
105 | * instead. | |
106 | */ | |
a8b72b05 | 107 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 | 108 | goto err_out; |
119d6258 BV |
109 | Py_DECREF(py_di_options); |
110 | py_di_options = PyDict_New(); | |
111 | PyObject_SetAttrString(di->py_inst, "options", py_di_options); | |
0bdadba2 | 112 | |
84c1c0b5 BV |
113 | for (l = di->decoder->options; l; l = l->next) { |
114 | sdo = l->data; | |
115 | if ((value = g_hash_table_lookup(options, sdo->id))) { | |
116 | /* A value was supplied for this option. */ | |
117 | if (!g_variant_type_equal(g_variant_get_type(value), | |
118 | g_variant_get_type(sdo->def))) { | |
119 | srd_err("Option '%s' should have the same type " | |
120 | "as the default value.", sdo->id); | |
121 | goto err_out; | |
122 | } | |
123 | } else { | |
124 | /* Use default for this option. */ | |
125 | value = sdo->def; | |
126 | } | |
127 | if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { | |
128 | val_str = g_variant_get_string(value, NULL); | |
129 | if (!(py_optval = PyUnicode_FromString(val_str))) { | |
130 | /* Some UTF-8 encoding error. */ | |
131 | PyErr_Clear(); | |
132 | srd_err("Option '%s' requires a UTF-8 string value.", sdo->id); | |
133 | goto err_out; | |
134 | } | |
135 | } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { | |
136 | val_int = g_variant_get_int64(value); | |
137 | if (!(py_optval = PyLong_FromLong(val_int))) { | |
138 | /* ValueError Exception */ | |
139 | PyErr_Clear(); | |
140 | srd_err("Option '%s' has invalid integer value.", sdo->id); | |
141 | goto err_out; | |
142 | } | |
143 | } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) { | |
24a3d8d0 | 144 | val_double = g_variant_get_double(value); |
84c1c0b5 BV |
145 | if (!(py_optval = PyFloat_FromDouble(val_double))) { |
146 | /* ValueError Exception */ | |
147 | PyErr_Clear(); | |
148 | srd_err("Option '%s' has invalid float value.", sdo->id); | |
149 | goto err_out; | |
150 | } | |
151 | } | |
152 | if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) | |
0bdadba2 | 153 | goto err_out; |
84c1c0b5 BV |
154 | /* Not harmful even if we used the default. */ |
155 | g_hash_table_remove(options, sdo->id); | |
156 | } | |
157 | if (g_hash_table_size(options) != 0) | |
158 | srd_warn("Unknown options specified for '%s'", di->inst_id); | |
0bdadba2 BV |
159 | |
160 | ret = SRD_OK; | |
161 | ||
162 | err_out: | |
84c1c0b5 | 163 | Py_XDECREF(py_optval); |
7fc7bde6 | 164 | if (PyErr_Occurred()) { |
aafeeaea | 165 | srd_exception_catch("Stray exception in srd_inst_option_set()."); |
7fc7bde6 BV |
166 | ret = SRD_ERR_PYTHON; |
167 | } | |
0bdadba2 BV |
168 | |
169 | return ret; | |
170 | } | |
171 | ||
6a15597a UH |
172 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */ |
173 | static gint compare_channel_id(const struct srd_channel *pdch, | |
174 | const char *channel_id) | |
f38ec285 | 175 | { |
6a15597a | 176 | return strcmp(pdch->id, channel_id); |
f38ec285 BV |
177 | } |
178 | ||
0bdadba2 | 179 | /** |
6a15597a | 180 | * Set all channels in a decoder instance. |
b33b8aa5 | 181 | * |
6a15597a UH |
182 | * This function sets _all_ channels for the specified decoder instance, i.e., |
183 | * it overwrites any channels that were already defined (if any). | |
0bdadba2 BV |
184 | * |
185 | * @param di Decoder instance. | |
6a15597a UH |
186 | * @param new_channels A GHashTable of channels to set. Key is channel name, |
187 | * value is the channel number. Samples passed to this | |
188 | * instance will be arranged in this order. | |
9eec72cb | 189 | * @param unit_size Number of bytes per sample in the data stream to be passed |
6a15597a UH |
190 | * to the decoder. The highest channel index specified in the |
191 | * channel map must lie within a sample unit. | |
12243c22 | 192 | * |
0bdadba2 | 193 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 | 194 | * |
c57d1013 | 195 | * @since 0.3.0 |
0bdadba2 | 196 | */ |
6a15597a UH |
197 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
198 | GHashTable *new_channels, int unit_size) | |
0bdadba2 | 199 | { |
6a15597a | 200 | GVariant *channel_val; |
f38ec285 BV |
201 | GList *l; |
202 | GSList *sl; | |
6a15597a UH |
203 | struct srd_channel *pdch; |
204 | int *new_channelmap, new_channelnum, num_required_channels, i; | |
205 | char *channel_id; | |
0bdadba2 | 206 | |
f714f8f8 UH |
207 | srd_dbg("Setting channels for instance %s with list of %d channels, " |
208 | "unitsize %d.", di->inst_id, g_hash_table_size(new_channels), unit_size); | |
ce46beed | 209 | |
6a15597a UH |
210 | if (g_hash_table_size(new_channels) == 0) |
211 | /* No channels provided. */ | |
0bdadba2 BV |
212 | return SRD_OK; |
213 | ||
6a15597a UH |
214 | if (di->dec_num_channels == 0) { |
215 | /* Decoder has no channels. */ | |
216 | srd_err("Protocol decoder %s has no channels to define.", | |
c9bfccc6 | 217 | di->decoder->name); |
f38ec285 BV |
218 | return SRD_ERR_ARG; |
219 | } | |
0bdadba2 | 220 | |
6a15597a | 221 | new_channelmap = NULL; |
0bdadba2 | 222 | |
6a15597a UH |
223 | if (!(new_channelmap = g_try_malloc(sizeof(int) * di->dec_num_channels))) { |
224 | srd_err("Failed to g_malloc() new channel map."); | |
f38ec285 | 225 | return SRD_ERR_MALLOC; |
0bdadba2 BV |
226 | } |
227 | ||
38ff5046 | 228 | /* |
6a15597a UH |
229 | * For now, map all indexes to channel -1 (can be overridden later). |
230 | * This -1 is interpreted as an unspecified channel later. | |
38ff5046 | 231 | */ |
6a15597a UH |
232 | for (i = 0; i < di->dec_num_channels; i++) |
233 | new_channelmap[i] = -1; | |
234 | ||
235 | for (l = g_hash_table_get_keys(new_channels); l; l = l->next) { | |
236 | channel_id = l->data; | |
237 | channel_val = g_hash_table_lookup(new_channels, channel_id); | |
238 | if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) { | |
239 | /* Channel name was specified without a value. */ | |
240 | srd_err("No channel number was specified for %s.", | |
241 | channel_id); | |
242 | g_free(new_channelmap); | |
be873260 BV |
243 | return SRD_ERR_ARG; |
244 | } | |
6a15597a UH |
245 | new_channelnum = g_variant_get_int32(channel_val); |
246 | if (new_channelnum >= 8 * unit_size) { | |
247 | srd_err("Channel index %d not within data unit (%d bit).", | |
248 | new_channelnum, 8 * unit_size); | |
249 | g_free(new_channelmap); | |
9eec72cb DE |
250 | return SRD_ERR_ARG; |
251 | } | |
6a15597a UH |
252 | if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id, |
253 | (GCompareFunc)compare_channel_id))) { | |
254 | /* Fall back on optional channels. */ | |
255 | if (!(sl = g_slist_find_custom(di->decoder->opt_channels, | |
256 | channel_id, (GCompareFunc) compare_channel_id))) { | |
257 | srd_err("Protocol decoder %s has no channel " | |
258 | "'%s'.", di->decoder->name, channel_id); | |
259 | g_free(new_channelmap); | |
f38ec285 BV |
260 | return SRD_ERR_ARG; |
261 | } | |
262 | } | |
6a15597a UH |
263 | pdch = sl->data; |
264 | new_channelmap[pdch->order] = new_channelnum; | |
265 | srd_dbg("Setting channel mapping: %s (index %d) = channel %d.", | |
266 | pdch->id, pdch->order, new_channelnum); | |
38ff5046 | 267 | } |
9eec72cb | 268 | di->data_unitsize = unit_size; |
38ff5046 | 269 | |
6a15597a UH |
270 | srd_dbg("Final channel map:"); |
271 | num_required_channels = g_slist_length(di->decoder->channels); | |
272 | for (i = 0; i < di->dec_num_channels; i++) { | |
273 | srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i], | |
274 | (i < num_required_channels) ? "required" : "optional"); | |
f38ec285 | 275 | } |
38ff5046 | 276 | |
6a15597a UH |
277 | /* Report an error if not all required channels were specified. */ |
278 | for (i = 0; i < num_required_channels; i++) { | |
279 | if (new_channelmap[i] != -1) | |
9bf7f71c | 280 | continue; |
6a15597a UH |
281 | pdch = g_slist_nth(di->decoder->channels, i)->data; |
282 | srd_err("Required channel '%s' (index %d) was not specified.", | |
283 | pdch->id, i); | |
9bf7f71c UH |
284 | return SRD_ERR; |
285 | } | |
286 | ||
6a15597a UH |
287 | g_free(di->dec_channelmap); |
288 | di->dec_channelmap = new_channelmap; | |
0bdadba2 | 289 | |
f38ec285 | 290 | return SRD_OK; |
0bdadba2 BV |
291 | } |
292 | ||
293 | /** | |
294 | * Create a new protocol decoder instance. | |
7ce7775c | 295 | * |
32cfb920 | 296 | * @param sess The session holding the protocol decoder instance. |
38ff5046 | 297 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 298 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 299 | * the decoder class. May be NULL. |
12243c22 | 300 | * |
a8b72b05 | 301 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 302 | * NULL in case of failure. |
8c664ca2 | 303 | * |
69075817 | 304 | * @since 0.3.0 |
7ce7775c | 305 | */ |
32cfb920 BV |
306 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
307 | const char *decoder_id, GHashTable *options) | |
b2c19614 | 308 | { |
c9bfccc6 | 309 | int i; |
b2c19614 | 310 | struct srd_decoder *dec; |
a8b72b05 BV |
311 | struct srd_decoder_inst *di; |
312 | char *inst_id; | |
b2c19614 | 313 | |
7a1712c4 | 314 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 315 | |
32cfb920 BV |
316 | if (session_is_valid(sess) != SRD_OK) { |
317 | srd_err("Invalid session."); | |
318 | return NULL; | |
319 | } | |
320 | ||
9d122fd5 | 321 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 322 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 323 | return NULL; |
0bdadba2 | 324 | } |
b2c19614 | 325 | |
a8b72b05 | 326 | if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { |
a61ece20 | 327 | srd_err("Failed to g_malloc() instance."); |
7ce7775c BV |
328 | return NULL; |
329 | } | |
0bdadba2 | 330 | |
b2c19614 | 331 | di->decoder = dec; |
32cfb920 | 332 | di->sess = sess; |
38ff5046 UH |
333 | if (options) { |
334 | inst_id = g_hash_table_lookup(options, "id"); | |
335 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
336 | g_hash_table_remove(options, "id"); | |
337 | } else | |
338 | di->inst_id = g_strdup(decoder_id); | |
b2c19614 | 339 | |
361fdcaa | 340 | /* |
6a15597a | 341 | * Prepare a default channel map, where samples come in the |
f38ec285 BV |
342 | * order in which the decoder class defined them. |
343 | */ | |
6a15597a UH |
344 | di->dec_num_channels = g_slist_length(di->decoder->channels) + |
345 | g_slist_length(di->decoder->opt_channels); | |
346 | if (di->dec_num_channels) { | |
347 | if (!(di->dec_channelmap = | |
348 | g_try_malloc(sizeof(int) * di->dec_num_channels))) { | |
349 | srd_err("Failed to g_malloc() channel map."); | |
19a90bab BV |
350 | g_free(di); |
351 | return NULL; | |
352 | } | |
6a15597a UH |
353 | for (i = 0; i < di->dec_num_channels; i++) |
354 | di->dec_channelmap[i] = i; | |
355 | di->data_unitsize = (di->dec_num_channels + 7) / 8; | |
37b94c20 BV |
356 | /* |
357 | * Will be used to prepare a sample at every iteration | |
358 | * of the instance's decode() method. | |
359 | */ | |
6a15597a | 360 | if (!(di->channel_samples = g_try_malloc(di->dec_num_channels))) { |
37b94c20 | 361 | srd_err("Failed to g_malloc() sample buffer."); |
6a15597a | 362 | g_free(di->dec_channelmap); |
37b94c20 BV |
363 | g_free(di); |
364 | return NULL; | |
365 | } | |
f38ec285 | 366 | } |
f38ec285 | 367 | |
0bdadba2 | 368 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 369 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 370 | if (PyErr_Occurred()) |
aafeeaea | 371 | srd_exception_catch("failed to create %s instance: ", |
69075817 | 372 | decoder_id); |
6a15597a | 373 | g_free(di->dec_channelmap); |
0bdadba2 | 374 | g_free(di); |
7ce7775c | 375 | return NULL; |
b2c19614 | 376 | } |
7ce7775c | 377 | |
38ff5046 | 378 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
6a15597a | 379 | g_free(di->dec_channelmap); |
0bdadba2 BV |
380 | g_free(di); |
381 | return NULL; | |
382 | } | |
b2c19614 | 383 | |
f38ec285 | 384 | /* Instance takes input from a frontend by default. */ |
32cfb920 | 385 | sess->di_list = g_slist_append(sess->di_list, di); |
f38ec285 | 386 | |
b2c19614 BV |
387 | return di; |
388 | } | |
389 | ||
582c8473 BV |
390 | /** |
391 | * Stack a decoder instance on top of another. | |
392 | * | |
32cfb920 | 393 | * @param sess The session holding the protocol decoder instances. |
4d2c7619 BV |
394 | * @param di_bottom The instance on top of which di_top will be stacked. |
395 | * @param di_top The instance to go on top. | |
582c8473 BV |
396 | * |
397 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 398 | * |
69075817 | 399 | * @since 0.3.0 |
582c8473 | 400 | */ |
32cfb920 | 401 | SRD_API int srd_inst_stack(struct srd_session *sess, |
4d2c7619 BV |
402 | struct srd_decoder_inst *di_bottom, |
403 | struct srd_decoder_inst *di_top) | |
7ce7775c | 404 | { |
32cfb920 BV |
405 | |
406 | if (session_is_valid(sess) != SRD_OK) { | |
407 | srd_err("Invalid session."); | |
408 | return SRD_ERR_ARG; | |
409 | } | |
410 | ||
4d2c7619 | 411 | if (!di_bottom || !di_top) { |
d906d3f9 | 412 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
413 | return SRD_ERR_ARG; |
414 | } | |
415 | ||
4d2c7619 | 416 | if (g_slist_find(sess->di_list, di_top)) { |
2072ae0c | 417 | /* Remove from the unstacked list. */ |
4d2c7619 | 418 | sess->di_list = g_slist_remove(sess->di_list, di_top); |
7ce7775c BV |
419 | } |
420 | ||
7ce7775c | 421 | /* Stack on top of source di. */ |
4d2c7619 BV |
422 | di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top); |
423 | ||
424 | srd_dbg("Stacked %s on top of %s.", di_top->inst_id, di_bottom->inst_id); | |
7ce7775c BV |
425 | |
426 | return SRD_OK; | |
427 | } | |
428 | ||
2072ae0c | 429 | /** |
361fdcaa UH |
430 | * Find a decoder instance by its instance ID. |
431 | * | |
432 | * Only the bottom level of instances are searched -- instances already stacked | |
433 | * on top of another one will not be found. | |
2072ae0c | 434 | * |
32cfb920 | 435 | * @param sess The session holding the protocol decoder instance. |
ed2306a6 | 436 | * @param inst_id The instance ID to be found. |
2072ae0c | 437 | * |
a8b72b05 | 438 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 | 439 | * |
69075817 | 440 | * @since 0.3.0 |
2072ae0c | 441 | */ |
32cfb920 BV |
442 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, |
443 | const char *inst_id) | |
7ce7775c BV |
444 | { |
445 | GSList *l; | |
a8b72b05 | 446 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 447 | |
32cfb920 BV |
448 | if (session_is_valid(sess) != SRD_OK) { |
449 | srd_err("Invalid session."); | |
450 | return NULL; | |
451 | } | |
452 | ||
7ce7775c | 453 | di = NULL; |
32cfb920 | 454 | for (l = sess->di_list; l; l = l->next) { |
7ce7775c | 455 | tmp = l->data; |
a8b72b05 | 456 | if (!strcmp(tmp->inst_id, inst_id)) { |
7ce7775c BV |
457 | di = tmp; |
458 | break; | |
459 | } | |
460 | } | |
461 | ||
462 | return di; | |
463 | } | |
464 | ||
32cfb920 BV |
465 | static struct srd_decoder_inst *srd_sess_inst_find_by_obj( |
466 | struct srd_session *sess, const GSList *stack, | |
467 | const PyObject *obj) | |
468 | { | |
469 | const GSList *l; | |
470 | struct srd_decoder_inst *tmp, *di; | |
471 | ||
472 | if (session_is_valid(sess) != SRD_OK) { | |
473 | srd_err("Invalid session."); | |
474 | return NULL; | |
475 | } | |
476 | ||
477 | di = NULL; | |
478 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
479 | tmp = l->data; | |
480 | if (tmp->py_inst == obj) | |
481 | di = tmp; | |
482 | else if (tmp->next_di) | |
483 | di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); | |
484 | } | |
485 | ||
486 | return di; | |
487 | } | |
488 | ||
2072ae0c | 489 | /** |
361fdcaa UH |
490 | * Find a decoder instance by its Python object. |
491 | * | |
492 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
32cfb920 BV |
493 | * This will recurse to find the instance anywhere in the stack tree of all |
494 | * sessions. | |
2072ae0c | 495 | * |
361fdcaa UH |
496 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the |
497 | * stack to search. To start searching at the bottom level of | |
498 | * decoder instances, pass NULL. | |
511e2123 | 499 | * @param obj The Python class instantiation. |
2072ae0c | 500 | * |
a8b72b05 | 501 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
57790bc8 UH |
502 | * |
503 | * @private | |
8c664ca2 UH |
504 | * |
505 | * @since 0.1.0 | |
2072ae0c | 506 | */ |
abeeed8b | 507 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
0ff2d191 | 508 | const PyObject *obj) |
2072ae0c | 509 | { |
32cfb920 BV |
510 | struct srd_decoder_inst *di; |
511 | struct srd_session *sess; | |
512 | GSList *l; | |
2072ae0c BV |
513 | |
514 | di = NULL; | |
32cfb920 BV |
515 | for (l = sessions; di == NULL && l != NULL; l = l->next) { |
516 | sess = l->data; | |
517 | di = srd_sess_inst_find_by_obj(sess, stack, obj); | |
2072ae0c BV |
518 | } |
519 | ||
520 | return di; | |
521 | } | |
522 | ||
57790bc8 | 523 | /** @private */ |
ed416497 | 524 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) |
b2c19614 | 525 | { |
ed416497 | 526 | PyObject *py_res; |
2072ae0c | 527 | GSList *l; |
a8b72b05 | 528 | struct srd_decoder_inst *next_di; |
ed416497 | 529 | int ret; |
b2c19614 | 530 | |
7a1712c4 | 531 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
ed416497 | 532 | di->inst_id); |
b2c19614 | 533 | |
ed416497 | 534 | if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { |
aafeeaea | 535 | srd_exception_catch("Protocol decoder instance %s: ", |
ed416497 | 536 | di->inst_id); |
7ce7775c BV |
537 | return SRD_ERR_PYTHON; |
538 | } | |
f38ec285 | 539 | Py_DecRef(py_res); |
7ce7775c | 540 | |
ed416497 | 541 | /* Start all the PDs stacked on top of this one. */ |
2072ae0c BV |
542 | for (l = di->next_di; l; l = l->next) { |
543 | next_di = l->data; | |
ed416497 BV |
544 | if ((ret = srd_inst_start(next_di)) != SRD_OK) |
545 | return ret; | |
2072ae0c BV |
546 | } |
547 | ||
b2c19614 BV |
548 | return SRD_OK; |
549 | } | |
550 | ||
b2c19614 BV |
551 | /** |
552 | * Run the specified decoder function. | |
553 | * | |
ed416497 | 554 | * @param di The decoder instance to call. Must not be NULL. |
d906d3f9 | 555 | * @param start_samplenum The starting sample number for the buffer's sample |
7a1712c4 | 556 | * set, relative to the start of capture. |
ed416497 BV |
557 | * @param end_samplenum The ending sample number for the buffer's sample |
558 | * set, relative to the start of capture. | |
7a1712c4 UH |
559 | * @param inbuf The buffer to decode. Must not be NULL. |
560 | * @param inbuflen Length of the buffer. Must be > 0. | |
b2c19614 BV |
561 | * |
562 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
563 | * |
564 | * @private | |
8c664ca2 UH |
565 | * |
566 | * @since 0.1.0 | |
b2c19614 | 567 | */ |
ed416497 BV |
568 | SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, |
569 | uint64_t start_samplenum, uint64_t end_samplenum, | |
570 | const uint8_t *inbuf, uint64_t inbuflen) | |
b2c19614 | 571 | { |
d906d3f9 | 572 | PyObject *py_res; |
bc5f5a43 | 573 | srd_logic *logic; |
b2c19614 | 574 | |
74bb0af5 UH |
575 | srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes " |
576 | "starting at sample %" PRIu64 ".", di->inst_id, inbuflen, | |
577 | start_samplenum); | |
b2c19614 | 578 | |
d906d3f9 | 579 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
580 | if (!di) { |
581 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
582 | return SRD_ERR_ARG; |
583 | } | |
7a1712c4 UH |
584 | if (!inbuf) { |
585 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
586 | return SRD_ERR_ARG; |
587 | } | |
588 | if (inbuflen == 0) { | |
7a1712c4 | 589 | srd_dbg("empty buffer"); |
d906d3f9 BV |
590 | return SRD_ERR_ARG; |
591 | } | |
b2c19614 | 592 | |
361fdcaa UH |
593 | /* |
594 | * Create new srd_logic object. Each iteration around the PD's loop | |
d906d3f9 BV |
595 | * will fill one sample into this object. |
596 | */ | |
bc5f5a43 BV |
597 | logic = PyObject_New(srd_logic, &srd_logic_type); |
598 | Py_INCREF(logic); | |
abeeed8b | 599 | logic->di = (struct srd_decoder_inst *)di; |
86528298 | 600 | logic->start_samplenum = start_samplenum; |
bc5f5a43 | 601 | logic->itercnt = 0; |
abeeed8b | 602 | logic->inbuf = (uint8_t *)inbuf; |
bc5f5a43 BV |
603 | logic->inbuflen = inbuflen; |
604 | logic->sample = PyList_New(2); | |
605 | Py_INCREF(logic->sample); | |
606 | ||
a8b72b05 | 607 | Py_IncRef(di->py_inst); |
a8b72b05 | 608 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", |
ed416497 BV |
609 | "KKO", start_samplenum, end_samplenum, logic))) { |
610 | srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); | |
0ff2d191 | 611 | return SRD_ERR_PYTHON; |
b2c19614 | 612 | } |
d906d3f9 | 613 | Py_DecRef(py_res); |
bc5f5a43 | 614 | |
b2c19614 BV |
615 | return SRD_OK; |
616 | } | |
617 | ||
57790bc8 | 618 | /** @private */ |
12243c22 | 619 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
620 | { |
621 | GSList *l; | |
622 | struct srd_pd_output *pdo; | |
623 | ||
a8b72b05 | 624 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 625 | |
a8b72b05 BV |
626 | Py_DecRef(di->py_inst); |
627 | g_free(di->inst_id); | |
6a15597a | 628 | g_free(di->dec_channelmap); |
fa12a21e BV |
629 | g_slist_free(di->next_di); |
630 | for (l = di->pd_output; l; l = l->next) { | |
631 | pdo = l->data; | |
632 | g_free(pdo->proto_id); | |
633 | g_free(pdo); | |
634 | } | |
635 | g_slist_free(di->pd_output); | |
e592ac89 | 636 | g_free(di); |
fa12a21e BV |
637 | } |
638 | ||
57790bc8 | 639 | /** @private */ |
32cfb920 | 640 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) |
fa12a21e BV |
641 | { |
642 | GSList *l; | |
a8b72b05 | 643 | struct srd_decoder_inst *di; |
fa12a21e | 644 | |
32cfb920 BV |
645 | if (session_is_valid(sess) != SRD_OK) { |
646 | srd_err("Invalid session."); | |
647 | return; | |
648 | } | |
649 | ||
fa12a21e | 650 | di = NULL; |
32cfb920 | 651 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { |
fa12a21e BV |
652 | di = l->data; |
653 | if (di->next_di) | |
32cfb920 | 654 | srd_inst_free_all(sess, di->next_di); |
a8b72b05 | 655 | srd_inst_free(di); |
fa12a21e BV |
656 | } |
657 | if (!stack) { | |
32cfb920 BV |
658 | g_slist_free(sess->di_list); |
659 | sess->di_list = NULL; | |
fa12a21e | 660 | } |
fa12a21e | 661 | } |
b2c19614 | 662 | |
4895418c UH |
663 | /** @} */ |
664 |