* 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
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
-#define LIBSIGROKDECODE_SIGROKDECODE_H
+#ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
+#define LIBSIGROKDECODE_LIBSIGROKDECODE_H
#include <stdint.h>
#include <glib.h>
SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */
SRD_ERR_PYTHON = -5, /**< Python C API error */
SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
+ SRD_ERR_TERM_REQ = -7, /**< Termination requested */
/*
* Note: When adding entries here, don't forget to also update the
*/
/* Marks public libsigrokdecode API symbols. */
-#ifndef _WIN32
-#define SRD_API __attribute__((visibility("default")))
+#if defined _WIN32
+# if defined DLL_EXPORT
+# define SRD_API __declspec(dllexport)
+# else
+# define SRD_API extern
+# endif
#else
-#define SRD_API
+# define SRD_API __attribute__((visibility("default")))
#endif
/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
-#ifndef _WIN32
-#define SRD_PRIV __attribute__((visibility("hidden")))
+#if defined _WIN32
+# define SRD_PRIV /* EMPTY */
#else
-#define SRD_PRIV
+# define SRD_PRIV __attribute__((visibility("hidden")))
#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
+ * - expose it to PDs in module_sigrokdecode.c:PyInit_sigrokdecode()
+ * - add a check in type_decoder.c:Decoder_put()
+ * - add a debug string in type_decoder.c:output_type_name()
*/
enum srd_output_type {
SRD_OUTPUT_ANN,
SRD_OUTPUT_PYTHON,
SRD_OUTPUT_BINARY,
+ SRD_OUTPUT_LOGIC,
SRD_OUTPUT_META,
};
*/
char *license;
+ /** List of possible decoder input IDs. */
+ GSList *inputs;
+
+ /** List of possible decoder output IDs. */
+ GSList *outputs;
+
+ /** List of tags associated with this decoder. */
+ GSList *tags;
+
/** List of channels required by this decoder. */
GSList *channels;
GSList *opt_channels;
/**
- * List of NULL-terminated char[], containing descriptions of the
- * supported annotation output.
+ * List of annotation classes. Each list item is a GSList itself, with
+ * two NUL-terminated strings: name and description.
*/
GSList *annotations;
GSList *annotation_rows;
/**
- * List of NULL-terminated char[], containing descriptions of the
- * supported binary output.
+ * List of binary classes. Each list item is a GSList itself, with
+ * two NUL-terminated strings: name and description.
*/
GSList *binary;
- /** List of decoder options. */
+ /**
+ * List of logic output channels (item: id, description).
+ */
+ GSList *logic_output_channels;
+
+ /** List of decoder options. */
GSList *options;
/** Python module. */
void *py_dec;
};
+enum srd_initial_pin {
+ SRD_INITIAL_PIN_LOW,
+ SRD_INITIAL_PIN_HIGH,
+ SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
+};
+
/**
* Structure which contains information about one protocol decoder channel.
* For example, I2C has two channels, SDA and SCL.
char *id;
char *desc;
GVariant *def;
- GSList *values;
+ GSList *values;
};
struct srd_decoder_annotation_row {
GSList *ann_classes;
};
+struct srd_decoder_logic_output_channel {
+ char *id;
+ char *desc;
+};
+
struct srd_decoder_inst {
struct srd_decoder *decoder;
struct srd_session *sess;
int data_unitsize;
uint8_t *channel_samples;
GSList *next_di;
+
+ /** List of conditions a PD wants to wait for. */
+ GSList *condition_list;
+
+ /** Array of booleans denoting which conditions matched. */
+ GArray *match_array;
+
+ /** Absolute start sample number. */
+ uint64_t abs_start_samplenum;
+
+ /** Absolute end sample number. */
+ uint64_t abs_end_samplenum;
+
+ /** Pointer to the buffer/chunk of input samples. */
+ const uint8_t *inbuf;
+
+ /** Length (in bytes) of the input sample buffer. */
+ uint64_t inbuflen;
+
+ /** Absolute current samplenumber. */
+ uint64_t abs_cur_samplenum;
+
+ /** Array of "old" (previous sample) pin values. */
+ GArray *old_pins_array;
+
+ /** Handle for this PD stack's worker thread. */
+ GThread *thread_handle;
+
+ /** Indicates whether new samples are available for processing. */
+ gboolean got_new_samples;
+
+ /** Indicates whether the worker thread has handled all samples. */
+ gboolean handled_all_samples;
+
+ /** Requests termination of wait() and decode(). */
+ gboolean want_wait_terminate;
+
+ /** Requests that .wait() terminates a Python iteration. */
+ gboolean communicate_eof;
+
+ /** Indicates the current state of the decoder stack. */
+ int decoder_state;
+
+ GCond got_new_samples_cond;
+ GCond handled_all_samples_cond;
+ GMutex data_mutex;
};
struct srd_pd_output {
void *data;
};
struct srd_proto_data_annotation {
- int ann_format;
+ int ann_class; /* Index into "struct srd_decoder"->annotations. */
char **ann_text;
};
struct srd_proto_data_binary {
- int bin_class;
+ int bin_class; /* Index into "struct srd_decoder"->binary. */
uint64_t size;
- const unsigned char *data;
+ const uint8_t *data;
+};
+struct srd_proto_data_logic {
+ int logic_group;
+ uint64_t repeat_count; /* Number of times the value in data was repeated. */
+ const uint8_t *data; /* Bitfield containing the states of the logic outputs */
};
typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
/* srd.c */
SRD_API int srd_init(const char *path);
SRD_API int srd_exit(void);
+SRD_API GSList *srd_searchpaths_get(void);
/* session.c */
SRD_API int srd_session_new(struct srd_session **sess);
SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
GVariant *data);
SRD_API int srd_session_send(struct srd_session *sess,
- uint64_t start_samplenum, uint64_t end_samplenum,
- const uint8_t *inbuf, uint64_t inbuflen);
+ uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
+ const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
+SRD_API int srd_session_send_eof(struct srd_session *sess);
+SRD_API int srd_session_terminate_reset(struct srd_session *sess);
SRD_API int srd_session_destroy(struct srd_session *sess);
SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
int output_type, srd_pd_output_callback cb, void *cb_data);
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
GHashTable *options);
SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
- GHashTable *channels, int unit_size);
+ GHashTable *channels);
SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
const char *id, GHashTable *options);
SRD_API int srd_inst_stack(struct srd_session *sess,
struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
const char *inst_id);
+SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di,
+ GArray *initial_pins);
/* log.c */
typedef int (*srd_log_callback)(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_get(srd_log_callback *cb, void **cb_data);
SRD_API int srd_log_callback_set(srd_log_callback 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);
/* error.c */
SRD_API const char *srd_strerror(int error_code);
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);
+SRD_API GSList *srd_buildinfo_libs_get(void);
+SRD_API char *srd_buildinfo_host_get(void);
#include "version.h"
projects / libsigrokdecode.git / blobdiff