libsigrok  0.4.0
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 int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
34  char **result);
35 SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q);
36 
37 /*--- backend.c -------------------------------------------------------------*/
38 
39 SR_API int sr_init(struct sr_context **ctx);
40 SR_API int sr_exit(struct sr_context *ctx);
41 
42 /*--- log.c -----------------------------------------------------------------*/
43 
44 typedef int (*sr_log_callback)(void *cb_data, int loglevel,
45  const char *format, va_list args);
46 
47 SR_API int sr_log_loglevel_set(int loglevel);
48 SR_API int sr_log_loglevel_get(void);
49 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
51 
52 /*--- device.c --------------------------------------------------------------*/
53 
54 SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
55  const char *name);
56 SR_API int sr_dev_channel_enable(struct sr_channel *channel,
57  gboolean state);
58 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
59 SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
60  const struct sr_channel_group *cg, int key);
61 SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
62  const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
63 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
64 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
65 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
66 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
67 
68 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
69 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
70 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
71 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
72 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
73 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
74 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
75 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
76 
77 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
78  const char *model, const char *version);
79 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
80 
81 /*--- hwdriver.c ------------------------------------------------------------*/
82 
83 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
84 SR_API int sr_driver_init(struct sr_context *ctx,
85  struct sr_dev_driver *driver);
86 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver);
87 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
88 SR_API int sr_config_get(const struct sr_dev_driver *driver,
89  const struct sr_dev_inst *sdi,
90  const struct sr_channel_group *cg,
91  uint32_t key, GVariant **data);
92 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
93  const struct sr_channel_group *cg,
94  uint32_t key, GVariant *data);
95 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
96 SR_API int sr_config_list(const struct sr_dev_driver *driver,
97  const struct sr_dev_inst *sdi,
98  const struct sr_channel_group *cg,
99  uint32_t key, GVariant **data);
100 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key);
101 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid);
102 
103 /*--- session.c -------------------------------------------------------------*/
104 
105 typedef void (*sr_session_stopped_callback)(void *data);
106 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
107  const struct sr_datafeed_packet *packet, void *cb_data);
108 
109 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
110 
111 /* Session setup */
112 SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
113  struct sr_session **session);
114 SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
115 SR_API int sr_session_destroy(struct sr_session *session);
116 SR_API int sr_session_dev_remove_all(struct sr_session *session);
117 SR_API int sr_session_dev_add(struct sr_session *session,
118  struct sr_dev_inst *sdi);
119 SR_API int sr_session_dev_remove(struct sr_session *session,
120  struct sr_dev_inst *sdi);
121 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
122 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
123 
124 /* Datafeed setup */
127  sr_datafeed_callback cb, void *cb_data);
128 
129 /* Session control */
130 SR_API int sr_session_start(struct sr_session *session);
131 SR_API int sr_session_run(struct sr_session *session);
132 SR_API int sr_session_stop(struct sr_session *session);
133 SR_API int sr_session_is_running(struct sr_session *session);
135  sr_session_stopped_callback cb, void *cb_data);
136 
137 /*--- input/input.c ---------------------------------------------------------*/
138 
139 SR_API const struct sr_input_module **sr_input_list(void);
140 SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
141 SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
142 SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
143 SR_API const char *const *sr_input_extensions_get(
144  const struct sr_input_module *imod);
145 SR_API const struct sr_input_module *sr_input_find(char *id);
146 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
147 SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
148  uint64_t flag);
149 SR_API void sr_input_options_free(const struct sr_option **options);
150 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
151  GHashTable *options);
152 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
153 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
154 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
155 SR_API int sr_input_send(const struct sr_input *in, GString *buf);
156 SR_API int sr_input_end(const struct sr_input *in);
157 SR_API void sr_input_free(const struct sr_input *in);
158 
159 /*--- output/output.c -------------------------------------------------------*/
160 
161 SR_API const struct sr_output_module **sr_output_list(void);
162 SR_API const char *sr_output_id_get(const struct sr_output_module *omod);
163 SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
164 SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
165 SR_API const char *const *sr_output_extensions_get(
166  const struct sr_output_module *omod);
167 SR_API const struct sr_output_module *sr_output_find(char *id);
168 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
169 SR_API void sr_output_options_free(const struct sr_option **opts);
170 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
171  GHashTable *params, const struct sr_dev_inst *sdi,
172  const char *filename);
173 SR_API int sr_output_send(const struct sr_output *o,
174  const struct sr_datafeed_packet *packet, GString **out);
175 SR_API int sr_output_free(const struct sr_output *o);
176 
177 /*--- transform/transform.c -------------------------------------------------*/
178 
179 SR_API const struct sr_transform_module **sr_transform_list(void);
180 SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
181 SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
182 SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
183 SR_API const struct sr_transform_module *sr_transform_find(const char *id);
184 SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
185 SR_API void sr_transform_options_free(const struct sr_option **opts);
186 SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
187  GHashTable *params, const struct sr_dev_inst *sdi);
188 SR_API int sr_transform_free(const struct sr_transform *t);
189 
190 /*--- trigger.c -------------------------------------------------------------*/
191 
192 SR_API struct sr_trigger *sr_trigger_new(const char *name);
193 SR_API void sr_trigger_free(struct sr_trigger *trig);
196  struct sr_channel *ch, int trigger_match, float value);
197 
198 /*--- serial.c --------------------------------------------------------------*/
199 
200 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
201 SR_API void sr_serial_free(struct sr_serial_port *serial);
202 
203 /*--- resource.c ------------------------------------------------------------*/
204 
205 typedef int (*sr_resource_open_callback)(struct sr_resource *res,
206  const char *name, void *cb_data);
207 typedef int (*sr_resource_close_callback)(struct sr_resource *res,
208  void *cb_data);
209 typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res,
210  void *buf, size_t count, void *cb_data);
211 
212 SR_API int sr_resource_set_hooks(struct sr_context *ctx,
215  sr_resource_read_callback read_cb, void *cb_data);
216 
217 /*--- strutil.c -------------------------------------------------------------*/
218 
219 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
220 SR_API char *sr_samplerate_string(uint64_t samplerate);
221 SR_API char *sr_period_string(uint64_t frequency);
222 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
223 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
224 SR_API uint64_t sr_parse_timestring(const char *timestring);
225 SR_API gboolean sr_parse_boolstring(const char *boolstring);
226 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
227 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
228 
229 /*--- version.c -------------------------------------------------------------*/
230 
234 SR_API const char *sr_package_version_string_get(void);
235 
239 SR_API const char *sr_lib_version_string_get(void);
240 
241 /*--- error.c ---------------------------------------------------------------*/
242 
243 SR_API const char *sr_strerror(int error_code);
244 SR_API const char *sr_strerror_name(int error_code);
245 
246 #endif
int(* sr_log_callback)(void *cb_data, int loglevel, const char *format, va_list args)
Definition: proto.h:44
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
The representation of a trigger, consisting of one or more stages containing one or more matches on a...
Definition: libsigrok.h:406
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
GSList * sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
Tell a hardware driver to scan for devices.
Definition: hwdriver.c:497
int sr_session_start(struct sr_session *session)
Start a session.
Definition: session.c:753
Serial port descriptor.
Definition: libsigrok.h:1160
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:686
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:334
int sr_dev_close(struct sr_dev_inst *sdi)
Close the specified device.
Definition: device.c:541
int sr_session_dev_add(struct sr_session *session, struct sr_dev_inst *sdi)
Add a device instance to a session.
Definition: session.c:317
gssize(* sr_resource_read_callback)(const struct sr_resource *res, void *buf, size_t count, void *cb_data)
Definition: proto.h:209
GSList * sr_serial_list(const struct sr_dev_driver *driver)
List available serial devices.
Definition: serial.c:909
int sr_input_end(const struct sr_input *in)
Signal the input module no more data will come.
Definition: input.c:556
int(* sr_resource_open_callback)(struct sr_resource *res, const char *name, void *cb_data)
Definition: proto.h:205
GSList * sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
Queries a device instances' channel list.
Definition: device.c:699
const char * sr_output_name_get(const struct sr_output_module *omod)
Returns the specified output module's name.
Definition: output.c:116
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:183
const struct sr_transform_module ** sr_transform_list(void)
Returns a NULL-terminated list of all available transform modules.
Definition: transform.c:62
int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
Enable or disable a channel.
Definition: device.c:111
void(* sr_datafeed_callback)(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data)
Definition: proto.h:106
int sr_exit(struct sr_context *ctx)
Shutdown libsigrok.
Definition: backend.c:550
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:231
struct sr_dev_inst * sr_input_dev_inst_get(const struct sr_input *in)
Return the input instance's (virtual) device instance.
Definition: input.c:519
const char * sr_input_description_get(const struct sr_input_module *imod)
Returns the specified input module's description.
Definition: input.c:127
Device driver data.
Definition: libsigrok.h:1090
const char * sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
Queries a device instances' serial number.
Definition: device.c:620
void(* sr_session_stopped_callback)(void *data)
Definition: proto.h:105
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:441
const char *const * sr_input_extensions_get(const struct sr_input_module *imod)
Returns the specified input module's file extensions typical for the file format, as a NULL terminate...
Definition: input.c:145
struct sr_trigger * sr_trigger_new(const char *name)
Create a new trigger.
Definition: trigger.c:54
int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:482
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
int sr_dev_clear(const struct sr_dev_driver *driver)
Clear the list of device instances a driver knows about.
Definition: device.c:494
const struct sr_input_module * sr_input_find(char *id)
Return the input module with the specified ID, or NULL if no module with that id is found...
Definition: input.c:162
int sr_package_version_micro_get(void)
Get the micro libsigrok package version number.
Definition: version.c:81
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:347
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:302
void sr_serial_free(struct sr_serial_port *serial)
Free a previously allocated sr_serial_port structure.
Definition: serial.c:893
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:226
Opaque structure representing a libsigrok session.
Definition: libsigrok.h:454
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
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:217
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:1014
const char * sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
Queries a device instances' vendor.
Definition: device.c:575
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:245
const char * sr_package_version_string_get(void)
Get the libsigrok package version number as a string.
Definition: version.c:94
int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:515
const char * sr_transform_name_get(const struct sr_transform_module *tmod)
Returns the specified transform module's name.
Definition: transform.c:87
const char * sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
Queries a device instances' model.
Definition: device.c:590
int sr_session_destroy(struct sr_session *session)
Destroy a session.
Definition: session.c:249
char * sr_samplerate_string(uint64_t samplerate)
Convert a numeric samplerate value to its "natural" string representation.
Definition: strutil.c:273
const char * sr_output_id_get(const struct sr_output_module *omod)
Returns the specified output module's ID.
Definition: output.c:101
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:731
const char * sr_transform_description_get(const struct sr_transform_module *tmod)
Returns the specified transform module's description.
Definition: transform.c:102
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:178
uint32_t key
Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc.
Definition: libsigrok.h:644
Structure for groups of channels that have common properties.
Definition: libsigrok.h:618
#define SR_API
Definition: libsigrok.h:121
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:210
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:178
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:350
Analog datafeed payload for type SR_DF_ANALOG.
Definition: libsigrok.h:516
int sr_session_datafeed_callback_remove_all(struct sr_session *session)
Remove all datafeed callbacks in a session.
Definition: session.c:457
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:374
int sr_lib_version_age_get(void)
Get the "age" part of the libsigrok library version number.
Definition: version.c:130
A trigger stage.
Definition: libsigrok.h:414
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:171
const char * sr_output_description_get(const struct sr_output_module *omod)
Returns the specified output module's description.
Definition: output.c:131
const char * sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
Queries a device instances' version.
Definition: device.c:605
int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig)
Set the trigger of this session.
Definition: session.c:537
struct sr_trigger * sr_session_trigger_get(struct sr_session *session)
Get the trigger assigned to this session.
Definition: session.c:518
Packet in a sigrok data feed.
Definition: libsigrok.h:474
int sr_log_loglevel_set(int loglevel)
Set the libsigrok loglevel.
Definition: log.c:82
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:264
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:884
GArray * sr_driver_scan_options_list(const struct sr_dev_driver *driver)
Enumerate scan options supported by this driver.
Definition: hwdriver.c:407
GSList * sr_dev_list(const struct sr_dev_driver *driver)
Get the list of devices/instances of the specified driver.
Definition: device.c:475
const char * sr_lib_version_string_get(void)
Get the libsigrok library version number as a string.
Definition: version.c:143
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:417
Generic option struct used by various subsystems.
Definition: libsigrok.h:547
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:213
char * name
A name for this trigger.
Definition: libsigrok.h:408
Information on single channel.
Definition: libsigrok.h:601
struct sr_dev_driver * sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
Queries a device instances' driver.
Definition: device.c:560
void sr_trigger_free(struct sr_trigger *trig)
Free a previously allocated trigger.
Definition: trigger.c:74
const char * sr_strerror_name(int error_code)
Return the "name" string of the given libsigrok error code.
Definition: error.c:109
int sr_dev_channel_name_set(struct sr_channel *channel, const char *name)
Set the name of the specified channel.
Definition: device.c:86
const char * sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
Queries a device instances' connection identifier.
Definition: device.c:636
int sr_session_dev_remove_all(struct sr_session *session)
Remove all the devices from a session.
Definition: session.c:283
int sr_log_loglevel_get(void)
Get the libsigrok loglevel.
Definition: log.c:106
int sr_session_is_running(struct sr_session *session)
Return whether the session is currently running.
Definition: session.c:986
int sr_output_free(const struct sr_output *o)
Free the specified output instance and all associated resources.
Definition: output.c:345
const char * sr_input_id_get(const struct sr_input_module *imod)
Returns the specified input module's ID.
Definition: input.c:97
const struct sr_key_info * sr_key_info_get(int keytype, uint32_t key)
Get information about a key, by key.
Definition: hwdriver.c:857
gboolean sr_parse_boolstring(const char *boolstring)
Definition: strutil.c:467
int sr_log_callback_set_default(void)
Set the libsigrok log callback to the default built-in one.
Definition: log.c:150
void sr_input_free(const struct sr_input *in)
Free the specified input instance and all associated resources.
Definition: input.c:567
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
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
char * sr_period_string(uint64_t frequency)
Convert a numeric frequency value to the "natural" string representation of its period.
Definition: strutil.c:292
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:320
int sr_lib_version_current_get(void)
Get the "current" part of the libsigrok library version number.
Definition: version.c:106
int stage
Starts at 0.
Definition: libsigrok.h:416
int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
Initialize a hardware driver.
Definition: hwdriver.c:370
int sr_session_stop(struct sr_session *session)
Stop a session.
Definition: session.c:944
int sr_config_commit(const struct sr_dev_inst *sdi)
Apply configuration settings to the device hardware.
Definition: hwdriver.c:764
int sr_session_dev_list(struct sr_session *session, GSList **devlist)
List all device instances attached to a session.
Definition: session.c:395
const struct sr_output_module ** sr_output_list(void)
Returns a NULL-terminated list of all available output modules.
Definition: output.c:91
const char *const * sr_output_extensions_get(const struct sr_output_module *omod)
Returns the specified output module'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:149
const char * sr_transform_id_get(const struct sr_transform_module *tmod)
Returns the specified transform module's ID.
Definition: transform.c:72
int sr_input_send(const struct sr_input *in, GString *buf)
Send data to the specified input instance.
Definition: input.c:541
Opaque structure representing a libsigrok context.
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
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:801
GSList * sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
Queries a device instances' channel groups list.
Definition: device.c:714
int sr_session_new(struct sr_context *ctx, struct sr_session **session)
Create a new session.
Definition: session.c:214
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:172
int sr_package_version_minor_get(void)
Get the minor libsigrok package version number.
Definition: version.c:69
uint64_t size
Size of resource in bytes; set by resource open callback.
Definition: libsigrok.h:572
int sr_lib_version_revision_get(void)
Get the "revision" part of the libsigrok library version number.
Definition: version.c:118
const struct sr_input_module ** sr_input_list(void)
Returns a NULL-terminated list of all available input modules.
Definition: input.c:87
struct sr_dev_driver ** sr_driver_list(const struct sr_context *ctx)
Return the list of supported hardware drivers.
Definition: hwdriver.c:343
int sr_package_version_major_get(void)
Get the major libsigrok package version number.
Definition: version.c:57
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:260
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
Information about a key.
Definition: libsigrok.h:642
gboolean sr_output_test_flag(const struct sr_output_module *omod, uint64_t flag)
Definition: output.c:166
int sr_session_run(struct sr_session *session)
Block until the running session stops.
Definition: session.c:865
const char * sr_strerror(int error_code)
Return a human-readable error string for the given libsigrok error code.
Definition: error.c:54
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:334
int sr_log_callback_set(sr_log_callback cb, void *cb_data)
Set the libsigrok log callback to the specified function.
Definition: log.c:126
int(* sr_resource_close_callback)(struct sr_resource *res, void *cb_data)
Definition: proto.h:207
int sr_init(struct sr_context **ctx)
Initialize libsigrok.
Definition: backend.c:464
const char * sr_input_name_get(const struct sr_input_module *imod)
Returns the specified input module's name.
Definition: input.c:112
Resource descriptor.
Definition: libsigrok.h:570
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:309
int sr_transform_free(const struct sr_transform *t)
Free the specified transform instance and all associated resources.
Definition: transform.c:272
int sr_dev_open(struct sr_dev_inst *sdi)
Open the specified device.
Definition: device.c:520
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:199