refactored PD framework, now using new sigrok.Decoder object
[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         /** The decoder ID. Must be non-NULL and unique for all decoders. */
59         char *id;
60
61         /** The (short) decoder name. */
62         char *name;
63
64         /** The (long) decoder name. May be NULL. */
65         char *longname;
66
67         /** A (short, one-line) description of the decoder. */
68         char *desc;
69
70         /** A (long, multi-line) description of the decoder. May be NULL. */
71         char *longdesc;
72
73         /** The author of the decoder. May be NULL. */
74         char *author;
75
76         /** An email address of the decoder's author. May be NULL. */
77         char *email;
78
79         /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
80         char *license;
81
82         /** TODO */
83         char *func;
84
85         /** TODO */
86         GSList *inputformats;
87
88         /** TODO */
89         GSList *outputformats;
90
91         /** TODO */
92         PyObject *py_mod;
93
94         /** Python object that performs the decoding */
95         PyObject *py_decobj;
96 };
97
98 struct srd_decoder_instance {
99         struct srd_decoder *decoder;
100         PyObject *py_instance;
101         GSList *pd_output;
102 };
103
104 int srd_init(void);
105 int srd_exit(void);
106 int set_modulepath(void);
107 struct srd_decoder_instance *srd_instance_new(const char *id);
108 int srd_instance_set_probe(struct srd_decoder_instance *di,
109                                 const char *probename, int num);
110 int srd_instance_start(struct srd_decoder_instance *di,
111                         const char *driver, int unitsize, uint64_t starttime);
112 int srd_run_decoder(struct srd_decoder_instance *dec,
113                     uint8_t *inbuf, uint64_t inbuflen);
114
115 /* decoder.c */
116 GSList *srd_list_decoders(void);
117 struct srd_decoder *srd_get_decoder_by_id(const char *id);
118 int srd_load_decoder(const char *name, struct srd_decoder **dec);
119 int srd_unload_decoder(struct srd_decoder *dec);
120 int srd_load_all_decoders(void);
121 int srd_unload_all_decoders(void);
122
123 /* util.c */
124 int h_str(PyObject *py_res, PyObject *py_mod, const char *key, char **outstr);
125
126
127 #ifdef __cplusplus
128 }
129 #endif
130
131 #endif