2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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
22 #ifndef LIBSIGROKDECODE_SIGROKDECODE_H
23 #define LIBSIGROKDECODE_SIGROKDECODE_H
25 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
34 * Status/error codes returned by libsigrokdecode functions.
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.
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
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.
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 */
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. */
67 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
69 * Variables and functions marked 'static' are private already and don't
70 * need SR_PRIV. However, functions which are not static (because they need
71 * to be used in other libsigrokdecode-internal files) but are also not
72 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
74 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
76 * Details: http://gcc.gnu.org/wiki/Visibility
79 /* Marks public libsigrokdecode API symbols. */
80 #define SRD_API __attribute__((visibility("default")))
82 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
83 #define SRD_PRIV __attribute__((visibility("hidden")))
86 * When adding an output type, don't forget to...
87 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
88 * - add a check in module_sigrokdecode.c:Decoder_put()
89 * - add a debug string in type_decoder.c:OUTPUT_TYPES
97 #define SRD_MAX_NUM_PROBES 64
99 /* TODO: Documentation. */
101 /** The decoder ID. Must be non-NULL and unique for all decoders. */
104 /** The (short) decoder name. */
107 /** The (long) decoder name. May be NULL. */
110 /** A (short, one-line) description of the decoder. */
113 /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
117 GSList *inputformats;
120 GSList *outputformats;
125 /** Optional probes */
129 * List of NULL-terminated char[], containing descriptions of the
130 * supported annotation output.
137 /** sigrokdecode.Decoder class */
148 struct srd_decoder_inst {
149 struct srd_decoder *decoder;
157 uint64_t data_samplerate;
161 struct srd_pd_output {
164 struct srd_decoder_inst *di;
168 struct srd_proto_data {
169 uint64_t start_sample;
171 struct srd_pd_output *pdo;
176 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
179 struct srd_pd_callback {
181 srd_pd_output_callback_t callback;
185 /* custom python types */
192 struct srd_decoder_inst *di;
193 uint64_t start_samplenum;
194 unsigned int itercnt;
200 /*--- controller.c ----------------------------------------------------------*/
202 SRD_API int srd_init(void);
203 SRD_API int srd_exit(void);
204 SRD_API int set_modulepath(void);
205 SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
206 GHashTable *options);
207 SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
209 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
210 GHashTable *options);
211 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
212 struct srd_decoder_inst *di_to);
213 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id);
214 SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
216 SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args);
217 SRD_API int srd_inst_decode(uint64_t start_samplenum,
218 struct srd_decoder_inst *dec,
219 uint8_t *inbuf, uint64_t inbuflen);
220 SRD_API void srd_inst_free(struct srd_decoder_inst *di);
221 SRD_API void srd_inst_free_all(GSList *stack);
222 SRD_API int srd_session_start(int num_probes, int unitsize,
223 uint64_t samplerate);
224 SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
226 SRD_API struct srd_decoder_inst *get_di_by_decobject(void *decobject);
227 SRD_API int srd_register_callback(int output_type,
228 srd_pd_output_callback_t cb, void *data);
229 SRD_API void *srd_find_callback(int output_type);
231 /*--- decoder.c -------------------------------------------------------------*/
233 SRD_API GSList *srd_list_decoders(void);
234 SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id);
235 SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec);
236 SRD_API int srd_unload_decoder(struct srd_decoder *dec);
237 SRD_API int srd_load_all_decoders(void);
238 SRD_API int srd_unload_all_decoders(void);
239 SRD_API char *srd_decoder_doc(struct srd_decoder *dec);
241 /*--- log.c -----------------------------------------------------------------*/
243 typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format,
246 SRD_API int srd_log_loglevel_set(int loglevel);
247 SRD_API int srd_log_loglevel_get(void);
248 SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *data);
249 SRD_API int srd_log_handler_set_default(void);
250 SRD_API int srd_log_logdomain_set(const char *logdomain);
251 SRD_API char *srd_log_logdomain_get(void);