2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 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_H
21 #define SIGROK_SIGROK_H
28 #ifdef HAVE_LIBUSB_1_0
37 * Status/error codes returned by libsigrok functions.
39 * All possible return codes of libsigrok functions must be listed here.
40 * Functions should never return hardcoded numbers as status, but rather
41 * use these #defines instead. All error codes are negative numbers.
43 * The error codes are globally unique in libsigrok, i.e. if one of the
44 * libsigrok functions returns a "malloc error" it must be exactly the same
45 * return value as used by all other functions to indicate "malloc error".
46 * There must be no functions which indicate two different errors via the
49 * Also, for compatibility reasons, no defined return codes are ever removed
50 * or reused for different #defines later. You can only add new #defines and
51 * return codes, but never remove or redefine existing ones.
53 #define SR_OK 0 /* No error */
54 #define SR_ERR -1 /* Generic/unspecified error */
55 #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
56 #define SR_ERR_ARG -3 /* Function argument error */
57 #define SR_ERR_SAMPLERATE -4 /* Incorrect samplerate */
59 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
60 #define SR_MAX_PROBENAME_LEN 32
62 /* Handy little macros */
64 #define SR_KHZ(n) ((n) * 1000)
65 #define SR_MHZ(n) ((n) * 1000000)
66 #define SR_GHZ(n) ((n) * 1000000000)
68 #define SR_HZ_TO_NS(n) (1000000000 / (n))
70 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
72 /* Data types used by hardware plugins for set_configuration() */
84 /* (Unused) protocol decoder stack entry */
92 /* sr_datafeed_packet.type values */
102 struct sr_datafeed_packet {
109 struct sr_datafeed_header {
111 struct timeval starttime;
114 int num_analog_probes;
115 int num_logic_probes;
119 struct sr_analog_probe {
121 uint8_t res; /* Needs to be a power of 2, FIXME */
122 uint16_t val; /* Max hardware ADC width is 16bits */
125 struct sr_analog_sample {
126 uint8_t num_probes; /* Max hardware probes is 256 */
127 struct sr_analog_probe probes[];
132 struct sr_input_format *format;
134 struct sr_device *vdevice;
137 struct sr_input_format {
140 int (*format_match) (const char *filename);
141 int (*init) (struct sr_input *in);
142 int (*loadfile) (struct sr_input *in, const char *filename);
146 struct sr_output_format *format;
147 struct sr_device *device;
152 struct sr_output_format {
156 int (*init) (struct sr_output *o);
157 int (*data) (struct sr_output *o, const char *data_in,
158 uint64_t length_in, char **data_out, uint64_t *length_out);
159 int (*event) (struct sr_output *o, int event_type, char **data_out,
160 uint64_t *length_out);
168 * TODO: Parameters? If so, configured plugins need another struct.
169 * TODO: Input and output format?
174 struct sr_datastore {
175 /* Size in bytes of the number of units stored in this datastore */
177 unsigned int num_units; /* TODO: uint64_t */
182 * This represents a generic device connected to the system.
183 * For device-specific information, ask the plugin. The plugin_index refers
184 * to the device index within that plugin; it may be handling more than one
185 * device. All relevant plugin calls take a device_index parameter for this.
188 /* Which plugin handles this device */
189 struct sr_device_plugin *plugin;
190 /* A plugin may handle multiple devices of the same type */
192 /* List of struct sr_probe* */
194 /* Data acquired by this device, if any */
195 struct sr_datastore *datastore;
200 SR_PROBE_TYPE_ANALOG,
211 /* TODO: Get rid of this global variable. */
212 extern GSList *devices;
214 /* Hardware plugin capabilities */
216 SR_HWCAP_DUMMY, /* Used to terminate lists */
218 SR_HWCAP_LOGIC_ANALYZER,
221 SR_HWCAP_SAMPLERATE, /* Change samplerate */
222 SR_HWCAP_PROBECONFIG, /* Configure probe mask */
223 SR_HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
224 SR_HWCAP_PATTERN_MODE, /* Pattern generator mode */
227 SR_HWCAP_CAPTUREFILE, /* capturefile to inject */
228 SR_HWCAP_CAPTURE_UNITSIZE, /* unitsize of capturefile data */
229 SR_HWCAP_CAPTURE_NUM_PROBES,/* set number of probes */
231 /* acquisition modes */
232 SR_HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
233 SR_HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
237 struct sr_hwcap_option {
244 struct sr_device_instance {
253 struct sr_usb_device_instance *usb;
254 struct sr_serial_device_instance *serial;
258 /* sr_device_instance types */
264 #ifdef HAVE_LIBUSB_1_0
265 struct sr_usb_device_instance {
268 struct libusb_device_handle *devhdl;
272 struct sr_serial_device_instance {
277 /* Device instance status */
280 /* Found, but still booting */
282 /* Live, but not in use */
284 /* Actively in use in a session */
289 * TODO: This sucks, you just kinda have to "know" the returned type.
290 * TODO: Need a DI to return the number of trigger stages supported.
293 /* Device info IDs */
295 /* struct sr_device_instance for this specific device */
297 /* The number of probes connected to this device */
299 /* Samplerates supported by this device, (struct sr_samplerates) */
301 /* Types of trigger supported, out of "01crf" (char *) */
303 /* The currently set samplerate in Hz (uint64_t) */
304 SR_DI_CUR_SAMPLERATE,
305 /* Supported pattern generator modes */
310 * A device supports either a range of samplerates with steps of a given
311 * granularity, or is limited to a set of defined samplerates. Use either
312 * step or list, but not both.
314 struct sr_samplerates {
321 struct sr_device_plugin {
322 /* Plugin-specific */
326 int (*init) (const char *deviceinfo);
327 void (*cleanup) (void);
329 /* Device-specific */
330 int (*open) (int device_index);
331 void (*close) (int device_index);
332 void *(*get_device_info) (int device_index, int device_info_id);
333 int (*get_status) (int device_index);
334 int *(*get_capabilities) (void);
335 int (*set_configuration) (int device_index, int capability, void *value);
336 int (*start_acquisition) (int device_index, gpointer session_device_id);
337 void (*stop_acquisition) (int device_index, gpointer session_device_id);
341 /* List of struct sr_device* */
343 /* List of struct analyzer* */
345 /* list of sr_receive_data_callback */
346 GSList *datafeed_callbacks;
351 #include "sigrok-proto.h"