]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> | |
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 | ||
22 | #ifndef SIGROKDECODE_SIGROKDECODE_H | |
23 | #define SIGROKDECODE_SIGROKDECODE_H | |
24 | ||
25 | #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
26 | #include <stdint.h> | |
27 | #include <glib.h> | |
28 | ||
29 | #ifdef __cplusplus | |
30 | extern "C" { | |
31 | #endif | |
32 | ||
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 | */ | |
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 */ | |
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 */ | |
57 | ||
58 | /* libsigrokdecode loglevels. */ | |
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. */ | |
65 | ||
66 | enum { | |
67 | SRD_OUTPUT_ANNOTATION, | |
68 | SRD_OUTPUT_PROTOCOL, | |
69 | SRD_OUTPUT_BINARY, | |
70 | /* When adding an output type, don't forget to expose it to PDs | |
71 | * in controller.c:PyInit_sigrokdecode() | |
72 | */ | |
73 | }; | |
74 | ||
75 | #define SRD_MAX_NUM_PROBES 64 | |
76 | ||
77 | /* TODO: Documentation. */ | |
78 | struct srd_decoder { | |
79 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ | |
80 | char *id; | |
81 | ||
82 | /** The (short) decoder name. */ | |
83 | char *name; | |
84 | ||
85 | /** The (long) decoder name. May be NULL. */ | |
86 | char *longname; | |
87 | ||
88 | /** A (short, one-line) description of the decoder. */ | |
89 | char *desc; | |
90 | ||
91 | /** A (long, multi-line) description of the decoder. May be NULL. */ | |
92 | char *longdesc; | |
93 | ||
94 | /** The author of the decoder. May be NULL. */ | |
95 | char *author; | |
96 | ||
97 | /** An email address of the decoder's author. May be NULL. */ | |
98 | char *email; | |
99 | ||
100 | /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ | |
101 | char *license; | |
102 | ||
103 | /** TODO */ | |
104 | char *func; | |
105 | ||
106 | /** TODO */ | |
107 | GSList *inputformats; | |
108 | ||
109 | /** TODO */ | |
110 | GSList *outputformats; | |
111 | ||
112 | /* List of NULL-terminated char[], containing descriptions of the | |
113 | * supported annotation output. | |
114 | */ | |
115 | GSList *annotation; | |
116 | ||
117 | /** TODO */ | |
118 | PyObject *py_mod; | |
119 | ||
120 | /** Python object that performs the decoding */ | |
121 | PyObject *py_decobj; | |
122 | }; | |
123 | ||
124 | struct srd_decoder_instance { | |
125 | struct srd_decoder *decoder; | |
126 | PyObject *py_instance; | |
127 | GSList *pd_output; | |
128 | int num_probes; | |
129 | int unitsize; | |
130 | uint64_t samplerate; | |
131 | }; | |
132 | ||
133 | struct srd_pd_output { | |
134 | int pdo_id; | |
135 | int output_type; | |
136 | struct srd_decoder *decoder; | |
137 | char *protocol_id; | |
138 | }; | |
139 | ||
140 | typedef struct { | |
141 | PyObject_HEAD | |
142 | struct srd_decoder_instance *di; | |
143 | unsigned int itercnt; | |
144 | uint8_t *inbuf; | |
145 | uint64_t inbuflen; | |
146 | PyObject *sample; | |
147 | } srd_logic; | |
148 | ||
149 | struct srd_protocol_data { | |
150 | uint64_t start_sample; | |
151 | uint64_t end_sample; | |
152 | struct srd_pd_output *pdo; | |
153 | int annotation_type; | |
154 | unsigned char **data; | |
155 | }; | |
156 | ||
157 | ||
158 | ||
159 | /*--- controller.c ----------------------------------------------------------*/ | |
160 | ||
161 | int srd_init(void); | |
162 | int srd_exit(void); | |
163 | int set_modulepath(void); | |
164 | struct srd_decoder_instance *srd_instance_new(const char *id); | |
165 | int srd_instance_set_probe(struct srd_decoder_instance *di, | |
166 | const char *probename, int num); | |
167 | int srd_session_start(int num_probes, int unitsize, uint64_t samplerate); | |
168 | int srd_run_decoder(uint64_t timeoffset, uint64_t duration, | |
169 | struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen); | |
170 | int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, | |
171 | uint64_t inbuflen); | |
172 | int pd_output_new(struct srd_decoder_instance *di, int output_type, | |
173 | char *output_id); | |
174 | struct srd_decoder_instance *get_di_by_decobject(void *decobject); | |
175 | ||
176 | /*--- decoder.c -------------------------------------------------------------*/ | |
177 | ||
178 | GSList *srd_list_decoders(void); | |
179 | struct srd_decoder *srd_get_decoder_by_id(const char *id); | |
180 | int srd_load_decoder(const char *name, struct srd_decoder **dec); | |
181 | int srd_unload_decoder(struct srd_decoder *dec); | |
182 | int srd_load_all_decoders(void); | |
183 | int srd_unload_all_decoders(void); | |
184 | ||
185 | /*--- util.c ----------------------------------------------------------------*/ | |
186 | int h_str(PyObject *py_res, const char *key, char **outstr); | |
187 | int py_strlist_to_char(PyObject *py_strlist, char ***outstr); | |
188 | ||
189 | /*--- log.c -----------------------------------------------------------------*/ | |
190 | ||
191 | int srd_set_loglevel(int loglevel); | |
192 | int srd_get_loglevel(void); | |
193 | ||
194 | #ifdef __cplusplus | |
195 | } | |
196 | #endif | |
197 | ||
198 | #endif |