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 SIGROKDECODE_SIGROKDECODE_H
  23 #define SIGROKDECODE_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_PYTHON        -4 /**< Python C API error */
  55 #define SRD_ERR_DECODERS_DIR  -5 /**< Protocol decoder path invalid */
  56
  57 /* libsigrokdecode loglevels. */
  58 #define SRD_LOG_NONE   0 /**< Output no messages at all. */
  59 #define SRD_LOG_ERR    1 /**< Output error messages. */
  60 #define SRD_LOG_WARN   2 /**< Output warnings. */
  61 #define SRD_LOG_INFO   3 /**< Output informational messages. */
  62 #define SRD_LOG_DBG    4 /**< Output debug messages. */
  63 #define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
  64
  65 enum {
  66         SRD_OUTPUT_ANNOTATION,
  67         SRD_OUTPUT_PROTOCOL,
  68         SRD_OUTPUT_BINARY,
  69 };
  70
  71 #define SRD_MAX_NUM_PROBES   64
  72
  73 /* TODO: Documentation. */
  74 struct srd_decoder {
  75         /** The decoder ID. Must be non-NULL and unique for all decoders. */
  76         char *id;
  77
  78         /** The (short) decoder name. */
  79         char *name;
  80
  81         /** The (long) decoder name. May be NULL. */
  82         char *longname;
  83
  84         /** A (short, one-line) description of the decoder. */
  85         char *desc;
  86
  87         /** A (long, multi-line) description of the decoder. May be NULL. */
  88         char *longdesc;
  89
  90         /** The author of the decoder. May be NULL. */
  91         char *author;
  92
  93         /** An email address of the decoder's author. May be NULL. */
  94         char *email;
  95
  96         /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
  97         char *license;
  98
  99         /** TODO */
 100         char *func;
 101
 102         /** TODO */
 103         GSList *inputformats;
 104
 105         /** TODO */
 106         GSList *outputformats;
 107
 108         /* List of NULL-terminated char[], containing descriptions of the
 109          * supported annotation output.
 110          */
 111         GSList *annotation;
 112
 113         /** TODO */
 114         PyObject *py_mod;
 115
 116         /** Python object that performs the decoding */
 117         PyObject *py_decobj;
 118 };
 119
 120 struct srd_decoder_instance {
 121         struct srd_decoder *decoder;
 122         PyObject *py_instance;
 123         GSList *pd_output;
 124         int num_probes;
 125         int unitsize;
 126         uint64_t samplerate;
 127 };
 128
 129 struct srd_pd_output {
 130         int pdo_id;
 131         int output_type;
 132         struct srd_decoder *decoder;
 133         char *protocol_id;
 134 };
 135
 136 typedef struct {
 137         PyObject_HEAD
 138         struct srd_decoder_instance *di;
 139         unsigned int itercnt;
 140         uint8_t *inbuf;
 141         uint64_t inbuflen;
 142         PyObject *sample;
 143 } srd_logic;
 144
 145 struct srd_protocol_data {
 146         uint64_t start_sample;
 147         uint64_t end_sample;
 148         struct srd_pd_output *pdo;
 149         int annotation_type;
 150         unsigned char **data;
 151 };
 152
 153
 154
 155 /*--- controller.c ----------------------------------------------------------*/
 156
 157 int srd_init(void);
 158 int srd_exit(void);
 159 int set_modulepath(void);
 160 struct srd_decoder_instance *srd_instance_new(const char *id);
 161 int srd_instance_set_probe(struct srd_decoder_instance *di,
 162                                 const char *probename, int num);
 163 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
 164 int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
 165                 struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
 166 int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
 167                 uint64_t inbuflen);
 168 int pd_output_new(struct srd_decoder_instance *di, int output_type,
 169                 char *output_id);
 170 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
 171
 172 /*--- decoder.c -------------------------------------------------------------*/
 173
 174 GSList *srd_list_decoders(void);
 175 struct srd_decoder *srd_get_decoder_by_id(const char *id);
 176 int srd_load_decoder(const char *name, struct srd_decoder **dec);
 177 int srd_unload_decoder(struct srd_decoder *dec);
 178 int srd_load_all_decoders(void);
 179 int srd_unload_all_decoders(void);
 180
 181 /*--- util.c ----------------------------------------------------------------*/
 182 int h_str(PyObject *py_res, const char *key, char **outstr);
 183 int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
 184
 185 /*--- log.c -----------------------------------------------------------------*/
 186
 187 int srd_set_loglevel(int loglevel);
 188 int srd_get_loglevel(void);
 189
 190 #ifdef __cplusplus
 191 }
 192 #endif
 193
 194 #endif