2 * This file is part of the sigrok project.
4 * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 #ifndef SIGROK_SIGROK_PROTO_H
21 #define SIGROK_SIGROK_PROTO_H
23 /*--- backend.c -------------------------------------------------------------*/
28 /*--- log.c -----------------------------------------------------------------*/
30 int sr_set_loglevel(int loglevel);
31 int sr_get_loglevel(void);
33 /*--- datastore.c -----------------------------------------------------------*/
35 int sr_datastore_new(int unitsize, struct sr_datastore **ds);
36 int sr_datastore_destroy(struct sr_datastore *ds);
37 void sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
38 int in_unitsize, int *probelist);
40 /*--- device.c --------------------------------------------------------------*/
42 void sr_device_scan(void);
43 int sr_device_plugin_init(struct sr_device_plugin *plugin);
44 void sr_device_close_all(void);
45 GSList *sr_device_list(void);
46 struct sr_device *sr_device_new(struct sr_device_plugin *plugin,
47 int plugin_index, int num_probes);
48 void sr_device_clear(struct sr_device *device);
49 void sr_device_destroy(struct sr_device *dev);
51 void sr_device_probe_clear(struct sr_device *device, int probenum);
52 void sr_device_probe_add(struct sr_device *device, const char *name);
53 struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum);
54 void sr_device_probe_name(struct sr_device *device, int probenum,
57 void sr_device_trigger_clear(struct sr_device *device);
58 void sr_device_trigger_set(struct sr_device *device, int probenum,
60 gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap);
62 /*--- filter.c --------------------------------------------------------------*/
64 int sr_filter_probes(int in_unitsize, int out_unitsize, int *probelist,
65 const char *data_in, uint64_t length_in, char **data_out,
66 uint64_t *length_out);
68 /*--- hwplugin.c ------------------------------------------------------------*/
70 GSList *sr_list_hwplugins(void);
72 /* Generic device instances */
73 struct sr_device_instance *sr_device_instance_new(int index,
74 int status, const char *vendor, const char *model, const char *version);
75 struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
77 void sr_device_instance_free(struct sr_device_instance *sdi);
79 /* USB-specific instances */
80 #ifdef HAVE_LIBUSB_1_0
81 struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
82 uint8_t address, struct libusb_device_handle *hdl);
83 void sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
86 /* Serial-specific instances */
87 struct sr_serial_device_instance *sr_serial_device_instance_new(
88 const char *port, int fd);
89 void sr_serial_device_instance_free(struct sr_serial_device_instance *serial);
91 int sr_find_hwcap(int *capabilities, int hwcap);
92 struct sr_hwcap_option *sr_find_hwcap_option(int hwcap);
93 void sr_source_remove(int fd);
94 void sr_source_add(int fd, int events, int timeout,
95 sr_receive_data_callback rcv_cb, void *user_data);
97 /*--- session.c -------------------------------------------------------------*/
99 typedef void (*sr_datafeed_callback) (struct sr_device *device,
100 struct sr_datafeed_packet *packet);
103 int sr_session_load(const char *filename);
104 struct sr_session *sr_session_new(void);
105 void sr_session_destroy(void);
106 void sr_session_device_clear(void);
107 int sr_session_device_add(struct sr_device *device);
110 /* Protocol analyzers setup */
111 void sr_session_pa_clear(void);
112 void sr_session_pa_add(struct sr_analyzer *pa);
116 void sr_session_datafeed_callback_clear(void);
117 void sr_session_datafeed_callback_add(sr_datafeed_callback callback);
119 /* Session control */
120 int sr_session_start(void);
121 void sr_session_run(void);
122 void sr_session_halt(void);
123 void sr_session_stop(void);
124 void sr_session_bus(struct sr_device *device,
125 struct sr_datafeed_packet *packet);
126 int sr_session_save(const char *filename);
127 void sr_session_source_add(int fd, int events, int timeout,
128 sr_receive_data_callback callback, void *user_data);
129 void sr_session_source_remove(int fd);
131 /*--- input/input.c ---------------------------------------------------------*/
133 struct sr_input_format **sr_input_list(void);
135 /*--- output/output.c -------------------------------------------------------*/
137 struct sr_output_format **sr_output_list(void);
139 /*--- output/common.c -------------------------------------------------------*/
141 char *sr_samplerate_string(uint64_t samplerate);
142 char *sr_period_string(uint64_t frequency);
143 char **sr_parse_triggerstring(struct sr_device *device,
144 const char *triggerstring);
145 uint64_t sr_parse_sizestring(const char *sizestring);
146 uint64_t sr_parse_timestring(const char *timestring);