]>
Commit | Line | Data |
---|---|---|
1c6fa20f UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
bc5f5a43 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
1c6fa20f UH |
6 | * |
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 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
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. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | */ | |
21 | ||
3cf4ed56 UH |
22 | #ifndef SIGROKDECODE_SIGROKDECODE_H |
23 | #define SIGROKDECODE_SIGROKDECODE_H | |
1c6fa20f UH |
24 | |
25 | #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
26 | #include <stdint.h> | |
5c55017c | 27 | #include <glib.h> |
1c6fa20f | 28 | |
253f9603 UH |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
a4898be7 UH |
33 | /* |
34 | * Status/error codes returned by libsigrokdecode functions. | |
35 | * | |
36 | * All possible return codes of libsigrokdecode functions must be listed here. | |
37 | * Functions should never return hardcoded numbers as status, but rather | |
38 | * use these #defines instead. All error codes are negative numbers. | |
39 | * | |
40 | * The error codes are globally unique in libsigrokdecode, i.e. if one of the | |
41 | * libsigrokdecode functions returns a "malloc error" it must be exactly the | |
42 | * same return value as used by all other functions to indicate "malloc error". | |
43 | * There must be no functions which indicate two different errors via the | |
44 | * same return code. | |
45 | * | |
46 | * Also, for compatibility reasons, no defined return codes are ever removed | |
47 | * or reused for different #defines later. You can only add new #defines and | |
48 | * return codes, but never remove or redefine existing ones. | |
49 | */ | |
bc5f5a43 BV |
50 | #define SRD_OK 0 /**< No error */ |
51 | #define SRD_ERR -1 /**< Generic/unspecified error */ | |
52 | #define SRD_ERR_MALLOC -2 /**< Malloc/calloc/realloc error */ | |
47bd8dde UH |
53 | #define SRD_ERR_ARG -3 /**< Function argument error */ |
54 | #define SRD_ERR_BUG -4 /**< Errors hinting at internal bugs */ | |
55 | #define SRD_ERR_PYTHON -5 /**< Python C API error */ | |
56 | #define SRD_ERR_DECODERS_DIR -6 /**< Protocol decoder path invalid */ | |
7c24d086 | 57 | |
43c0a640 | 58 | /* libsigrokdecode loglevels. */ |
bc5f5a43 BV |
59 | #define SRD_LOG_NONE 0 /**< Output no messages at all. */ |
60 | #define SRD_LOG_ERR 1 /**< Output error messages. */ | |
61 | #define SRD_LOG_WARN 2 /**< Output warnings. */ | |
62 | #define SRD_LOG_INFO 3 /**< Output informational messages. */ | |
63 | #define SRD_LOG_DBG 4 /**< Output debug messages. */ | |
64 | #define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */ | |
43c0a640 | 65 | |
e5080882 | 66 | enum { |
94d43b37 UH |
67 | SRD_OUTPUT_ANN, |
68 | SRD_OUTPUT_PROTO, | |
15969949 | 69 | SRD_OUTPUT_BINARY, |
983cb0f5 BV |
70 | /* When adding an output type, don't forget to expose it to PDs in: |
71 | * controller.c:PyInit_sigrokdecode() | |
72 | * and add a check in: | |
73 | * module_sigrokdecode.c:Decoder_put() | |
3e2a9de2 | 74 | */ |
e5080882 BV |
75 | }; |
76 | ||
bc5f5a43 BV |
77 | #define SRD_MAX_NUM_PROBES 64 |
78 | ||
31b82285 | 79 | /* TODO: Documentation. */ |
d752b12b | 80 | struct srd_decoder { |
775dda7a | 81 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 82 | char *id; |
775dda7a UH |
83 | |
84 | /** The (short) decoder name. */ | |
31b82285 | 85 | char *name; |
775dda7a UH |
86 | |
87 | /** The (long) decoder name. May be NULL. */ | |
75a282e5 | 88 | char *longname; |
775dda7a UH |
89 | |
90 | /** A (short, one-line) description of the decoder. */ | |
5c55017c | 91 | char *desc; |
775dda7a | 92 | |
775dda7a | 93 | /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ |
75a282e5 UH |
94 | char *license; |
95 | ||
775dda7a | 96 | /** TODO */ |
5c55017c | 97 | GSList *inputformats; |
775dda7a UH |
98 | |
99 | /** TODO */ | |
5c55017c UH |
100 | GSList *outputformats; |
101 | ||
15969949 BV |
102 | /* List of NULL-terminated char[], containing descriptions of the |
103 | * supported annotation output. | |
104 | */ | |
e97b6ef5 | 105 | GSList *annotations; |
15969949 | 106 | |
451680f1 | 107 | /** Python module */ |
b2c19614 BV |
108 | PyObject *py_mod; |
109 | ||
451680f1 BV |
110 | /** sigrokdecode.Decoder class */ |
111 | PyObject *py_dec; | |
74911b4c GM |
112 | }; |
113 | ||
114 | struct srd_decoder_instance { | |
b2c19614 | 115 | struct srd_decoder *decoder; |
052f32ee | 116 | PyObject *py_instance; |
7ce7775c | 117 | char *instance_id; |
b2c19614 | 118 | GSList *pd_output; |
bc5f5a43 BV |
119 | int num_probes; |
120 | int unitsize; | |
121 | uint64_t samplerate; | |
7ce7775c | 122 | GSList *next_di; |
31b82285 | 123 | }; |
124 | ||
e5080882 BV |
125 | struct srd_pd_output { |
126 | int pdo_id; | |
127 | int output_type; | |
15969949 | 128 | struct srd_decoder *decoder; |
94d43b37 | 129 | char *proto_id; |
e5080882 BV |
130 | }; |
131 | ||
94d43b37 | 132 | struct srd_proto_data { |
15969949 BV |
133 | uint64_t start_sample; |
134 | uint64_t end_sample; | |
135 | struct srd_pd_output *pdo; | |
94d43b37 | 136 | int ann_format; |
983cb0f5 | 137 | void *data; |
15969949 BV |
138 | }; |
139 | ||
983cb0f5 BV |
140 | struct srd_pd_callback { |
141 | int output_type; | |
94d43b37 | 142 | void (*callback)(struct srd_proto_data *); |
983cb0f5 | 143 | }; |
bc5f5a43 BV |
144 | |
145 | ||
f8e45857 BV |
146 | /* custom python types */ |
147 | typedef struct { | |
148 | PyObject_HEAD | |
149 | } srd_Decoder; | |
43c0a640 | 150 | |
f8e45857 BV |
151 | typedef struct { |
152 | PyObject_HEAD | |
153 | struct srd_decoder_instance *di; | |
86528298 | 154 | uint64_t start_samplenum; |
f8e45857 BV |
155 | unsigned int itercnt; |
156 | uint8_t *inbuf; | |
157 | uint64_t inbuflen; | |
158 | PyObject *sample; | |
159 | } srd_logic; | |
160 | ||
161 | ||
162 | /*--- controller.c ----------------------------------------------------------*/ | |
d752b12b | 163 | int srd_init(void); |
b2c19614 BV |
164 | int srd_exit(void); |
165 | int set_modulepath(void); | |
0bdadba2 BV |
166 | int srd_instance_set_options(struct srd_decoder_instance *di, |
167 | GHashTable *options); | |
168 | int srd_instance_set_probes(struct srd_decoder_instance *di, | |
169 | GHashTable *probes); | |
7ce7775c | 170 | struct srd_decoder_instance *srd_instance_new(const char *id, |
0bdadba2 | 171 | GHashTable *options); |
7ce7775c BV |
172 | int srd_instance_stack(struct srd_decoder_instance *di_from, |
173 | struct srd_decoder_instance *di_to); | |
7ce7775c BV |
174 | struct srd_decoder_instance *srd_instance_find(char *instance_id); |
175 | int srd_instance_start(struct srd_decoder_instance *di, PyObject *args); | |
86528298 | 176 | int srd_instance_decode(uint64_t start_samplenum, |
1aef2f93 | 177 | struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen); |
7ce7775c | 178 | int srd_session_start(int num_probes, int unitsize, uint64_t samplerate); |
86528298 BV |
179 | int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen); |
180 | int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id); | |
bc5f5a43 | 181 | struct srd_decoder_instance *get_di_by_decobject(void *decobject); |
983cb0f5 BV |
182 | int srd_register_callback(int output_type, void *cb); |
183 | void *srd_find_callback(int output_type); | |
b2c19614 | 184 | |
43c0a640 | 185 | /*--- decoder.c -------------------------------------------------------------*/ |
b2c19614 BV |
186 | GSList *srd_list_decoders(void); |
187 | struct srd_decoder *srd_get_decoder_by_id(const char *id); | |
188 | int srd_load_decoder(const char *name, struct srd_decoder **dec); | |
189 | int srd_unload_decoder(struct srd_decoder *dec); | |
190 | int srd_load_all_decoders(void); | |
191 | int srd_unload_all_decoders(void); | |
451680f1 | 192 | char *srd_decoder_doc(struct srd_decoder *dec); |
b2c19614 | 193 | |
43c0a640 | 194 | /*--- util.c ----------------------------------------------------------------*/ |
451680f1 BV |
195 | int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr); |
196 | int py_str_as_str(PyObject *py_str, char **outstr); | |
15969949 | 197 | int py_strlist_to_char(PyObject *py_strlist, char ***outstr); |
b2c19614 | 198 | |
43c0a640 | 199 | /*--- log.c -----------------------------------------------------------------*/ |
43c0a640 UH |
200 | int srd_set_loglevel(int loglevel); |
201 | int srd_get_loglevel(void); | |
1c6fa20f | 202 | |
253f9603 UH |
203 | #ifdef __cplusplus |
204 | } | |
205 | #endif | |
206 | ||
1c6fa20f | 207 | #endif |