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
36 #define SIGROK_MAJOR_VERSION @SIGROK_MAJOR_VERSION@
37 #define SIGROK_MINOR_VERSION @SIGROK_MINOR_VERSION@
38 #define SIGROK_MICRO_VERSION @SIGROK_MICRO_VERSION@
39 #define SIGROK_VERSION "@SIGROK_VERSION@"
42 * Status/error codes returned by libsigrok functions.
44 * All possible return codes of libsigrok functions must be listed here.
45 * Functions should never return hardcoded numbers as status, but rather
46 * use these #defines instead. All error codes are negative numbers.
48 * The error codes are globally unique in libsigrok, i.e. if one of the
49 * libsigrok functions returns a "malloc error" it must be exactly the same
50 * return value as used by all other functions to indicate "malloc error".
51 * There must be no functions which indicate two different errors via the
54 * Also, for compatibility reasons, no defined return codes are ever removed
55 * or reused for different #defines later. You can only add new #defines and
56 * return codes, but never remove or redefine existing ones.
58 #define SR_OK 0 /* No error */
59 #define SR_ERR -1 /* Generic/unspecified error */
60 #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
61 #define SR_ERR_ARG -3 /* Function argument error */
62 #define SR_ERR_SAMPLERATE -4 /* Incorrect samplerate */
64 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
65 #define SR_MAX_PROBENAME_LEN 32
67 /* Handy little macros */
69 #define SR_KHZ(n) ((n) * 1000)
70 #define SR_MHZ(n) ((n) * 1000000)
71 #define SR_GHZ(n) ((n) * 1000000000)
73 #define SR_HZ_TO_NS(n) (1000000000 / (n))
75 /* libsigrok loglevels. */
83 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
85 /* Data types used by hardware plugins for set_configuration() */
93 /* (Unused) protocol decoder stack entry */
101 /* sr_datafeed_packet.type values */
111 struct sr_datafeed_packet {
113 /* timeoffset since start, in picoseconds */
115 /* duration of data in this packet, in picoseconds */
120 struct sr_datafeed_header {
122 struct timeval starttime;
124 int num_analog_probes;
125 int num_logic_probes;
128 struct sr_datafeed_logic {
134 struct sr_datafeed_pd {
140 #if defined(HAVE_LA_ALSA)
141 struct sr_analog_probe {
143 uint8_t res; /* Needs to be a power of 2, FIXME */
144 uint16_t val; /* Max hardware ADC width is 16bits */
147 struct sr_analog_sample {
148 uint8_t num_probes; /* Max hardware probes is 256 */
149 struct sr_analog_probe probes[];
154 struct sr_input_format *format;
156 struct sr_device *vdevice;
159 struct sr_input_format {
162 int (*format_match) (const char *filename);
163 int (*init) (struct sr_input *in);
164 int (*loadfile) (struct sr_input *in, const char *filename);
168 struct sr_output_format *format;
169 struct sr_device *device;
174 struct sr_output_format {
178 int (*init) (struct sr_output *o);
179 int (*data) (struct sr_output *o, const char *data_in,
180 uint64_t length_in, char **data_out, uint64_t *length_out);
181 int (*event) (struct sr_output *o, int event_type, char **data_out,
182 uint64_t *length_out);
190 * TODO: Parameters? If so, configured plugins need another struct.
191 * TODO: Input and output format?
196 struct sr_datastore {
197 /* Size in bytes of the number of units stored in this datastore */
199 unsigned int num_units; /* TODO: uint64_t */
204 * This represents a generic device connected to the system.
205 * For device-specific information, ask the plugin. The plugin_index refers
206 * to the device index within that plugin; it may be handling more than one
207 * device. All relevant plugin calls take a device_index parameter for this.
210 /* Which plugin handles this device */
211 struct sr_device_plugin *plugin;
212 /* A plugin may handle multiple devices of the same type */
214 /* List of struct sr_probe* */
216 /* Data acquired by this device, if any */
217 struct sr_datastore *datastore;
222 SR_PROBE_TYPE_ANALOG,
233 /* TODO: Get rid of this global variable. */
234 extern GSList *devices;
236 /* Hardware plugin capabilities */
238 SR_HWCAP_DUMMY, /* Used to terminate lists */
240 /*--- Device classes ------------------------------------------------*/
242 /** The device can act as logic analyzer. */
243 SR_HWCAP_LOGIC_ANALYZER,
245 /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
247 /*--- Device options ------------------------------------------------*/
249 /** The device supports setting/changing its samplerate. */
252 /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
253 /** The device supports setting a probe mask. */
254 SR_HWCAP_PROBECONFIG,
256 /** The device supports setting a pre/post-trigger capture ratio. */
257 SR_HWCAP_CAPTURE_RATIO,
260 /** The device supports setting a pattern (pattern generator mode). */
261 SR_HWCAP_PATTERN_MODE,
263 /** The device supports Run Length Encoding. */
266 /*--- Special stuff -------------------------------------------------*/
268 /* TODO: Better description. */
269 /** The device supports specifying a capturefile to inject. */
270 SR_HWCAP_CAPTUREFILE,
272 /* TODO: Better description. */
273 /** The device supports specifying the capturefile unit size. */
274 SR_HWCAP_CAPTURE_UNITSIZE,
276 /* TODO: Better description. */
277 /** The device supports setting the number of probes. */
278 SR_HWCAP_CAPTURE_NUM_PROBES,
280 /*--- Acquisition modes ---------------------------------------------*/
283 * The device supports setting a sample time limit, i.e. how long the
284 * sample acquisition should run (in ms).
289 * The device supports setting a sample number limit, i.e. how many
290 * samples should be acquired.
292 SR_HWCAP_LIMIT_SAMPLES,
295 * The device supports continuous sampling, i.e. neither a time limit
296 * nor a sample number limit has to be supplied, it will just acquire
297 * samples continuously, until explicitly stopped by a certain command.
301 /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
304 struct sr_hwcap_option {
311 struct sr_device_instance {
320 struct sr_usb_device_instance *usb;
321 struct sr_serial_device_instance *serial;
325 /* sr_device_instance types */
331 #ifdef HAVE_LIBUSB_1_0
332 struct sr_usb_device_instance {
335 struct libusb_device_handle *devhdl;
339 struct sr_serial_device_instance {
344 /* Device instance status */
347 /* Found, but still booting */
349 /* Live, but not in use */
351 /* Actively in use in a session */
356 * TODO: This sucks, you just kinda have to "know" the returned type.
357 * TODO: Need a DI to return the number of trigger stages supported.
360 /* Device info IDs */
362 /* struct sr_device_instance for this specific device */
364 /* The number of probes connected to this device */
366 /* Samplerates supported by this device, (struct sr_samplerates) */
368 /* Types of trigger supported, out of "01crf" (char *) */
370 /* The currently set samplerate in Hz (uint64_t) */
371 SR_DI_CUR_SAMPLERATE,
372 /* Supported pattern generator modes */
377 * A device supports either a range of samplerates with steps of a given
378 * granularity, or is limited to a set of defined samplerates. Use either
379 * step or list, but not both.
381 struct sr_samplerates {
388 struct sr_device_plugin {
389 /* Plugin-specific */
393 int (*init) (const char *deviceinfo);
394 void (*cleanup) (void);
396 /* Device-specific */
397 int (*opendev) (int device_index);
398 int (*closedev) (int device_index);
399 void *(*get_device_info) (int device_index, int device_info_id);
400 int (*get_status) (int device_index);
401 int *(*get_capabilities) (void);
402 int (*set_configuration) (int device_index, int capability, void *value);
403 int (*start_acquisition) (int device_index, gpointer session_device_id);
404 void (*stop_acquisition) (int device_index, gpointer session_device_id);
408 /* List of struct sr_device* */
410 /* List of struct analyzer* */
412 /* list of sr_receive_data_callback */
413 GSList *datafeed_callbacks;
418 #include "sigrok-proto.h"