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
32 * Status/error codes returned by libsigrok functions.
34 * All possible return codes of libsigrok functions must be listed here.
35 * Functions should never return hardcoded numbers as status, but rather
36 * use these #defines instead. All error codes are negative numbers.
38 * The error codes are globally unique in libsigrok, i.e. if one of the
39 * libsigrok functions returns a "malloc error" it must be exactly the same
40 * return value as used by all other functions to indicate "malloc error".
41 * There must be no functions which indicate two different errors via the
44 * Also, for compatibility reasons, no defined return codes are ever removed
45 * or reused for different #defines later. You can only add new #defines and
46 * return codes, but never remove or redefine existing ones.
48 #define SIGROK_OK 0 /* No error */
49 #define SIGROK_ERR -1 /* Generic/unspecified error */
50 #define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
51 #define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */
53 /* limited by uint64_t */
54 #define MAX_NUM_PROBES 64
55 #define MAX_PROBENAME_LEN 32
58 /* Handy little macros */
59 #define KHZ(n) ((n) * 1000)
60 #define MHZ(n) ((n) * 1000000)
61 #define GHZ(n) ((n) * 1000000000)
64 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
67 #ifndef ARRAY_AND_SIZE
68 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
72 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
75 /* Data types used by hardware plugins for set_configuration() */
85 /* (Unused) protocol decoder stack entry */
94 /* datafeed_packet.type values */
104 struct datafeed_packet {
111 struct datafeed_header {
113 struct timeval starttime;
122 struct input_format *format;
127 struct input_format {
130 int (*format_match) (const char *filename);
131 int (*in_loadfile) (const char *filename);
137 struct output_format *format;
138 struct device *device;
143 struct output_format {
147 int (*init) (struct output *o);
148 int (*data) (struct output *o, char *data_in, uint64_t length_in,
149 char **data_out, uint64_t *length_out);
150 int (*event) (struct output *o, int event_type, char **data_out,
151 uint64_t *length_out);
159 * TODO: Parameters? If so, configured plugins need another struct.
160 * TODO: Input and output format?
165 /* Size of a chunk in units */
166 #define DATASTORE_CHUNKSIZE 512000
169 /* Size in bytes of the number of units stored in this datastore */
171 unsigned int num_units; /* TODO: uint64_t */
177 * This represents a generic device connected to the system.
178 * For device-specific information, ask the plugin. The plugin_index refers
179 * to the device index within that plugin; it may be handling more than one
180 * device. All relevant plugin calls take a device_index parameter for this.
183 /* Which plugin handles this device */
184 struct device_plugin *plugin;
185 /* A plugin may handle multiple devices of the same type */
187 /* List of struct probe* */
189 /* Data acquired by this device, if any */
190 struct datastore *datastore;
200 extern GSList *devices;
203 /* Hardware plugin capabilities */
205 HWCAP_DUMMY, /* Used to terminate lists */
206 HWCAP_LOGIC_ANALYZER,
207 HWCAP_SAMPLERATE, /* Change samplerate */
208 HWCAP_PROBECONFIG, /* Configure probe mask */
209 HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
210 HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
211 HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
214 struct hwcap_option {
222 struct sigrok_device_instance {
231 struct usb_device_instance *usb;
232 struct serial_device_instance *serial;
236 /* sigrok_device_instance types */
242 struct usb_device_instance {
245 struct libusb_device_handle *devhdl;
248 struct serial_device_instance {
253 /* Device instance status */
256 /* Found, but still booting */
258 /* Live, but not in use */
260 /* Actively in use in a session */
265 * TODO: This sucks, you just kinda have to "know" the returned type.
266 * TODO: Need a DI to return the number of trigger stages supported.
269 /* Device info IDs */
271 /* struct sigrok_device_instance for this specific device */
273 /* The number of probes connected to this device */
275 /* Samplerates supported by this device, (struct samplerates) */
277 /* Types of trigger supported, out of "01crf" (char *) */
279 /* The currently set samplerate in Hz (uint64_t) */
284 * A device supports either a range of samplerates with steps of a given
285 * granularity, or is limited to a set of defined samplerates. Use either
286 * step or list, but not both.
295 struct device_plugin {
296 /* Plugin-specific */
299 int (*init) (char *deviceinfo);
300 void (*cleanup) (void);
302 /* Device-specific */
303 int (*open) (int device_index);
304 void (*close) (int device_index);
305 void *(*get_device_info) (int device_index, int device_info_id);
306 int (*get_status) (int device_index);
307 int *(*get_capabilities) (void);
308 int (*set_configuration) (int device_index, int capability, void *value);
309 int (*start_acquisition) (int device_index, gpointer session_device_id);
310 void (*stop_acquisition) (int device_index, gpointer session_device_id);
316 /* Not really using this */
317 GSource *timeout_source;
321 /* List of struct device* */
323 /* List of struct analyzer* */
325 /* Datafeed callbacks */
326 GSList *datafeed_callbacks;
330 #include "sigrok-proto.h"