libsigrok  unreleased development snapshot
sigrok hardware access and backend library
proto.h
Go to the documentation of this file.
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 SR_API GSList *sr_buildinfo_libs_get(void);
50 SR_API char *sr_buildinfo_host_get(void);
51 SR_API char *sr_buildinfo_scpi_backends_get(void);
52 
53 /*--- conversion.c ----------------------------------------------------------*/
54 
55 SR_API int sr_a2l_threshold(const struct sr_datafeed_analog *analog,
56  float threshold, uint8_t *output, uint64_t count);
57 SR_API int sr_a2l_schmitt_trigger(const struct sr_datafeed_analog *analog,
58  float lo_thr, float hi_thr, uint8_t *state, uint8_t *output,
59  uint64_t count);
60 
61 /*--- log.c -----------------------------------------------------------------*/
62 
63 typedef int (*sr_log_callback)(void *cb_data, int loglevel,
64  const char *format, va_list args);
65 
66 SR_API int sr_log_loglevel_set(int loglevel);
67 SR_API int sr_log_loglevel_get(void);
68 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
69 SR_API int sr_log_callback_set_default(void);
70 SR_API int sr_log_callback_get(sr_log_callback *cb, void **cb_data);
71 
72 /*--- device.c --------------------------------------------------------------*/
73 
74 SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
75  const char *name);
76 SR_API int sr_dev_channel_enable(struct sr_channel *channel,
77  gboolean state);
78 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
79 SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
80  const struct sr_channel_group *cg, int key);
81 SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
82  const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
83 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
84 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
85 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
86 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
87 
88 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
89 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
90 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
91 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
92 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
93 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
94 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
95 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
96 
97 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
98  const char *model, const char *version);
99 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
100 
101 /*--- hwdriver.c ------------------------------------------------------------*/
102 
103 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
104 SR_API int sr_driver_init(struct sr_context *ctx,
105  struct sr_dev_driver *driver);
106 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver);
107 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
108 SR_API int sr_config_get(const struct sr_dev_driver *driver,
109  const struct sr_dev_inst *sdi,
110  const struct sr_channel_group *cg,
111  uint32_t key, GVariant **data);
112 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
113  const struct sr_channel_group *cg,
114  uint32_t key, GVariant *data);
115 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
116 SR_API int sr_config_list(const struct sr_dev_driver *driver,
117  const struct sr_dev_inst *sdi,
118  const struct sr_channel_group *cg,
119  uint32_t key, GVariant **data);
120 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key);
121 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid);
122 
123 /*--- session.c -------------------------------------------------------------*/
124 
125 typedef void (*sr_session_stopped_callback)(void *data);
126 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
127  const struct sr_datafeed_packet *packet, void *cb_data);
128 
129 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
130 
131 /* Session setup */
132 SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
133  struct sr_session **session);
134 SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
135 SR_API int sr_session_destroy(struct sr_session *session);
136 SR_API int sr_session_dev_remove_all(struct sr_session *session);
137 SR_API int sr_session_dev_add(struct sr_session *session,
138  struct sr_dev_inst *sdi);
139 SR_API int sr_session_dev_remove(struct sr_session *session,
140  struct sr_dev_inst *sdi);
141 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
142 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
143 
144 /* Datafeed setup */
145 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
146 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
147  sr_datafeed_callback cb, void *cb_data);
148 
149 /* Session control */
150 SR_API int sr_session_start(struct sr_session *session);
151 SR_API int sr_session_run(struct sr_session *session);
152 SR_API int sr_session_stop(struct sr_session *session);
153 SR_API int sr_session_is_running(struct sr_session *session);
154 SR_API int sr_session_stopped_callback_set(struct sr_session *session,
155  sr_session_stopped_callback cb, void *cb_data);
156 
157 SR_API int sr_packet_copy(const struct sr_datafeed_packet *packet,
158  struct sr_datafeed_packet **copy);
159 SR_API void sr_packet_free(struct sr_datafeed_packet *packet);
160 
161 /*--- input/input.c ---------------------------------------------------------*/
162 
163 SR_API const struct sr_input_module **sr_input_list(void);
164 SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
165 SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
166 SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
167 SR_API const char *const *sr_input_extensions_get(
168  const struct sr_input_module *imod);
169 SR_API const struct sr_input_module *sr_input_find(const char *id);
170 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
171 SR_API void sr_input_options_free(const struct sr_option **options);
172 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
173  GHashTable *options);
174 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
175 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
176 SR_API const struct sr_input_module *sr_input_module_get(const struct sr_input *in);
177 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
178 SR_API int sr_input_send(const struct sr_input *in, GString *buf);
179 SR_API int sr_input_end(const struct sr_input *in);
180 SR_API int sr_input_reset(const struct sr_input *in);
181 SR_API void sr_input_free(const struct sr_input *in);
182 
183 /*--- output/output.c -------------------------------------------------------*/
184 
185 SR_API const struct sr_output_module **sr_output_list(void);
186 SR_API const char *sr_output_id_get(const struct sr_output_module *omod);
187 SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
188 SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
189 SR_API const char *const *sr_output_extensions_get(
190  const struct sr_output_module *omod);
191 SR_API const struct sr_output_module *sr_output_find(char *id);
192 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
193 SR_API void sr_output_options_free(const struct sr_option **opts);
194 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
195  GHashTable *params, const struct sr_dev_inst *sdi,
196  const char *filename);
197 SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
198  uint64_t flag);
199 SR_API int sr_output_send(const struct sr_output *o,
200  const struct sr_datafeed_packet *packet, GString **out);
201 SR_API int sr_output_free(const struct sr_output *o);
202 
203 /*--- transform/transform.c -------------------------------------------------*/
204 
205 SR_API const struct sr_transform_module **sr_transform_list(void);
206 SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
207 SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
208 SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
209 SR_API const struct sr_transform_module *sr_transform_find(const char *id);
210 SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
211 SR_API void sr_transform_options_free(const struct sr_option **opts);
212 SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
213  GHashTable *params, const struct sr_dev_inst *sdi);
214 SR_API int sr_transform_free(const struct sr_transform *t);
215 
216 /*--- trigger.c -------------------------------------------------------------*/
217 
218 SR_API struct sr_trigger *sr_trigger_new(const char *name);
219 SR_API void sr_trigger_free(struct sr_trigger *trig);
220 SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
221 SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
222  struct sr_channel *ch, int trigger_match, float value);
223 
224 /*--- serial.c --------------------------------------------------------------*/
225 
226 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
227 SR_API void sr_serial_free(struct sr_serial_port *serial);
228 
229 /*--- resource.c ------------------------------------------------------------*/
230 
231 typedef int (*sr_resource_open_callback)(struct sr_resource *res,
232  const char *name, void *cb_data);
233 typedef int (*sr_resource_close_callback)(struct sr_resource *res,
234  void *cb_data);
235 typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res,
236  void *buf, size_t count, void *cb_data);
237 
238 SR_API GSList *sr_resourcepaths_get(int res_type);
239 
240 SR_API int sr_resource_set_hooks(struct sr_context *ctx,
241  sr_resource_open_callback open_cb,
242  sr_resource_close_callback close_cb,
243  sr_resource_read_callback read_cb, void *cb_data);
244 
245 /*--- strutil.c -------------------------------------------------------------*/
246 
247 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
248 SR_API char *sr_samplerate_string(uint64_t samplerate);
249 SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q);
250 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
251 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
252 SR_API uint64_t sr_parse_timestring(const char *timestring);
253 SR_API gboolean sr_parse_boolstring(const char *boolstring);
254 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
255 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
256 SR_API char **sr_parse_probe_names(const char *spec,
257  const char **dflt_names, size_t dflt_count,
258  size_t max_count, size_t *ret_count);
259 SR_API void sr_free_probe_names(char **names);
260 SR_API int sr_sprintf_ascii(char *buf, const char *format, ...);
261 SR_API int sr_vsprintf_ascii(char *buf, const char *format, va_list args);
262 SR_API int sr_snprintf_ascii(char *buf, size_t buf_size,
263  const char *format, ...);
264 SR_API int sr_vsnprintf_ascii(char *buf, size_t buf_size,
265  const char *format, va_list args);
266 SR_API int sr_parse_rational(const char *str, struct sr_rational *ret);
267 SR_API char *sr_text_trim_spaces(char *s);
268 SR_API char *sr_text_next_line(char *s, size_t l, char **next, size_t *taken);
269 SR_API char *sr_text_next_word(char *s, char **next);
270 
271 SR_API int sr_next_power_of_two(size_t value, size_t *bits, size_t *power);
272 
273 /*--- version.c -------------------------------------------------------------*/
274 
275 SR_API int sr_package_version_major_get(void);
276 SR_API int sr_package_version_minor_get(void);
277 SR_API int sr_package_version_micro_get(void);
278 SR_API const char *sr_package_version_string_get(void);
279 
280 SR_API int sr_lib_version_current_get(void);
281 SR_API int sr_lib_version_revision_get(void);
282 SR_API int sr_lib_version_age_get(void);
283 SR_API const char *sr_lib_version_string_get(void);
284 
285 /*--- error.c ---------------------------------------------------------------*/
286 
287 SR_API const char *sr_strerror(int error_code);
288 SR_API const char *sr_strerror_name(int error_code);
289 
290 #endif
sr_serial_port
Serial port descriptor.
Definition: libsigrok.h:1322
sr_input_scan_buffer
int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
Try to find an input module that can parse the given buffer.
Definition: input.c:370
sr_output_send
int sr_output_send(const struct sr_output *o, const struct sr_datafeed_packet *packet, GString **out)
Send a packet to the specified output instance.
Definition: output.c:336
sr_output_extensions_get
const char *const * sr_output_extensions_get(const struct sr_output_module *omod)
Returns the specified output module&#39;s file extensions typical for the file format, as a NULL terminated array, or returns a NULL pointer if there is no preferred extension.
Definition: output.c:151
sr_sprintf_ascii
int sr_sprintf_ascii(char *buf, const char *format,...)
Compose a string with a format string in the buffer pointed to by buf.
Definition: strutil.c:467
sr_input_id_get
const char * sr_input_id_get(const struct sr_input_module *imod)
Returns the specified input module&#39;s ID.
Definition: input.c:113
sr_text_next_line
char * sr_text_next_line(char *s, size_t l, char **next, size_t *taken)
Check for another complete text line, trim, return consumed char count.
Definition: strutil.c:1741
sr_channel
Information on single channel.
Definition: libsigrok.h:639
sr_analog_to_float
int sr_analog_to_float(const struct sr_datafeed_analog *analog, float *buf)
Convert an analog datafeed payload to an array of floats.
Definition: analog.c:177
sr_packet_free
void sr_packet_free(struct sr_datafeed_packet *packet)
Definition: session.c:1577
sr_dev_inst_channel_groups_get
GSList * sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; channel groups list.
Definition: device.c:963
sr_dev_open
int sr_dev_open(struct sr_dev_inst *sdi)
Open the specified device instance.
Definition: device.c:726
sr_dev_inst_channel_add
int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
Add a new channel to the specified device instance.
Definition: device.c:489
sr_input_free
void sr_input_free(const struct sr_input *in)
Free the specified input instance and all associated resources.
Definition: input.c:675
int
typedef int
Definition: lzoconf.h:282
sr_parse_boolstring
gboolean sr_parse_boolstring(const char *boolstring)
Definition: strutil.c:1253
sr_vsprintf_ascii
int sr_vsprintf_ascii(char *buf, const char *format, va_list args)
Compose a string with a format string in the buffer pointed to by buf.
Definition: strutil.c:506
sr_output_list
const struct sr_output_module ** sr_output_list(void)
Returns a NULL-terminated list of all available output modules.
Definition: output.c:93
sr_serial_list
GSList * sr_serial_list(const struct sr_dev_driver *driver)
List available serial devices.
Definition: serial.c:1074
sr_transform_find
const struct sr_transform_module * sr_transform_find(const char *id)
Return the transform module with the specified ID, or NULL if no module with that ID is found...
Definition: transform.c:118
sr_resource_open_callback
int(* sr_resource_open_callback)(struct sr_resource *res, const char *name, void *cb_data)
Definition: proto.h:231
sr_transform_options_get
const struct sr_option ** sr_transform_options_get(const struct sr_transform_module *tmod)
Returns a NULL-terminated array of struct sr_option, or NULL if the module takes no options...
Definition: transform.c:139
sr_config_get
int sr_config_get(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, uint32_t key, GVariant **data)
Query value of a configuration key at the given driver or device instance.
Definition: hwdriver.c:804
sr_parse_rational
int sr_parse_rational(const char *str, struct sr_rational *ret)
Convert a string representation of a numeric value to a sr_rational.
Definition: strutil.c:836
sr_output_options_get
const struct sr_option ** sr_output_options_get(const struct sr_output_module *omod)
Returns a NULL-terminated array of struct sr_option, or NULL if the module takes no options...
Definition: output.c:201
sr_rational_div
int sr_rational_div(struct sr_rational *res, const struct sr_rational *num, const struct sr_rational *div)
Divide rational a by rational b.
Definition: analog.c:693
sr_input_reset
int sr_input_reset(const struct sr_input *in)
Reset the input module&#39;s input handling structures.
Definition: input.c:625
sr_dev_inst_model_get
const char * sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; model.
Definition: device.c:823
sr_si_string_u64
char * sr_si_string_u64(uint64_t x, const char *unit)
Convert a numeric value value to its "natural" string representation in SI units. ...
Definition: strutil.c:1009
SR_API
#define SR_API
Definition: libsigrok.h:128
sr_resource
Resource descriptor.
Definition: libsigrok.h:608
sr_snprintf_ascii
int sr_snprintf_ascii(char *buf, size_t buf_size, const char *format,...)
Composes a string with a format string (like printf) in the buffer pointed by buf (taking buf_size as...
Definition: strutil.c:631
sr_config_set
int sr_config_set(const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, uint32_t key, GVariant *data)
Set value of a configuration key in a device instance.
Definition: hwdriver.c:859
sr_package_version_minor_get
int sr_package_version_minor_get(void)
Get the minor libsigrok package version number.
Definition: version.c:71
size
lzo_uint lzo_uint size
Definition: lzoconf.h:276
sr_option
Generic option struct used by various subsystems.
Definition: libsigrok.h:585
sr_transform_list
const struct sr_transform_module ** sr_transform_list(void)
Returns a NULL-terminated list of all available transform modules.
Definition: transform.c:62
sr_lib_version_revision_get
int sr_lib_version_revision_get(void)
Get the "revision" part of the libsigrok library version number.
Definition: version.c:120
sr_package_version_major_get
int sr_package_version_major_get(void)
Get the major libsigrok package version number.
Definition: version.c:59
sr_log_loglevel_get
int sr_log_loglevel_get(void)
Get the libsigrok loglevel.
Definition: log.c:107
sr_packet_copy
int sr_packet_copy(const struct sr_datafeed_packet *packet, struct sr_datafeed_packet **copy)
Definition: session.c:1497
sr_text_trim_spaces
char * sr_text_trim_spaces(char *s)
Trim leading and trailing whitespace off text.
Definition: strutil.c:1681
sr_buildinfo_libs_get
GSList * sr_buildinfo_libs_get(void)
Definition: backend.c:126
sr_datafeed_packet
Packet in a sigrok data feed.
Definition: libsigrok.h:494
sr_lib_version_current_get
int sr_lib_version_current_get(void)
Get the "current" part of the libsigrok library version number.
Definition: version.c:108
sr_key_info::key
uint32_t key
Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc.
Definition: libsigrok.h:682
sr_dev_channel_enable
int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
Enable or disable a channel.
Definition: device.c:144
sr_init
int sr_init(struct sr_context **ctx)
Initialize libsigrok.
Definition: backend.c:557
sr_dev_close
int sr_dev_close(struct sr_dev_inst *sdi)
Close the specified device instance.
Definition: device.c:768
void
typedef void(__LZO_CDECL *lzo_free_func_t)(lzo_callback_p self
sr_analog_unit_to_string
int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog, char **result)
Convert the unit/MQ/MQ flags in the analog struct to a string.
Definition: analog.c:472
sr_trigger_match_add
int sr_trigger_match_add(struct sr_trigger_stage *stage, struct sr_channel *ch, int trigger_match, float value)
Allocate a new trigger match and add it to the specified trigger stage.
Definition: trigger.c:141
sr_analog_si_prefix_friendly
gboolean sr_analog_si_prefix_friendly(enum sr_unit unit)
Check if a unit "accepts" an SI prefix.
Definition: analog.c:430
sr_resource_read_callback
gssize(* sr_resource_read_callback)(const struct sr_resource *res, void *buf, size_t count, void *cb_data)
Definition: proto.h:235
sr_parse_timestring
uint64_t sr_parse_timestring(const char *timestring)
Convert a "natural" string representation of a time value to an uint64_t value in milliseconds...
Definition: strutil.c:1227
sr_a2l_schmitt_trigger
int sr_a2l_schmitt_trigger(const struct sr_datafeed_analog *analog, float lo_thr, float hi_thr, uint8_t *state, uint8_t *output, uint64_t count)
Convert analog values to logic values by using a Schmitt-trigger algorithm.
Definition: conversion.c:81
sr_input_send
int sr_input_send(const struct sr_input *in, GString *buf)
Send data to the specified input instance.
Definition: input.c:593
sr_next_power_of_two
int sr_next_power_of_two(size_t value, size_t *bits, size_t *power)
Get the number of necessary bits to hold a given value.
Definition: strutil.c:1837
sr_parse_voltage
int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:1306
sr_output_free
int sr_output_free(const struct sr_output *o)
Free the specified output instance and all associated resources.
Definition: output.c:347
sr_session_stop
int sr_session_stop(struct sr_session *session)
Stop a session.
Definition: session.c:946
sr_unit
sr_unit
Unit of measured quantity, sr_analog_meaning.unit.
Definition: libsigrok.h:253
sr_dev_inst_sernum_get
const char * sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; serial number.
Definition: device.c:853
sr_session_dev_list
int sr_session_dev_list(struct sr_session *session, GSList **devlist)
List all device instances attached to a session.
Definition: session.c:395
sr_transform_id_get
const char * sr_transform_id_get(const struct sr_transform_module *tmod)
Returns the specified transform module&#39;s ID.
Definition: transform.c:72
sr_trigger
The representation of a trigger, consisting of one or more stages containing one or more matches on a...
Definition: libsigrok.h:426
sr_serial_free
void sr_serial_free(struct sr_serial_port *serial)
Free a previously allocated sr_serial_port structure.
Definition: serial.c:1053
sr_output_name_get
const char * sr_output_name_get(const struct sr_output_module *omod)
Returns the specified output module&#39;s name.
Definition: output.c:118
sr_parse_probe_names
char ** sr_parse_probe_names(const char *spec, const char **dflt_names, size_t dflt_count, size_t max_count, size_t *ret_count)
Parse a probe names specification, allocate a string vector.
Definition: strutil.c:1563
sr_dev_list
GSList * sr_dev_list(const struct sr_dev_driver *driver)
Get the list of devices/instances of the specified driver.
Definition: device.c:668
sr_buildinfo_host_get
char * sr_buildinfo_host_get(void)
Definition: backend.c:205
sr_dev_channel_name_set
int sr_dev_channel_name_set(struct sr_channel *channel, const char *name)
Set the name of the specified channel.
Definition: device.c:118
sr_datafeed_analog
Analog datafeed payload for type SR_DF_ANALOG.
Definition: libsigrok.h:518
sr_input_end
int sr_input_end(const struct sr_input *in)
Signal the input module no more data will come.
Definition: input.c:610
sr_dev_inst_connid_get
const char * sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; connection identifier.
Definition: device.c:869
sr_parse_period
int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:1273
sr_voltage_string
char * sr_voltage_string(uint64_t v_p, uint64_t v_q)
Convert a numeric voltage value to the "natural" string representation of its voltage value...
Definition: strutil.c:1119
sr_input_options_get
const struct sr_option ** sr_input_options_get(const struct sr_input_module *imod)
Returns a NULL-terminated array of struct sr_option, or NULL if the module takes no options...
Definition: input.c:199
sr_rational_mult
int sr_rational_mult(struct sr_rational *res, const struct sr_rational *a, const struct sr_rational *b)
Multiply two sr_rational.
Definition: analog.c:615
sr_input_list
const struct sr_input_module ** sr_input_list(void)
Returns a NULL-terminated list of all available input modules.
Definition: input.c:103
sr_session_datafeed_callback_remove_all
int sr_session_datafeed_callback_remove_all(struct sr_session *session)
Remove all datafeed callbacks in a session.
Definition: session.c:457
sr_text_next_word
char * sr_text_next_word(char *s, char **next)
Isolates another space separated word in a text line.
Definition: strutil.c:1784
sr_dev_inst_driver_get
struct sr_dev_driver * sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; driver.
Definition: device.c:793
sr_output_find
const struct sr_output_module * sr_output_find(char *id)
Return the output module with the specified ID, or NULL if no module with that id is found...
Definition: output.c:180
sr_session_dev_remove_all
int sr_session_dev_remove_all(struct sr_session *session)
Remove all the devices from a session.
Definition: session.c:284
sr_vsnprintf_ascii
int sr_vsnprintf_ascii(char *buf, size_t buf_size, const char *format, va_list args)
Composes a string with a format string (like printf) in the buffer pointed by buf (taking buf_size as...
Definition: strutil.c:678
sr_dev_inst_version_get
const char * sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; version.
Definition: device.c:838
sr_output_test_flag
gboolean sr_output_test_flag(const struct sr_output_module *omod, uint64_t flag)
Definition: output.c:168
sr_session_trigger_get
struct sr_trigger * sr_session_trigger_get(struct sr_session *session)
Get the trigger assigned to this session.
Definition: session.c:518
sr_session_start
int sr_session_start(struct sr_session *session)
Start a session.
Definition: session.c:753
sr_trigger_stage::stage
int stage
Starts at 0.
Definition: libsigrok.h:436
sr_key_info_get
const struct sr_key_info * sr_key_info_get(int keytype, uint32_t key)
Get information about a key, by key.
Definition: hwdriver.c:1036
sr_log_callback_set_default
int sr_log_callback_set_default(void)
Set the libsigrok log callback to the default built-in one.
Definition: log.c:151
sr_trigger_stage_add
struct sr_trigger_stage * sr_trigger_stage_add(struct sr_trigger *trig)
Allocate a new trigger stage and add it to the specified trigger.
Definition: trigger.c:108
sr_input_module_get
const struct sr_input_module * sr_input_module_get(const struct sr_input *in)
Return the input instance&#39;s module "class".
Definition: input.c:553
sr_samplerate_string
char * sr_samplerate_string(uint64_t samplerate)
Convert a numeric samplerate value to its "natural" string representation.
Definition: strutil.c:1051
sr_input_name_get
const char * sr_input_name_get(const struct sr_input_module *imod)
Returns the specified input module&#39;s name.
Definition: input.c:128
sr_package_version_micro_get
int sr_package_version_micro_get(void)
Get the micro libsigrok package version number.
Definition: version.c:83
sr_rational_set
void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q)
Set sr_rational r to the given value.
Definition: analog.c:509
name
const char * name
Definition: strutil.c:1407
sr_dev_inst_channels_get
GSList * sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; channel list.
Definition: device.c:948
sr_transform_options_free
void sr_transform_options_free(const struct sr_option **opts)
After a call to sr_transform_options_get(), this function cleans up all resources returned by that ca...
Definition: transform.c:166
sr_key_info
Information about a key.
Definition: libsigrok.h:680
sr_key_info_name_get
const struct sr_key_info * sr_key_info_name_get(int keytype, const char *keyid)
Get information about a key, by name.
Definition: hwdriver.c:1063
sr_driver_scan_options_list
GArray * sr_driver_scan_options_list(const struct sr_dev_driver *driver)
Enumerate scan options supported by this driver.
Definition: hwdriver.c:463
sr_strerror_name
const char * sr_strerror_name(int error_code)
Return the "name" string of the given libsigrok error code.
Definition: error.c:108
sr_dev_options
GArray * sr_dev_options(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
Enumerate the configuration options of the specified item.
Definition: device.c:375
sr_driver_init
int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
Initialize a hardware driver.
Definition: hwdriver.c:425
sr_config_commit
int sr_config_commit(const struct sr_dev_inst *sdi)
Apply configuration settings to the device hardware.
Definition: hwdriver.c:900
sr_session_destroy
int sr_session_destroy(struct sr_session *session)
Destroy a session.
Definition: session.c:250
sr_session
Opaque structure representing a libsigrok session.
Definition: libsigrok.h:474
sr_datafeed_callback
void(* sr_datafeed_callback)(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data)
Definition: proto.h:126
sr_output_id_get
const char * sr_output_id_get(const struct sr_output_module *omod)
Returns the specified output module&#39;s ID.
Definition: output.c:103
sr_log_callback_set
int sr_log_callback_set(sr_log_callback cb, void *cb_data)
Set the libsigrok log callback to the specified function.
Definition: log.c:127
sr_context
Opaque structure representing a libsigrok context.
sr_trigger_free
void sr_trigger_free(struct sr_trigger *trig)
Free a previously allocated trigger.
Definition: trigger.c:74
sr_config_list
int sr_config_list(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, uint32_t key, GVariant **data)
List all possible values for a configuration key.
Definition: hwdriver.c:947
sr_session_dev_add
int sr_session_dev_add(struct sr_session *session, struct sr_dev_inst *sdi)
Add a device instance to a session.
Definition: session.c:318
sr_channel_group
Structure for groups of channels that have common properties.
Definition: libsigrok.h:656
sr_session_new
int sr_session_new(struct sr_context *ctx, struct sr_session **session)
Create a new session.
Definition: session.c:215
sr_exit
int sr_exit(struct sr_context *ctx)
Shutdown libsigrok.
Definition: backend.c:657
sr_session_stopped_callback_set
int sr_session_stopped_callback_set(struct sr_session *session, sr_session_stopped_callback cb, void *cb_data)
Set the callback to be invoked after a session stopped running.
Definition: session.c:1016
sr_input_dev_inst_get
struct sr_dev_inst * sr_input_dev_inst_get(const struct sr_input *in)
Return the input instance&#39;s (virtual) device instance.
Definition: input.c:571
sr_transform_new
const struct sr_transform * sr_transform_new(const struct sr_transform_module *tmod, GHashTable *params, const struct sr_dev_inst *sdi)
Create a new transform instance using the specified transform module.
Definition: transform.c:200
sr_input_description_get
const char * sr_input_description_get(const struct sr_input_module *imod)
Returns the specified input module&#39;s description.
Definition: input.c:143
sr_input_extensions_get
const char *const * sr_input_extensions_get(const struct sr_input_module *imod)
Returns the specified input module&#39;s file extensions typical for the file format, as a NULL terminate...
Definition: input.c:161
sr_dev_inst_user_new
struct sr_dev_inst * sr_dev_inst_user_new(const char *vendor, const char *model, const char *version)
Allocate and init a new user-generated device instance.
Definition: device.c:463
sr_analog_si_prefix
const char * sr_analog_si_prefix(float *value, int *digits)
Scale a float value to the appropriate SI prefix.
Definition: analog.c:391
sr_dev_has_option
gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
Determine whether the specified device instance has the specified capability.
Definition: device.c:333
sr_session_trigger_set
int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
Set the trigger of this session.
Definition: session.c:537
sr_input_options_free
void sr_input_options_free(const struct sr_option **options)
After a call to sr_input_options_get(), this function cleans up all resources returned by that call...
Definition: input.c:226
sr_input_find
const struct sr_input_module * sr_input_find(const char *id)
Return the input module with the specified ID, or NULL if no module with that id is found...
Definition: input.c:178
sr_driver_list
struct sr_dev_driver ** sr_driver_list(const struct sr_context *ctx)
Return the list of supported hardware drivers.
Definition: hwdriver.c:398
sr_log_loglevel_set
int sr_log_loglevel_set(int loglevel)
Set the libsigrok loglevel.
Definition: log.c:83
sr_dev_inst_vendor_get
const char * sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
Queries a device instances&#39; vendor.
Definition: device.c:808
sr_dev_config_capabilities_list
int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int key)
Enumerate the configuration capabilities supported by a device instance for a given configuration key...
Definition: device.c:425
sr_output_description_get
const char * sr_output_description_get(const struct sr_output_module *omod)
Returns the specified output module&#39;s description.
Definition: output.c:133
sr_lib_version_age_get
int sr_lib_version_age_get(void)
Get the "age" part of the libsigrok library version number.
Definition: version.c:132
sr_period_string
char * sr_period_string(uint64_t v_p, uint64_t v_q)
Convert a numeric period value to the "natural" string representation of its period value...
Definition: strutil.c:1073
sr_session_run
int sr_session_run(struct sr_session *session)
Block until the running session stops.
Definition: session.c:868
sr_session_dev_remove
int sr_session_dev_remove(struct sr_session *session, struct sr_dev_inst *sdi)
Remove a device instance from a session.
Definition: session.c:421
sr_trigger_stage
A trigger stage.
Definition: libsigrok.h:434
sr_resource_set_hooks
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)
Install resource access hooks.
Definition: resource.c:263
sr_strerror
const char * sr_strerror(int error_code)
Return a human-readable error string for the given libsigrok error code.
Definition: error.c:53
sr_input_new
struct sr_input * sr_input_new(const struct sr_input_module *imod, GHashTable *options)
Create a new input instance using the specified input module.
Definition: input.c:261
sr_trigger_new
struct sr_trigger * sr_trigger_new(const char *name)
Create a new trigger.
Definition: trigger.c:54
sr_session_load
int sr_session_load(struct sr_context *ctx, const char *filename, struct sr_session **session)
Load the session from the specified filename.
Definition: session_file.c:207
sr_package_version_string_get
const char * sr_package_version_string_get(void)
Get the libsigrok package version number as a string.
Definition: version.c:96
sr_output_new
const struct sr_output * sr_output_new(const struct sr_output_module *omod, GHashTable *params, const struct sr_dev_inst *sdi, const char *filename)
Create a new output instance using the specified output module.
Definition: output.c:262
sr_buildinfo_scpi_backends_get
char * sr_buildinfo_scpi_backends_get(void)
Definition: backend.c:216
sr_lib_version_string_get
const char * sr_lib_version_string_get(void)
Get the libsigrok library version number as a string.
Definition: version.c:145
sr_input_scan_file
int sr_input_scan_file(const char *filename, const struct sr_input **in)
Try to find an input module that can parse the given file.
Definition: input.c:448
sr_driver_scan
GSList * sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
Tell a hardware driver to scan for devices.
Definition: hwdriver.c:553
sr_dev_clear
int sr_dev_clear(const struct sr_dev_driver *driver)
Clear the list of device instances a driver knows about.
Definition: device.c:687
sr_session_stopped_callback
void(* sr_session_stopped_callback)(void *data)
Definition: proto.h:125
sr_transform_free
int sr_transform_free(const struct sr_transform *t)
Free the specified transform instance and all associated resources.
Definition: transform.c:272
sr_session_is_running
int sr_session_is_running(struct sr_session *session)
Return whether the session is currently running.
Definition: session.c:988
sr_free_probe_names
void sr_free_probe_names(char **names)
Release previously allocated probe names (string vector).
Definition: strutil.c:1665
sr_transform_name_get
const char * sr_transform_name_get(const struct sr_transform_module *tmod)
Returns the specified transform module&#39;s name.
Definition: transform.c:87
sr_session_datafeed_callback_add
int sr_session_datafeed_callback_add(struct sr_session *session, sr_datafeed_callback cb, void *cb_data)
Add a datafeed callback to a session.
Definition: session.c:483
sr_dev_driver
Device driver data.
Definition: libsigrok.h:1254
sr_transform_description_get
const char * sr_transform_description_get(const struct sr_transform_module *tmod)
Returns the specified transform module&#39;s description.
Definition: transform.c:102
sr_rational_eq
int sr_rational_eq(const struct sr_rational *a, const struct sr_rational *b)
Compare two sr_rational for equality.
Definition: analog.c:576
sr_output_options_free
void sr_output_options_free(const struct sr_option **opts)
After a call to sr_output_options_get(), this function cleans up all resources returned by that call...
Definition: output.c:228
sr_a2l_threshold
int sr_a2l_threshold(const struct sr_datafeed_analog *analog, float threshold, uint8_t *output, uint64_t count)
Convert analog values to logic values by using a fixed threshold.
Definition: conversion.c:44
sr_log_callback_get
int sr_log_callback_get(sr_log_callback *cb, void **cb_data)
Get the libsigrok log callback routine and callback data.
Definition: log.c:175
sr_parse_sizestring
int sr_parse_sizestring(const char *sizestring, uint64_t *size)
Convert a "natural" string representation of a size value to uint64_t.
Definition: strutil.c:1146
sr_log_callback
int(* sr_log_callback)(void *cb_data, int loglevel, const char *format, va_list args)
Definition: proto.h:63
sr_resourcepaths_get
GSList * sr_resourcepaths_get(int res_type)
Get a list of paths where we look for resource (e.g.
Definition: resource.c:47
sr_resource_close_callback
int(* sr_resource_close_callback)(struct sr_resource *res, void *cb_data)
Definition: proto.h:233
Generated on Wed Feb 28 2024 07:36:00 for libsigrok by   doxygen 1.8.11