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