2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "sigrokdecode-internal.h"
26 /* The list of protocol decoders. */
27 SRD_PRIV GSList *pd_list = NULL;
29 /* module_sigrokdecode.c */
30 extern SRD_PRIV PyObject *mod_sigrokdecode;
33 * Returns the list of supported/loaded protocol decoders.
35 * This is a GSList containing the names of the decoders as strings.
37 * @return List of decoders, NULL if none are supported or loaded.
39 SRD_API GSList *srd_decoder_list(void)
45 * Get the decoder with the specified ID.
47 * @param id The ID string of the decoder to return.
49 * @return The decoder with the specified ID, or NULL if not found.
51 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
54 struct srd_decoder *dec;
56 for (l = srd_decoder_list(); l; l = l->next) {
58 if (!strcmp(dec->id, id))
65 static int get_probes(const struct srd_decoder *d, const char *attr,
68 PyObject *py_probelist, *py_entry;
70 int ret, num_probes, i;
72 if (!PyObject_HasAttrString(d->py_dec, attr))
73 /* No probes of this type specified. */
77 py_probelist = py_entry = NULL;
79 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
80 if (!PyList_Check(py_probelist)) {
81 srd_err("Protocol decoder %s %s attribute is not "
82 "a list.", d->name, attr);
86 num_probes = PyList_Size(py_probelist);
88 /* Empty probelist. */
91 for (i = 0; i < num_probes; i++) {
92 py_entry = PyList_GetItem(py_probelist, i);
93 if (!PyDict_Check(py_entry)) {
94 srd_err("Protocol decoder %s %s attribute is not "
95 "a list with dict elements.", d->name, attr);
99 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
100 srd_err("Failed to g_malloc() struct srd_probe.");
101 ret = SRD_ERR_MALLOC;
105 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
107 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
109 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
113 *pl = g_slist_append(*pl, p);
119 Py_DecRef(py_probelist);
125 * Load a protocol decoder module into the embedded Python interpreter.
127 * @param module_name The module name to be loaded.
129 * @return SRD_OK upon success, a (negative) error code otherwise.
131 SRD_API int srd_decoder_load(const char *module_name)
133 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
134 struct srd_decoder *d;
140 srd_dbg("Loading protocol decoder '%s'.", module_name);
142 py_basedec = py_method = py_attr = NULL;
144 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
145 srd_dbg("Failed to g_malloc() struct srd_decoder.");
146 ret = SRD_ERR_MALLOC;
150 ret = SRD_ERR_PYTHON;
152 /* Import the Python module. */
153 if (!(d->py_mod = PyImport_ImportModule(module_name))) {
154 srd_exception_catch("Import of '%s' failed.", module_name);
158 /* Get the 'Decoder' class as Python object. */
159 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
160 /* This generated an AttributeError exception. */
162 srd_err("Decoder class not found in protocol decoder %s.",
167 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
168 srd_dbg("sigrokdecode module not loaded.");
172 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
173 srd_err("Decoder class in protocol decoder module %s is not "
174 "a subclass of sigrokdecode.Decoder.", module_name);
177 Py_CLEAR(py_basedec);
179 /* Check for a proper start() method. */
180 if (!PyObject_HasAttrString(d->py_dec, "start")) {
181 srd_err("Protocol decoder %s has no start() method Decoder "
182 "class.", module_name);
185 py_method = PyObject_GetAttrString(d->py_dec, "start");
186 if (!PyFunction_Check(py_method)) {
187 srd_err("Protocol decoder %s Decoder class attribute 'start' "
188 "is not a method.", module_name);
193 /* Check for a proper decode() method. */
194 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
195 srd_err("Protocol decoder %s has no decode() method Decoder "
196 "class.", module_name);
199 py_method = PyObject_GetAttrString(d->py_dec, "decode");
200 if (!PyFunction_Check(py_method)) {
201 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
202 "is not a method.", module_name);
207 /* If present, options must be a dictionary. */
208 if (PyObject_HasAttrString(d->py_dec, "options")) {
209 py_attr = PyObject_GetAttrString(d->py_dec, "options");
210 if (!PyDict_Check(py_attr)) {
211 srd_err("Protocol decoder %s options attribute is not "
212 "a dictionary.", d->name);
219 /* Check and import required probes. */
220 if (get_probes(d, "probes", &d->probes) != SRD_OK)
223 /* Check and import optional probes. */
224 if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
228 * Fix order numbers for the optional probes.
231 * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
232 * 'order' fields in the d->probes list = 0, 1, 2.
233 * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
235 for (l = d->opt_probes; l; l = l->next) {
237 p->order += g_slist_length(d->probes);
240 /* Store required fields in newly allocated strings. */
241 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
244 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
247 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
250 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
253 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
256 /* Convert class annotation attribute to GSList of **char. */
257 d->annotations = NULL;
258 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
259 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
260 if (!PyList_Check(py_annlist)) {
261 srd_err("Protocol decoder module %s annotations "
262 "should be a list.", module_name);
265 alen = PyList_Size(py_annlist);
266 for (i = 0; i < alen; i++) {
267 py_ann = PyList_GetItem(py_annlist, i);
268 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
269 srd_err("Protocol decoder module %s "
270 "annotation %d should be a list with "
271 "two elements.", module_name, i + 1);
275 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
278 d->annotations = g_slist_append(d->annotations, ann);
282 /* Append it to the list of supported/loaded decoders. */
283 pd_list = g_slist_append(pd_list, d);
289 Py_XDECREF(py_method);
290 Py_XDECREF(py_basedec);
291 Py_XDECREF(d->py_dec);
292 Py_XDECREF(d->py_mod);
300 * Return a protocol decoder's docstring.
302 * @param dec The loaded protocol decoder.
304 * @return A newly allocated buffer containing the protocol decoder's
305 * documentation. The caller is responsible for free'ing the buffer.
307 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
312 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
315 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
316 srd_exception_catch("");
321 if (py_str != Py_None)
322 py_str_as_str(py_str, &doc);
328 static void free_probes(GSList *probelist)
333 if (probelist == NULL)
336 for (l = probelist; l; l = l->next) {
343 g_slist_free(probelist);
347 * Unload decoder module.
349 * @param dec The struct srd_decoder to be unloaded.
351 * @return SRD_OK upon success, a (negative) error code otherwise.
353 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
355 srd_dbg("Unloading protocol decoder '%s'.", dec->name);
358 * Since any instances of this decoder need to be released as well,
359 * but they could be anywhere in the stack, just free the entire
360 * stack. A frontend reloading a decoder thus has to restart all
361 * instances, and rebuild the stack.
363 srd_inst_free_all(NULL);
365 free_probes(dec->probes);
366 free_probes(dec->opt_probes);
369 g_free(dec->longname);
371 g_free(dec->license);
373 /* The module's Decoder class. */
374 Py_XDECREF(dec->py_dec);
375 /* The module itself. */
376 Py_XDECREF(dec->py_mod);
378 /* TODO: (g_)free dec itself? */
384 * Load all installed protocol decoders.
386 * @return SRD_OK upon success, a (negative) error code otherwise.
388 SRD_API int srd_decoder_load_all(void)
392 const gchar *direntry;
394 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
395 srd_err("Unable to open %s for reading.", DECODERS_DIR);
396 return SRD_ERR_DECODERS_DIR;
399 while ((direntry = g_dir_read_name(dir)) != NULL) {
400 /* The directory name is the module name (e.g. "i2c"). */
401 srd_decoder_load(direntry);
409 * Unload all loaded protocol decoders.
411 * @return SRD_OK upon success, a (negative) error code otherwise.
413 SRD_API int srd_decoder_unload_all(void)
416 struct srd_decoder *dec;
418 for (l = srd_decoder_list(); l; l = l->next) {
420 srd_decoder_unload(dec);