include/libsigrok/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 gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
  53 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
  54 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
  55 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
  56 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
  57
  58 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
  59 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
  60 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
  61 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
  62 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
  63 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
  64 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
  65 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
  66
  67 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
  68                 const char *model, const char *version);
  69 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
  70
  71 /*--- hwdriver.c ------------------------------------------------------------*/
  72
  73 SR_API struct sr_dev_driver **sr_driver_list(void);
  74 SR_API int sr_driver_init(struct sr_context *ctx,
  75                 struct sr_dev_driver *driver);
  76 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
  77 SR_API int sr_config_get(const struct sr_dev_driver *driver,
  78                 const struct sr_dev_inst *sdi,
  79                 const struct sr_channel_group *cg,
  80                 uint32_t key, GVariant **data);
  81 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
  82                 const struct sr_channel_group *cg,
  83                 uint32_t key, GVariant *data);
  84 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
  85 SR_API int sr_config_list(const struct sr_dev_driver *driver,
  86                 const struct sr_dev_inst *sdi,
  87                 const struct sr_channel_group *cg,
  88                 uint32_t key, GVariant **data);
  89 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key);
  90 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
  91
  92 /*--- session.c -------------------------------------------------------------*/
  93
  94 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
  95                 const struct sr_datafeed_packet *packet, void *cb_data);
  96 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
  97
  98 /* Session setup */
  99 SR_API int sr_session_load(const char *filename, struct sr_session **session);
 100 SR_API int sr_session_new(struct sr_session **session);
 101 SR_API int sr_session_destroy(struct sr_session *session);
 102 SR_API int sr_session_dev_remove_all(struct sr_session *session);
 103 SR_API int sr_session_dev_add(struct sr_session *session,
 104                 struct sr_dev_inst *sdi);
 105 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
 106 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
 107
 108 /* Datafeed setup */
 109 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
 110 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
 111                 sr_datafeed_callback cb, void *cb_data);
 112
 113 /* Session control */
 114 SR_API int sr_session_start(struct sr_session *session);
 115 SR_API int sr_session_run(struct sr_session *session);
 116 SR_API int sr_session_stop(struct sr_session *session);
 117 SR_API int sr_session_save(struct sr_session *session, const char *filename,
 118                 const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
 119                 int units);
 120 SR_API int sr_session_save_init(struct sr_session *session,
 121                 const char *filename, uint64_t samplerate, char **channels);
 122 SR_API int sr_session_append(struct sr_session *session,
 123                 const char *filename, unsigned char *buf, int unitsize, int units);
 124 SR_API int sr_session_source_add(struct sr_session *session, int fd,
 125                 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
 126 SR_API int sr_session_source_add_pollfd(struct sr_session *session,
 127                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 128                 void *cb_data);
 129 SR_API int sr_session_source_add_channel(struct sr_session *session,
 130                 GIOChannel *channel, int events, int timeout,
 131                 sr_receive_data_callback cb, void *cb_data);
 132 SR_API int sr_session_source_remove(struct sr_session *session, int fd);
 133 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
 134                 GPollFD *pollfd);
 135 SR_API int sr_session_source_remove_channel(struct sr_session *session,
 136                 GIOChannel *channel);
 137
 138 /*--- input/input.c ---------------------------------------------------------*/
 139
 140 SR_API const struct sr_input_module **sr_input_list(void);
 141 SR_API const char *sr_input_id_get(const struct sr_input_module *in);
 142 SR_API const char *sr_input_name_get(const struct sr_input_module *in);
 143 SR_API const char *sr_input_description_get(const struct sr_input_module *in);
 144 SR_API const struct sr_input_module *sr_input_find(char *id);
 145 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *in);
 146 SR_API void sr_input_options_free(const struct sr_option **options);
 147 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
 148                 GHashTable *options);
 149 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
 150 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
 151 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
 152 SR_API int sr_input_send(const struct sr_input *in, GString *buf);
 153 SR_API int sr_input_end(const struct sr_input *in);
 154 SR_API void sr_input_free(const struct sr_input *in);
 155
 156 /*--- output/output.c -------------------------------------------------------*/
 157
 158 SR_API const struct sr_output_module **sr_output_list(void);
 159 SR_API const char *sr_output_id_get(const struct sr_output_module *o);
 160 SR_API const char *sr_output_name_get(const struct sr_output_module *o);
 161 SR_API const char *sr_output_description_get(const struct sr_output_module *o);
 162 SR_API const struct sr_output_module *sr_output_find(char *id);
 163 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *o);
 164 SR_API void sr_output_options_free(const struct sr_option **opts);
 165 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
 166                 GHashTable *params, const struct sr_dev_inst *sdi);
 167 SR_API int sr_output_send(const struct sr_output *o,
 168                 const struct sr_datafeed_packet *packet, GString **out);
 169 SR_API int sr_output_free(const struct sr_output *o);
 170
 171 /*--- trigger.c -------------------------------------------------------------*/
 172
 173 SR_API struct sr_trigger *sr_trigger_new(const char *name);
 174 SR_API void sr_trigger_free(struct sr_trigger *trig);
 175 SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
 176 SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
 177                 struct sr_channel *ch, int trigger_match, float value);
 178
 179 /*--- strutil.c -------------------------------------------------------------*/
 180
 181 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
 182 SR_API char *sr_samplerate_string(uint64_t samplerate);
 183 SR_API char *sr_period_string(uint64_t frequency);
 184 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
 185 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
 186 SR_API uint64_t sr_parse_timestring(const char *timestring);
 187 SR_API gboolean sr_parse_boolstring(const char *boolstring);
 188 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
 189 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
 190
 191 /*--- version.c -------------------------------------------------------------*/
 192
 193 SR_API int sr_package_version_major_get(void);
 194 SR_API int sr_package_version_minor_get(void);
 195 SR_API int sr_package_version_micro_get(void);
 196 SR_API const char *sr_package_version_string_get(void);
 197
 198 SR_API int sr_lib_version_current_get(void);
 199 SR_API int sr_lib_version_revision_get(void);
 200 SR_API int sr_lib_version_age_get(void);
 201 SR_API const char *sr_lib_version_string_get(void);
 202
 203 /*--- error.c ---------------------------------------------------------------*/
 204
 205 SR_API const char *sr_strerror(int error_code);
 206 SR_API const char *sr_strerror_name(int error_code);
 207
 208 #endif