libsigrok  0.3.0
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 /*--- 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)(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 cb, void *cb_data);
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 
49  int channelnum, const char *name);
50 SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
51  gboolean state);
52 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum,
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_list(const struct sr_dev_driver *driver);
56 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
57 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
58 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
59 
60 /*--- hwdriver.c ------------------------------------------------------------*/
61 
62 SR_API struct sr_dev_driver **sr_driver_list(void);
63 SR_API int sr_driver_init(struct sr_context *ctx,
64  struct sr_dev_driver *driver);
65 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
66 SR_API int sr_config_get(const struct sr_dev_driver *driver,
67  const struct sr_dev_inst *sdi,
68  const struct sr_channel_group *cg,
69  int key, GVariant **data);
70 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
71  const struct sr_channel_group *cg,
72  int key, GVariant *data);
73 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
74 SR_API int sr_config_list(const struct sr_dev_driver *driver,
75  const struct sr_dev_inst *sdi,
76  const struct sr_channel_group *cg,
77  int key, GVariant **data);
78 SR_API const struct sr_config_info *sr_config_info_get(int key);
79 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
80 
81 /*--- session.c -------------------------------------------------------------*/
82 
83 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
84  const struct sr_datafeed_packet *packet, void *cb_data);
85 
86 /* Session setup */
87 SR_API int sr_session_load(const char *filename);
88 SR_API struct sr_session *sr_session_new(void);
89 SR_API int sr_session_destroy(void);
91 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
92 SR_API int sr_session_dev_list(GSList **devlist);
93 
94 /* Datafeed setup */
97  void *cb_data);
98 
99 /* Session control */
100 SR_API int sr_session_start(void);
101 SR_API int sr_session_run(void);
102 SR_API int sr_session_stop(void);
103 SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
104  unsigned char *buf, int unitsize, int units);
105 SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
106  char **channels);
107 SR_API int sr_session_append(const char *filename, unsigned char *buf,
108  int unitsize, int units);
109 SR_API int sr_session_source_add(int fd, int events, int timeout,
110  sr_receive_data_callback cb, void *cb_data);
111 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
112  sr_receive_data_callback cb, void *cb_data);
113 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
114  int timeout, sr_receive_data_callback cb, void *cb_data);
115 SR_API int sr_session_source_remove(int fd);
116 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
117 SR_API int sr_session_source_remove_channel(GIOChannel *channel);
118 
119 /*--- input/input.c ---------------------------------------------------------*/
120 
121 SR_API struct sr_input_format **sr_input_list(void);
122 
123 /*--- output/output.c -------------------------------------------------------*/
124 
125 SR_API struct sr_output_format **sr_output_list(void);
127  GHashTable *params, const struct sr_dev_inst *sdi);
128 SR_API int sr_output_send(struct sr_output *o,
129  const struct sr_datafeed_packet *packet, GString **out);
130 SR_API int sr_output_free(struct sr_output *o);
131 
132 /*--- strutil.c -------------------------------------------------------------*/
133 
134 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
135 SR_API char *sr_samplerate_string(uint64_t samplerate);
136 SR_API char *sr_period_string(uint64_t frequency);
137 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
138 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
139  const char *triggerstring);
140 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
141 SR_API uint64_t sr_parse_timestring(const char *timestring);
142 SR_API gboolean sr_parse_boolstring(const char *boolstring);
143 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
144 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
145 
146 /*--- version.c -------------------------------------------------------------*/
147 
151 SR_API const char *sr_package_version_string_get(void);
152 
156 SR_API const char *sr_lib_version_string_get(void);
157 
158 /*--- error.c ---------------------------------------------------------------*/
159 
160 SR_API const char *sr_strerror(int error_code);
161 SR_API const char *sr_strerror_name(int error_code);
162 
163 #endif
int sr_dev_channel_name_set(const struct sr_dev_inst *sdi, int channelnum, const char *name)
Set the name of the specified channel in the specified device.
Definition: device.c:88
Packet in a sigrok data feed.
Definition: libsigrok.h:318
struct sr_input_format ** sr_input_list(void)
Definition: input.c:71
GSList * sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
Tell a hardware driver to scan for devices.
Definition: hwdriver.c:517
const struct sr_dev_inst * sdi
The device for which this output module is creating output.
Definition: libsigrok.h:440
int sr_output_free(struct sr_output *o)
Definition: output.c:108
Output (file) format struct.
Definition: libsigrok.h:432
int sr_lib_version_revision_get(void)
Get the "revision" part of the libsigrok library version number.
Definition: version.c:117
int sr_session_dev_add(const struct sr_dev_inst *sdi)
Add a device instance to the current session.
Definition: session.c:157
int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
Initialize a hardware driver.
Definition: hwdriver.c:471
int sr_exit(struct sr_context *ctx)
Shutdown libsigrok.
Definition: backend.c:381
const char * sr_strerror_name(int error_code)
Return the "name" string of the given libsigrok error code.
Definition: error.c:104
char ** sr_parse_triggerstring(const struct sr_dev_inst *sdi, const char *triggerstring)
Parse a trigger specification string.
Definition: strutil.c:391
GSList * sr_dev_list(const struct sr_dev_driver *driver)
Get the list of devices/instances of the specified driver.
Definition: device.c:452
int sr_session_stop(void)
Stop the current session.
Definition: session.c:494
gboolean sr_parse_boolstring(const char *boolstring)
Definition: strutil.c:572
const struct sr_config_info * sr_config_info_get(int key)
Get information about a configuration key, by key.
Definition: hwdriver.c:743
int sr_session_start(void)
Start a session.
Definition: session.c:360
int sr_session_destroy(void)
Destroy the current session.
Definition: session.c:101
struct sr_output_format * format
A pointer to this output's format.
Definition: libsigrok.h:434
char * sr_period_string(uint64_t frequency)
Convert a numeric frequency value to the "natural" string representation of its period.
Definition: strutil.c:295
int sr_session_run(void)
Run the session.
Definition: session.c:408
const char * sr_package_version_string_get(void)
Get the libsigrok package version number as a string.
Definition: version.c:93
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:340
int sr_lib_version_current_get(void)
Get the "current" part of the libsigrok library version number.
Definition: version.c:105
struct sr_dev_driver ** sr_driver_list(void)
Return the list of supported hardware drivers.
Definition: hwdriver.c:446
int sr_session_append(const char *filename, unsigned char *buf, int unitsize, int units)
Append data to an existing session file.
Definition: session_file.c:387
int sr_package_version_minor_get(void)
Get the minor libsigrok package version number.
Definition: version.c:68
int sr_config_commit(const struct sr_dev_inst *sdi)
Apply configuration settings to the device hardware.
Definition: hwdriver.c:679
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:233
int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_data)
Add a datafeed callback to the current session.
Definition: session.c:269
int sr_package_version_micro_get(void)
Get the micro libsigrok package version number.
Definition: version.c:80
int sr_log_loglevel_set(int loglevel)
Set the libsigrok loglevel.
Definition: log.c:83
Input (file) format driver.
Definition: libsigrok.h:375
const char * sr_lib_version_string_get(void)
Get the libsigrok library version number as a string.
Definition: version.c:142
Device instance data.
Definition: libsigrok.h:841
int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, sr_receive_data_callback cb, void *cb_data)
Add an event source for a GPollFD.
Definition: session.c:689
int sr_log_loglevel_get(void)
Get the libsigrok loglevel.
Definition: log.c:104
char * sr_log_logdomain_get(void)
Get the currently configured libsigrok logdomain.
Definition: log.c:149
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:234
Opaque data structure representing a libsigrok session.
int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum, gboolean state)
Enable or disable a channel on the specified device.
Definition: device.c:127
Opaque structure representing a libsigrok context.
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)
Query value of a configuration key at the given driver or device instance.
Definition: hwdriver.c:609
int(* sr_receive_data_callback)(int fd, int revents, void *cb_data)
Type definition for callback function for data reception.
Definition: libsigrok.h:135
int sr_session_source_add_channel(GIOChannel *channel, int events, int timeout, sr_receive_data_callback cb, void *cb_data)
Add an event source for a GIOChannel.
Definition: session.c:711
int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:587
int sr_dev_open(struct sr_dev_inst *sdi)
Open the specified device.
Definition: device.c:497
int sr_session_save_init(const char *filename, uint64_t samplerate, char **channels)
Initialize a saved session file.
Definition: session_file.c:294
int sr_dev_close(struct sr_dev_inst *sdi)
Close the specified device.
Definition: device.c:518
int sr_session_source_remove_pollfd(GPollFD *pollfd)
Remove the source belonging to the specified poll descriptor.
Definition: session.c:813
void(* sr_datafeed_callback)(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data)
Definition: proto.h:83
int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum, const char *trigger)
Add a trigger to the specified device (and the specified channel).
Definition: device.c:176
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)
List all possible values for a configuration key.
Definition: hwdriver.c:716
struct sr_output_format ** sr_output_list(void)
Definition: output.c:77
int key
Config key like SR_CONF_CONN, etc.
Definition: libsigrok.h:571
int sr_output_send(struct sr_output *o, const struct sr_datafeed_packet *packet, GString **out)
Definition: output.c:101
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:546
Device driver data.
Definition: libsigrok.h:891
int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:620
int sr_session_source_remove_channel(GIOChannel *channel)
Remove the source belonging to the specified channel.
Definition: session.c:830
const struct sr_config_info * sr_config_info_name_get(const char *optname)
Get information about a configuration key, by name.
Definition: hwdriver.c:765
int sr_log_logdomain_set(const char *logdomain)
Set the libsigrok logdomain string.
Definition: log.c:125
int sr_config_set(const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, int key, GVariant *data)
Set value of a configuration key in a device instance.
Definition: hwdriver.c:650
int sr_dev_clear(const struct sr_dev_driver *driver)
Clear the list of device instances a driver knows about.
Definition: device.c:471
int sr_lib_version_age_get(void)
Get the "age" part of the libsigrok library version number.
Definition: version.c:129
int sr_session_source_remove(int fd)
Remove the source belonging to the specified file descriptor.
Definition: session.c:797
int sr_package_version_major_get(void)
Get the major libsigrok package version number.
Definition: version.c:56
const char * sr_strerror(int error_code)
Return a human-readable error string for the given libsigrok error code.
Definition: error.c:53
struct sr_session * sr_session_new(void)
Create a new session.
Definition: session.c:77
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:479
int sr_init(struct sr_context **ctx)
Initialize libsigrok.
Definition: backend.c:318
int(* sr_log_callback)(void *cb_data, int loglevel, const char *format, va_list args)
Definition: proto.h:36
char * sr_samplerate_string(uint64_t samplerate)
Convert a numeric samplerate value to its "natural" string representation.
Definition: strutil.c:276
int sr_log_callback_set_default(void)
Set the libsigrok log callback to the default built-in one.
Definition: log.c:193
Output (file) format driver.
Definition: libsigrok.h:460
int sr_session_save(const char *filename, const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize, int units)
Save the current session to the specified file.
Definition: session_file.c:238
struct sr_output * sr_output_new(struct sr_output_format *of, GHashTable *params, const struct sr_dev_inst *sdi)
Definition: output.c:83
int sr_log_callback_set(sr_log_callback cb, void *cb_data)
Set the libsigrok log callback to the specified function.
Definition: log.c:169
Information about a config key.
Definition: libsigrok.h:569
int sr_session_datafeed_callback_remove_all(void)
Remove all datafeed callbacks in the current session.
Definition: session.c:244
int sr_session_dev_list(GSList **devlist)
List all device instances attached to the current session.
Definition: session.c:223
Structure for groups of channels that have common properties.
Definition: libsigrok.h:551
int sr_session_load(const char *filename)
Load the session from the specified filename.
Definition: session_file.c:110
int sr_session_source_add(int fd, int events, int timeout, sr_receive_data_callback cb, void *cb_data)
Add an event source for a file descriptor.
Definition: session.c:664
GHashTable * params
An optional parameter which the frontend can pass in to the output module.
Definition: libsigrok.h:447
int sr_session_dev_remove_all(void)
Remove all the devices from the current session.
Definition: session.c:131
#define SR_API
Definition: libsigrok.h:122