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
35 * Status/error codes returned by libsigrok functions.
37 * All possible return codes of libsigrok functions must be listed here.
38 * Functions should never return hardcoded numbers as status, but rather
39 * use these #defines instead. All error codes are negative numbers.
41 * The error codes are globally unique in libsigrok, i.e. if one of the
42 * libsigrok functions returns a "malloc error" it must be exactly the same
43 * return value as used by all other functions to indicate "malloc error".
44 * There must be no functions which indicate two different errors via the
47 * Also, for compatibility reasons, no defined return codes are ever removed
48 * or reused for different #defines later. You can only add new #defines and
49 * return codes, but never remove or redefine existing ones.
51 #define SIGROK_OK 0 /* No error */
52 #define SIGROK_ERR -1 /* Generic/unspecified error */
53 #define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
54 #define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */
56 /* limited by uint64_t */
57 #define MAX_NUM_PROBES 64
58 #define MAX_PROBENAME_LEN 32
60 /* Handy little macros */
61 #define KHZ(n) ((n) * 1000)
62 #define MHZ(n) ((n) * 1000000)
63 #define GHZ(n) ((n) * 1000000000)
65 #define HZ_TO_NS(n) (1000000000 / (n))
68 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
71 #ifndef ARRAY_AND_SIZE
72 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
75 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
77 /* Data types used by hardware plugins for set_configuration() */
87 /* (Unused) protocol decoder stack entry */
94 /* datafeed_packet.type values */
104 struct datafeed_packet {
111 struct datafeed_header {
113 struct timeval starttime;
116 int num_analog_probes;
117 int num_logic_probes;
121 struct input_format *format;
123 struct device *vdevice;
126 struct input_format {
129 int (*format_match) (const char *filename);
130 int (*init) (struct input *in);
131 int (*loadfile) (struct input *in, const char *filename);
135 struct output_format *format;
136 struct device *device;
141 struct output_format {
145 int (*init) (struct output *o);
146 int (*data) (struct output *o, char *data_in, uint64_t length_in,
147 char **data_out, uint64_t *length_out);
148 int (*event) (struct output *o, int event_type, char **data_out,
149 uint64_t *length_out);
156 * TODO: Parameters? If so, configured plugins need another struct.
157 * TODO: Input and output format?
161 /* Size of a chunk in units */
162 #define DATASTORE_CHUNKSIZE 512000
165 /* Size in bytes of the number of units stored in this datastore */
167 unsigned int num_units; /* TODO: uint64_t */
172 * This represents a generic device connected to the system.
173 * For device-specific information, ask the plugin. The plugin_index refers
174 * to the device index within that plugin; it may be handling more than one
175 * device. All relevant plugin calls take a device_index parameter for this.
178 /* Which plugin handles this device */
179 struct device_plugin *plugin;
180 /* A plugin may handle multiple devices of the same type */
182 /* List of struct probe* */
184 /* Data acquired by this device, if any */
185 struct datastore *datastore;
201 extern GSList *devices;
203 /* Hardware plugin capabilities */
205 HWCAP_DUMMY, /* Used to terminate lists */
207 HWCAP_LOGIC_ANALYZER,
210 HWCAP_SAMPLERATE, /* Change samplerate */
211 HWCAP_PROBECONFIG, /* Configure probe mask */
212 HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
213 HWCAP_PATTERN_MODE, /* Pattern generator mode */
215 /* acquisition modes */
216 HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
217 HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
221 struct hwcap_option {
228 struct sigrok_device_instance {
237 struct usb_device_instance *usb;
238 struct serial_device_instance *serial;
242 /* sigrok_device_instance types */
248 struct usb_device_instance {
251 struct libusb_device_handle *devhdl;
254 struct serial_device_instance {
259 /* Device instance status */
262 /* Found, but still booting */
264 /* Live, but not in use */
266 /* Actively in use in a session */
271 * TODO: This sucks, you just kinda have to "know" the returned type.
272 * TODO: Need a DI to return the number of trigger stages supported.
275 /* Device info IDs */
277 /* struct sigrok_device_instance for this specific device */
279 /* The number of probes connected to this device */
281 /* Samplerates supported by this device, (struct samplerates) */
283 /* Types of trigger supported, out of "01crf" (char *) */
285 /* The currently set samplerate in Hz (uint64_t) */
287 /* Supported pattern generator modes */
292 * A device supports either a range of samplerates with steps of a given
293 * granularity, or is limited to a set of defined samplerates. Use either
294 * step or list, but not both.
303 struct device_plugin {
304 /* Plugin-specific */
307 int (*init) (char *deviceinfo);
308 void (*cleanup) (void);
310 /* Device-specific */
311 int (*open) (int device_index);
312 void (*close) (int device_index);
313 void *(*get_device_info) (int device_index, int device_info_id);
314 int (*get_status) (int device_index);
315 int *(*get_capabilities) (void);
316 int (*set_configuration) (int device_index, int capability, void *value);
317 int (*start_acquisition) (int device_index, gpointer session_device_id);
318 void (*stop_acquisition) (int device_index, gpointer session_device_id);
324 /* Not really using this */
325 GSource *timeout_source;
329 /* List of struct device* */
331 /* List of struct analyzer* */
333 /* Datafeed callbacks */
334 GSList *datafeed_callbacks;
338 #include "sigrok-proto.h"