1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
* This file is part of the sigrok project.
*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef SIGROKDECODE_SIGROKDECODE_H
#define SIGROKDECODE_SIGROKDECODE_H
#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include <stdint.h>
#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Status/error codes returned by libsigrokdecode functions.
*
* All possible return codes of libsigrokdecode functions must be listed here.
* Functions should never return hardcoded numbers as status, but rather
* use these #defines instead. All error codes are negative numbers.
*
* The error codes are globally unique in libsigrokdecode, i.e. if one of the
* libsigrokdecode functions returns a "malloc error" it must be exactly the
* same return value as used by all other functions to indicate "malloc error".
* There must be no functions which indicate two different errors via the
* same return code.
*
* Also, for compatibility reasons, no defined return codes are ever removed
* or reused for different #defines later. You can only add new #defines and
* return codes, but never remove or redefine existing ones.
*/
#define SRD_OK 0 /**< No error */
#define SRD_ERR -1 /**< Generic/unspecified error */
#define SRD_ERR_MALLOC -2 /**< Malloc/calloc/realloc error */
#define SRD_ERR_ARG -3 /**< Function argument error */
#define SRD_ERR_BUG -4 /**< Errors hinting at internal bugs */
#define SRD_ERR_PYTHON -5 /**< Python C API error */
#define SRD_ERR_DECODERS_DIR -6 /**< Protocol decoder path invalid */
/* libsigrokdecode loglevels. */
#define SRD_LOG_NONE 0 /**< Output no messages at all. */
#define SRD_LOG_ERR 1 /**< Output error messages. */
#define SRD_LOG_WARN 2 /**< Output warnings. */
#define SRD_LOG_INFO 3 /**< Output informational messages. */
#define SRD_LOG_DBG 4 /**< Output debug messages. */
#define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */
enum {
SRD_OUTPUT_ANN,
SRD_OUTPUT_PROTO,
SRD_OUTPUT_BINARY,
/* When adding an output type, don't forget to expose it to PDs in:
* controller.c:PyInit_sigrokdecode()
* and add a check in:
* module_sigrokdecode.c:Decoder_put()
*/
};
#define SRD_MAX_NUM_PROBES 64
/* TODO: Documentation. */
struct srd_decoder {
/** The decoder ID. Must be non-NULL and unique for all decoders. */
char *id;
/** The (short) decoder name. */
char *name;
/** The (long) decoder name. May be NULL. */
char *longname;
/** A (short, one-line) description of the decoder. */
char *desc;
/** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
char *license;
/** TODO */
GSList *inputformats;
/** TODO */
GSList *outputformats;
/* List of NULL-terminated char[], containing descriptions of the
* supported annotation output.
*/
GSList *annotations;
/** Python module */
PyObject *py_mod;
/** sigrokdecode.Decoder class */
PyObject *py_dec;
};
struct srd_decoder_instance {
struct srd_decoder *decoder;
PyObject *py_instance;
char *instance_id;
GSList *pd_output;
int num_probes;
int unitsize;
uint64_t samplerate;
GSList *next_di;
};
struct srd_pd_output {
int pdo_id;
int output_type;
struct srd_decoder *decoder;
char *proto_id;
};
struct srd_proto_data {
uint64_t start_sample;
uint64_t end_sample;
struct srd_pd_output *pdo;
int ann_format;
void *data;
};
struct srd_pd_callback {
int output_type;
void (*callback)(struct srd_proto_data *);
};
/* custom python types */
typedef struct {
PyObject_HEAD
} srd_Decoder;
typedef struct {
PyObject_HEAD
struct srd_decoder_instance *di;
uint64_t start_samplenum;
unsigned int itercnt;
uint8_t *inbuf;
uint64_t inbuflen;
PyObject *sample;
} srd_logic;
/*--- controller.c ----------------------------------------------------------*/
int srd_init(void);
int srd_exit(void);
int set_modulepath(void);
struct srd_decoder_instance *srd_instance_new(const char *id,
const char *instance_id);
int srd_instance_stack(struct srd_decoder_instance *di_from,
struct srd_decoder_instance *di_to);
int srd_instance_set_probe(struct srd_decoder_instance *di,
const char *probename, int num);
struct srd_decoder_instance *srd_instance_find(char *instance_id);
int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
int srd_instance_decode(uint64_t start_samplenum,
struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen);
int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id);
struct srd_decoder_instance *get_di_by_decobject(void *decobject);
int srd_register_callback(int output_type, void *cb);
void *srd_find_callback(int output_type);
/*--- decoder.c -------------------------------------------------------------*/
GSList *srd_list_decoders(void);
struct srd_decoder *srd_get_decoder_by_id(const char *id);
int srd_load_decoder(const char *name, struct srd_decoder **dec);
int srd_unload_decoder(struct srd_decoder *dec);
int srd_load_all_decoders(void);
int srd_unload_all_decoders(void);
char *srd_decoder_doc(struct srd_decoder *dec);
/*--- util.c ----------------------------------------------------------------*/
int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
int py_str_as_str(PyObject *py_str, char **outstr);
int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
/*--- log.c -----------------------------------------------------------------*/
int srd_set_loglevel(int loglevel);
int srd_get_loglevel(void);
#ifdef __cplusplus
}
#endif
#endif
|
