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  * When adding an output type, don't forget to...
  68  *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
  69  *   - add a check in module_sigrokdecode.c:Decoder_put()
  70  *   - add a debug string in type_decoder.c:OUTPUT_TYPES
  71  */
  72 enum {
  73         SRD_OUTPUT_ANN,
  74         SRD_OUTPUT_PROTO,
  75         SRD_OUTPUT_BINARY,
  76 };
  77
  78 #define SRD_MAX_NUM_PROBES   64
  79
  80 /* TODO: Documentation. */
  81 struct srd_decoder {
  82         /** The decoder ID. Must be non-NULL and unique for all decoders. */
  83         char *id;
  84
  85         /** The (short) decoder name. */
  86         char *name;
  87
  88         /** The (long) decoder name. May be NULL. */
  89         char *longname;
  90
  91         /** A (short, one-line) description of the decoder. */
  92         char *desc;
  93
  94         /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
  95         char *license;
  96
  97         /** TODO */
  98         GSList *inputformats;
  99
 100         /** TODO */
 101         GSList *outputformats;
 102
 103         /** Probes */
 104         GSList *probes;
 105
 106         /** Optional probes */
 107         GSList *opt_probes;
 108
 109         /*
 110          * List of NULL-terminated char[], containing descriptions of the
 111          * supported annotation output.
 112          */
 113         GSList *annotations;
 114
 115         /** Python module */
 116         PyObject *py_mod;
 117
 118         /** sigrokdecode.Decoder class */
 119         PyObject *py_dec;
 120 };
 121
 122 struct srd_probe {
 123         char *id;
 124         char *name;
 125         char *desc;
 126         int order;
 127 };
 128
 129 struct srd_decoder_instance {
 130         struct srd_decoder *decoder;
 131         PyObject *py_instance;
 132         char *instance_id;
 133         GSList *pd_output;
 134         int dec_num_probes;
 135         int *dec_probemap;
 136         int data_num_probes;
 137         int data_unitsize;
 138         uint64_t data_samplerate;
 139         GSList *next_di;
 140 };
 141
 142 struct srd_pd_output {
 143         int pdo_id;
 144         int output_type;
 145         struct srd_decoder_instance *di;
 146         char *proto_id;
 147 };
 148
 149 struct srd_proto_data {
 150         uint64_t start_sample;
 151         uint64_t end_sample;
 152         struct srd_pd_output *pdo;
 153         int ann_format;
 154         void *data;
 155 };
 156
 157 struct srd_pd_callback {
 158         int output_type;
 159         void (*callback)(struct srd_proto_data *);
 160 };
 161
 162 /* custom python types */
 163 typedef struct {
 164         PyObject_HEAD
 165 } srd_Decoder;
 166
 167 typedef struct {
 168         PyObject_HEAD
 169         struct srd_decoder_instance *di;
 170         uint64_t start_samplenum;
 171         unsigned int itercnt;
 172         uint8_t *inbuf;
 173         uint64_t inbuflen;
 174         PyObject *sample;
 175 } srd_logic;
 176
 177 /*--- controller.c ----------------------------------------------------------*/
 178
 179 int srd_init(void);
 180 int srd_exit(void);
 181 int set_modulepath(void);
 182 int srd_instance_set_options(struct srd_decoder_instance *di,
 183                              GHashTable *options);
 184 int srd_instance_set_probes(struct srd_decoder_instance *di,
 185                             GHashTable *probes);
 186 struct srd_decoder_instance *srd_instance_new(const char *id,
 187                                               GHashTable *options);
 188 int srd_instance_stack(struct srd_decoder_instance *di_from,
 189                        struct srd_decoder_instance *di_to);
 190 struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id);
 191 struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
 192                                                       PyObject *obj);
 193 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
 194 int srd_instance_decode(uint64_t start_samplenum,
 195                         struct srd_decoder_instance *dec,
 196                         uint8_t *inbuf, uint64_t inbuflen);
 197 void srd_instance_free(struct srd_decoder_instance *di);
 198 void srd_instance_free_all(GSList *stack);
 199 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
 200 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
 201                      uint64_t inbuflen);
 202 int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id);
 203 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
 204 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata);
 205 int srd_register_callback(int output_type, srd_pd_output_callback_t cb);
 206 void *srd_find_callback(int output_type);
 207
 208 /*--- decoder.c -------------------------------------------------------------*/
 209
 210 GSList *srd_list_decoders(void);
 211 struct srd_decoder *srd_get_decoder_by_id(const char *id);
 212 int srd_load_decoder(const char *name, struct srd_decoder **dec);
 213 int srd_unload_decoder(struct srd_decoder *dec);
 214 int srd_load_all_decoders(void);
 215 int srd_unload_all_decoders(void);
 216 char *srd_decoder_doc(struct srd_decoder *dec);
 217
 218 /*--- exception.c -----------------------------------------------------------*/
 219
 220 void catch_exception(const char *format, ...);
 221
 222 /*--- util.c ----------------------------------------------------------------*/
 223
 224 int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
 225 int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
 226 int py_str_as_str(PyObject *py_str, char **outstr);
 227 int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
 228
 229 /*--- log.c -----------------------------------------------------------------*/
 230
 231 typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format,
 232                                  va_list args);
 233
 234 int srd_log_loglevel_set(int loglevel);
 235 int srd_log_loglevel_get(void);
 236 int srd_log_handler_set(srd_log_handler_t handler, void *data);
 237 int srd_log_handler_set_default(void);
 238 int srd_log_logdomain_set(const char *logdomain);
 239 char *srd_log_logdomain_get(void);
 240
 241 #ifdef __cplusplus
 242 }
 243 #endif
 244
 245 #endif