]>
Commit | Line | Data |
---|---|---|
1c6fa20f UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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 | |
19 | */ | |
20 | ||
3cf4ed56 UH |
21 | #ifndef SIGROKDECODE_SIGROKDECODE_H |
22 | #define SIGROKDECODE_SIGROKDECODE_H | |
1c6fa20f UH |
23 | |
24 | #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
25 | #include <stdint.h> | |
5c55017c | 26 | #include <glib.h> |
1c6fa20f | 27 | |
253f9603 UH |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
a4898be7 UH |
32 | /* |
33 | * Status/error codes returned by libsigrokdecode functions. | |
34 | * | |
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. | |
38 | * | |
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 | |
43 | * same return code. | |
44 | * | |
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. | |
48 | */ | |
775dda7a UH |
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 */ | |
7c24d086 | 55 | |
31b82285 | 56 | /* TODO: Documentation. */ |
d752b12b | 57 | struct srd_decoder { |
775dda7a | 58 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 59 | char *id; |
775dda7a UH |
60 | |
61 | /** The (short) decoder name. */ | |
31b82285 | 62 | char *name; |
775dda7a UH |
63 | |
64 | /** The (long) decoder name. May be NULL. */ | |
75a282e5 | 65 | char *longname; |
775dda7a UH |
66 | |
67 | /** A (short, one-line) description of the decoder. */ | |
5c55017c | 68 | char *desc; |
775dda7a UH |
69 | |
70 | /** A (long, multi-line) description of the decoder. May be NULL. */ | |
75a282e5 | 71 | char *longdesc; |
775dda7a UH |
72 | |
73 | /** The author of the decoder. May be NULL. */ | |
75a282e5 | 74 | char *author; |
775dda7a UH |
75 | |
76 | /** An email address of the decoder's author. May be NULL. */ | |
75a282e5 | 77 | char *email; |
775dda7a UH |
78 | |
79 | /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ | |
75a282e5 UH |
80 | char *license; |
81 | ||
775dda7a | 82 | /** TODO */ |
5c55017c | 83 | char *func; |
75a282e5 | 84 | |
775dda7a | 85 | /** TODO */ |
5c55017c | 86 | GSList *inputformats; |
775dda7a UH |
87 | |
88 | /** TODO */ | |
5c55017c UH |
89 | GSList *outputformats; |
90 | ||
6eb87578 GM |
91 | /** Python object that performs the decoding */ |
92 | PyObject *py_decobj; | |
74911b4c GM |
93 | }; |
94 | ||
95 | struct srd_decoder_instance { | |
052f32ee | 96 | PyObject *py_instance; |
31b82285 | 97 | }; |
98 | ||
d752b12b UH |
99 | int srd_init(void); |
100 | GSList *srd_list_decoders(void); | |
101 | struct srd_decoder *srd_get_decoder_by_id(const char *id); | |
74911b4c | 102 | struct srd_decoder_instance *srd_instance_new(const char *id); |
f97f531c GM |
103 | int srd_instance_set_probe(struct srd_decoder_instance *di, |
104 | const char *probename, int num); | |
60b928b2 GM |
105 | int srd_session_start(const char *driver, int unitsize, uint64_t starttime, |
106 | uint64_t samplerate); | |
107 | int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen); | |
7ea73e33 | 108 | int srd_exit(void); |
1c6fa20f | 109 | |
253f9603 UH |
110 | #ifdef __cplusplus |
111 | } | |
112 | #endif | |
113 | ||
1c6fa20f | 114 | #endif |