2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
21 #ifndef SIGROKDECODE_SIGROKDECODE_H
22 #define SIGROKDECODE_SIGROKDECODE_H
24 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
33 * Status/error codes returned by libsigrokdecode functions.
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.
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
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.
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 */
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. */
64 /* TODO: Documentation. */
66 /** The decoder ID. Must be non-NULL and unique for all decoders. */
69 /** The (short) decoder name. */
72 /** The (long) decoder name. May be NULL. */
75 /** A (short, one-line) description of the decoder. */
78 /** A (long, multi-line) description of the decoder. May be NULL. */
81 /** The author of the decoder. May be NULL. */
84 /** An email address of the decoder's author. May be NULL. */
87 /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
97 GSList *outputformats;
102 /** Python object that performs the decoding */
106 struct srd_decoder_instance {
107 struct srd_decoder *decoder;
108 PyObject *py_instance;
112 /*--- controller.c ----------------------------------------------------------*/
116 int set_modulepath(void);
117 struct srd_decoder_instance *srd_instance_new(const char *id);
118 int srd_instance_set_probe(struct srd_decoder_instance *di,
119 const char *probename, int num);
120 int srd_instance_start(struct srd_decoder_instance *di,
121 const char *driver, int unitsize, uint64_t starttime);
122 int srd_session_start(const char *driver, int unitsize, uint64_t starttime,
123 uint64_t samplerate);
124 int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen);
126 /*--- decoder.c -------------------------------------------------------------*/
128 GSList *srd_list_decoders(void);
129 struct srd_decoder *srd_get_decoder_by_id(const char *id);
130 int srd_load_decoder(const char *name, struct srd_decoder **dec);
131 int srd_unload_decoder(struct srd_decoder *dec);
132 int srd_load_all_decoders(void);
133 int srd_unload_all_decoders(void);
135 /*--- util.c ----------------------------------------------------------------*/
137 int h_str(PyObject *py_res, PyObject *py_mod, const char *key, char **outstr);
139 /*--- log.c -----------------------------------------------------------------*/
141 int srd_set_loglevel(int loglevel);
142 int srd_get_loglevel(void);