053a7a1ae5362f0c259d59b081a66824c9f33239
[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_ARG             -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 /* libsigrokdecode loglevels. */
57 #define SRD_LOG_NONE    0 /**< Output no messages at all. */
58 #define SRD_LOG_ERR     1 /**< Output error messages. */
59 #define SRD_LOG_WARN    2 /**< Output warnings. */
60 #define SRD_LOG_INFO    3 /**< Output informational messages. */
61 #define SRD_LOG_DBG     4 /**< Output debug messages. */
62 #define SRD_LOG_SPEW    5 /**< Output very noisy debug messages. */
63
64 enum {
65         SRD_OUTPUT_LOGIC = 1,
66         SRD_OUTPUT_ANNOTATION,
67         SRD_OUTPUT_PROTOCOL,
68 };
69
70 /* TODO: Documentation. */
71 struct srd_decoder {
72         /** The decoder ID. Must be non-NULL and unique for all decoders. */
73         char *id;
74
75         /** The (short) decoder name. */
76         char *name;
77
78         /** The (long) decoder name. May be NULL. */
79         char *longname;
80
81         /** A (short, one-line) description of the decoder. */
82         char *desc;
83
84         /** A (long, multi-line) description of the decoder. May be NULL. */
85         char *longdesc;
86
87         /** The author of the decoder. May be NULL. */
88         char *author;
89
90         /** An email address of the decoder's author. May be NULL. */
91         char *email;
92
93         /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
94         char *license;
95
96         /** TODO */
97         char *func;
98
99         /** TODO */
100         GSList *inputformats;
101
102         /** TODO */
103         GSList *outputformats;
104
105         /** TODO */
106         PyObject *py_mod;
107
108         /** Python object that performs the decoding */
109         PyObject *py_decobj;
110 };
111
112 struct srd_decoder_instance {
113         struct srd_decoder *decoder;
114         PyObject *py_instance;
115         GSList *pd_output;
116 };
117
118 struct srd_pd_output {
119         int pdo_id;
120         int output_type;
121         char *protocol_id;
122         char *description;
123 };
124
125 /*--- controller.c ----------------------------------------------------------*/
126
127 int srd_init(void);
128 int srd_exit(void);
129 int set_modulepath(void);
130 struct srd_decoder_instance *srd_instance_new(const char *id);
131 int srd_instance_set_probe(struct srd_decoder_instance *di,
132                                 const char *probename, int num);
133 int srd_instance_start(struct srd_decoder_instance *di,
134                         const char *driver, int unitsize, uint64_t starttime);
135 int srd_session_start(const char *driver, int unitsize, uint64_t starttime,
136                 uint64_t samplerate);
137 int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen);
138 int pd_output_new(struct srd_decoder_instance *di, int output_type,
139                 char *output_id, char *description);
140
141 /*--- decoder.c -------------------------------------------------------------*/
142
143 GSList *srd_list_decoders(void);
144 struct srd_decoder *srd_get_decoder_by_id(const char *id);
145 int srd_load_decoder(const char *name, struct srd_decoder **dec);
146 int srd_unload_decoder(struct srd_decoder *dec);
147 int srd_load_all_decoders(void);
148 int srd_unload_all_decoders(void);
149
150 /*--- util.c ----------------------------------------------------------------*/
151
152 int h_str(PyObject *py_res, PyObject *py_mod, const char *key, char **outstr);
153
154 /*--- log.c -----------------------------------------------------------------*/
155
156 int srd_set_loglevel(int loglevel);
157 int srd_get_loglevel(void);
158
159 #ifdef __cplusplus
160 }
161 #endif
162
163 #endif