2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 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 LIBSIGROK_SIGROK_H
21 #define LIBSIGROK_SIGROK_H
34 * Package version macros (can be used for conditional compilation).
37 /** The libsigrok package 'major' version number. */
38 #define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@
40 /** The libsigrok package 'minor' version number. */
41 #define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@
43 /** The libsigrok package 'micro' version number. */
44 #define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@
46 /** The libsigrok package version ("major.minor.micro") as string. */
47 #define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@"
50 * Library/libtool version macros (can be used for conditional compilation).
53 /** The libsigrok libtool 'current' version number. */
54 #define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@
56 /** The libsigrok libtool 'revision' version number. */
57 #define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@
59 /** The libsigrok libtool 'age' version number. */
60 #define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@
62 /** The libsigrok libtool version ("current:revision:age") as string. */
63 #define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@"
66 * Status/error codes returned by libsigrok functions.
68 * All possible return codes of libsigrok functions must be listed here.
69 * Functions should never return hardcoded numbers as status, but rather
70 * use these #defines instead. All error codes are negative numbers.
72 * The error codes are globally unique in libsigrok, i.e. if one of the
73 * libsigrok functions returns a "malloc error" it must be exactly the same
74 * return value as used by all other functions to indicate "malloc error".
75 * There must be no functions which indicate two different errors via the
78 * Also, for compatibility reasons, no defined return codes are ever removed
79 * or reused for different #defines later. You can only add new #defines and
80 * return codes, but never remove or redefine existing ones.
82 #define SR_OK 0 /* No error */
83 #define SR_ERR -1 /* Generic/unspecified error */
84 #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
85 #define SR_ERR_ARG -3 /* Function argument error */
86 #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */
87 #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */
89 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
90 #define SR_MAX_PROBENAME_LEN 32
92 /* Handy little macros */
94 #define SR_KHZ(n) ((n) * 1000)
95 #define SR_MHZ(n) ((n) * 1000000)
96 #define SR_GHZ(n) ((n) * 1000000000)
98 #define SR_HZ_TO_NS(n) (1000000000 / (n))
100 /* libsigrok loglevels. */
101 #define SR_LOG_NONE 0 /**< Output no messages at all. */
102 #define SR_LOG_ERR 1 /**< Output error messages. */
103 #define SR_LOG_WARN 2 /**< Output warnings. */
104 #define SR_LOG_INFO 3 /**< Output informational messages. */
105 #define SR_LOG_DBG 4 /**< Output debug messages. */
106 #define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */
109 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
111 * Variables and functions marked 'static' are private already and don't
112 * need SR_PRIV. However, functions which are not static (because they need
113 * to be used in other libsigrok-internal files) but are also not meant to
114 * be part of the public libsigrok API, must use SR_PRIV.
116 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
118 * This feature is not available on MinGW/Windows, as it is a feature of
119 * ELF files and MinGW/Windows uses PE files.
121 * Details: http://gcc.gnu.org/wiki/Visibility
124 /* Marks public libsigrok API symbols. */
126 #define SR_API __attribute__((visibility("default")))
131 /* Marks private, non-public libsigrok symbols (not part of the API). */
133 #define SR_PRIV __attribute__((visibility("hidden")))
138 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
140 /* Data types used by hardware drivers for dev_config_set() */
147 /* sr_datafeed_packet.type values */
156 struct sr_datafeed_packet {
161 struct sr_datafeed_header {
163 struct timeval starttime;
165 int num_logic_probes;
168 struct sr_datafeed_logic {
175 struct sr_input_format *format;
180 struct sr_input_format {
183 int (*format_match) (const char *filename);
184 int (*init) (struct sr_input *in);
185 int (*loadfile) (struct sr_input *in, const char *filename);
189 struct sr_output_format *format;
195 struct sr_output_format {
199 int (*init) (struct sr_output *o);
200 int (*data) (struct sr_output *o, const uint8_t *data_in,
201 uint64_t length_in, uint8_t **data_out,
202 uint64_t *length_out);
203 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
204 uint64_t *length_out);
207 struct sr_datastore {
208 /* Size in bytes of the number of units stored in this datastore */
210 unsigned int num_units; /* TODO: uint64_t */
215 * This represents a generic device connected to the system.
216 * For device-specific information, ask the driver. The driver_index refers
217 * to the device index within that driver; it may be handling more than one
218 * device. All relevant driver calls take a dev_index parameter for this.
221 /* Which driver handles this device */
222 struct sr_dev_driver *driver;
223 /* A driver may handle multiple devices of the same type */
225 /* List of struct sr_probe* */
227 /* Data acquired by this device, if any */
228 struct sr_datastore *datastore;
243 /* Hardware driver capabilities */
245 SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
247 /*--- Device classes ------------------------------------------------*/
249 /** The device can act as logic analyzer. */
250 SR_HWCAP_LOGIC_ANALYZER,
252 /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
254 /*--- Device types --------------------------------------------------*/
256 /** The device is demo device. */
259 /*--- Device options ------------------------------------------------*/
261 /** The device supports setting/changing its samplerate. */
264 /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
265 /** The device supports setting a probe mask. */
266 SR_HWCAP_PROBECONFIG,
268 /** The device supports setting a pre/post-trigger capture ratio. */
269 SR_HWCAP_CAPTURE_RATIO,
272 /** The device supports setting a pattern (pattern generator mode). */
273 SR_HWCAP_PATTERN_MODE,
275 /** The device supports Run Length Encoding. */
278 /*--- Special stuff -------------------------------------------------*/
280 /* TODO: Better description. */
281 /** The device supports specifying a capturefile to inject. */
282 SR_HWCAP_CAPTUREFILE,
284 /* TODO: Better description. */
285 /** The device supports specifying the capturefile unit size. */
286 SR_HWCAP_CAPTURE_UNITSIZE,
288 /* TODO: Better description. */
289 /** The device supports setting the number of probes. */
290 SR_HWCAP_CAPTURE_NUM_PROBES,
292 /*--- Acquisition modes ---------------------------------------------*/
295 * The device supports setting a sample time limit, i.e. how long the
296 * sample acquisition should run (in ms).
301 * The device supports setting a sample number limit, i.e. how many
302 * samples should be acquired.
304 SR_HWCAP_LIMIT_SAMPLES,
307 * The device supports continuous sampling, i.e. neither a time limit
308 * nor a sample number limit has to be supplied, it will just acquire
309 * samples continuously, until explicitly stopped by a certain command.
313 /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
316 struct sr_hwcap_option {
333 /* sr_dev_inst types */
335 /** Device instance type for USB devices. */
337 /** Device instance type for serial port devices. */
341 /* Device instance status */
344 /* Found, but still booting */
346 /* Live, but not in use */
348 /* Actively in use in a session */
353 * TODO: This sucks, you just kinda have to "know" the returned type.
354 * TODO: Need a DI to return the number of trigger stages supported.
357 /* Device info IDs */
359 /* struct sr_dev_inst for this specific device */
361 /* The number of probes connected to this device */
363 /* The probe names on this device */
365 /* Samplerates supported by this device, (struct sr_samplerates) */
367 /* Types of trigger supported, out of "01crf" (char *) */
369 /* The currently set samplerate in Hz (uint64_t) */
370 SR_DI_CUR_SAMPLERATE,
371 /* Supported patterns (in pattern generator mode) */
376 * A device supports either a range of samplerates with steps of a given
377 * granularity, or is limited to a set of defined samplerates. Use either
378 * step or list, but not both.
380 struct sr_samplerates {
387 struct sr_dev_driver {
388 /* Driver-specific */
392 int (*init) (const char *devinfo);
393 int (*cleanup) (void);
395 /* Device-specific */
396 int (*dev_open) (int dev_index);
397 int (*dev_close) (int dev_index);
398 void *(*dev_info_get) (int dev_index, int dev_info_id);
399 int (*dev_status_get) (int dev_index);
400 int *(*hwcap_get_all) (void);
401 int (*dev_config_set) (int dev_index, int hwcap, void *value);
402 int (*dev_acquisition_start) (int dev_index, void *session_dev_id);
403 int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
407 /* List of struct sr_dev* */
409 /* list of sr_receive_data_callback_t */
410 GSList *datafeed_callbacks;
415 #include "sigrok-proto.h"