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_ARGS -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 /* TODO: Documentation. */
58 /** The decoder ID. Must be non-NULL and unique for all decoders. */
61 /** The (short) decoder name. */
64 /** The (long) decoder name. May be NULL. */
67 /** A (short, one-line) description of the decoder. */
70 /** A (long, multi-line) description of the decoder. May be NULL. */
73 /** The author of the decoder. May be NULL. */
76 /** An email address of the decoder's author. May be NULL. */
79 /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
89 GSList *outputformats;
94 /** Python object that performs the decoding */
98 struct srd_decoder_instance {
99 PyObject *py_instance;
103 GSList *srd_list_decoders(void);
104 struct srd_decoder *srd_get_decoder_by_id(const char *id);
105 struct srd_decoder_instance *srd_instance_new(const char *id);
106 int srd_instance_set_probe(struct srd_decoder_instance *di,
107 const char *probename, int num);
108 int srd_session_start(const char *driver, int unitsize, uint64_t starttime,
109 uint64_t samplerate);
110 int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen);