libsigrokdecode.h

   1 /*
   2  * This file is part of the libsigrokdecode 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, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
  22 #define LIBSIGROKDECODE_LIBSIGROKDECODE_H
  23
  24 #include <stdint.h>
  25 #include <glib.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 struct srd_session;
  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 <libsigrokdecode/libsigrokdecode.h>
  46  * @endcode
  47  */
  48
  49 /*
  50  * All possible return codes of libsigrokdecode functions must be listed here.
  51  * Functions should never return hardcoded numbers as status, but rather
  52  * use these enum values. All error codes are negative numbers.
  53  *
  54  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
  55  * libsigrokdecode functions returns a "malloc error" it must be exactly the
  56  * same return value as used by all other functions to indicate "malloc error".
  57  * There must be no functions which indicate two different errors via the
  58  * same return code.
  59  *
  60  * Also, for compatibility reasons, no defined return codes are ever removed
  61  * or reused for different errors later. You can only add new entries and
  62  * return codes, but never remove or redefine existing ones.
  63  */
  64
  65 /** Status/error codes returned by libsigrokdecode functions. */
  66 enum srd_error_code {
  67         SRD_OK               =  0, /**< No error */
  68         SRD_ERR              = -1, /**< Generic/unspecified error */
  69         SRD_ERR_MALLOC       = -2, /**< Malloc/calloc/realloc error */
  70         SRD_ERR_ARG          = -3, /**< Function argument error */
  71         SRD_ERR_BUG          = -4, /**< Errors hinting at internal bugs */
  72         SRD_ERR_PYTHON       = -5, /**< Python C API error */
  73         SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
  74         SRD_ERR_TERM_REQ     = -7, /**< Termination requested */
  75
  76         /*
  77          * Note: When adding entries here, don't forget to also update the
  78          * srd_strerror() and srd_strerror_name() functions in error.c.
  79          */
  80 };
  81
  82 /* libsigrokdecode loglevels. */
  83 enum srd_loglevel {
  84         SRD_LOG_NONE = 0, /**< Output no messages at all. */
  85         SRD_LOG_ERR  = 1, /**< Output error messages. */
  86         SRD_LOG_WARN = 2, /**< Output warnings. */
  87         SRD_LOG_INFO = 3, /**< Output informational messages. */
  88         SRD_LOG_DBG  = 4, /**< Output debug messages. */
  89         SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
  90 };
  91
  92 /*
  93  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
  94  *
  95  * Variables and functions marked 'static' are private already and don't
  96  * need SRD_PRIV. However, functions which are not static (because they need
  97  * to be used in other libsigrokdecode-internal files) but are also not
  98  * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
  99  *
 100  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 101  *
 102  * This feature is not available on MinGW/Windows, as it is a feature of
 103  * ELF files and MinGW/Windows uses PE files.
 104  *
 105  * Details: http://gcc.gnu.org/wiki/Visibility
 106  */
 107
 108 /* Marks public libsigrokdecode API symbols. */
 109 #if defined _WIN32
 110 #  if defined DLL_EXPORT
 111 #    define SRD_API __declspec(dllexport)
 112 #  else
 113 #    define SRD_API extern
 114 #  endif
 115 #else
 116 #  define SRD_API __attribute__((visibility("default")))
 117 #endif
 118
 119 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
 120 #if defined _WIN32
 121 #  define SRD_PRIV /* EMPTY */
 122 #else
 123 #  define SRD_PRIV __attribute__((visibility("hidden")))
 124 #endif
 125
 126 /*
 127  * When adding an output type, don't forget to...
 128  *   - expose it to PDs in module_sigrokdecode.c:PyInit_sigrokdecode()
 129  *   - add a check in type_decoder.c:Decoder_put()
 130  *   - add a debug string in type_decoder.c:output_type_name()
 131  */
 132 enum srd_output_type {
 133         SRD_OUTPUT_ANN,
 134         SRD_OUTPUT_PYTHON,
 135         SRD_OUTPUT_BINARY,
 136         SRD_OUTPUT_LOGIC,
 137         SRD_OUTPUT_META,
 138 };
 139
 140 enum srd_configkey {
 141         SRD_CONF_SAMPLERATE = 10000,
 142 };
 143
 144 struct srd_decoder {
 145         /** The decoder ID. Must be non-NULL and unique for all decoders. */
 146         char *id;
 147
 148         /** The (short) decoder name. Must be non-NULL. */
 149         char *name;
 150
 151         /** The (long) decoder name. Must be non-NULL. */
 152         char *longname;
 153
 154         /** A (short, one-line) description of the decoder. Must be non-NULL. */
 155         char *desc;
 156
 157         /**
 158          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
 159          * Other values are currently not allowed. Must be non-NULL.
 160          */
 161         char *license;
 162
 163         /** List of possible decoder input IDs. */
 164         GSList *inputs;
 165
 166         /** List of possible decoder output IDs. */
 167         GSList *outputs;
 168
 169         /** List of tags associated with this decoder. */
 170         GSList *tags;
 171
 172         /** List of channels required by this decoder. */
 173         GSList *channels;
 174
 175         /** List of optional channels for this decoder. */
 176         GSList *opt_channels;
 177
 178         /**
 179          * List of annotation classes. Each list item is a GSList itself, with
 180          * two NUL-terminated strings: name and description.
 181          */
 182         GSList *annotations;
 183
 184         /**
 185          * List of annotation rows (row items: id, description, and a list
 186          * of annotation classes belonging to this row).
 187          */
 188         GSList *annotation_rows;
 189
 190         /**
 191          * List of binary classes. Each list item is a GSList itself, with
 192          * two NUL-terminated strings: name and description.
 193          */
 194         GSList *binary;
 195
 196         /**
 197          * List of logic output channels (item: id, description).
 198          */
 199         GSList *logic_output_channels;
 200
 201         /** List of decoder options. */
 202         GSList *options;
 203
 204         /** Python module. */
 205         void *py_mod;
 206
 207         /** sigrokdecode.Decoder class. */
 208         void *py_dec;
 209 };
 210
 211 enum srd_initial_pin {
 212         SRD_INITIAL_PIN_LOW,
 213         SRD_INITIAL_PIN_HIGH,
 214         SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
 215 };
 216
 217 /**
 218  * Structure which contains information about one protocol decoder channel.
 219  * For example, I2C has two channels, SDA and SCL.
 220  */
 221 struct srd_channel {
 222         /** The ID of the channel. Must be non-NULL. */
 223         char *id;
 224         /** The name of the channel. Must not be NULL. */
 225         char *name;
 226         /** The description of the channel. Must not be NULL. */
 227         char *desc;
 228         /** The index of the channel, i.e. its order in the list of channels. */
 229         int order;
 230 };
 231
 232 struct srd_decoder_option {
 233         char *id;
 234         char *desc;
 235         GVariant *def;
 236         GSList *values;
 237 };
 238
 239 struct srd_decoder_annotation_row {
 240         char *id;
 241         char *desc;
 242         GSList *ann_classes;
 243 };
 244
 245 struct srd_decoder_logic_output_channel {
 246         char *id;
 247         char *desc;
 248 };
 249
 250 struct srd_decoder_inst {
 251         struct srd_decoder *decoder;
 252         struct srd_session *sess;
 253         void *py_inst;
 254         char *inst_id;
 255         GSList *pd_output;
 256         int dec_num_channels;
 257         int *dec_channelmap;
 258         int data_unitsize;
 259         uint8_t *channel_samples;
 260         GSList *next_di;
 261
 262         /** List of conditions a PD wants to wait for. */
 263         GSList *condition_list;
 264
 265         /** Array of booleans denoting which conditions matched. */
 266         GArray *match_array;
 267
 268         /** Absolute start sample number. */
 269         uint64_t abs_start_samplenum;
 270
 271         /** Absolute end sample number. */
 272         uint64_t abs_end_samplenum;
 273
 274         /** Pointer to the buffer/chunk of input samples. */
 275         const uint8_t *inbuf;
 276
 277         /** Length (in bytes) of the input sample buffer. */
 278         uint64_t inbuflen;
 279
 280         /** Absolute current samplenumber. */
 281         uint64_t abs_cur_samplenum;
 282
 283         /** Array of "old" (previous sample) pin values. */
 284         GArray *old_pins_array;
 285
 286         /** Handle for this PD stack's worker thread. */
 287         GThread *thread_handle;
 288
 289         /** Indicates whether new samples are available for processing. */
 290         gboolean got_new_samples;
 291
 292         /** Indicates whether the worker thread has handled all samples. */
 293         gboolean handled_all_samples;
 294
 295         /** Requests termination of wait() and decode(). */
 296         gboolean want_wait_terminate;
 297
 298         /** Requests that .wait() terminates a Python iteration. */
 299         gboolean communicate_eof;
 300
 301         /** Indicates the current state of the decoder stack. */
 302         int decoder_state;
 303
 304         GCond got_new_samples_cond;
 305         GCond handled_all_samples_cond;
 306         GMutex data_mutex;
 307 };
 308
 309 struct srd_pd_output {
 310         int pdo_id;
 311         int output_type;
 312         struct srd_decoder_inst *di;
 313         char *proto_id;
 314         /* Only used for OUTPUT_META. */
 315         const GVariantType *meta_type;
 316         char *meta_name;
 317         char *meta_descr;
 318 };
 319
 320 struct srd_proto_data {
 321         uint64_t start_sample;
 322         uint64_t end_sample;
 323         struct srd_pd_output *pdo;
 324         void *data;
 325 };
 326 struct srd_proto_data_annotation {
 327         int ann_class; /* Index into "struct srd_decoder"->annotations. */
 328         char **ann_text;
 329 };
 330 struct srd_proto_data_binary {
 331         int bin_class; /* Index into "struct srd_decoder"->binary. */
 332         uint64_t size;
 333         const uint8_t *data;
 334 };
 335 struct srd_proto_data_logic {
 336         int logic_group;
 337         uint64_t repeat_count; /* Number of times the value in data was repeated. */
 338         const uint8_t *data; /* Bitfield containing the states of the logic outputs */
 339 };
 340
 341 typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
 342                                         void *cb_data);
 343
 344 struct srd_pd_callback {
 345         int output_type;
 346         srd_pd_output_callback cb;
 347         void *cb_data;
 348 };
 349
 350 /* srd.c */
 351 SRD_API int srd_init(const char *path);
 352 SRD_API int srd_exit(void);
 353 SRD_API GSList *srd_searchpaths_get(void);
 354
 355 /* session.c */
 356 SRD_API int srd_session_new(struct srd_session **sess);
 357 SRD_API int srd_session_start(struct srd_session *sess);
 358 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
 359                 GVariant *data);
 360 SRD_API int srd_session_send(struct srd_session *sess,
 361                 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
 362                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
 363 SRD_API int srd_session_send_eof(struct srd_session *sess);
 364 SRD_API int srd_session_terminate_reset(struct srd_session *sess);
 365 SRD_API int srd_session_destroy(struct srd_session *sess);
 366 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
 367                 int output_type, srd_pd_output_callback cb, void *cb_data);
 368
 369 /* decoder.c */
 370 SRD_API const GSList *srd_decoder_list(void);
 371 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
 372 SRD_API int srd_decoder_load(const char *name);
 373 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
 374 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
 375 SRD_API int srd_decoder_load_all(void);
 376 SRD_API int srd_decoder_unload_all(void);
 377
 378 /* instance.c */
 379 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
 380                 GHashTable *options);
 381 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
 382                 GHashTable *channels);
 383 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
 384                 const char *id, GHashTable *options);
 385 SRD_API int srd_inst_stack(struct srd_session *sess,
 386                 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
 387 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
 388                 const char *inst_id);
 389 SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di,
 390                 GArray *initial_pins);
 391
 392 /* log.c */
 393 typedef int (*srd_log_callback)(void *cb_data, int loglevel,
 394                                   const char *format, va_list args);
 395 SRD_API int srd_log_loglevel_set(int loglevel);
 396 SRD_API int srd_log_loglevel_get(void);
 397 SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data);
 398 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
 399 SRD_API int srd_log_callback_set_default(void);
 400
 401 /* error.c */
 402 SRD_API const char *srd_strerror(int error_code);
 403 SRD_API const char *srd_strerror_name(int error_code);
 404
 405 /* version.c */
 406 SRD_API int srd_package_version_major_get(void);
 407 SRD_API int srd_package_version_minor_get(void);
 408 SRD_API int srd_package_version_micro_get(void);
 409 SRD_API const char *srd_package_version_string_get(void);
 410 SRD_API int srd_lib_version_current_get(void);
 411 SRD_API int srd_lib_version_revision_get(void);
 412 SRD_API int srd_lib_version_age_get(void);
 413 SRD_API const char *srd_lib_version_string_get(void);
 414 SRD_API GSList *srd_buildinfo_libs_get(void);
 415 SRD_API char *srd_buildinfo_host_get(void);
 416
 417 #include "version.h"
 418
 419 #ifdef __cplusplus
 420 }
 421 #endif
 422
 423 #endif