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 SR_OK 0 /* No error */
52 #define SR_ERR -1 /* Generic/unspecified error */
53 #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
54 #define SR_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() */
88 /* (Unused) protocol decoder stack entry */
95 /* sr_datafeed_packet.type values */
105 struct sr_datafeed_packet {
112 struct sr_datafeed_header {
114 struct timeval starttime;
117 int num_analog_probes;
118 int num_logic_probes;
121 struct analog_probe {
123 uint8_t res; /* Needs to be a power of 2, FIXME */
124 uint16_t val; /* Max hardware ADC width is 16bits */
127 struct analog_sample {
128 uint8_t num_probes; /* Max hardware probes is 256 */
129 struct analog_probe probes[];
133 struct sr_input_format *format;
135 struct device *vdevice;
138 struct sr_input_format {
141 int (*format_match) (const char *filename);
142 int (*init) (struct sr_input *in);
143 int (*loadfile) (struct sr_input *in, const char *filename);
147 struct sr_output_format *format;
148 struct device *device;
153 struct sr_output_format {
157 int (*init) (struct sr_output *o);
158 int (*data) (struct sr_output *o, char *data_in, uint64_t length_in,
159 char **data_out, uint64_t *length_out);
160 int (*event) (struct sr_output *o, int event_type, char **data_out,
161 uint64_t *length_out);
168 * TODO: Parameters? If so, configured plugins need another struct.
169 * TODO: Input and output format?
173 /* Size of a chunk in units */
174 #define DATASTORE_CHUNKSIZE 512000
177 /* Size in bytes of the number of units stored in this datastore */
179 unsigned int num_units; /* TODO: uint64_t */
184 * This represents a generic device connected to the system.
185 * For device-specific information, ask the plugin. The plugin_index refers
186 * to the device index within that plugin; it may be handling more than one
187 * device. All relevant plugin calls take a device_index parameter for this.
190 /* Which plugin handles this device */
191 struct device_plugin *plugin;
192 /* A plugin may handle multiple devices of the same type */
194 /* List of struct probe* */
196 /* Data acquired by this device, if any */
197 struct datastore *datastore;
213 extern GSList *devices;
215 /* Hardware plugin capabilities */
217 HWCAP_DUMMY, /* Used to terminate lists */
219 HWCAP_LOGIC_ANALYZER,
222 HWCAP_SAMPLERATE, /* Change samplerate */
223 HWCAP_PROBECONFIG, /* Configure probe mask */
224 HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
225 HWCAP_PATTERN_MODE, /* Pattern generator mode */
227 /* acquisition modes */
228 HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
229 HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
233 struct hwcap_option {
240 struct sr_device_instance {
249 struct usb_device_instance *usb;
250 struct serial_device_instance *serial;
254 /* sr_device_instance types */
260 struct usb_device_instance {
263 struct libusb_device_handle *devhdl;
266 struct serial_device_instance {
271 /* Device instance status */
274 /* Found, but still booting */
276 /* Live, but not in use */
278 /* Actively in use in a session */
283 * TODO: This sucks, you just kinda have to "know" the returned type.
284 * TODO: Need a DI to return the number of trigger stages supported.
287 /* Device info IDs */
289 /* struct sr_device_instance for this specific device */
291 /* The number of probes connected to this device */
293 /* Samplerates supported by this device, (struct samplerates) */
295 /* Types of trigger supported, out of "01crf" (char *) */
297 /* The currently set samplerate in Hz (uint64_t) */
299 /* Supported pattern generator modes */
304 * A device supports either a range of samplerates with steps of a given
305 * granularity, or is limited to a set of defined samplerates. Use either
306 * step or list, but not both.
315 struct device_plugin {
316 /* Plugin-specific */
319 int (*init) (char *deviceinfo);
320 void (*cleanup) (void);
322 /* Device-specific */
323 int (*open) (int device_index);
324 void (*close) (int device_index);
325 void *(*get_device_info) (int device_index, int device_info_id);
326 int (*get_status) (int device_index);
327 int *(*get_capabilities) (void);
328 int (*set_configuration) (int device_index, int capability, void *value);
329 int (*start_acquisition) (int device_index, gpointer session_device_id);
330 void (*stop_acquisition) (int device_index, gpointer session_device_id);
336 /* Not really using this */
337 GSource *timeout_source;
341 /* List of struct device* */
343 /* List of struct analyzer* */
345 /* list of receive_data_callback */
346 GSList *datafeed_callbacks;
351 #include "sigrok-proto.h"