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 /* libsigrok loglevels. */
78 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
80 /* Data types used by hardware plugins for set_configuration() */
92 /* (Unused) protocol decoder stack entry */
100 /* sr_datafeed_packet.type values */
110 struct sr_datafeed_packet {
117 struct sr_datafeed_header {
119 struct timeval starttime;
122 int num_analog_probes;
123 int num_logic_probes;
126 #if defined(HAVE_LA_ALSA)
127 struct sr_analog_probe {
129 uint8_t res; /* Needs to be a power of 2, FIXME */
130 uint16_t val; /* Max hardware ADC width is 16bits */
133 struct sr_analog_sample {
134 uint8_t num_probes; /* Max hardware probes is 256 */
135 struct sr_analog_probe probes[];
140 struct sr_input_format *format;
142 struct sr_device *vdevice;
145 struct sr_input_format {
148 int (*format_match) (const char *filename);
149 int (*init) (struct sr_input *in);
150 int (*loadfile) (struct sr_input *in, const char *filename);
154 struct sr_output_format *format;
155 struct sr_device *device;
160 struct sr_output_format {
164 int (*init) (struct sr_output *o);
165 int (*data) (struct sr_output *o, const char *data_in,
166 uint64_t length_in, char **data_out, uint64_t *length_out);
167 int (*event) (struct sr_output *o, int event_type, char **data_out,
168 uint64_t *length_out);
176 * TODO: Parameters? If so, configured plugins need another struct.
177 * TODO: Input and output format?
182 struct sr_datastore {
183 /* Size in bytes of the number of units stored in this datastore */
185 unsigned int num_units; /* TODO: uint64_t */
190 * This represents a generic device connected to the system.
191 * For device-specific information, ask the plugin. The plugin_index refers
192 * to the device index within that plugin; it may be handling more than one
193 * device. All relevant plugin calls take a device_index parameter for this.
196 /* Which plugin handles this device */
197 struct sr_device_plugin *plugin;
198 /* A plugin may handle multiple devices of the same type */
200 /* List of struct sr_probe* */
202 /* Data acquired by this device, if any */
203 struct sr_datastore *datastore;
208 SR_PROBE_TYPE_ANALOG,
219 /* TODO: Get rid of this global variable. */
220 extern GSList *devices;
222 /* Hardware plugin capabilities */
224 SR_HWCAP_DUMMY, /* Used to terminate lists */
226 /*--- Device classes ------------------------------------------------*/
228 /** The device can act as logic analyzer. */
229 SR_HWCAP_LOGIC_ANALYZER,
231 /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
233 /*--- Device options ------------------------------------------------*/
235 /** The device supports setting/changing its samplerate. */
238 /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
239 /** The device supports setting a probe mask. */
240 SR_HWCAP_PROBECONFIG,
242 /** The device supports setting a pre/post-trigger capture ratio. */
243 SR_HWCAP_CAPTURE_RATIO,
246 /** The device supports setting a pattern (pattern generator mode). */
247 SR_HWCAP_PATTERN_MODE,
249 /*--- Special stuff -------------------------------------------------*/
251 /* TODO: Better description. */
252 /** The device supports specifying a capturefile to inject. */
253 SR_HWCAP_CAPTUREFILE,
255 /* TODO: Better description. */
256 /** The device supports specifying the capturefile unit size. */
257 SR_HWCAP_CAPTURE_UNITSIZE,
259 /* TODO: Better description. */
260 /** The device supports setting the number of probes. */
261 SR_HWCAP_CAPTURE_NUM_PROBES,
263 /*--- Acquisition modes ---------------------------------------------*/
266 * The device supports setting a sample time limit, i.e. how long the
267 * sample acquisition should run (in ms).
272 * The device supports setting a sample number limit, i.e. how many
273 * samples should be acquired.
275 SR_HWCAP_LIMIT_SAMPLES,
278 * The device supports continuous sampling, i.e. neither a time limit
279 * nor a sample number limit has to be supplied, it will just acquire
280 * samples continuously, until explicitly stopped by a certain command.
284 /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
287 struct sr_hwcap_option {
294 struct sr_device_instance {
303 struct sr_usb_device_instance *usb;
304 struct sr_serial_device_instance *serial;
308 /* sr_device_instance types */
314 #ifdef HAVE_LIBUSB_1_0
315 struct sr_usb_device_instance {
318 struct libusb_device_handle *devhdl;
322 struct sr_serial_device_instance {
327 /* Device instance status */
330 /* Found, but still booting */
332 /* Live, but not in use */
334 /* Actively in use in a session */
339 * TODO: This sucks, you just kinda have to "know" the returned type.
340 * TODO: Need a DI to return the number of trigger stages supported.
343 /* Device info IDs */
345 /* struct sr_device_instance for this specific device */
347 /* The number of probes connected to this device */
349 /* Samplerates supported by this device, (struct sr_samplerates) */
351 /* Types of trigger supported, out of "01crf" (char *) */
353 /* The currently set samplerate in Hz (uint64_t) */
354 SR_DI_CUR_SAMPLERATE,
355 /* Supported pattern generator modes */
360 * A device supports either a range of samplerates with steps of a given
361 * granularity, or is limited to a set of defined samplerates. Use either
362 * step or list, but not both.
364 struct sr_samplerates {
371 struct sr_device_plugin {
372 /* Plugin-specific */
376 int (*init) (const char *deviceinfo);
377 void (*cleanup) (void);
379 /* Device-specific */
380 int (*opendev) (int device_index);
381 int (*closedev) (int device_index);
382 void *(*get_device_info) (int device_index, int device_info_id);
383 int (*get_status) (int device_index);
384 int *(*get_capabilities) (void);
385 int (*set_configuration) (int device_index, int capability, void *value);
386 int (*start_acquisition) (int device_index, gpointer session_device_id);
387 void (*stop_acquisition) (int device_index, gpointer session_device_id);
391 /* List of struct sr_device* */
393 /* List of struct analyzer* */
395 /* list of sr_receive_data_callback */
396 GSList *datafeed_callbacks;
401 #include "sigrok-proto.h"