sigrokdecode.h.in

   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, 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 struct srd_decoder {
 159         /** The decoder ID. Must be non-NULL and unique for all decoders. */
 160         char *id;
 161
 162         /** The (short) decoder name. Must be non-NULL. */
 163         char *name;
 164
 165         /** The (long) decoder name. Must be non-NULL. */
 166         char *longname;
 167
 168         /** A (short, one-line) description of the decoder. Must be non-NULL. */
 169         char *desc;
 170
 171         /**
 172          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
 173          * Other values are currently not allowed. Must be non-NULL.
 174          */
 175         char *license;
 176
 177         /** List of probes required by this decoder. */
 178         GSList *probes;
 179
 180         /** List of optional probes for this decoder. */
 181         GSList *opt_probes;
 182
 183         /**
 184          * List of NULL-terminated char[], containing descriptions of the
 185          * supported annotation output.
 186          */
 187         GSList *annotations;
 188
 189         /** List of decoder options.  */
 190         GSList *options;
 191
 192         /** Python module. */
 193         PyObject *py_mod;
 194
 195         /** sigrokdecode.Decoder class. */
 196         PyObject *py_dec;
 197 };
 198
 199 /**
 200  * Structure which contains information about one protocol decoder probe.
 201  * For example, I2C has two probes, SDA and SCL.
 202  */
 203 struct srd_probe {
 204         /** The ID of the probe. Must be non-NULL. */
 205         char *id;
 206         /** The name of the probe. Must not be NULL. */
 207         char *name;
 208         /** The description of the probe. Must not be NULL. */
 209         char *desc;
 210         /** The index of the probe, i.e. its order in the list of probes. */
 211         int order;
 212 };
 213
 214 struct srd_decoder_option {
 215         char *id;
 216         char *desc;
 217         GVariant *def;
 218 };
 219
 220 struct srd_decoder_inst {
 221         struct srd_decoder *decoder;
 222         PyObject *py_inst;
 223         char *inst_id;
 224         GSList *pd_output;
 225         int dec_num_probes;
 226         int *dec_probemap;
 227         int data_num_probes;
 228         int data_unitsize;
 229         uint64_t data_samplerate;
 230         GSList *next_di;
 231 };
 232
 233 struct srd_pd_output {
 234         int pdo_id;
 235         int output_type;
 236         struct srd_decoder_inst *di;
 237         char *proto_id;
 238 };
 239
 240 struct srd_proto_data {
 241         uint64_t start_sample;
 242         uint64_t end_sample;
 243         struct srd_pd_output *pdo;
 244         int ann_format;
 245         void *data;
 246 };
 247
 248 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
 249                                          void *cb_data);
 250
 251 struct srd_pd_callback {
 252         int output_type;
 253         srd_pd_output_callback_t cb;
 254         void *cb_data;
 255 };
 256
 257 /* Custom Python types: */
 258
 259 typedef struct {
 260         PyObject_HEAD
 261 } srd_Decoder;
 262
 263 typedef struct {
 264         PyObject_HEAD
 265         struct srd_decoder_inst *di;
 266         uint64_t start_samplenum;
 267         unsigned int itercnt;
 268         uint8_t *inbuf;
 269         uint64_t inbuflen;
 270         PyObject *sample;
 271 } srd_logic;
 272
 273 /*--- controller.c ----------------------------------------------------------*/
 274
 275 SRD_API int srd_init(const char *path);
 276 SRD_API int srd_exit(void);
 277 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
 278                 GHashTable *options);
 279 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 280                 GHashTable *probes);
 281 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
 282                 GHashTable *options);
 283 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
 284                 struct srd_decoder_inst *di_to);
 285 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
 286 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
 287 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
 288                 uint64_t inbuflen);
 289 SRD_API int srd_pd_output_callback_add(int output_type,
 290                 srd_pd_output_callback_t cb, void *cb_data);
 291
 292 /*--- decoder.c -------------------------------------------------------------*/
 293
 294 SRD_API const GSList *srd_decoder_list(void);
 295 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
 296 SRD_API int srd_decoder_load(const char *name);
 297 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
 298 SRD_API int srd_decoder_load_all(void);
 299 SRD_API int srd_decoder_unload_all(void);
 300 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
 301
 302 /*--- log.c -----------------------------------------------------------------*/
 303
 304 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
 305                                   const char *format, va_list args);
 306
 307 SRD_API int srd_log_loglevel_set(int loglevel);
 308 SRD_API int srd_log_loglevel_get(void);
 309 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
 310 SRD_API int srd_log_callback_set_default(void);
 311 SRD_API int srd_log_logdomain_set(const char *logdomain);
 312 SRD_API char *srd_log_logdomain_get(void);
 313
 314 /*--- version.c -------------------------------------------------------------*/
 315
 316 SRD_API int srd_package_version_major_get(void);
 317 SRD_API int srd_package_version_minor_get(void);
 318 SRD_API int srd_package_version_micro_get(void);
 319 SRD_API const char *srd_package_version_string_get(void);
 320
 321 SRD_API int srd_lib_version_current_get(void);
 322 SRD_API int srd_lib_version_revision_get(void);
 323 SRD_API int srd_lib_version_age_get(void);
 324 SRD_API const char *srd_lib_version_string_get(void);
 325
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330 #endif