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 * Status/error codes returned by libsigrok functions.
36 * All possible return codes of libsigrok functions must be listed here.
37 * Functions should never return hardcoded numbers as status, but rather
38 * use these #defines instead. All error codes are negative numbers.
40 * The error codes are globally unique in libsigrok, i.e. if one of the
41 * libsigrok functions returns a "malloc error" it must be exactly the same
42 * return value as used by all other functions to indicate "malloc error".
43 * There must be no functions which indicate two different errors via the
46 * Also, for compatibility reasons, no defined return codes are ever removed
47 * or reused for different #defines later. You can only add new #defines and
48 * return codes, but never remove or redefine existing ones.
50 #define SR_OK 0 /* No error */
51 #define SR_ERR -1 /* Generic/unspecified error */
52 #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
53 #define SR_ERR_ARG -3 /* Function argument error */
54 #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */
55 #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */
57 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
58 #define SR_MAX_PROBENAME_LEN 32
60 /* Handy little macros */
62 #define SR_KHZ(n) ((n) * 1000)
63 #define SR_MHZ(n) ((n) * 1000000)
64 #define SR_GHZ(n) ((n) * 1000000000)
66 #define SR_HZ_TO_NS(n) (1000000000 / (n))
68 /* libsigrok loglevels. */
69 #define SR_LOG_NONE 0 /**< Output no messages at all. */
70 #define SR_LOG_ERR 1 /**< Output error messages. */
71 #define SR_LOG_WARN 2 /**< Output warnings. */
72 #define SR_LOG_INFO 3 /**< Output informational messages. */
73 #define SR_LOG_DBG 4 /**< Output debug messages. */
74 #define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */
77 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
79 * Variables and functions marked 'static' are private already and don't
80 * need SR_PRIV. However, functions which are not static (because they need
81 * to be used in other libsigrok-internal files) but are also not meant to
82 * be part of the public libsigrok API, must use SR_PRIV.
84 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
86 * This feature is not available on MinGW/Windows, as it is a feature of
87 * ELF files and MinGW/Windows uses PE files.
89 * Details: http://gcc.gnu.org/wiki/Visibility
92 /* Marks public libsigrok API symbols. */
94 #define SR_API __attribute__((visibility("default")))
99 /* Marks private, non-public libsigrok symbols (not part of the API). */
101 #define SR_PRIV __attribute__((visibility("hidden")))
106 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
108 /* Data types used by hardware drivers for dev_config_set() */
114 SR_T_RATIONAL_PERIOD,
126 /* sr_datafeed_packet.type values */
139 /* sr_datafeed_analog.mq values */
150 /* sr_datafeed_analog.unit values */
162 struct sr_datafeed_packet {
167 struct sr_datafeed_header {
169 struct timeval starttime;
172 struct sr_datafeed_meta_logic {
177 struct sr_datafeed_logic {
183 struct sr_datafeed_meta_analog {
187 struct sr_datafeed_analog {
189 int mq; /* Measured quantity (e.g. voltage, current, temperature) */
190 int unit; /* Unit in which the MQ is measured. */
195 struct sr_input_format *format;
200 struct sr_input_format {
203 int (*format_match) (const char *filename);
204 int (*init) (struct sr_input *in);
205 int (*loadfile) (struct sr_input *in, const char *filename);
209 struct sr_output_format *format;
215 struct sr_output_format {
219 int (*init) (struct sr_output *o);
220 int (*data) (struct sr_output *o, const uint8_t *data_in,
221 uint64_t length_in, uint8_t **data_out,
222 uint64_t *length_out);
223 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
224 uint64_t *length_out);
227 struct sr_datastore {
228 /* Size in bytes of the number of units stored in this datastore */
230 unsigned int num_units; /* TODO: uint64_t */
235 * This represents a generic device connected to the system.
236 * For device-specific information, ask the driver. The driver_index refers
237 * to the device index within that driver; it may be handling more than one
238 * device. All relevant driver calls take a dev_index parameter for this.
241 /* Which driver handles this device */
242 struct sr_dev_driver *driver;
243 /* A driver may handle multiple devices of the same type */
245 /* List of struct sr_probe* */
247 /* Data acquired by this device, if any */
248 struct sr_datastore *datastore;
263 /* Hardware driver capabilities */
265 SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
267 /*--- Device classes ------------------------------------------------*/
269 /** The device can act as logic analyzer. */
270 SR_HWCAP_LOGIC_ANALYZER,
272 /** The device can act as an oscilloscope. */
273 SR_HWCAP_OSCILLOSCOPE,
275 /** The device can act as a multimeter. */
278 /** The device is a demo device. */
282 /*--- Device communication ------------------------------------------*/
283 /** Some drivers cannot detect the exact model they're talking to. */
286 /** Specification on how to connect to a device */
289 /** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
293 /*--- Device configuration ------------------------------------------*/
295 /** The device supports setting/changing its samplerate. */
298 /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
299 /** The device supports setting a probe mask. */
300 SR_HWCAP_PROBECONFIG,
302 /** The device supports setting a pre/post-trigger capture ratio. */
303 SR_HWCAP_CAPTURE_RATIO,
306 /** The device supports setting a pattern (pattern generator mode). */
307 SR_HWCAP_PATTERN_MODE,
309 /** The device supports Run Length Encoding. */
312 /** The device supports setting trigger slope. */
313 SR_HWCAP_TRIGGER_SLOPE,
315 /** Trigger source. */
316 SR_HWCAP_TRIGGER_SOURCE,
318 /** Horizontal trigger position */
319 SR_HWCAP_HORIZ_TRIGGERPOS,
337 /*--- Special stuff -------------------------------------------------*/
339 /* TODO: Better description. */
340 /** The device supports specifying a capturefile to inject. */
341 SR_HWCAP_CAPTUREFILE,
343 /* TODO: Better description. */
344 /** The device supports specifying the capturefile unit size. */
345 SR_HWCAP_CAPTURE_UNITSIZE,
347 /* TODO: Better description. */
348 /** The device supports setting the number of probes. */
349 SR_HWCAP_CAPTURE_NUM_PROBES,
352 /*--- Acquisition modes ---------------------------------------------*/
355 * The device supports setting a sample time limit, i.e. how long the
356 * sample acquisition should run (in ms).
361 * The device supports setting a sample number limit, i.e. how many
362 * samples should be acquired.
364 SR_HWCAP_LIMIT_SAMPLES,
367 * The device supports setting a frame limit, i.e. how many
368 * frames should be acquired.
370 SR_HWCAP_LIMIT_FRAMES,
373 * The device supports continuous sampling, i.e. neither a time limit
374 * nor a sample number limit has to be supplied, it will just acquire
375 * samples continuously, until explicitly stopped by a certain command.
381 struct sr_hwcap_option {
398 /* sr_dev_inst types */
400 /** Device instance type for USB devices. */
402 /** Device instance type for serial port devices. */
406 /* Device instance status */
409 /* Found, but still booting */
411 /* Live, but not in use */
413 /* Actively in use in a session */
418 * TODO: This sucks, you just kinda have to "know" the returned type.
419 * TODO: Need a DI to return the number of trigger stages supported.
422 /* Device info IDs */
424 /* struct sr_dev_inst for this specific device */
426 /* The number of probes connected to this device */
428 /* The probe names on this device */
430 /* Samplerates supported by this device, (struct sr_samplerates) */
432 /* Types of logic trigger supported, out of "01crf" (char *) */
434 /* The currently set samplerate in Hz (uint64_t) */
435 SR_DI_CUR_SAMPLERATE,
436 /* Supported patterns (in pattern generator mode) */
438 /* Supported buffer sizes */
440 /* Supported time bases */
442 /* Supported trigger sources */
443 SR_DI_TRIGGER_SOURCES,
444 /* Supported filter targets */
446 /* Valid volts/div values */
448 /* Coupling options */
453 * A device supports either a range of samplerates with steps of a given
454 * granularity, or is limited to a set of defined samplerates. Use either
455 * step or list, but not both.
457 struct sr_samplerates {
461 const uint64_t *list;
464 struct sr_dev_driver {
465 /* Driver-specific */
469 int (*init) (const char *devinfo);
470 int (*cleanup) (void);
472 /* Device-specific */
473 int (*dev_open) (int dev_index);
474 int (*dev_close) (int dev_index);
475 const void *(*dev_info_get) (int dev_index, int dev_info_id);
476 int (*dev_status_get) (int dev_index);
477 const int *(*hwcap_get_all) (void);
478 int (*dev_config_set) (int dev_index, int hwcap, const void *value);
479 int (*dev_acquisition_start) (int dev_index, void *session_dev_id);
480 int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
484 /* List of struct sr_dev* */
486 /* list of sr_receive_data_callback_t */
487 GSList *datafeed_callbacks;
491 unsigned int num_sources;
493 /* Both "sources" and "pollfds" are of the same size and contain pairs of
494 * descriptor and callback function. We can not embed the GPollFD into the
495 * source struct since we want to be able to pass the array of all poll
496 * descriptors to g_poll.
498 struct source *sources;