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 /*--- analog.c --------------------------------------------------------------*/
  30
  31 SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog,
  32                 float *buf);
  33 SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
  34                 char **result);
  35 SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q);
  36
  37 /*--- backend.c -------------------------------------------------------------*/
  38
  39 SR_API int sr_init(struct sr_context **ctx);
  40 SR_API int sr_exit(struct sr_context *ctx);
  41
  42 /*--- log.c -----------------------------------------------------------------*/
  43
  44 typedef int (*sr_log_callback)(void *cb_data, int loglevel,
  45                                 const char *format, va_list args);
  46
  47 SR_API int sr_log_loglevel_set(int loglevel);
  48 SR_API int sr_log_loglevel_get(void);
  49 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
  50 SR_API int sr_log_callback_set_default(void);
  51
  52 /*--- device.c --------------------------------------------------------------*/
  53
  54 SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
  55                 const char *name);
  56 SR_API int sr_dev_channel_enable(struct sr_channel *channel,
  57                 gboolean state);
  58 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
  59 SR_API int sr_dev_config_capabilities(const struct sr_dev_inst *sdi,
  60                 const struct sr_channel_group *cg, int key);
  61 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
  62 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
  63 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
  64 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
  65
  66 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
  67 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
  68 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
  69 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
  70 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
  71 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
  72 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
  73 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
  74
  75 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
  76                 const char *model, const char *version);
  77 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
  78
  79 /*--- hwdriver.c ------------------------------------------------------------*/
  80
  81 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
  82 SR_API int sr_driver_init(struct sr_context *ctx,
  83                 struct sr_dev_driver *driver);
  84 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
  85 SR_API int sr_config_get(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 int sr_config_set(const struct sr_dev_inst *sdi,
  90                 const struct sr_channel_group *cg,
  91                 uint32_t key, GVariant *data);
  92 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
  93 SR_API int sr_config_list(const struct sr_dev_driver *driver,
  94                 const struct sr_dev_inst *sdi,
  95                 const struct sr_channel_group *cg,
  96                 uint32_t key, GVariant **data);
  97 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key);
  98 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid);
  99
 100 /*--- session.c -------------------------------------------------------------*/
 101
 102 typedef void (*sr_session_stopped_callback)(void *data);
 103 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
 104                 const struct sr_datafeed_packet *packet, void *cb_data);
 105
 106 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
 107
 108 /* Session setup */
 109 SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
 110         struct sr_session **session);
 111 SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
 112 SR_API int sr_session_destroy(struct sr_session *session);
 113 SR_API int sr_session_dev_remove_all(struct sr_session *session);
 114 SR_API int sr_session_dev_add(struct sr_session *session,
 115                 struct sr_dev_inst *sdi);
 116 SR_API int sr_session_dev_remove(struct sr_session *session,
 117                 struct sr_dev_inst *sdi);
 118 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
 119 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
 120
 121 /* Datafeed setup */
 122 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
 123 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
 124                 sr_datafeed_callback cb, void *cb_data);
 125
 126 /* Session control */
 127 SR_API int sr_session_start(struct sr_session *session);
 128 SR_API int sr_session_run(struct sr_session *session);
 129 SR_API int sr_session_stop(struct sr_session *session);
 130 SR_API int sr_session_is_running(struct sr_session *session);
 131 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
 132                 sr_session_stopped_callback cb, void *cb_data);
 133
 134 /*--- input/input.c ---------------------------------------------------------*/
 135
 136 SR_API const struct sr_input_module **sr_input_list(void);
 137 SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
 138 SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
 139 SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
 140 SR_API const char *const *sr_input_extensions_get(
 141                 const struct sr_input_module *imod);
 142 SR_API const struct sr_input_module *sr_input_find(char *id);
 143 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
 144 SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
 145                 uint64_t flag);
 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 *omod);
 160 SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
 161 SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
 162 SR_API const char *const *sr_output_extensions_get(
 163                 const struct sr_output_module *omod);
 164 SR_API const struct sr_output_module *sr_output_find(char *id);
 165 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
 166 SR_API void sr_output_options_free(const struct sr_option **opts);
 167 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
 168                 GHashTable *params, const struct sr_dev_inst *sdi,
 169                 const char *filename);
 170 SR_API int sr_output_send(const struct sr_output *o,
 171                 const struct sr_datafeed_packet *packet, GString **out);
 172 SR_API int sr_output_free(const struct sr_output *o);
 173
 174 /*--- transform/transform.c -------------------------------------------------*/
 175
 176 SR_API const struct sr_transform_module **sr_transform_list(void);
 177 SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
 178 SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
 179 SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
 180 SR_API const struct sr_transform_module *sr_transform_find(const char *id);
 181 SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
 182 SR_API void sr_transform_options_free(const struct sr_option **opts);
 183 SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
 184                 GHashTable *params, const struct sr_dev_inst *sdi);
 185 SR_API int sr_transform_free(const struct sr_transform *t);
 186
 187 /*--- trigger.c -------------------------------------------------------------*/
 188
 189 SR_API struct sr_trigger *sr_trigger_new(const char *name);
 190 SR_API void sr_trigger_free(struct sr_trigger *trig);
 191 SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
 192 SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
 193                 struct sr_channel *ch, int trigger_match, float value);
 194
 195 /*--- serial.c --------------------------------------------------------------*/
 196
 197 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
 198 SR_API void sr_serial_free(struct sr_serial_port *serial);
 199
 200 /*--- resource.c ------------------------------------------------------------*/
 201
 202 typedef int (*sr_resource_open_callback)(struct sr_resource *res,
 203                 const char *name, void *cb_data);
 204 typedef int (*sr_resource_close_callback)(struct sr_resource *res,
 205                 void *cb_data);
 206 typedef ssize_t (*sr_resource_read_callback)(const struct sr_resource *res,
 207                 void *buf, size_t count, void *cb_data);
 208
 209 SR_API int sr_resource_set_hooks(struct sr_context *ctx,
 210                 sr_resource_open_callback open_cb,
 211                 sr_resource_close_callback close_cb,
 212                 sr_resource_read_callback read_cb, void *cb_data);
 213
 214 /*--- strutil.c -------------------------------------------------------------*/
 215
 216 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
 217 SR_API char *sr_samplerate_string(uint64_t samplerate);
 218 SR_API char *sr_period_string(uint64_t frequency);
 219 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
 220 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
 221 SR_API uint64_t sr_parse_timestring(const char *timestring);
 222 SR_API gboolean sr_parse_boolstring(const char *boolstring);
 223 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
 224 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
 225
 226 /*--- version.c -------------------------------------------------------------*/
 227
 228 SR_API int sr_package_version_major_get(void);
 229 SR_API int sr_package_version_minor_get(void);
 230 SR_API int sr_package_version_micro_get(void);
 231 SR_API const char *sr_package_version_string_get(void);
 232
 233 SR_API int sr_lib_version_current_get(void);
 234 SR_API int sr_lib_version_revision_get(void);
 235 SR_API int sr_lib_version_age_get(void);
 236 SR_API const char *sr_lib_version_string_get(void);
 237
 238 /*--- error.c ---------------------------------------------------------------*/
 239
 240 SR_API const char *sr_strerror(int error_code);
 241 SR_API const char *sr_strerror_name(int error_code);
 242
 243 #endif