libsigrok
sigrok-proto.h
Go to the documentation of this file.
00001 /*
00002  * This file is part of the sigrok project.
00003  *
00004  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
00005  *
00006  * This program is free software: you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation, either version 3 of the License, or
00009  * (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
00018  */
00019 
00020 #ifndef LIBSIGROK_SIGROK_PROTO_H
00021 #define LIBSIGROK_SIGROK_PROTO_H
00022 
00023 /*--- backend.c -------------------------------------------------------------*/
00024 
00025 SR_API int sr_init(void);
00026 SR_API int sr_exit(void);
00027 
00028 /*--- log.c -----------------------------------------------------------------*/
00029 
00030 typedef int (*sr_log_callback_t)(void *cb_data, int loglevel,
00031                                  const char *format, va_list args);
00032 
00033 SR_API int sr_log_loglevel_set(int loglevel);
00034 SR_API int sr_log_loglevel_get(void);
00035 SR_API int sr_log_callback_set(sr_log_callback_t cb, void *cb_data);
00036 SR_API int sr_log_callback_set_default(void);
00037 SR_API int sr_log_logdomain_set(const char *logdomain);
00038 SR_API char *sr_log_logdomain_get(void);
00039 
00040 /*--- datastore.c -----------------------------------------------------------*/
00041 
00042 SR_API int sr_datastore_new(int unitsize, struct sr_datastore **ds);
00043 SR_API int sr_datastore_destroy(struct sr_datastore *ds);
00044 SR_API int sr_datastore_put(struct sr_datastore *ds, void *data,
00045                             unsigned int length, int in_unitsize,
00046                             const int *probelist);
00047 
00048 /*--- device.c --------------------------------------------------------------*/
00049 
00050 SR_API int sr_dev_scan(void);
00051 SR_API GSList *sr_dev_list(void);
00052 SR_API struct sr_dev *sr_dev_new(const struct sr_dev_driver *driver,
00053                                  int driver_index);
00054 SR_API int sr_dev_probe_add(struct sr_dev *dev, const char *name);
00055 SR_API struct sr_probe *sr_dev_probe_find(const struct sr_dev *dev,
00056                                           int probenum);
00057 SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum,
00058                                  const char *name);
00059 SR_API int sr_dev_trigger_remove_all(struct sr_dev *dev);
00060 SR_API int sr_dev_trigger_set(struct sr_dev *dev, int probenum,
00061                               const char *trigger);
00062 SR_API gboolean sr_dev_has_hwcap(const struct sr_dev *dev, int hwcap);
00063 SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data);
00064 
00065 /*--- filter.c --------------------------------------------------------------*/
00066 
00067 SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
00068                             const int *probelist, const uint8_t *data_in,
00069                             uint64_t length_in, uint8_t **data_out,
00070                             uint64_t *length_out);
00071 
00072 /*--- hwdriver.c ------------------------------------------------------------*/
00073 
00074 SR_API struct sr_dev_driver **sr_driver_list(void);
00075 SR_API int sr_driver_init(struct sr_dev_driver *driver);
00076 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap);
00077 SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap);
00078 
00079 /*--- session.c -------------------------------------------------------------*/
00080 
00081 typedef void (*sr_datafeed_callback_t)(struct sr_dev *dev,
00082                                        struct sr_datafeed_packet *packet);
00083 
00084 /* Session setup */
00085 SR_API int sr_session_load(const char *filename);
00086 SR_API struct sr_session *sr_session_new(void);
00087 SR_API int sr_session_destroy(void);
00088 SR_API int sr_session_dev_remove_all(void);
00089 SR_API int sr_session_dev_add(struct sr_dev *dev);
00090 
00091 /* Datafeed setup */
00092 SR_API int sr_session_datafeed_callback_remove_all(void);
00093 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
00094 
00095 /* Session control */
00096 SR_API int sr_session_start(void);
00097 SR_API int sr_session_run(void);
00098 SR_API int sr_session_halt(void);
00099 SR_API int sr_session_stop(void);
00100 SR_API int sr_session_save(const char *filename);
00101 SR_API int sr_session_source_add(int fd, int events, int timeout,
00102                 sr_receive_data_callback_t cb, void *cb_data);
00103 SR_API int sr_session_source_remove(int fd);
00104 
00105 /*--- input/input.c ---------------------------------------------------------*/
00106 
00107 SR_API struct sr_input_format **sr_input_list(void);
00108 
00109 /*--- output/output.c -------------------------------------------------------*/
00110 
00111 SR_API struct sr_output_format **sr_output_list(void);
00112 
00113 /*--- strutil.c -------------------------------------------------------------*/
00114 
00115 SR_API char *sr_samplerate_string(uint64_t samplerate);
00116 SR_API char *sr_period_string(uint64_t frequency);
00117 SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
00118                                      const char *triggerstring);
00119 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
00120 SR_API uint64_t sr_parse_timestring(const char *timestring);
00121 SR_API gboolean sr_parse_boolstring(const char *boolstring);
00122 
00123 /*--- version.c -------------------------------------------------------------*/
00124 
00125 SR_API int sr_package_version_major_get(void);
00126 SR_API int sr_package_version_minor_get(void);
00127 SR_API int sr_package_version_micro_get(void);
00128 SR_API const char *sr_package_version_string_get(void);
00129 
00130 SR_API int sr_lib_version_current_get(void);
00131 SR_API int sr_lib_version_revision_get(void);
00132 SR_API int sr_lib_version_age_get(void);
00133 SR_API const char *sr_lib_version_string_get(void);
00134 
00135 #endif
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines