proto.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef LIBSIGROK_PROTO_H
  21 #define LIBSIGROK_PROTO_H
  22
  23 /**
  24  * @file
  25  *
  26  * Header file containing API function prototypes.
  27  */
  28
  29 /*--- backend.c -------------------------------------------------------------*/
  30
  31 SR_API int sr_init(struct sr_context **ctx);
  32 SR_API int sr_exit(struct sr_context *ctx);
  33
  34 /*--- log.c -----------------------------------------------------------------*/
  35
  36 typedef int (*sr_log_callback)(void *cb_data, int loglevel,
  37                                 const char *format, va_list args);
  38
  39 SR_API int sr_log_loglevel_set(int loglevel);
  40 SR_API int sr_log_loglevel_get(void);
  41 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
  42 SR_API int sr_log_callback_set_default(void);
  43 SR_API int sr_log_logdomain_set(const char *logdomain);
  44 SR_API char *sr_log_logdomain_get(void);
  45
  46 /*--- device.c --------------------------------------------------------------*/
  47
  48 SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
  49                 int channelnum, const char *name);
  50 SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
  51                 gboolean state);
  52 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum,
  53                 const char *trigger);
  54 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
  55 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
  56 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
  57 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
  58 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
  59
  60 /*--- hwdriver.c ------------------------------------------------------------*/
  61
  62 SR_API struct sr_dev_driver **sr_driver_list(void);
  63 SR_API int sr_driver_init(struct sr_context *ctx,
  64                 struct sr_dev_driver *driver);
  65 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
  66 SR_API int sr_config_get(const struct sr_dev_driver *driver,
  67                 const struct sr_dev_inst *sdi,
  68                 const struct sr_channel_group *cg,
  69                 int key, GVariant **data);
  70 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
  71                 const struct sr_channel_group *cg,
  72                 int key, GVariant *data);
  73 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
  74 SR_API int sr_config_list(const struct sr_dev_driver *driver,
  75                 const struct sr_dev_inst *sdi,
  76                 const struct sr_channel_group *cg,
  77                 int key, GVariant **data);
  78 SR_API const struct sr_config_info *sr_config_info_get(int key);
  79 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
  80
  81 /*--- session.c -------------------------------------------------------------*/
  82
  83 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
  84                 const struct sr_datafeed_packet *packet, void *cb_data);
  85
  86 /* Session setup */
  87 SR_API int sr_session_load(const char *filename);
  88 SR_API struct sr_session *sr_session_new(void);
  89 SR_API int sr_session_destroy(void);
  90 SR_API int sr_session_dev_remove_all(void);
  91 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
  92 SR_API int sr_session_dev_list(GSList **devlist);
  93 SR_API int sr_session_trigger_set(struct sr_trigger *trig);
  94
  95 /* Datafeed setup */
  96 SR_API int sr_session_datafeed_callback_remove_all(void);
  97 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb,
  98                 void *cb_data);
  99
 100 /* Session control */
 101 SR_API int sr_session_start(void);
 102 SR_API int sr_session_run(void);
 103 SR_API int sr_session_stop(void);
 104 SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
 105                 unsigned char *buf, int unitsize, int units);
 106 SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
 107                 char **channels);
 108 SR_API int sr_session_append(const char *filename, unsigned char *buf,
 109                 int unitsize, int units);
 110 SR_API int sr_session_source_add(int fd, int events, int timeout,
 111                 sr_receive_data_callback cb, void *cb_data);
 112 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
 113                 sr_receive_data_callback cb, void *cb_data);
 114 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
 115                 int timeout, sr_receive_data_callback cb, void *cb_data);
 116 SR_API int sr_session_source_remove(int fd);
 117 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
 118 SR_API int sr_session_source_remove_channel(GIOChannel *channel);
 119
 120 /*--- input/input.c ---------------------------------------------------------*/
 121
 122 SR_API struct sr_input_format **sr_input_list(void);
 123
 124 /*--- output/output.c -------------------------------------------------------*/
 125
 126 SR_API struct sr_output_format **sr_output_list(void);
 127 SR_API struct sr_output *sr_output_new(struct sr_output_format *of,
 128                 GHashTable *params, const struct sr_dev_inst *sdi);
 129 SR_API int sr_output_send(struct sr_output *o,
 130                 const struct sr_datafeed_packet *packet, GString **out);
 131 SR_API int sr_output_free(struct sr_output *o);
 132
 133 /*--- trigger.c -------------------------------------------------------------*/
 134
 135 SR_API struct sr_trigger *sr_trigger_new(char *name);
 136 SR_API void sr_trigger_free(struct sr_trigger *trig);
 137 SR_API struct sr_trigger_stage *sr_trigger_stage_new(struct sr_trigger *trig);
 138 SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
 139                 struct sr_channel *ch, int trigger_match, float value);
 140
 141 /*--- strutil.c -------------------------------------------------------------*/
 142
 143 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
 144 SR_API char *sr_samplerate_string(uint64_t samplerate);
 145 SR_API char *sr_period_string(uint64_t frequency);
 146 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
 147 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
 148                 const char *triggerstring);
 149 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
 150 SR_API uint64_t sr_parse_timestring(const char *timestring);
 151 SR_API gboolean sr_parse_boolstring(const char *boolstring);
 152 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
 153 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
 154
 155 /*--- version.c -------------------------------------------------------------*/
 156
 157 SR_API int sr_package_version_major_get(void);
 158 SR_API int sr_package_version_minor_get(void);
 159 SR_API int sr_package_version_micro_get(void);
 160 SR_API const char *sr_package_version_string_get(void);
 161
 162 SR_API int sr_lib_version_current_get(void);
 163 SR_API int sr_lib_version_revision_get(void);
 164 SR_API int sr_lib_version_age_get(void);
 165 SR_API const char *sr_lib_version_string_get(void);
 166
 167 /*--- error.c ---------------------------------------------------------------*/
 168
 169 SR_API const char *sr_strerror(int error_code);
 170 SR_API const char *sr_strerror_name(int error_code);
 171
 172 #endif