]>
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 */ | |
a62186e4 | 52 | #define SRD_ERR_ARG -3 /**< Function argument error */ |
775dda7a UH |
53 | #define SRD_ERR_PYTHON -4 /**< Python C API error */ |
54 | #define SRD_ERR_DECODERS_DIR -5 /**< Protocol decoder path invalid */ | |
7c24d086 | 55 | |
43c0a640 UH |
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. */ | |
63 | ||
e5080882 BV |
64 | enum { |
65 | SRD_OUTPUT_LOGIC = 1, | |
66 | SRD_OUTPUT_ANNOTATION, | |
67 | SRD_OUTPUT_PROTOCOL, | |
68 | }; | |
69 | ||
31b82285 | 70 | /* TODO: Documentation. */ |
d752b12b | 71 | struct srd_decoder { |
775dda7a | 72 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 73 | char *id; |
775dda7a UH |
74 | |
75 | /** The (short) decoder name. */ | |
31b82285 | 76 | char *name; |
775dda7a UH |
77 | |
78 | /** The (long) decoder name. May be NULL. */ | |
75a282e5 | 79 | char *longname; |
775dda7a UH |
80 | |
81 | /** A (short, one-line) description of the decoder. */ | |
5c55017c | 82 | char *desc; |
775dda7a UH |
83 | |
84 | /** A (long, multi-line) description of the decoder. May be NULL. */ | |
75a282e5 | 85 | char *longdesc; |
775dda7a UH |
86 | |
87 | /** The author of the decoder. May be NULL. */ | |
75a282e5 | 88 | char *author; |
775dda7a UH |
89 | |
90 | /** An email address of the decoder's author. May be NULL. */ | |
75a282e5 | 91 | char *email; |
775dda7a UH |
92 | |
93 | /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ | |
75a282e5 UH |
94 | char *license; |
95 | ||
775dda7a | 96 | /** TODO */ |
5c55017c | 97 | char *func; |
75a282e5 | 98 | |
775dda7a | 99 | /** TODO */ |
5c55017c | 100 | GSList *inputformats; |
775dda7a UH |
101 | |
102 | /** TODO */ | |
5c55017c UH |
103 | GSList *outputformats; |
104 | ||
b2c19614 BV |
105 | /** TODO */ |
106 | PyObject *py_mod; | |
107 | ||
6eb87578 GM |
108 | /** Python object that performs the decoding */ |
109 | PyObject *py_decobj; | |
74911b4c GM |
110 | }; |
111 | ||
112 | struct srd_decoder_instance { | |
b2c19614 | 113 | struct srd_decoder *decoder; |
052f32ee | 114 | PyObject *py_instance; |
b2c19614 | 115 | GSList *pd_output; |
31b82285 | 116 | }; |
117 | ||
e5080882 BV |
118 | struct srd_pd_output { |
119 | int pdo_id; | |
120 | int output_type; | |
121 | char *protocol_id; | |
122 | char *description; | |
123 | }; | |
124 | ||
43c0a640 UH |
125 | /*--- controller.c ----------------------------------------------------------*/ |
126 | ||
d752b12b | 127 | int srd_init(void); |
b2c19614 BV |
128 | int srd_exit(void); |
129 | int set_modulepath(void); | |
74911b4c | 130 | struct srd_decoder_instance *srd_instance_new(const char *id); |
f97f531c GM |
131 | int srd_instance_set_probe(struct srd_decoder_instance *di, |
132 | const char *probename, int num); | |
b2c19614 BV |
133 | int srd_instance_start(struct srd_decoder_instance *di, |
134 | const char *driver, int unitsize, uint64_t starttime); | |
6547acfd GM |
135 | int srd_session_start(const char *driver, int unitsize, uint64_t starttime, |
136 | uint64_t samplerate); | |
1aef2f93 BV |
137 | int srd_run_decoder(uint64_t timeoffset, uint64_t duration, |
138 | struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen); | |
139 | int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, | |
140 | uint64_t inbuflen); | |
e5080882 BV |
141 | int pd_output_new(struct srd_decoder_instance *di, int output_type, |
142 | char *output_id, char *description); | |
b2c19614 | 143 | |
43c0a640 UH |
144 | /*--- decoder.c -------------------------------------------------------------*/ |
145 | ||
b2c19614 BV |
146 | GSList *srd_list_decoders(void); |
147 | struct srd_decoder *srd_get_decoder_by_id(const char *id); | |
148 | int srd_load_decoder(const char *name, struct srd_decoder **dec); | |
149 | int srd_unload_decoder(struct srd_decoder *dec); | |
150 | int srd_load_all_decoders(void); | |
151 | int srd_unload_all_decoders(void); | |
152 | ||
43c0a640 | 153 | /*--- util.c ----------------------------------------------------------------*/ |
8b4bbd2a | 154 | int h_str(PyObject *py_res, const char *key, char **outstr); |
b2c19614 | 155 | |
43c0a640 UH |
156 | /*--- log.c -----------------------------------------------------------------*/ |
157 | ||
158 | int srd_set_loglevel(int loglevel); | |
159 | int srd_get_loglevel(void); | |
1c6fa20f | 160 | |
253f9603 UH |
161 | #ifdef __cplusplus |
162 | } | |
163 | #endif | |
164 | ||
1c6fa20f | 165 | #endif |