[libsigrokdecode.git] / sigrokdecode.h.in

/*
 * 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 LIBSIGROKDECODE_SIGROKDECODE_H
#define LIBSIGROKDECODE_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

/**
 * @file
 *
 * The public libsigrokdecode header file to be used by frontends.
 *
 * This is the only file that libsigrokdecode users (frontends) are supposed
 * to use and include. There are other header files which get installed with
 * libsigrokdecode, but those are not meant to be used directly by frontends.
 *
 * The correct way to get/use the libsigrokdecode API functions is:
 *
 * @code{.c}
 *   #include <sigrokdecode.h>
 * @endcode
 */

/*
 * Package version macros (can be used for conditional compilation).
 */

/** The libsigrokdecode package 'major' version number. */
#define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@

/** The libsigrokdecode package 'minor' version number. */
#define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@

/** The libsigrokdecode package 'micro' version number. */
#define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@

/** The libsigrokdecode package version ("major.minor.micro") as string. */
#define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"

/*
 * Library/libtool version macros (can be used for conditional compilation).
 */

/** The libsigrokdecode libtool 'current' version number. */
#define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@

/** The libsigrokdecode libtool 'revision' version number. */
#define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@

/** The libsigrokdecode libtool 'age' version number. */
#define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@

/** The libsigrokdecode libtool version ("current:revision:age") as string. */
#define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"

/*
 * 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. */

/*
 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
 *
 * Variables and functions marked 'static' are private already and don't
 * need SRD_PRIV. However, functions which are not static (because they need
 * to be used in other libsigrokdecode-internal files) but are also not
 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
 *
 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 *
 * This feature is not available on MinGW/Windows, as it is a feature of
 * ELF files and MinGW/Windows uses PE files.
 *
 * Details: http://gcc.gnu.org/wiki/Visibility
 */

/* Marks public libsigrokdecode API symbols. */
#ifndef _WIN32
#define SRD_API __attribute__((visibility("default")))
#else
#define SRD_API
#endif

/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
#ifndef _WIN32
#define SRD_PRIV __attribute__((visibility("hidden")))
#else
#define SRD_PRIV
#endif

/*
 * When adding an output type, don't forget to...
 *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
 *   - add a check in module_sigrokdecode.c:Decoder_put()
 *   - add a debug string in type_decoder.c:OUTPUT_TYPES
 */
enum {
	SRD_OUTPUT_ANN,
	SRD_OUTPUT_PROTO,
	SRD_OUTPUT_BINARY,
};

#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. Must be non-NULL. */
	char *name;

	/** The (long) decoder name. Must be non-NULL. */
	char *longname;

	/** A (short, one-line) description of the decoder. Must be non-NULL. */
	char *desc;

	/**
	 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
	 * Other values are currently not allowed. Must be non-NULL.
	 */
	char *license;

	/** List of probes required by this decoder. */
	GSList *probes;

	/** List of optional probes for this decoder. */
	GSList *opt_probes;

	/**
	 * 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;
};

/**
 * Structure which contains information about one protocol decoder probe.
 * For example, I2C has two probes, SDA and SCL.
 */
struct srd_probe {
	/** The ID of the probe. Must be non-NULL. */
	char *id;
	/** The name of the probe. Must not be NULL. */
	char *name;
	/** The description of the probe. Must not be NULL. */
	char *desc;
	/** The index of the probe, i.e. its order in the list of probes. */
	int order;
};

struct srd_decoder_inst {
	struct srd_decoder *decoder;
	PyObject *py_inst;
	char *inst_id;
	GSList *pd_output;
	int dec_num_probes;
	int *dec_probemap;
	int data_num_probes;
	int data_unitsize;
	uint64_t data_samplerate;
	GSList *next_di;
};

struct srd_pd_output {
	int pdo_id;
	int output_type;
	struct srd_decoder_inst *di;
	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;
};

typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
					 void *cb_data);

struct srd_pd_callback {
	int output_type;
	srd_pd_output_callback_t cb;
	void *cb_data;
};

/* Custom Python types: */

typedef struct {
	PyObject_HEAD
} srd_Decoder;

typedef struct {
	PyObject_HEAD
	struct srd_decoder_inst *di;
	uint64_t start_samplenum;
	unsigned int itercnt;
	uint8_t *inbuf;
	uint64_t inbuflen;
	PyObject *sample;
} srd_logic;

/*--- controller.c ----------------------------------------------------------*/

SRD_API int srd_init(const char *path);
SRD_API int srd_exit(void);
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
				GHashTable *options);
SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
				   GHashTable *probes);
SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
					      GHashTable *options);
SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
			   struct srd_decoder_inst *di_to);
SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
SRD_API int srd_session_start(int num_probes, int unitsize,
			      uint64_t samplerate);
SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
			     uint64_t inbuflen);
SRD_API int srd_pd_output_callback_add(int output_type,
				srd_pd_output_callback_t cb, void *cb_data);

/*--- decoder.c -------------------------------------------------------------*/

SRD_API const GSList *srd_decoder_list(void);
SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
SRD_API int srd_decoder_load(const char *name);
SRD_API int srd_decoder_unload(struct srd_decoder *dec);
SRD_API int srd_decoder_load_all(void);
SRD_API int srd_decoder_unload_all(void);
SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);

/*--- log.c -----------------------------------------------------------------*/

typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
				  const char *format, va_list args);

SRD_API int srd_log_loglevel_set(int loglevel);
SRD_API int srd_log_loglevel_get(void);
SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
SRD_API int srd_log_callback_set_default(void);
SRD_API int srd_log_logdomain_set(const char *logdomain);
SRD_API char *srd_log_logdomain_get(void);

/*--- version.c -------------------------------------------------------------*/

SRD_API int srd_package_version_major_get(void);
SRD_API int srd_package_version_minor_get(void);
SRD_API int srd_package_version_micro_get(void);
SRD_API const char *srd_package_version_string_get(void);

SRD_API int srd_lib_version_current_get(void);
SRD_API int srd_lib_version_revision_get(void);
SRD_API int srd_lib_version_age_get(void);
SRD_API const char *srd_lib_version_string_get(void);

#ifdef __cplusplus
}
#endif

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
	5	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
	6	*
	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
	22	#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
	23	#define LIBSIGROKDECODE_SIGROKDECODE_H
	24
	25	#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
	26	#include <stdint.h>
	27	#include <glib.h>
	28
	29	#ifdef __cplusplus
	30	extern "C" {
	31	#endif
	32
	33	/**
	34	* @file
	35	*
	36	* The public libsigrokdecode header file to be used by frontends.
	37	*
	38	* This is the only file that libsigrokdecode users (frontends) are supposed
	39	* to use and include. There are other header files which get installed with
	40	* libsigrokdecode, but those are not meant to be used directly by frontends.
	41	*
	42	* The correct way to get/use the libsigrokdecode API functions is:
	43	*
	44	* @code{.c}
	45	* #include <sigrokdecode.h>
	46	* @endcode
	47	*/
	48
	49	/*
	50	* Package version macros (can be used for conditional compilation).
	51	*/
	52
	53	/** The libsigrokdecode package 'major' version number. */
	54	#define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
	55
	56	/** The libsigrokdecode package 'minor' version number. */
	57	#define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
	58
	59	/** The libsigrokdecode package 'micro' version number. */
	60	#define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
	61
	62	/** The libsigrokdecode package version ("major.minor.micro") as string. */
	63	#define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
	64
	65	/*
	66	* Library/libtool version macros (can be used for conditional compilation).
	67	*/
	68
	69	/** The libsigrokdecode libtool 'current' version number. */
	70	#define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
	71
	72	/** The libsigrokdecode libtool 'revision' version number. */
	73	#define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
	74
	75	/** The libsigrokdecode libtool 'age' version number. */
	76	#define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
	77
	78	/** The libsigrokdecode libtool version ("current:revision:age") as string. */
	79	#define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
	80
	81	/*
	82	* Status/error codes returned by libsigrokdecode functions.
	83	*
	84	* All possible return codes of libsigrokdecode functions must be listed here.
	85	* Functions should never return hardcoded numbers as status, but rather
	86	* use these #defines instead. All error codes are negative numbers.
	87	*
	88	* The error codes are globally unique in libsigrokdecode, i.e. if one of the
	89	* libsigrokdecode functions returns a "malloc error" it must be exactly the
	90	* same return value as used by all other functions to indicate "malloc error".
	91	* There must be no functions which indicate two different errors via the
	92	* same return code.
	93	*
	94	* Also, for compatibility reasons, no defined return codes are ever removed
	95	* or reused for different #defines later. You can only add new #defines and
	96	* return codes, but never remove or redefine existing ones.
	97	*/
	98	#define SRD_OK 0 /*< No error /
	99	#define SRD_ERR -1 /*< Generic/unspecified error /
	100	#define SRD_ERR_MALLOC -2 /*< Malloc/calloc/realloc error /
	101	#define SRD_ERR_ARG -3 /*< Function argument error /
	102	#define SRD_ERR_BUG -4 /*< Errors hinting at internal bugs /
	103	#define SRD_ERR_PYTHON -5 /*< Python C API error /
	104	#define SRD_ERR_DECODERS_DIR -6 /*< Protocol decoder path invalid /
	105
	106	/* libsigrokdecode loglevels. */
	107	#define SRD_LOG_NONE 0 /*< Output no messages at all. /
	108	#define SRD_LOG_ERR 1 /*< Output error messages. /
	109	#define SRD_LOG_WARN 2 /*< Output warnings. /
	110	#define SRD_LOG_INFO 3 /*< Output informational messages. /
	111	#define SRD_LOG_DBG 4 /*< Output debug messages. /
	112	#define SRD_LOG_SPEW 5 /*< Output very noisy debug messages. /
	113
	114	/*
	115	* Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
	116	*
	117	* Variables and functions marked 'static' are private already and don't
	118	* need SRD_PRIV. However, functions which are not static (because they need
	119	* to be used in other libsigrokdecode-internal files) but are also not
	120	* meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
	121	*
	122	* This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
	123	*
	124	* This feature is not available on MinGW/Windows, as it is a feature of
	125	* ELF files and MinGW/Windows uses PE files.
	126	*
	127	* Details: http://gcc.gnu.org/wiki/Visibility
	128	*/
	129
	130	/* Marks public libsigrokdecode API symbols. */
	131	#ifndef _WIN32
	132	#define SRD_API __attribute__((visibility("default")))
	133	#else
	134	#define SRD_API
	135	#endif
	136
	137	/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
	138	#ifndef _WIN32
	139	#define SRD_PRIV __attribute__((visibility("hidden")))
	140	#else
	141	#define SRD_PRIV
	142	#endif
	143
	144	/*
	145	* When adding an output type, don't forget to...
	146	* - expose it to PDs in controller.c:PyInit_sigrokdecode()
	147	* - add a check in module_sigrokdecode.c:Decoder_put()
	148	* - add a debug string in type_decoder.c:OUTPUT_TYPES
	149	*/
	150	enum {
	151	SRD_OUTPUT_ANN,
	152	SRD_OUTPUT_PROTO,
	153	SRD_OUTPUT_BINARY,
	154	};
	155
	156	#define SRD_MAX_NUM_PROBES 64
	157
	158	/* TODO: Documentation. */
	159	struct srd_decoder {
	160	/** The decoder ID. Must be non-NULL and unique for all decoders. */
	161	char *id;
	162
	163	/** The (short) decoder name. Must be non-NULL. */
	164	char *name;
	165
	166	/** The (long) decoder name. Must be non-NULL. */
	167	char *longname;
	168
	169	/** A (short, one-line) description of the decoder. Must be non-NULL. */
	170	char *desc;
	171
	172	/**
	173	* The license of the decoder. Valid values: "gplv2+", "gplv3+".
	174	* Other values are currently not allowed. Must be non-NULL.
	175	*/
	176	char *license;
	177
	178	/** List of probes required by this decoder. */
	179	GSList *probes;
	180
	181	/** List of optional probes for this decoder. */
	182	GSList *opt_probes;
	183
	184	/**
	185	* List of NULL-terminated char[], containing descriptions of the
	186	* supported annotation output.
	187	*/
	188	GSList *annotations;
	189
	190	/** Python module. */
	191	PyObject *py_mod;
	192
	193	/** sigrokdecode.Decoder class. */
	194	PyObject *py_dec;
	195	};
	196
	197	/**
	198	* Structure which contains information about one protocol decoder probe.
	199	* For example, I2C has two probes, SDA and SCL.
	200	*/
	201	struct srd_probe {
	202	/** The ID of the probe. Must be non-NULL. */
	203	char *id;
	204	/** The name of the probe. Must not be NULL. */
	205	char *name;
	206	/** The description of the probe. Must not be NULL. */
	207	char *desc;
	208	/** The index of the probe, i.e. its order in the list of probes. */
	209	int order;
	210	};
	211
	212	struct srd_decoder_inst {
	213	struct srd_decoder *decoder;
	214	PyObject *py_inst;
	215	char *inst_id;
	216	GSList *pd_output;
	217	int dec_num_probes;
	218	int *dec_probemap;
	219	int data_num_probes;
	220	int data_unitsize;
	221	uint64_t data_samplerate;
	222	GSList *next_di;
	223	};
	224
	225	struct srd_pd_output {
	226	int pdo_id;
	227	int output_type;
	228	struct srd_decoder_inst *di;
	229	char *proto_id;
	230	};
	231
	232	struct srd_proto_data {
	233	uint64_t start_sample;
	234	uint64_t end_sample;
	235	struct srd_pd_output *pdo;
	236	int ann_format;
	237	void *data;
	238	};
	239
	240	typedef void (srd_pd_output_callback_t)(struct srd_proto_data pdata,
	241	void *cb_data);
	242
	243	struct srd_pd_callback {
	244	int output_type;
	245	srd_pd_output_callback_t cb;
	246	void *cb_data;
	247	};
	248
	249	/* Custom Python types: */
	250
	251	typedef struct {
	252	PyObject_HEAD
	253	} srd_Decoder;
	254
	255	typedef struct {
	256	PyObject_HEAD
	257	struct srd_decoder_inst *di;
	258	uint64_t start_samplenum;
	259	unsigned int itercnt;
	260	uint8_t *inbuf;
	261	uint64_t inbuflen;
	262	PyObject *sample;
	263	} srd_logic;
	264
	265	/--- controller.c ----------------------------------------------------------/
	266
	267	SRD_API int srd_init(const char *path);
	268	SRD_API int srd_exit(void);
	269	SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
	270	GHashTable *options);
	271	SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
	272	GHashTable *probes);
	273	SRD_API struct srd_decoder_inst srd_inst_new(const char id,
	274	GHashTable *options);
	275	SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
	276	struct srd_decoder_inst *di_to);
	277	SRD_API struct srd_decoder_inst srd_inst_find_by_id(const char inst_id);
	278	SRD_API int srd_session_start(int num_probes, int unitsize,
	279	uint64_t samplerate);
	280	SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
	281	uint64_t inbuflen);
	282	SRD_API int srd_pd_output_callback_add(int output_type,
	283	srd_pd_output_callback_t cb, void *cb_data);
	284
	285	/--- decoder.c -------------------------------------------------------------/
	286
	287	SRD_API const GSList *srd_decoder_list(void);
	288	SRD_API struct srd_decoder srd_decoder_get_by_id(const char id);
	289	SRD_API int srd_decoder_load(const char *name);
	290	SRD_API int srd_decoder_unload(struct srd_decoder *dec);
	291	SRD_API int srd_decoder_load_all(void);
	292	SRD_API int srd_decoder_unload_all(void);
	293	SRD_API char srd_decoder_doc_get(const struct srd_decoder dec);
	294
	295	/--- log.c -----------------------------------------------------------------/
	296
	297	typedef int (srd_log_callback_t)(void cb_data, int loglevel,
	298	const char *format, va_list args);
	299
	300	SRD_API int srd_log_loglevel_set(int loglevel);
	301	SRD_API int srd_log_loglevel_get(void);
	302	SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
	303	SRD_API int srd_log_callback_set_default(void);
	304	SRD_API int srd_log_logdomain_set(const char *logdomain);
	305	SRD_API char *srd_log_logdomain_get(void);
	306
	307	/--- version.c -------------------------------------------------------------/
	308
	309	SRD_API int srd_package_version_major_get(void);
	310	SRD_API int srd_package_version_minor_get(void);
	311	SRD_API int srd_package_version_micro_get(void);
	312	SRD_API const char *srd_package_version_string_get(void);
	313
	314	SRD_API int srd_lib_version_current_get(void);
	315	SRD_API int srd_lib_version_revision_get(void);
	316	SRD_API int srd_lib_version_age_get(void);
	317	SRD_API const char *srd_lib_version_string_get(void);
	318
	319	#ifdef __cplusplus
	320	}
	321	#endif
	322
	323	#endif