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 SIGROKDECODE_SIGROKDECODE_H
23 #define SIGROKDECODE_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. */
70 /* When adding an output type, don't forget to...
71 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
72 * - add a check in module_sigrokdecode.c:Decoder_put()
73 * - add a debug string in type_decoder.c:OUTPUT_TYPES
77 #define SRD_MAX_NUM_PROBES 64
79 /* TODO: Documentation. */
81 /** The decoder ID. Must be non-NULL and unique for all decoders. */
84 /** The (short) decoder name. */
87 /** The (long) decoder name. May be NULL. */
90 /** A (short, one-line) description of the decoder. */
93 /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
100 GSList *outputformats;
105 /** Optional probes */
106 GSList *extra_probes;
108 /* List of NULL-terminated char[], containing descriptions of the
109 * supported annotation output.
116 /** sigrokdecode.Decoder class */
127 struct srd_decoder_instance {
128 struct srd_decoder *decoder;
129 PyObject *py_instance;
136 uint64_t data_samplerate;
140 struct srd_pd_output {
143 struct srd_decoder_instance *di;
147 struct srd_proto_data {
148 uint64_t start_sample;
150 struct srd_pd_output *pdo;
155 struct srd_pd_callback {
157 void (*callback)(struct srd_proto_data *);
161 /* custom python types */
168 struct srd_decoder_instance *di;
169 uint64_t start_samplenum;
170 unsigned int itercnt;
177 /*--- controller.c ----------------------------------------------------------*/
180 int set_modulepath(void);
181 int srd_instance_set_options(struct srd_decoder_instance *di,
182 GHashTable *options);
183 int srd_instance_set_probes(struct srd_decoder_instance *di,
185 struct srd_decoder_instance *srd_instance_new(const char *id,
186 GHashTable *options);
187 int srd_instance_stack(struct srd_decoder_instance *di_from,
188 struct srd_decoder_instance *di_to);
189 struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id);
190 struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
192 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
193 int srd_instance_decode(uint64_t start_samplenum,
194 struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
195 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
196 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen);
197 int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id);
198 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
199 int srd_register_callback(int output_type, void *cb);
200 void *srd_find_callback(int output_type);
202 /*--- decoder.c -------------------------------------------------------------*/
203 GSList *srd_list_decoders(void);
204 struct srd_decoder *srd_get_decoder_by_id(const char *id);
205 int srd_load_decoder(const char *name, struct srd_decoder **dec);
206 int srd_unload_decoder(struct srd_decoder *dec);
207 int srd_load_all_decoders(void);
208 int srd_unload_all_decoders(void);
209 char *srd_decoder_doc(struct srd_decoder *dec);
211 /*--- exception.c -----------------------------------------------------------*/
212 void catch_exception(const char *format, ...);
214 /*--- util.c ----------------------------------------------------------------*/
215 int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
216 int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
217 int py_str_as_str(PyObject *py_str, char **outstr);
218 int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
220 /*--- log.c -----------------------------------------------------------------*/
221 int srd_set_loglevel(int loglevel);
222 int srd_get_loglevel(void);