![]() |
libsigrokdecode
0.2.0
sigrok protocol decoding library
|
The public libsigrokdecode header file to be used by frontends. More...
#include <Python.h>
#include <stdint.h>
#include <glib.h>
Go to the source code of this file.
Data Structures | |
struct | srd_decoder |
struct | srd_probe |
Structure which contains information about one protocol decoder probe. More... | |
struct | srd_decoder_option |
struct | srd_decoder_inst |
struct | srd_pd_output |
struct | srd_proto_data |
struct | srd_pd_callback |
struct | srd_Decoder |
struct | srd_logic |
Macros | |
#define | SRD_PACKAGE_VERSION_MAJOR 0 |
The libsigrokdecode package 'major' version number. More... | |
#define | SRD_PACKAGE_VERSION_MINOR 2 |
The libsigrokdecode package 'minor' version number. More... | |
#define | SRD_PACKAGE_VERSION_MICRO 0 |
The libsigrokdecode package 'micro' version number. More... | |
#define | SRD_PACKAGE_VERSION_STRING "0.2.0" |
The libsigrokdecode package version ("major.minor.micro") as string. More... | |
#define | SRD_LIB_VERSION_CURRENT 1 |
The libsigrokdecode libtool 'current' version number. More... | |
#define | SRD_LIB_VERSION_REVISION 0 |
The libsigrokdecode libtool 'revision' version number. More... | |
#define | SRD_LIB_VERSION_AGE 0 |
The libsigrokdecode libtool 'age' version number. More... | |
#define | SRD_LIB_VERSION_STRING "1:0:0" |
The libsigrokdecode libtool version ("current:revision:age") as string. More... | |
#define | SRD_API __attribute__((visibility("default"))) |
#define | SRD_PRIV __attribute__((visibility("hidden"))) |
#define | SRD_MAX_NUM_PROBES 64 |
Typedefs | |
typedef void(* | srd_pd_output_callback_t )(struct srd_proto_data *pdata, void *cb_data) |
typedef int(* | srd_log_callback_t )(void *cb_data, int loglevel, const char *format, va_list args) |
Enumerations | |
enum | { SRD_OK = 0, SRD_ERR = -1, SRD_ERR_MALLOC = -2, SRD_ERR_ARG = -3, SRD_ERR_BUG = -4, SRD_ERR_PYTHON = -5, SRD_ERR_DECODERS_DIR = -6 } |
Status/error codes returned by libsigrokdecode functions. More... | |
enum | { SRD_LOG_NONE = 0, SRD_LOG_ERR = 1, SRD_LOG_WARN = 2, SRD_LOG_INFO = 3, SRD_LOG_DBG = 4, SRD_LOG_SPEW = 5 } |
enum | { SRD_OUTPUT_ANN, SRD_OUTPUT_PROTO, SRD_OUTPUT_BINARY } |
Functions | |
int | srd_init (const char *path) |
Initialize libsigrokdecode. More... | |
int | srd_exit (void) |
Shutdown libsigrokdecode. More... | |
int | srd_inst_option_set (struct srd_decoder_inst *di, GHashTable *options) |
Set one or more options in a decoder instance. More... | |
int | srd_inst_probe_set_all (struct srd_decoder_inst *di, GHashTable *probes) |
Set all probes in a decoder instance. More... | |
struct srd_decoder_inst * | srd_inst_new (const char *id, GHashTable *options) |
Create a new protocol decoder instance. More... | |
int | srd_inst_stack (struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to) |
Stack a decoder instance on top of another. More... | |
struct srd_decoder_inst * | srd_inst_find_by_id (const char *inst_id) |
Find a decoder instance by its instance ID. More... | |
int | srd_session_start (int num_probes, int unitsize, uint64_t samplerate) |
Start a decoding session. More... | |
int | srd_session_send (uint64_t start_samplenum, const uint8_t *inbuf, uint64_t inbuflen) |
Send a chunk of logic sample data to a running decoder session. More... | |
int | srd_pd_output_callback_add (int output_type, srd_pd_output_callback_t cb, void *cb_data) |
Register/add a decoder output callback function. More... | |
const GSList * | srd_decoder_list (void) |
Returns the list of supported/loaded protocol decoders. More... | |
struct srd_decoder * | srd_decoder_get_by_id (const char *id) |
Get the decoder with the specified ID. More... | |
int | srd_decoder_load (const char *name) |
Load a protocol decoder module into the embedded Python interpreter. More... | |
int | srd_decoder_unload (struct srd_decoder *dec) |
Unload the specified protocol decoder. More... | |
int | srd_decoder_load_all (void) |
Load all installed protocol decoders. More... | |
int | srd_decoder_unload_all (void) |
Unload all loaded protocol decoders. More... | |
char * | srd_decoder_doc_get (const struct srd_decoder *dec) |
Return a protocol decoder's docstring. More... | |
int | srd_log_loglevel_set (int loglevel) |
Set the libsigrokdecode loglevel. More... | |
int | srd_log_loglevel_get (void) |
Get the libsigrokdecode loglevel. More... | |
int | srd_log_callback_set (srd_log_callback_t cb, void *cb_data) |
Set the libsigrokdecode log callback to the specified function. More... | |
int | srd_log_callback_set_default (void) |
Set the libsigrokdecode log callback to the default built-in one. More... | |
int | srd_log_logdomain_set (const char *logdomain) |
Set the libsigrokdecode logdomain string. More... | |
char * | srd_log_logdomain_get (void) |
Get the currently configured libsigrokdecode logdomain. More... | |
int | srd_package_version_major_get (void) |
Get the major libsigrokdecode package version number. More... | |
int | srd_package_version_minor_get (void) |
Get the minor libsigrokdecode package version number. More... | |
int | srd_package_version_micro_get (void) |
Get the micro libsigrokdecode package version number. More... | |
const char * | srd_package_version_string_get (void) |
Get the libsigrokdecode package version number as a string. More... | |
int | srd_lib_version_current_get (void) |
Get the "current" part of the libsigrokdecode library version number. More... | |
int | srd_lib_version_revision_get (void) |
Get the "revision" part of the libsigrokdecode library version number. More... | |
int | srd_lib_version_age_get (void) |
Get the "age" part of the libsigrokdecode library version number. More... | |
const char * | srd_lib_version_string_get (void) |
Get the libsigrokdecode library version number as a string. More... | |
const char * | srd_strerror (int error_code) |
Return a human-readable error string for the given libsigrokdecode error code. More... | |
const char * | srd_strerror_name (int error_code) |
Return the "name" string of the given libsigrokdecode error code. More... | |
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:
Definition in file libsigrokdecode.h.
#define SRD_API __attribute__((visibility("default"))) |
Definition at line 141 of file libsigrokdecode.h.
#define SRD_LIB_VERSION_AGE 0 |
The libsigrokdecode libtool 'age' version number.
Definition at line 76 of file libsigrokdecode.h.
Referenced by srd_lib_version_age_get().
#define SRD_LIB_VERSION_CURRENT 1 |
The libsigrokdecode libtool 'current' version number.
Definition at line 70 of file libsigrokdecode.h.
Referenced by srd_lib_version_current_get().
#define SRD_LIB_VERSION_REVISION 0 |
The libsigrokdecode libtool 'revision' version number.
Definition at line 73 of file libsigrokdecode.h.
Referenced by srd_lib_version_revision_get().
#define SRD_LIB_VERSION_STRING "1:0:0" |
The libsigrokdecode libtool version ("current:revision:age") as string.
Definition at line 79 of file libsigrokdecode.h.
Referenced by srd_lib_version_string_get().
#define SRD_MAX_NUM_PROBES 64 |
Definition at line 165 of file libsigrokdecode.h.
#define SRD_PACKAGE_VERSION_MAJOR 0 |
The libsigrokdecode package 'major' version number.
Definition at line 54 of file libsigrokdecode.h.
Referenced by srd_package_version_major_get().
#define SRD_PACKAGE_VERSION_MICRO 0 |
The libsigrokdecode package 'micro' version number.
Definition at line 60 of file libsigrokdecode.h.
Referenced by srd_package_version_micro_get().
#define SRD_PACKAGE_VERSION_MINOR 2 |
The libsigrokdecode package 'minor' version number.
Definition at line 57 of file libsigrokdecode.h.
Referenced by srd_package_version_minor_get().
#define SRD_PACKAGE_VERSION_STRING "0.2.0" |
The libsigrokdecode package version ("major.minor.micro") as string.
Definition at line 63 of file libsigrokdecode.h.
Referenced by srd_package_version_string_get().
#define SRD_PRIV __attribute__((visibility("hidden"))) |
Definition at line 148 of file libsigrokdecode.h.
typedef int(* srd_log_callback_t)(void *cb_data, int loglevel, const char *format, va_list args) |
Definition at line 313 of file libsigrokdecode.h.
typedef void(* srd_pd_output_callback_t)(struct srd_proto_data *pdata, void *cb_data) |
Definition at line 257 of file libsigrokdecode.h.
anonymous enum |
Status/error codes returned by libsigrokdecode functions.
Definition at line 98 of file libsigrokdecode.h.
anonymous enum |
Definition at line 114 of file libsigrokdecode.h.
anonymous enum |
Enumerator | |
---|---|
SRD_OUTPUT_ANN | |
SRD_OUTPUT_PROTO | |
SRD_OUTPUT_BINARY |
Definition at line 159 of file libsigrokdecode.h.