]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 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_SIGROK_PROTO_H | |
21 | #define LIBSIGROK_SIGROK_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_t)(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_t 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_probe_name_set(const struct sr_dev_inst *sdi, | |
49 | int probenum, const char *name); | |
50 | SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, | |
51 | gboolean state); | |
52 | SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, | |
53 | const char *trigger); | |
54 | SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key); | |
55 | SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver); | |
56 | SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver); | |
57 | ||
58 | /*--- filter.c --------------------------------------------------------------*/ | |
59 | ||
60 | SR_API int sr_filter_probes(unsigned int in_unitsize, unsigned int out_unitsize, | |
61 | const GArray *probe_array, const uint8_t *data_in, | |
62 | uint64_t length_in, uint8_t **data_out, | |
63 | uint64_t *length_out); | |
64 | ||
65 | /*--- hwdriver.c ------------------------------------------------------------*/ | |
66 | ||
67 | SR_API struct sr_dev_driver **sr_driver_list(void); | |
68 | SR_API int sr_driver_init(struct sr_context *ctx, | |
69 | struct sr_dev_driver *driver); | |
70 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options); | |
71 | SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, | |
72 | const void **data, const struct sr_dev_inst *sdi); | |
73 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, | |
74 | const void *value); | |
75 | SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, | |
76 | const void **data, const struct sr_dev_inst *sdi); | |
77 | SR_API const struct sr_config_info *sr_config_info_get(int key); | |
78 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname); | |
79 | ||
80 | /*--- session.c -------------------------------------------------------------*/ | |
81 | ||
82 | typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi, | |
83 | const struct sr_datafeed_packet *packet); | |
84 | ||
85 | /* Session setup */ | |
86 | SR_API int sr_session_load(const char *filename); | |
87 | SR_API struct sr_session *sr_session_new(void); | |
88 | SR_API int sr_session_destroy(void); | |
89 | SR_API int sr_session_dev_remove_all(void); | |
90 | SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi); | |
91 | ||
92 | /* Datafeed setup */ | |
93 | SR_API int sr_session_datafeed_callback_remove_all(void); | |
94 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb); | |
95 | ||
96 | /* Session control */ | |
97 | SR_API int sr_session_start(void); | |
98 | SR_API int sr_session_run(void); | |
99 | SR_API int sr_session_halt(void); | |
100 | SR_API int sr_session_stop(void); | |
101 | SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi, | |
102 | unsigned char *buf, int unitsize, int units); | |
103 | SR_API int sr_session_source_add(int fd, int events, int timeout, | |
104 | sr_receive_data_callback_t cb, void *cb_data); | |
105 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, | |
106 | sr_receive_data_callback_t cb, void *cb_data); | |
107 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, | |
108 | int timeout, sr_receive_data_callback_t cb, void *cb_data); | |
109 | SR_API int sr_session_source_remove(int fd); | |
110 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd); | |
111 | SR_API int sr_session_source_remove_channel(GIOChannel *channel); | |
112 | ||
113 | /*--- input/input.c ---------------------------------------------------------*/ | |
114 | ||
115 | SR_API struct sr_input_format **sr_input_list(void); | |
116 | ||
117 | /*--- output/output.c -------------------------------------------------------*/ | |
118 | ||
119 | SR_API struct sr_output_format **sr_output_list(void); | |
120 | ||
121 | /*--- strutil.c -------------------------------------------------------------*/ | |
122 | ||
123 | SR_API char *sr_si_string_u64(uint64_t x, const char *unit); | |
124 | SR_API char *sr_samplerate_string(uint64_t samplerate); | |
125 | SR_API char *sr_period_string(uint64_t frequency); | |
126 | SR_API char *sr_voltage_string(struct sr_rational *voltage); | |
127 | SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, | |
128 | const char *triggerstring); | |
129 | SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size); | |
130 | SR_API uint64_t sr_parse_timestring(const char *timestring); | |
131 | SR_API gboolean sr_parse_boolstring(const char *boolstring); | |
132 | SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r); | |
133 | SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r); | |
134 | ||
135 | /*--- version.c -------------------------------------------------------------*/ | |
136 | ||
137 | SR_API int sr_package_version_major_get(void); | |
138 | SR_API int sr_package_version_minor_get(void); | |
139 | SR_API int sr_package_version_micro_get(void); | |
140 | SR_API const char *sr_package_version_string_get(void); | |
141 | ||
142 | SR_API int sr_lib_version_current_get(void); | |
143 | SR_API int sr_lib_version_revision_get(void); | |
144 | SR_API int sr_lib_version_age_get(void); | |
145 | SR_API const char *sr_lib_version_string_get(void); | |
146 | ||
147 | /*--- error.c ---------------------------------------------------------------*/ | |
148 | ||
149 | SR_API const char *sr_strerror(int error_code); | |
150 | SR_API const char *sr_strerror_name(int error_code); | |
151 | ||
152 | #endif |