sigrokdecode.h

   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. Must be non-NULL. */
 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. Must be non-NULL. */
 111         char *desc;
 112
 113         /**
 114          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
 115          * Other values are currently not allowed. Must be non-NULL.
 116          */
 117         char *license;
 118
 119         /** TODO */
 120         GSList *inputformats;
 121
 122         /** TODO */
 123         GSList *outputformats;
 124
 125         /** List of probes required by this decoder. */
 126         GSList *probes;
 127
 128         /** List of optional probes for this decoder. */
 129         GSList *opt_probes;
 130
 131         /**
 132          * List of NULL-terminated char[], containing descriptions of the
 133          * supported annotation output.
 134          */
 135         GSList *annotations;
 136
 137         /** Python module. */
 138         PyObject *py_mod;
 139
 140         /** sigrokdecode.Decoder class. */
 141         PyObject *py_dec;
 142 };
 143
 144 /**
 145  * Structure which contains information about one protocol decoder probe.
 146  * For example, I2C has two probes, SDA and SCL.
 147  */
 148 struct srd_probe {
 149         /** The ID of the probe. Must be non-NULL. */
 150         char *id;
 151         /** The name of the probe. Must not be NULL. */
 152         char *name;
 153         /** The description of the probe. Must not be NULL. */
 154         char *desc;
 155         /** The index of the probe, i.e. its order in the list of probes. */
 156         int order;
 157 };
 158
 159 struct srd_decoder_inst {
 160         struct srd_decoder *decoder;
 161         PyObject *py_inst;
 162         char *inst_id;
 163         GSList *pd_output;
 164         int dec_num_probes;
 165         int *dec_probemap;
 166         int data_num_probes;
 167         int data_unitsize;
 168         uint64_t data_samplerate;
 169         GSList *next_di;
 170 };
 171
 172 struct srd_pd_output {
 173         int pdo_id;
 174         int output_type;
 175         struct srd_decoder_inst *di;
 176         char *proto_id;
 177 };
 178
 179 struct srd_proto_data {
 180         uint64_t start_sample;
 181         uint64_t end_sample;
 182         struct srd_pd_output *pdo;
 183         int ann_format;
 184         void *data;
 185 };
 186
 187 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
 188                                          void *cb_data);
 189
 190 struct srd_pd_callback {
 191         int output_type;
 192         srd_pd_output_callback_t cb;
 193         void *cb_data;
 194 };
 195
 196 /* Custom Python types: */
 197
 198 typedef struct {
 199         PyObject_HEAD
 200 } srd_Decoder;
 201
 202 typedef struct {
 203         PyObject_HEAD
 204         struct srd_decoder_inst *di;
 205         uint64_t start_samplenum;
 206         unsigned int itercnt;
 207         uint8_t *inbuf;
 208         uint64_t inbuflen;
 209         PyObject *sample;
 210 } srd_logic;
 211
 212 /*--- controller.c ----------------------------------------------------------*/
 213
 214 SRD_API int srd_init(const char *path);
 215 SRD_API int srd_exit(void);
 216 SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
 217                                  GHashTable *options);
 218 SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
 219                                 GHashTable *probes);
 220 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
 221                                               GHashTable *options);
 222 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
 223                            struct srd_decoder_inst *di_to);
 224 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
 225 SRD_API int srd_session_start(int num_probes, int unitsize,
 226                               uint64_t samplerate);
 227 SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf,
 228                              uint64_t inbuflen);
 229 SRD_API int srd_register_callback(int output_type,
 230                                   srd_pd_output_callback_t cb, void *cb_data);
 231
 232 /*--- decoder.c -------------------------------------------------------------*/
 233
 234 SRD_API GSList *srd_decoders_list(void);
 235 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
 236 SRD_API int srd_decoder_load(const char *name);
 237 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
 238 SRD_API int srd_decoders_load_all(void);
 239 SRD_API int srd_decoders_unload_all(void);
 240 SRD_API char *srd_decoder_doc(const struct srd_decoder *dec);
 241
 242 /*--- log.c -----------------------------------------------------------------*/
 243
 244 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
 245                                   const char *format, va_list args);
 246
 247 SRD_API int srd_log_loglevel_set(int loglevel);
 248 SRD_API int srd_log_loglevel_get(void);
 249 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
 250 SRD_API int srd_log_callback_set_default(void);
 251 SRD_API int srd_log_logdomain_set(const char *logdomain);
 252 SRD_API char *srd_log_logdomain_get(void);
 253
 254 #ifdef __cplusplus
 255 }
 256 #endif
 257
 258 #endif