blob: 3175fd8b94a1f35d0b50d89dc9919b813ec6cd86 [file] [log] [blame]
Uwe Hermann1c6fa202010-04-02 20:18:27 +02001/*
Uwe Hermann50bd5d22013-04-23 22:27:20 +02002 * This file is part of the libsigrokdecode project.
Uwe Hermann1c6fa202010-04-02 20:18:27 +02003 *
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +01005 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
Uwe Hermann1c6fa202010-04-02 20:18:27 +02006 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
Uwe Hermann3b5839d2012-02-04 10:41:30 +010022#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
23#define LIBSIGROKDECODE_SIGROKDECODE_H
Uwe Hermann1c6fa202010-04-02 20:18:27 +020024
25#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
26#include <stdint.h>
Uwe Hermann5c550172010-04-24 01:04:20 +020027#include <glib.h>
Uwe Hermann1c6fa202010-04-02 20:18:27 +020028
Uwe Hermann253f9602011-01-20 23:00:59 +010029#ifdef __cplusplus
30extern "C" {
31#endif
32
Bert Vermeulen32cfb922013-09-12 23:54:43 +020033struct srd_session;
34
Uwe Hermann54fdeee2013-02-09 22:10:57 +010035/**
36 * @file
37 *
38 * The public libsigrokdecode header file to be used by frontends.
39 *
40 * This is the only file that libsigrokdecode users (frontends) are supposed
41 * to use and include. There are other header files which get installed with
42 * libsigrokdecode, but those are not meant to be used directly by frontends.
43 *
44 * The correct way to get/use the libsigrokdecode API functions is:
45 *
46 * @code{.c}
Uwe Hermannc1f86f02013-05-03 14:49:21 +020047 * #include <libsigrokdecode/libsigrokdecode.h>
Uwe Hermann54fdeee2013-02-09 22:10:57 +010048 * @endcode
49 */
50
Uwe Hermanna4898be2010-04-06 01:29:32 +020051/*
Uwe Hermanna4898be2010-04-06 01:29:32 +020052 * All possible return codes of libsigrokdecode functions must be listed here.
53 * Functions should never return hardcoded numbers as status, but rather
Uwe Hermann47dfa772013-05-03 23:51:35 +020054 * use these enum values. All error codes are negative numbers.
Uwe Hermanna4898be2010-04-06 01:29:32 +020055 *
56 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
57 * libsigrokdecode functions returns a "malloc error" it must be exactly the
58 * same return value as used by all other functions to indicate "malloc error".
59 * There must be no functions which indicate two different errors via the
60 * same return code.
61 *
62 * Also, for compatibility reasons, no defined return codes are ever removed
Uwe Hermann47dfa772013-05-03 23:51:35 +020063 * or reused for different errors later. You can only add new entries and
Uwe Hermanna4898be2010-04-06 01:29:32 +020064 * return codes, but never remove or redefine existing ones.
65 */
Uwe Hermann47dfa772013-05-03 23:51:35 +020066
67/** Status/error codes returned by libsigrokdecode functions. */
68enum {
69 SRD_OK = 0, /**< No error */
70 SRD_ERR = -1, /**< Generic/unspecified error */
71 SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */
72 SRD_ERR_ARG = -3, /**< Function argument error */
73 SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */
74 SRD_ERR_PYTHON = -5, /**< Python C API error */
75 SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
76
77 /*
78 * Note: When adding entries here, don't forget to also update the
79 * srd_strerror() and srd_strerror_name() functions in error.c.
80 */
81};
Uwe Hermann7c24d082011-01-15 01:44:41 +010082
Uwe Hermann43c0a642011-12-21 18:57:04 +010083/* libsigrokdecode loglevels. */
Uwe Hermann47dfa772013-05-03 23:51:35 +020084enum {
85 SRD_LOG_NONE = 0, /**< Output no messages at all. */
86 SRD_LOG_ERR = 1, /**< Output error messages. */
87 SRD_LOG_WARN = 2, /**< Output warnings. */
88 SRD_LOG_INFO = 3, /**< Output informational messages. */
89 SRD_LOG_DBG = 4, /**< Output debug messages. */
90 SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
91};
Uwe Hermann43c0a642011-12-21 18:57:04 +010092
Uwe Hermannc9bfccc2012-02-08 22:39:30 +010093/*
Uwe Hermann55c3c5f2012-02-09 19:11:53 +010094 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
95 *
96 * Variables and functions marked 'static' are private already and don't
Uwe Hermannd523eae2013-01-07 22:30:17 +010097 * need SRD_PRIV. However, functions which are not static (because they need
Uwe Hermann55c3c5f2012-02-09 19:11:53 +010098 * to be used in other libsigrokdecode-internal files) but are also not
99 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
100 *
101 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
102 *
Uwe Hermanna4cb05f2012-04-16 23:16:00 +0200103 * This feature is not available on MinGW/Windows, as it is a feature of
104 * ELF files and MinGW/Windows uses PE files.
105 *
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100106 * Details: http://gcc.gnu.org/wiki/Visibility
107 */
108
109/* Marks public libsigrokdecode API symbols. */
Uwe Hermanna4cb05f2012-04-16 23:16:00 +0200110#ifndef _WIN32
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100111#define SRD_API __attribute__((visibility("default")))
Uwe Hermanna4cb05f2012-04-16 23:16:00 +0200112#else
113#define SRD_API
114#endif
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100115
116/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
Uwe Hermanna4cb05f2012-04-16 23:16:00 +0200117#ifndef _WIN32
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100118#define SRD_PRIV __attribute__((visibility("hidden")))
Uwe Hermanna4cb05f2012-04-16 23:16:00 +0200119#else
120#define SRD_PRIV
121#endif
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100122
123/*
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100124 * When adding an output type, don't forget to...
125 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
126 * - add a check in module_sigrokdecode.c:Decoder_put()
127 * - add a debug string in type_decoder.c:OUTPUT_TYPES
128 */
Bert Vermeulene5080882011-12-07 09:56:49 +0100129enum {
Uwe Hermann94d43b32012-01-10 20:44:22 +0100130 SRD_OUTPUT_ANN,
Bert Vermeulenf2a5df42013-11-05 11:21:33 +0100131 SRD_OUTPUT_PYTHON,
Bert Vermeulen15969942012-01-07 02:50:14 +0100132 SRD_OUTPUT_BINARY,
Bert Vermeulen7ee0c402013-11-14 00:19:28 +0100133 SRD_OUTPUT_META,
Bert Vermeulene5080882011-12-07 09:56:49 +0100134};
135
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200136enum {
Bert Vermeulened416492013-10-30 16:30:05 +0100137 SRD_CONF_SAMPLERATE = 10000,
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200138};
139
Uwe Hermannd752b122011-01-29 15:41:39 +0100140struct srd_decoder {
Uwe Hermann775dda72011-02-09 00:01:02 +0100141 /** The decoder ID. Must be non-NULL and unique for all decoders. */
unknown31b82282010-04-23 18:49:17 +0200142 char *id;
Uwe Hermann775dda72011-02-09 00:01:02 +0100143
Uwe Hermann361fdca2012-03-15 22:00:24 +0100144 /** The (short) decoder name. Must be non-NULL. */
unknown31b82282010-04-23 18:49:17 +0200145 char *name;
Uwe Hermann775dda72011-02-09 00:01:02 +0100146
Uwe Hermann122e9a92012-03-25 09:39:44 +0200147 /** The (long) decoder name. Must be non-NULL. */
Uwe Hermann75a282e2011-02-06 17:36:32 +0100148 char *longname;
Uwe Hermann775dda72011-02-09 00:01:02 +0100149
Uwe Hermann361fdca2012-03-15 22:00:24 +0100150 /** A (short, one-line) description of the decoder. Must be non-NULL. */
Uwe Hermann5c550172010-04-24 01:04:20 +0200151 char *desc;
Uwe Hermann775dda72011-02-09 00:01:02 +0100152
Uwe Hermann361fdca2012-03-15 22:00:24 +0100153 /**
154 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
155 * Other values are currently not allowed. Must be non-NULL.
156 */
Uwe Hermann75a282e2011-02-06 17:36:32 +0100157 char *license;
158
Uwe Hermann361fdca2012-03-15 22:00:24 +0100159 /** List of probes required by this decoder. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100160 GSList *probes;
161
Uwe Hermann361fdca2012-03-15 22:00:24 +0100162 /** List of optional probes for this decoder. */
Bert Vermeulendcdf4882012-02-01 00:07:55 +0100163 GSList *opt_probes;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100164
Uwe Hermann361fdca2012-03-15 22:00:24 +0100165 /**
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100166 * List of NULL-terminated char[], containing descriptions of the
Bert Vermeulen15969942012-01-07 02:50:14 +0100167 * supported annotation output.
168 */
Uwe Hermanne97b6ef2012-01-10 21:05:09 +0100169 GSList *annotations;
Bert Vermeulen15969942012-01-07 02:50:14 +0100170
Bert Vermeulend75d8a72013-11-10 12:42:11 +0100171 /**
172 * List of NULL-terminated char[], containing descriptions of the
173 * supported binary output.
174 */
175 GSList *binary;
176
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100177 /** List of decoder options. */
178 GSList *options;
179
Uwe Hermann361fdca2012-03-15 22:00:24 +0100180 /** Python module. */
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100181 PyObject *py_mod;
182
Uwe Hermann361fdca2012-03-15 22:00:24 +0100183 /** sigrokdecode.Decoder class. */
Bert Vermeulen451680f2012-01-15 03:58:27 +0100184 PyObject *py_dec;
Gareth McMullin74911b42011-11-20 16:30:38 +1300185};
186
Uwe Hermann361fdca2012-03-15 22:00:24 +0100187/**
188 * Structure which contains information about one protocol decoder probe.
189 * For example, I2C has two probes, SDA and SCL.
190 */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100191struct srd_probe {
Uwe Hermann361fdca2012-03-15 22:00:24 +0100192 /** The ID of the probe. Must be non-NULL. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100193 char *id;
Uwe Hermann361fdca2012-03-15 22:00:24 +0100194 /** The name of the probe. Must not be NULL. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100195 char *name;
Uwe Hermann361fdca2012-03-15 22:00:24 +0100196 /** The description of the probe. Must not be NULL. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100197 char *desc;
Uwe Hermann361fdca2012-03-15 22:00:24 +0100198 /** The index of the probe, i.e. its order in the list of probes. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100199 int order;
200};
201
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100202struct srd_decoder_option {
203 char *id;
204 char *desc;
205 GVariant *def;
206};
207
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100208struct srd_decoder_inst {
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100209 struct srd_decoder *decoder;
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200210 struct srd_session *sess;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100211 PyObject *py_inst;
212 char *inst_id;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100213 GSList *pd_output;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100214 int dec_num_probes;
215 int *dec_probemap;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100216 int data_unitsize;
Bert Vermeulen37b94c22013-11-26 16:05:54 +0100217 uint8_t *probe_samples;
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100218 GSList *next_di;
unknown31b82282010-04-23 18:49:17 +0200219};
220
Bert Vermeulene5080882011-12-07 09:56:49 +0100221struct srd_pd_output {
222 int pdo_id;
223 int output_type;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100224 struct srd_decoder_inst *di;
Uwe Hermann94d43b32012-01-10 20:44:22 +0100225 char *proto_id;
Bert Vermeulen7ee0c402013-11-14 00:19:28 +0100226 /* Only used for OUTPUT_META. */
227 const GVariantType *meta_type;
228 char *meta_name;
229 char *meta_descr;
Bert Vermeulene5080882011-12-07 09:56:49 +0100230};
231
Uwe Hermann94d43b32012-01-10 20:44:22 +0100232struct srd_proto_data {
Bert Vermeulen15969942012-01-07 02:50:14 +0100233 uint64_t start_sample;
234 uint64_t end_sample;
235 struct srd_pd_output *pdo;
Bert Vermeulen983cb0f2012-01-08 03:20:12 +0100236 void *data;
Bert Vermeulen15969942012-01-07 02:50:14 +0100237};
Bert Vermeulen0b922462013-11-07 22:38:47 +0100238struct srd_proto_data_annotation {
239 int ann_format;
240 char **ann_text;
241};
Bert Vermeulend75d8a72013-11-10 12:42:11 +0100242struct srd_proto_data_binary {
243 int bin_class;
244 uint64_t size;
245 const unsigned char *data;
246};
Bert Vermeulen15969942012-01-07 02:50:14 +0100247
Uwe Hermannae53d0a2012-02-11 22:38:17 +0100248typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
Uwe Hermann41a5d962012-02-29 22:32:34 +0100249 void *cb_data);
Uwe Hermannae53d0a2012-02-11 22:38:17 +0100250
Bert Vermeulen983cb0f2012-01-08 03:20:12 +0100251struct srd_pd_callback {
252 int output_type;
Uwe Hermann4c1d0672012-02-29 21:56:24 +0100253 srd_pd_output_callback_t cb;
Uwe Hermann41a5d962012-02-29 22:32:34 +0100254 void *cb_data;
Bert Vermeulen983cb0f2012-01-08 03:20:12 +0100255};
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100256
Uwe Hermann361fdca2012-03-15 22:00:24 +0100257/* Custom Python types: */
258
Bert Vermeulenf8e45852012-01-15 03:43:01 +0100259typedef struct {
260 PyObject_HEAD
261} srd_Decoder;
Uwe Hermann43c0a642011-12-21 18:57:04 +0100262
Bert Vermeulenf8e45852012-01-15 03:43:01 +0100263typedef struct {
264 PyObject_HEAD
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100265 struct srd_decoder_inst *di;
Bert Vermeulen86528292012-01-15 23:20:39 +0100266 uint64_t start_samplenum;
Bert Vermeulenf8e45852012-01-15 03:43:01 +0100267 unsigned int itercnt;
268 uint8_t *inbuf;
269 uint64_t inbuflen;
270 PyObject *sample;
271} srd_logic;
272
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100273
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100274/* srd.c */
Uwe Hermannabeeed82012-03-16 15:12:54 +0100275SRD_API int srd_init(const char *path);
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100276SRD_API int srd_exit(void);
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100277
278/* session.c */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200279SRD_API int srd_session_new(struct srd_session **sess);
280SRD_API int srd_session_start(struct srd_session *sess);
Bert Vermeulened416492013-10-30 16:30:05 +0100281SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200282 GVariant *data);
283SRD_API int srd_session_send(struct srd_session *sess,
Bert Vermeulened416492013-10-30 16:30:05 +0100284 uint64_t start_samplenum, uint64_t end_samplenum,
285 const uint8_t *inbuf, uint64_t inbuflen);
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200286SRD_API int srd_session_destroy(struct srd_session *sess);
287SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
288 int output_type, srd_pd_output_callback_t cb, void *cb_data);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100289
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100290/* decoder.c */
Uwe Hermann38ff5042013-02-02 12:18:29 +0100291SRD_API const GSList *srd_decoder_list(void);
Bert Vermeulen9d122fd2012-02-14 03:43:28 +0100292SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
293SRD_API int srd_decoder_load(const char *name);
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100294SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
Bert Vermeulen9d122fd2012-02-14 03:43:28 +0100295SRD_API int srd_decoder_unload(struct srd_decoder *dec);
Uwe Hermann8ad6e502012-03-16 15:25:53 +0100296SRD_API int srd_decoder_load_all(void);
297SRD_API int srd_decoder_unload_all(void);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100298
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100299/* instance.c */
300SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
301 GHashTable *options);
302SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
303 GHashTable *probes);
304SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
305 const char *id, GHashTable *options);
306SRD_API int srd_inst_stack(struct srd_session *sess,
307 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
308SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
309 const char *inst_id);
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100310
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100311/* log.c */
Uwe Hermann0082d592012-03-03 14:13:21 +0100312typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
313 const char *format, va_list args);
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100314SRD_API int srd_log_loglevel_set(int loglevel);
315SRD_API int srd_log_loglevel_get(void);
Uwe Hermann0082d592012-03-03 14:13:21 +0100316SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
317SRD_API int srd_log_callback_set_default(void);
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100318SRD_API int srd_log_logdomain_set(const char *logdomain);
319SRD_API char *srd_log_logdomain_get(void);
Uwe Hermann1c6fa202010-04-02 20:18:27 +0200320
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100321/* error.c */
322SRD_API const char *srd_strerror(int error_code);
323SRD_API const char *srd_strerror_name(int error_code);
Uwe Hermann0c081c62012-04-15 20:58:08 +0200324
Bert Vermeulen909fbf42013-11-18 01:14:02 +0100325/* version.c */
Uwe Hermann0c081c62012-04-15 20:58:08 +0200326SRD_API int srd_package_version_major_get(void);
327SRD_API int srd_package_version_minor_get(void);
328SRD_API int srd_package_version_micro_get(void);
329SRD_API const char *srd_package_version_string_get(void);
Uwe Hermann0c081c62012-04-15 20:58:08 +0200330SRD_API int srd_lib_version_current_get(void);
331SRD_API int srd_lib_version_revision_get(void);
332SRD_API int srd_lib_version_age_get(void);
333SRD_API const char *srd_lib_version_string_get(void);
334
Bert Vermeulen2b628af2013-11-15 23:37:47 +0100335#include "version.h"
336
Uwe Hermann253f9602011-01-20 23:00:59 +0100337#ifdef __cplusplus
338}
339#endif
340
Uwe Hermann1c6fa202010-04-02 20:18:27 +0200341#endif