libsigrok  0.2.2
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs 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_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);
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_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 /*--- filter.c --------------------------------------------------------------*/
61 
62 SR_API int sr_filter_probes(unsigned int in_unitsize, unsigned int out_unitsize,
63  const GArray *probe_array, const uint8_t *data_in,
64  uint64_t length_in, uint8_t **data_out,
65  uint64_t *length_out);
66 
67 /*--- hwdriver.c ------------------------------------------------------------*/
68 
69 SR_API struct sr_dev_driver **sr_driver_list(void);
70 SR_API int sr_driver_init(struct sr_context *ctx,
71  struct sr_dev_driver *driver);
72 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
73 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
74  GVariant **data, const struct sr_dev_inst *sdi);
75 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
76  GVariant *data);
77 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
78  GVariant **data, const struct sr_dev_inst *sdi);
79 SR_API const struct sr_config_info *sr_config_info_get(int key);
80 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
81 
82 /*--- session.c -------------------------------------------------------------*/
83 
84 typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi,
85  const struct sr_datafeed_packet *packet, void *cb_data);
86 
87 /* Session setup */
88 SR_API int sr_session_load(const char *filename);
89 SR_API struct sr_session *sr_session_new(void);
90 SR_API int sr_session_destroy(void);
92 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
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_source_add(int fd, int events, int timeout,
106  sr_receive_data_callback_t cb, void *cb_data);
107 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
108  sr_receive_data_callback_t cb, void *cb_data);
109 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
110  int timeout, sr_receive_data_callback_t cb, void *cb_data);
111 SR_API int sr_session_source_remove(int fd);
112 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
113 SR_API int sr_session_source_remove_channel(GIOChannel *channel);
114 
115 /*--- input/input.c ---------------------------------------------------------*/
116 
117 SR_API struct sr_input_format **sr_input_list(void);
118 
119 /*--- output/output.c -------------------------------------------------------*/
120 
121 SR_API struct sr_output_format **sr_output_list(void);
122 
123 /*--- strutil.c -------------------------------------------------------------*/
124 
125 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
126 SR_API char *sr_samplerate_string(uint64_t samplerate);
127 SR_API char *sr_period_string(uint64_t frequency);
128 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
129 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
130  const char *triggerstring);
131 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
132 SR_API uint64_t sr_parse_timestring(const char *timestring);
133 SR_API gboolean sr_parse_boolstring(const char *boolstring);
134 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
135 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
136 
137 /*--- version.c -------------------------------------------------------------*/
138 
142 SR_API const char *sr_package_version_string_get(void);
143 
147 SR_API const char *sr_lib_version_string_get(void);
148 
149 /*--- error.c ---------------------------------------------------------------*/
150 
151 SR_API const char *sr_strerror(int error_code);
152 SR_API const char *sr_strerror_name(int error_code);
153 
154 #endif
struct sr_output_format ** sr_output_list(void)
Definition: output.c:80
int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, int probenum, const char *name)
Set the name of the specified probe in the specified device.
Definition: device.c:85
int sr_package_version_major_get(void)
Get the major libsigrok package version number.
Definition: version.c:56
int sr_log_callback_set(sr_log_callback_t cb, void *cb_data)
Set the libsigrok log callback to the specified function.
Definition: log.c:166
int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:428
int sr_filter_probes(unsigned int in_unitsize, unsigned int out_unitsize, const GArray *probe_array, const uint8_t *data_in, uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
Remove unused probes from samples.
Definition: filter.c:101
int sr_session_destroy(void)
Destroy the current session.
Definition: session.c:101
char * sr_voltage_string(uint64_t v_p, uint64_t v_q)
Convert a numeric voltage value to the &quot;natural&quot; string representation of its voltage value...
Definition: strutil.c:165
int sr_parse_sizestring(const char *sizestring, uint64_t *size)
Convert a &quot;natural&quot; string representation of a size value to uint64_t.
Definition: strutil.c:299
int sr_package_version_minor_get(void)
Get the minor libsigrok package version number.
Definition: version.c:68
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:213
int sr_exit(struct sr_context *ctx)
Shutdown libsigrok.
Definition: backend.c:389
char * sr_log_logdomain_get(void)
Get the currently configured libsigrok logdomain.
Definition: log.c:146
int sr_session_source_remove(int fd)
Remove the source belonging to the specified file descriptor.
Definition: session.c:716
const char * sr_strerror_name(int error_code)
Return the &quot;name&quot; string of the given libsigrok error code.
Definition: error.c:102
char * sr_si_string_u64(uint64_t x, const char *unit)
Convert a numeric value value to its &quot;natural&quot; string representation in SI units. ...
Definition: strutil.c:65
int sr_log_loglevel_set(int loglevel)
Set the libsigrok loglevel.
Definition: log.c:80
GSList * sr_dev_list(const struct sr_dev_driver *driver)
Get the list of devices/instances of the specified driver.
Definition: device.c:357
int sr_package_version_micro_get(void)
Get the micro libsigrok package version number.
Definition: version.c:80
int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q)
Definition: strutil.c:395
char * sr_samplerate_string(uint64_t samplerate)
Convert a numeric samplerate value to its &quot;natural&quot; string representation.
Definition: strutil.c:105
int sr_log_loglevel_get(void)
Get the libsigrok loglevel.
Definition: log.c:101
const char * sr_package_version_string_get(void)
Get the libsigrok package version number as a string.
Definition: version.c:93
int sr_session_dev_remove_all(void)
Remove all the devices from the current session.
Definition: session.c:128
struct sr_config_info * sr_config_info_get(int key)
Get information about a configuration key.
Definition: hwdriver.c:600
uint64_t sr_parse_timestring(const char *timestring)
Convert a &quot;natural&quot; string representation of a time value to an uint64_t value in milliseconds...
Definition: strutil.c:356
int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, gboolean state)
Enable or disable a probe on the specified device.
Definition: device.c:122
int sr_session_stop(void)
Stop the current session.
Definition: session.c:429
void(* sr_datafeed_callback_t)(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, void *cb_data)
Definition: proto.h:84
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:201
int sr_session_source_add_channel(GIOChannel *channel, int events, int timeout, sr_receive_data_callback_t cb, void *cb_data)
Add an event source for a GIOChannel.
Definition: session.c:634
int sr_session_load(const char *filename)
Load the session from the specified filename.
Definition: session_file.c:63
struct sr_input_format ** sr_input_list(void)
Definition: input.c:70
int(* sr_log_callback_t)(void *cb_data, int loglevel, const char *format, va_list args)
Definition: proto.h:36
int sr_lib_version_revision_get(void)
Get the &quot;revision&quot; part of the libsigrok library version number.
Definition: version.c:117
int sr_session_source_remove_channel(GIOChannel *channel)
Remove the source belonging to the specified channel.
Definition: session.c:744
char * sr_period_string(uint64_t frequency)
Convert a numeric frequency value to the &quot;natural&quot; string representation of its period.
Definition: strutil.c:122
int sr_log_callback_set_default(void)
Set the libsigrok log callback to the default built-in one.
Definition: log.c:190
int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
Add a datafeed callback to the current session.
Definition: session.c:220
GSList * sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
Tell a hardware driver to scan for devices.
Definition: hwdriver.c:425
int sr_lib_version_current_get(void)
Get the &quot;current&quot; part of the libsigrok library version number.
Definition: version.c:105
int sr_session_datafeed_callback_remove_all(void)
Remove all datafeed callbacks in the current session.
Definition: session.c:198
int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, sr_receive_data_callback_t cb, void *cb_data)
Add an event source for a GPollFD.
Definition: session.c:615
struct sr_config_info * sr_config_info_name_get(const char *optname)
Get information about an configuration key, by name.
Definition: hwdriver.c:620
int(* sr_receive_data_callback_t)(int fd, int revents, void *cb_data)
Definition: libsigrok.h:133
int sr_dev_open(struct sr_dev_inst *sdi)
Open the specified device.
Definition: device.c:391
int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
Set a configuration key in a device instance.
Definition: hwdriver.c:541
int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
Initialize a hardware driver.
Definition: hwdriver.c:381
int sr_dev_close(struct sr_dev_inst *sdi)
Close the specified device.
Definition: device.c:412
int sr_session_run(void)
Run the session.
Definition: session.c:347
const char * sr_lib_version_string_get(void)
Get the libsigrok library version number as a string.
Definition: version.c:142
struct sr_session * sr_session_new(void)
Create a new session.
Definition: session.c:79
struct sr_dev_driver ** sr_driver_list(void)
Return the list of supported hardware drivers.
Definition: hwdriver.c:359
int sr_dev_clear(const struct sr_dev_driver *driver)
Clear all devices/instances of the specified driver.
Definition: device.c:374
int sr_session_source_remove_pollfd(GPollFD *pollfd)
Remove the source belonging to the specified poll descriptor.
Definition: session.c:730
int sr_session_dev_add(const struct sr_dev_inst *sdi)
Add a device instance to the current session.
Definition: session.c:150
int sr_session_start(void)
Start a session.
Definition: session.c:307
int sr_session_source_add(int fd, int events, int timeout, sr_receive_data_callback_t cb, void *cb_data)
Add an event source for a file descriptor.
Definition: session.c:593
char ** sr_parse_triggerstring(const struct sr_dev_inst *sdi, const char *triggerstring)
Parse a trigger specification string.
Definition: strutil.c:214
const char * sr_strerror(int error_code)
Return a human-readable error string for the given libsigrok error code.
Definition: error.c:53
gboolean sr_parse_boolstring(const char *boolstring)
Definition: strutil.c:381
int sr_lib_version_age_get(void)
Get the &quot;age&quot; part of the libsigrok library version number.
Definition: version.c:129
int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, const char *trigger)
Add a trigger to the specified device (and the specified probe).
Definition: device.c:159
int sr_init(struct sr_context **ctx)
Initialize libsigrok.
Definition: backend.c:327
int sr_config_get(const struct sr_dev_driver *driver, int key, GVariant **data, const struct sr_dev_inst *sdi)
Returns information about the given driver or device instance.
Definition: hwdriver.c:507
int sr_config_list(const struct sr_dev_driver *driver, int key, GVariant **data, const struct sr_dev_inst *sdi)
List all possible values for a configuration key.
Definition: hwdriver.c:577
int sr_log_logdomain_set(const char *logdomain)
Set the libsigrok logdomain string.
Definition: log.c:122
#define SR_API
Definition: libsigrok.h:121