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. */
28 static GSList *pipelines = NULL;
35 /* lives in decoder.c */
36 extern GSList *pd_list;
37 extern GSList *di_list;
39 /* lives in module_sigrokdecode.c */
40 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
42 /* lives in type_logic.c */
43 extern PyTypeObject srd_logic_type;
47 * Initialize libsigrokdecode.
49 * This initializes the Python interpreter, and creates and initializes
50 * a "sigrok" Python module with a single put() method.
52 * Then, it searches for sigrok protocol decoder files (*.py) in the
53 * "decoders" subdirectory of the the sigrok installation directory.
54 * All decoders that are found are loaded into memory and added to an
55 * internal list of decoders, which can be queried via srd_list_decoders().
57 * The caller is responsible for calling the clean-up function srd_exit(),
58 * which will properly shut down libsigrokdecode and free its allocated memory.
60 * Multiple calls to srd_init(), without calling srd_exit() inbetween,
63 * @return SRD_OK upon success, a (negative) error code otherwise.
64 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
65 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
66 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
72 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
74 /* Py_Initialize() returns void and usually cannot fail. */
77 if ((ret = set_modulepath()) != SRD_OK) {
82 if ((ret = srd_load_all_decoders()) != SRD_OK) {
92 * Shutdown libsigrokdecode.
94 * This frees all the memory allocated for protocol decoders and shuts down
95 * the Python interpreter.
97 * This function should only be called if there was a (successful!) invocation
98 * of srd_init() before. Calling this function multiple times in a row, without
99 * any successful srd_init() calls inbetween, is not allowed.
101 * @return SRD_OK upon success, a (negative) error code otherwise.
105 /* Unload/free all decoders, and then the list of decoders itself. */
106 /* TODO: Error handling. */
107 srd_unload_all_decoders();
108 g_slist_free(pd_list);
110 /* Py_Finalize() returns void, any finalization errors are ignored. */
118 * Add search directories for the protocol decoders.
120 * TODO: add path from env var SIGROKDECODE_PATH, config etc
122 int set_modulepath(void)
126 PyRun_SimpleString("import sys");
127 ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');");
133 struct srd_decoder_instance *srd_instance_new(const char *id)
135 struct srd_decoder *dec;
136 struct srd_decoder_instance *di;
139 fprintf(stdout, "%s: %s\n", __func__, id);
141 if (!(dec = srd_get_decoder_by_id(id)))
144 /* TODO: Error handling. Use g_try_malloc(). */
145 di = g_malloc(sizeof(*di));
147 di->pd_output = NULL;
150 /* Create an empty Python tuple. */
151 if (!(py_args = PyTuple_New(0))) { /* NEWREF */
152 if (PyErr_Occurred())
153 PyErr_Print(); /* Returns void. */
155 return NULL; /* TODO: More specific error? */
158 /* Create an instance of the 'Decoder' class. */
159 di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL);
160 if (!di->py_instance) {
161 if (PyErr_Occurred())
162 PyErr_Print(); /* Returns void. */
164 return NULL; /* TODO: More specific error? */
166 di_list = g_slist_append(di_list, di);
174 int srd_instance_set_probe(struct srd_decoder_instance *di,
175 const char *probename, int num)
177 PyObject *probedict, *probenum;
179 probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
181 if (PyErr_Occurred())
182 PyErr_Print(); /* Returns void. */
184 return SRD_ERR_PYTHON; /* TODO: More specific error? */
187 probenum = PyLong_FromLong(num);
188 PyMapping_SetItemString(probedict, (char *)probename, probenum);
190 Py_XDECREF(probenum);
191 Py_XDECREF(probedict);
197 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
201 struct srd_decoder_instance *di;
203 fprintf(stdout, "%s\n", __func__);
205 for (d = di_list; d; d = d->next) {
207 di->num_probes = num_probes;
208 di->unitsize = unitsize;
209 di->samplerate = samplerate;
210 if (!(py_res = PyObject_CallMethod(di->py_instance, "start",
212 "samplerate", (long)samplerate))) {
213 if (PyErr_Occurred())
214 PyErr_Print(); /* Returns void. */
216 return SRD_ERR_PYTHON; /* TODO: More specific error? */
226 * Run the specified decoder function.
230 * @param inbuflen TODO
232 * @return SRD_OK upon success, a (negative) error code otherwise.
234 int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
235 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
237 PyObject *py_instance, *py_res;
240 /* Return an error upon unusable input. */
242 return SRD_ERR_ARG; /* TODO: More specific error? */
244 return SRD_ERR_ARG; /* TODO: More specific error? */
245 if (inbuflen == 0) /* No point in working on empty buffers. */
246 return SRD_ERR_ARG; /* TODO: More specific error? */
248 /* TODO: Error handling. */
249 py_instance = di->py_instance;
250 Py_XINCREF(py_instance);
252 logic = PyObject_New(srd_logic, &srd_logic_type);
256 logic->inbuf = inbuf;
257 logic->inbuflen = inbuflen;
258 logic->sample = PyList_New(2);
259 Py_INCREF(logic->sample);
261 if (!(py_res = PyObject_CallMethod(py_instance, "decode",
262 "KKO", timeoffset, duration, logic))) {
263 if (PyErr_Occurred())
264 PyErr_Print(); /* Returns void. */
266 return SRD_ERR_PYTHON; /* TODO: More specific error? */
275 /* Feed logic samples to decoder session. */
276 int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
282 // fprintf(stdout, "%s: %d bytes\n", __func__, inbuflen);
284 for (d = di_list; d; d = d->next) {
285 if ((ret = srd_run_decoder(timeoffset, duration, d->data, inbuf,
286 inbuflen)) != SRD_OK)
294 int pd_output_new(struct srd_decoder_instance *di, int output_type,
295 char *protocol_id, char *description)
298 struct srd_pd_output *pdo;
301 fprintf(stdout, "%s: output type %d, protocol_id %s, description %s\n",
302 __func__, output_type, protocol_id, description);
305 for (l = di->pd_output; l; l = l->next) {
307 if (pdo->pdo_id > pdo_id)
308 pdo_id = pdo->pdo_id;
312 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
315 pdo->pdo_id = pdo_id;
316 pdo->output_type = output_type;
317 pdo->protocol_id = g_strdup(protocol_id);
318 pdo->description = g_strdup(description);
319 di->pd_output = g_slist_append(di->pd_output, pdo);
324 struct srd_decoder_instance *get_di_by_decobject(void *decobject)
327 struct srd_decoder_instance *di;
329 for (l = di_list; l; l = l->next) {
331 if (decobject == di->py_instance)
339 //int srd_pipeline_new(int plid)