X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=include%2Flibsigrok%2Fproto.h;h=c799919e267a710dfed69de94db5a303dec8edd9;hb=962172e4950f3fbc42d5a79cdf63dc179d7513be;hp=f11efeda3712572c7719c23ef35bc12f9c39f2a0;hpb=00ebcbf48a775e56b6e73a39e69af390db547865;p=libsigrok.git diff --git a/include/libsigrok/proto.h b/include/libsigrok/proto.h index f11efeda..c799919e 100644 --- a/include/libsigrok/proto.h +++ b/include/libsigrok/proto.h @@ -26,6 +26,20 @@ * Header file containing API function prototypes. */ +/*--- analog.c --------------------------------------------------------------*/ + +SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog, + float *buf); +SR_API const char *sr_analog_si_prefix(float *value, int *digits); +SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog, + char **result); +SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q); +SR_API int sr_rational_eq(const struct sr_rational *a, const struct sr_rational *b); +SR_API int sr_rational_mult(struct sr_rational *res, const struct sr_rational *a, + const struct sr_rational *b); +SR_API int sr_rational_div(struct sr_rational *res, const struct sr_rational *num, + const struct sr_rational *div); + /*--- backend.c -------------------------------------------------------------*/ SR_API int sr_init(struct sr_context **ctx); @@ -40,55 +54,76 @@ SR_API int sr_log_loglevel_set(int loglevel); SR_API int sr_log_loglevel_get(void); SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data); SR_API int sr_log_callback_set_default(void); -SR_API int sr_log_logdomain_set(const char *logdomain); -SR_API char *sr_log_logdomain_get(void); /*--- device.c --------------------------------------------------------------*/ -SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi, - int channelnum, const char *name); -SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum, +SR_API int sr_dev_channel_name_set(struct sr_channel *channel, + const char *name); +SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state); SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key); +SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg, int key); +SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver, + const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver); SR_API int sr_dev_clear(const struct sr_dev_driver *driver); SR_API int sr_dev_open(struct sr_dev_inst *sdi); SR_API int sr_dev_close(struct sr_dev_inst *sdi); +SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi); +SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi); +SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi); +SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi); +SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi); +SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi); +SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi); +SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi); + +SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor, + const char *model, const char *version); +SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name); + /*--- hwdriver.c ------------------------------------------------------------*/ -SR_API struct sr_dev_driver **sr_driver_list(void); +SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx); SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver); +SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver); SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options); SR_API int sr_config_get(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, - int key, GVariant **data); + uint32_t key, GVariant **data); SR_API int sr_config_set(const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, - int key, GVariant *data); + uint32_t key, GVariant *data); SR_API int sr_config_commit(const struct sr_dev_inst *sdi); SR_API int sr_config_list(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, - int key, GVariant **data); -SR_API const struct sr_config_info *sr_config_info_get(int key); -SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname); + uint32_t key, GVariant **data); +SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key); +SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid); /*--- session.c -------------------------------------------------------------*/ +typedef void (*sr_session_stopped_callback)(void *data); typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data); + SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session); /* Session setup */ -SR_API int sr_session_load(const char *filename, struct sr_session **session); -SR_API int sr_session_new(struct sr_session **session); +SR_API int sr_session_load(struct sr_context *ctx, const char *filename, + struct sr_session **session); +SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session); SR_API int sr_session_destroy(struct sr_session *session); SR_API int sr_session_dev_remove_all(struct sr_session *session); SR_API int sr_session_dev_add(struct sr_session *session, struct sr_dev_inst *sdi); +SR_API int sr_session_dev_remove(struct sr_session *session, + struct sr_dev_inst *sdi); SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist); SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig); @@ -101,39 +136,63 @@ SR_API int sr_session_datafeed_callback_add(struct sr_session *session, SR_API int sr_session_start(struct sr_session *session); SR_API int sr_session_run(struct sr_session *session); SR_API int sr_session_stop(struct sr_session *session); -SR_API int sr_session_save(struct sr_session *session, const char *filename, - const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize, - int units); -SR_API int sr_session_save_init(struct sr_session *session, - const char *filename, uint64_t samplerate, char **channels); -SR_API int sr_session_append(struct sr_session *session, - const char *filename, unsigned char *buf, int unitsize, int units); -SR_API int sr_session_source_add(struct sr_session *session, int fd, - int events, int timeout, sr_receive_data_callback cb, void *cb_data); -SR_API int sr_session_source_add_pollfd(struct sr_session *session, - GPollFD *pollfd, int timeout, sr_receive_data_callback cb, - void *cb_data); -SR_API int sr_session_source_add_channel(struct sr_session *session, - GIOChannel *channel, int events, int timeout, - sr_receive_data_callback cb, void *cb_data); -SR_API int sr_session_source_remove(struct sr_session *session, int fd); -SR_API int sr_session_source_remove_pollfd(struct sr_session *session, - GPollFD *pollfd); -SR_API int sr_session_source_remove_channel(struct sr_session *session, - GIOChannel *channel); +SR_API int sr_session_is_running(struct sr_session *session); +SR_API int sr_session_stopped_callback_set(struct sr_session *session, + sr_session_stopped_callback cb, void *cb_data); /*--- input/input.c ---------------------------------------------------------*/ -SR_API struct sr_input_format **sr_input_list(void); +SR_API const struct sr_input_module **sr_input_list(void); +SR_API const char *sr_input_id_get(const struct sr_input_module *imod); +SR_API const char *sr_input_name_get(const struct sr_input_module *imod); +SR_API const char *sr_input_description_get(const struct sr_input_module *imod); +SR_API const char *const *sr_input_extensions_get( + const struct sr_input_module *imod); +SR_API const struct sr_input_module *sr_input_find(char *id); +SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod); +SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod, + uint64_t flag); +SR_API void sr_input_options_free(const struct sr_option **options); +SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod, + GHashTable *options); +SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in); +SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in); +SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in); +SR_API int sr_input_send(const struct sr_input *in, GString *buf); +SR_API int sr_input_end(const struct sr_input *in); +SR_API int sr_input_reset(const struct sr_input *in); +SR_API void sr_input_free(const struct sr_input *in); /*--- output/output.c -------------------------------------------------------*/ -SR_API struct sr_output_format **sr_output_list(void); -SR_API struct sr_output *sr_output_new(struct sr_output_format *of, - GHashTable *params, const struct sr_dev_inst *sdi); -SR_API int sr_output_send(struct sr_output *o, +SR_API const struct sr_output_module **sr_output_list(void); +SR_API const char *sr_output_id_get(const struct sr_output_module *omod); +SR_API const char *sr_output_name_get(const struct sr_output_module *omod); +SR_API const char *sr_output_description_get(const struct sr_output_module *omod); +SR_API const char *const *sr_output_extensions_get( + const struct sr_output_module *omod); +SR_API const struct sr_output_module *sr_output_find(char *id); +SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod); +SR_API void sr_output_options_free(const struct sr_option **opts); +SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod, + GHashTable *params, const struct sr_dev_inst *sdi, + const char *filename); +SR_API int sr_output_send(const struct sr_output *o, const struct sr_datafeed_packet *packet, GString **out); -SR_API int sr_output_free(struct sr_output *o); +SR_API int sr_output_free(const struct sr_output *o); + +/*--- transform/transform.c -------------------------------------------------*/ + +SR_API const struct sr_transform_module **sr_transform_list(void); +SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod); +SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod); +SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod); +SR_API const struct sr_transform_module *sr_transform_find(const char *id); +SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod); +SR_API void sr_transform_options_free(const struct sr_option **opts); +SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod, + GHashTable *params, const struct sr_dev_inst *sdi); +SR_API int sr_transform_free(const struct sr_transform *t); /*--- trigger.c -------------------------------------------------------------*/ @@ -143,6 +202,25 @@ SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig); SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage, struct sr_channel *ch, int trigger_match, float value); +/*--- serial.c --------------------------------------------------------------*/ + +SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver); +SR_API void sr_serial_free(struct sr_serial_port *serial); + +/*--- resource.c ------------------------------------------------------------*/ + +typedef int (*sr_resource_open_callback)(struct sr_resource *res, + const char *name, void *cb_data); +typedef int (*sr_resource_close_callback)(struct sr_resource *res, + void *cb_data); +typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res, + void *buf, size_t count, void *cb_data); + +SR_API int sr_resource_set_hooks(struct sr_context *ctx, + sr_resource_open_callback open_cb, + sr_resource_close_callback close_cb, + sr_resource_read_callback read_cb, void *cb_data); + /*--- strutil.c -------------------------------------------------------------*/ SR_API char *sr_si_string_u64(uint64_t x, const char *unit); @@ -154,6 +232,7 @@ SR_API uint64_t sr_parse_timestring(const char *timestring); SR_API gboolean sr_parse_boolstring(const char *boolstring); SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q); SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q); +SR_API int sr_parse_rational(const char *str, struct sr_rational *ret); /*--- version.c -------------------------------------------------------------*/