2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef SIGROKDECODE_SIGROKDECODE_H
22 #define SIGROKDECODE_SIGROKDECODE_H
24 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
29 * Status/error codes returned by libsigrokdecode functions.
31 * All possible return codes of libsigrokdecode functions must be listed here.
32 * Functions should never return hardcoded numbers as status, but rather
33 * use these #defines instead. All error codes are negative numbers.
35 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
36 * libsigrokdecode functions returns a "malloc error" it must be exactly the
37 * same return value as used by all other functions to indicate "malloc error".
38 * There must be no functions which indicate two different errors via the
41 * Also, for compatibility reasons, no defined return codes are ever removed
42 * or reused for different #defines later. You can only add new #defines and
43 * return codes, but never remove or redefine existing ones.
45 #define SIGROKDECODE_OK 0 /* No error */
46 #define SIGROKDECODE_ERR -1 /* Generic/unspecified error */
47 #define SIGROKDECODE_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
48 #define SIGROKDECODE_ERR_ARGS -3 /* Function argument error */
49 #define SIGROKDECODE_ERR_PYTHON -4 /* Python C API error */
50 #define SIGROKDECODE_ERR_DECODERS_DIR -5 /* Protocol decoder path invalid */
52 /* TODO: Documentation. */
53 struct sigrokdecode_decoder {
59 GSList *outputformats;
65 int sigrokdecode_init(void);
66 GSList *sigrokdecode_list_decoders(void);
67 int sigrokdecode_load_decoder(const char *name, struct sigrokdecode_decoder **dec);
68 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
69 uint8_t *inbuf, uint64_t inbuflen,
70 uint8_t **outbuf, uint64_t *outbuflen);
71 int sigrokdecode_shutdown(void);