Revert FIRMWARE_DIR / DECODERS_DIR method for now.
[libsigrokdecode.git] / sigrokdecode.h
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #ifndef SIGROKDECODE_SIGROKDECODE_H
22 #define SIGROKDECODE_SIGROKDECODE_H
23
24 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
25 #include <stdint.h>
26 #include <glib.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /*
33  * Status/error codes returned by libsigrokdecode functions.
34  *
35  * All possible return codes of libsigrokdecode functions must be listed here.
36  * Functions should never return hardcoded numbers as status, but rather
37  * use these #defines instead. All error codes are negative numbers.
38  *
39  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
40  * libsigrokdecode functions returns a "malloc error" it must be exactly the
41  * same return value as used by all other functions to indicate "malloc error".
42  * There must be no functions which indicate two different errors via the
43  * same return code.
44  *
45  * Also, for compatibility reasons, no defined return codes are ever removed
46  * or reused for different #defines later. You can only add new #defines and
47  * return codes, but never remove or redefine existing ones.
48  */
49 #define SRD_OK                   0 /* No error */
50 #define SRD_ERR                 -1 /* Generic/unspecified error */
51 #define SRD_ERR_MALLOC          -2 /* Malloc/calloc/realloc error */
52 #define SRD_ERR_ARGS            -3 /* Function argument error */
53 #define SRD_ERR_PYTHON          -4 /* Python C API error */
54 #define SRD_ERR_DECODERS_DIR    -5 /* Protocol decoder path invalid */
55
56 /* TODO: Documentation. */
57 struct srd_decoder {
58         char *id;
59         char *name;
60         char *desc;
61         char *func;
62         GSList *inputformats;
63         GSList *outputformats;
64
65         PyObject *py_mod;
66         PyObject *py_func;
67 };
68
69 int srd_init(void);
70 GSList *srd_list_decoders(void);
71 struct srd_decoder *srd_get_decoder_by_id(const char *id);
72 int srd_run_decoder(struct srd_decoder *dec, uint8_t *inbuf, uint64_t inbuflen,
73                     uint8_t **outbuf, uint64_t *outbuflen);
74 int srd_exit(void);
75
76 #ifdef __cplusplus
77 }
78 #endif
79
80 #endif