[libsigrokdecode.git] / sigrokdecode.h

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

/*
 * 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 SR_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).
 *
 * Details: http://gcc.gnu.org/wiki/Visibility
 */

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

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

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

	/** Probes */
	GSList *probes;

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

struct srd_probe {
	char *id;
	char *name;
	char *desc;
	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 *user_data);

struct srd_pd_callback {
	int output_type;
	srd_pd_output_callback_t callback;
	void *user_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(char *path);
SRD_API int srd_exit(void);
SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
				     GHashTable *options);
SRD_API int srd_inst_probes_set(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(char *inst_id);
SRD_API int srd_session_start(int num_probes, int unitsize,
			      uint64_t samplerate);
SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
			     uint64_t inbuflen);
SRD_API int srd_register_callback(int output_type,
				  srd_pd_output_callback_t cb, void *user_data);

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

SRD_API GSList *srd_decoders_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_decoders_load_all(void);
SRD_API int srd_decoders_unload_all(void);
SRD_API char *srd_decoder_doc(struct srd_decoder *dec);

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

typedef int (*srd_log_handler_t)(void *user_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_handler_set(srd_log_handler_t handler, void *user_data);
SRD_API int srd_log_handler_set_default(void);
SRD_API int srd_log_logdomain_set(const char *logdomain);
SRD_API char *srd_log_logdomain_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	* Status/error codes returned by libsigrokdecode functions.
	35	*
	36	* All possible return codes of libsigrokdecode functions must be listed here.
	37	* Functions should never return hardcoded numbers as status, but rather
	38	* use these #defines instead. All error codes are negative numbers.
	39	*
	40	* The error codes are globally unique in libsigrokdecode, i.e. if one of the
	41	* libsigrokdecode functions returns a "malloc error" it must be exactly the
	42	* same return value as used by all other functions to indicate "malloc error".
	43	* There must be no functions which indicate two different errors via the
	44	* same return code.
	45	*
	46	* Also, for compatibility reasons, no defined return codes are ever removed
	47	* or reused for different #defines later. You can only add new #defines and
	48	* return codes, but never remove or redefine existing ones.
	49	*/
	50	#define SRD_OK 0 /*< No error /
	51	#define SRD_ERR -1 /*< Generic/unspecified error /
	52	#define SRD_ERR_MALLOC -2 /*< Malloc/calloc/realloc error /
	53	#define SRD_ERR_ARG -3 /*< Function argument error /
	54	#define SRD_ERR_BUG -4 /*< Errors hinting at internal bugs /
	55	#define SRD_ERR_PYTHON -5 /*< Python C API error /
	56	#define SRD_ERR_DECODERS_DIR -6 /*< Protocol decoder path invalid /
	57
	58	/* libsigrokdecode loglevels. */
	59	#define SRD_LOG_NONE 0 /*< Output no messages at all. /
	60	#define SRD_LOG_ERR 1 /*< Output error messages. /
	61	#define SRD_LOG_WARN 2 /*< Output warnings. /
	62	#define SRD_LOG_INFO 3 /*< Output informational messages. /
	63	#define SRD_LOG_DBG 4 /*< Output debug messages. /
	64	#define SRD_LOG_SPEW 5 /*< Output very noisy debug messages. /
	65
	66	/*
	67	* Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
	68	*
	69	* Variables and functions marked 'static' are private already and don't
	70	* need SR_PRIV. However, functions which are not static (because they need
	71	* to be used in other libsigrokdecode-internal files) but are also not
	72	* meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
	73	*
	74	* This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
	75	*
	76	* Details: http://gcc.gnu.org/wiki/Visibility
	77	*/
	78
	79	/* Marks public libsigrokdecode API symbols. */
	80	#define SRD_API __attribute__((visibility("default")))
	81
	82	/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
	83	#define SRD_PRIV __attribute__((visibility("hidden")))
	84
	85	/*
	86	* When adding an output type, don't forget to...
	87	* - expose it to PDs in controller.c:PyInit_sigrokdecode()
	88	* - add a check in module_sigrokdecode.c:Decoder_put()
	89	* - add a debug string in type_decoder.c:OUTPUT_TYPES
	90	*/
	91	enum {
	92	SRD_OUTPUT_ANN,
	93	SRD_OUTPUT_PROTO,
	94	SRD_OUTPUT_BINARY,
	95	};
	96
	97	#define SRD_MAX_NUM_PROBES 64
	98
	99	/* TODO: Documentation. */
	100	struct srd_decoder {
	101	/** The decoder ID. Must be non-NULL and unique for all decoders. */
	102	char *id;
	103
	104	/** The (short) decoder name. */
	105	char *name;
	106
	107	/** The (long) decoder name. May be NULL. */
	108	char *longname;
	109
	110	/** A (short, one-line) description of the decoder. */
	111	char *desc;
	112
	113	/** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
	114	char *license;
	115
	116	/** TODO */
	117	GSList *inputformats;
	118
	119	/** TODO */
	120	GSList *outputformats;
	121
	122	/** Probes */
	123	GSList *probes;
	124
	125	/** Optional probes */
	126	GSList *opt_probes;
	127
	128	/*
	129	* List of NULL-terminated char[], containing descriptions of the
	130	* supported annotation output.
	131	*/
	132	GSList *annotations;
	133
	134	/** Python module */
	135	PyObject *py_mod;
	136
	137	/** sigrokdecode.Decoder class */
	138	PyObject *py_dec;
	139	};
	140
	141	struct srd_probe {
	142	char *id;
	143	char *name;
	144	char *desc;
	145	int order;
	146	};
	147
	148	struct srd_decoder_inst {
	149	struct srd_decoder *decoder;
	150	PyObject *py_inst;
	151	char *inst_id;
	152	GSList *pd_output;
	153	int dec_num_probes;
	154	int *dec_probemap;
	155	int data_num_probes;
	156	int data_unitsize;
	157	uint64_t data_samplerate;
	158	GSList *next_di;
	159	};
	160
	161	struct srd_pd_output {
	162	int pdo_id;
	163	int output_type;
	164	struct srd_decoder_inst *di;
	165	char *proto_id;
	166	};
	167
	168	struct srd_proto_data {
	169	uint64_t start_sample;
	170	uint64_t end_sample;
	171	struct srd_pd_output *pdo;
	172	int ann_format;
	173	void *data;
	174	};
	175
	176	typedef void (srd_pd_output_callback_t)(struct srd_proto_data pdata,
	177	void *user_data);
	178
	179	struct srd_pd_callback {
	180	int output_type;
	181	srd_pd_output_callback_t callback;
	182	void *user_data;
	183	};
	184
	185	/* custom python types */
	186	typedef struct {
	187	PyObject_HEAD
	188	} srd_Decoder;
	189
	190	typedef struct {
	191	PyObject_HEAD
	192	struct srd_decoder_inst *di;
	193	uint64_t start_samplenum;
	194	unsigned int itercnt;
	195	uint8_t *inbuf;
	196	uint64_t inbuflen;
	197	PyObject *sample;
	198	} srd_logic;
	199
	200	/--- controller.c ----------------------------------------------------------/
	201
	202	SRD_API int srd_init(char *path);
	203	SRD_API int srd_exit(void);
	204	SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
	205	GHashTable *options);
	206	SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
	207	GHashTable *probes);
	208	SRD_API struct srd_decoder_inst srd_inst_new(const char id,
	209	GHashTable *options);
	210	SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
	211	struct srd_decoder_inst *di_to);
	212	SRD_API struct srd_decoder_inst srd_inst_find_by_id(char inst_id);
	213	SRD_API int srd_session_start(int num_probes, int unitsize,
	214	uint64_t samplerate);
	215	SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
	216	uint64_t inbuflen);
	217	SRD_API int srd_register_callback(int output_type,
	218	srd_pd_output_callback_t cb, void *user_data);
	219
	220	/--- decoder.c -------------------------------------------------------------/
	221
	222	SRD_API GSList *srd_decoders_list(void);
	223	SRD_API struct srd_decoder srd_decoder_get_by_id(const char id);
	224	SRD_API int srd_decoder_load(const char *name);
	225	SRD_API int srd_decoder_unload(struct srd_decoder *dec);
	226	SRD_API int srd_decoders_load_all(void);
	227	SRD_API int srd_decoders_unload_all(void);
	228	SRD_API char srd_decoder_doc(struct srd_decoder dec);
	229
	230	/--- log.c -----------------------------------------------------------------/
	231
	232	typedef int (srd_log_handler_t)(void user_data, int loglevel,
	233	const char *format, va_list args);
	234
	235	SRD_API int srd_log_loglevel_set(int loglevel);
	236	SRD_API int srd_log_loglevel_get(void);
	237	SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *user_data);
	238	SRD_API int srd_log_handler_set_default(void);
	239	SRD_API int srd_log_logdomain_set(const char *logdomain);
	240	SRD_API char *srd_log_logdomain_get(void);
	241
	242	#ifdef __cplusplus
	243	}
	244	#endif
	245
	246	#endif