sigrokdecode.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef SIGROKDECODE_SIGROKDECODE_H
  22 #define SIGROKDECODE_SIGROKDECODE_H
  23
  24 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
  25 #include <stdint.h>
  26
  27 /*
  28  * Status/error codes returned by libsigrokdecode functions.
  29  *
  30  * All possible return codes of libsigrokdecode functions must be listed here.
  31  * Functions should never return hardcoded numbers as status, but rather
  32  * use these #defines instead. All error codes are negative numbers.
  33  *
  34  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
  35  * libsigrokdecode functions returns a "malloc error" it must be exactly the
  36  * same return value as used by all other functions to indicate "malloc error".
  37  * There must be no functions which indicate two different errors via the
  38  * same return code.
  39  *
  40  * Also, for compatibility reasons, no defined return codes are ever removed
  41  * or reused for different #defines later. You can only add new #defines and
  42  * return codes, but never remove or redefine existing ones.
  43  */
  44 #define SIGROKDECODE_OK                  0 /* No error */
  45 #define SIGROKDECODE_ERR                -1 /* Generic/unspecified error */
  46 #define SIGROKDECODE_ERR_MALLOC         -2 /* Malloc/calloc/realloc error */
  47
  48 /* TODO: Documentation. */
  49 struct sigrokdecode_decoder_info {
  50         char *id;
  51         char *name;
  52         char *description;
  53         char *function;
  54         char *inputformats; /* FIXME: Should be a list. */
  55         char *outputformats; /* FIXME: Should be a list. */
  56 };
  57
  58 int sigrokdecode_init(void);
  59 int sigrokdecode_load_decoder_file(const char *name);
  60 int sigrokdecode_run_decoder(const char *modulename, const char *decodername,
  61                              uint8_t *inbuf, uint64_t inbuflen,
  62                              uint8_t **outbuf, uint64_t *outbuflen);
  63 int sigrokdecode_shutdown(void);
  64
  65 #endif