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
36 * The public libsigrok header file to be used by frontends.
38 * This is the only file that libsigrok users (frontends) are supposed to
39 * use and #include. There are other header files which get installed with
40 * libsigrok, but those are not meant to be used directly by frontends.
42 * The correct way to get/use the libsigrok API functions is:
45 * #include <libsigrok/libsigrok.h>
50 * All possible return codes of libsigrok functions must be listed here.
51 * Functions should never return hardcoded numbers as status, but rather
52 * use these enum values. All error codes are negative numbers.
54 * The error codes are globally unique in libsigrok, i.e. if one of the
55 * libsigrok functions returns a "malloc error" it must be exactly the same
56 * return value as used by all other functions to indicate "malloc error".
57 * There must be no functions which indicate two different errors via the
60 * Also, for compatibility reasons, no defined return codes are ever removed
61 * or reused for different errors later. You can only add new entries and
62 * return codes, but never remove or redefine existing ones.
65 /** Status/error codes returned by libsigrok functions. */
67 SR_OK = 0, /**< No error. */
68 SR_ERR = -1, /**< Generic/unspecified error. */
69 SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
70 SR_ERR_ARG = -3, /**< Function argument error. */
71 SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */
72 SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
75 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
76 #define SR_MAX_PROBENAME_LEN 32
78 /* Handy little macros */
80 #define SR_KHZ(n) ((n) * 1000)
81 #define SR_MHZ(n) ((n) * 1000000)
82 #define SR_GHZ(n) ((n) * 1000000000)
84 #define SR_HZ_TO_NS(n) (1000000000 / (n))
86 /** libsigrok loglevels. */
88 SR_LOG_NONE = 0, /**< Output no messages at all. */
89 SR_LOG_ERR = 1, /**< Output error messages. */
90 SR_LOG_WARN = 2, /**< Output warnings. */
91 SR_LOG_INFO = 3, /**< Output informational messages. */
92 SR_LOG_DBG = 4, /**< Output debug messages. */
93 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
97 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
99 * Variables and functions marked 'static' are private already and don't
100 * need SR_PRIV. However, functions which are not static (because they need
101 * to be used in other libsigrok-internal files) but are also not meant to
102 * be part of the public libsigrok API, must use SR_PRIV.
104 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
106 * This feature is not available on MinGW/Windows, as it is a feature of
107 * ELF files and MinGW/Windows uses PE files.
109 * Details: http://gcc.gnu.org/wiki/Visibility
112 /* Marks public libsigrok API symbols. */
114 #define SR_API __attribute__((visibility("default")))
119 /* Marks private, non-public libsigrok symbols (not part of the API). */
121 #define SR_PRIV __attribute__((visibility("hidden")))
126 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
128 /** Data types used by hardware drivers for dev_config_set(). */
134 SR_T_RATIONAL_PERIOD,
139 /** Rational number data type, containing numerator and denominator values. */
141 /** Numerator of the rational number. */
143 /** Denominator of the rational number. */
147 /** Value for sr_datafeed_packet.type. */
149 SR_DF_HEADER = 10000,
160 /** Values for sr_datafeed_analog.mq. */
162 SR_MQ_VOLTAGE = 10000,
172 /** Electrical power, usually in W, or dBm. */
174 /** Gain (a transistor's gain, or hFE, for example). */
176 /** Logarithmic representation of sound pressure relative to a
177 * reference value. */
178 SR_MQ_SOUND_PRESSURE_LEVEL,
179 SR_MQ_CARBON_MONOXIDE,
180 SR_MQ_RELATIVE_HUMIDITY,
183 /** Values for sr_datafeed_analog.unit. */
185 SR_UNIT_VOLT = 10000,
196 /** Unit of conductance, the inverse of resistance. */
199 * An absolute measurement of power, in decibels, referenced to
203 /** Voltage in decibel, referenced to 1 volt (dBV). */
204 SR_UNIT_DECIBEL_VOLT,
206 * Measurements that intrinsically do not have units attached, such
207 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
208 * a unitless quantity, for example.
211 /** Sound pressure level relative so 20 micropascals. */
214 * Normalized (0 to 1) concentration of a substance or compound with 0
215 * representing a concentration of 0%, and 1 being 100%. This is
216 * represented as the fraction of number of particles of the substance.
218 SR_UNIT_CONCENTRATION,
221 /** Values for sr_datafeed_analog.flags. */
223 /** Voltage measurement is alternating current (AC). */
225 /** Voltage measurement is direct current (DC). */
227 /** This is a true RMS measurement. */
228 SR_MQFLAG_RMS = 0x04,
229 /** Value is voltage drop across a diode, or NAN. */
230 SR_MQFLAG_DIODE = 0x08,
231 /** Device is in "hold" mode (repeating the last measurement). */
232 SR_MQFLAG_HOLD = 0x10,
233 /** Device is in "max" mode, only updating upon a new max value. */
234 SR_MQFLAG_MAX = 0x20,
235 /** Device is in "min" mode, only updating upon a new min value. */
236 SR_MQFLAG_MIN = 0x40,
237 /** Device is in autoranging mode. */
238 SR_MQFLAG_AUTORANGE = 0x80,
239 /** Device is in relative mode. */
240 SR_MQFLAG_RELATIVE = 0x100,
241 /** Sound pressure level is A-weighted in the frequency domain,
242 * according to IEC 61672:2003. */
243 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
244 /** Sound pressure level is C-weighted in the frequency domain,
245 * according to IEC 61672:2003. */
246 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
247 /** Sound pressure level is Z-weighted (i.e. not at all) in the
248 * frequency domain, according to IEC 61672:2003. */
249 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
250 /** Sound pressure level is not weighted in the frequency domain,
251 * albeit without standards-defined low and high frequency limits. */
252 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
253 /** Sound pressure level measurement is S-weighted (1s) in the
255 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
256 /** Sound pressure level measurement is F-weighted (125ms) in the
258 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
259 /** Sound pressure level is time-averaged (LAT), also known as
260 * Equivalent Continuous A-weighted Sound Level (LEQ). */
261 SR_MQFLAG_SPL_LAT = 0x8000,
262 /** Sound pressure level represented as a percentage of measurements
263 * that were over a preset alarm level. */
264 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
269 struct sr_datafeed_packet {
274 struct sr_datafeed_header {
276 struct timeval starttime;
279 struct sr_datafeed_meta_logic {
284 struct sr_datafeed_logic {
290 struct sr_datafeed_meta_analog {
294 struct sr_datafeed_analog {
296 /** Measured quantity (voltage, current, temperature, and so on). */
298 /** Unit in which the MQ is measured. */
300 /** Bitmap with extra information about the MQ. */
302 /** The analog value. */
307 struct sr_input_format *format;
309 struct sr_dev_inst *sdi;
313 struct sr_input_format {
316 int (*format_match) (const char *filename);
317 int (*init) (struct sr_input *in);
318 int (*loadfile) (struct sr_input *in, const char *filename);
322 struct sr_output_format *format;
323 struct sr_dev_inst *sdi;
328 struct sr_output_format {
332 int (*init) (struct sr_output *o);
333 int (*data) (struct sr_output *o, const uint8_t *data_in,
334 uint64_t length_in, uint8_t **data_out,
335 uint64_t *length_out);
336 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
337 uint64_t *length_out);
338 GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
339 const struct sr_datafeed_packet *packet);
340 int (*cleanup) (struct sr_output *o);
343 struct sr_datastore {
344 /** Size in bytes of the number of units stored in this datastore. */
346 unsigned int num_units; /* TODO: uint64_t */
351 * This represents a generic device connected to the system.
352 * For device-specific information, ask the driver. The driver_index refers
353 * to the device index within that driver; it may be handling more than one
354 * device. All relevant driver calls take a dev_index parameter for this.
357 /** Which driver handles this device. */
358 struct sr_dev_driver *driver;
359 /** A driver may handle multiple devices of the same type. */
361 /** List of struct sr_probe pointers. */
363 /** Data acquired by this device, if any. */
364 struct sr_datastore *datastore;
368 SR_PROBE_LOGIC = 10000,
385 /** Hardware driver options. */
388 * Some drivers cannot detect the exact model they're talking to
389 * (may be phased out).
391 SR_HWOPT_MODEL = 10000,
394 * Specification on how to connect to a device.
396 * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
397 * the form which makes sense to the OS (e.g., /dev/ttyS0).
398 * Otherwise this specifies a USB device, either in the form of
399 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
400 * @verbatim <vendorid>.<productid> @endverbatim
401 * (hexadecimal, e.g. 1d6b.0001).
406 * Serial communication specification, in the form:
408 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
412 * This is always an optional parameter, since a driver typically
413 * knows the speed at which the device wants to communicate.
418 /** Hardware device capabilities. */
420 /*--- Device classes ------------------------------------------------*/
422 /** The device can act as logic analyzer. */
423 SR_HWCAP_LOGIC_ANALYZER = 10000,
425 /** The device can act as an oscilloscope. */
426 SR_HWCAP_OSCILLOSCOPE,
428 /** The device can act as a multimeter. */
431 /** The device is a demo device. */
434 /** The device can act as a sound level meter. */
435 SR_HWCAP_SOUNDLEVELMETER,
437 /** The device can measure temperature. */
438 SR_HWCAP_THERMOMETER,
440 /** The device can measure humidity. */
443 /*--- Device configuration ------------------------------------------*/
445 /** The device supports setting/changing its samplerate. */
446 SR_HWCAP_SAMPLERATE = 20000,
448 /** The device supports setting a pre/post-trigger capture ratio. */
449 SR_HWCAP_CAPTURE_RATIO,
452 /** The device supports setting a pattern (pattern generator mode). */
453 SR_HWCAP_PATTERN_MODE,
455 /** The device supports Run Length Encoding. */
458 /** The device supports setting trigger slope. */
459 SR_HWCAP_TRIGGER_SLOPE,
461 /** Trigger source. */
462 SR_HWCAP_TRIGGER_SOURCE,
464 /** Horizontal trigger position. */
465 SR_HWCAP_HORIZ_TRIGGERPOS,
482 /*--- Special stuff -------------------------------------------------*/
484 /** Session filename. */
485 SR_HWCAP_SESSIONFILE = 30000,
487 /* TODO: Better description. */
488 /** The device supports specifying a capturefile to inject. */
489 SR_HWCAP_CAPTUREFILE,
491 /* TODO: Better description. */
492 /** The device supports specifying the capturefile unit size. */
493 SR_HWCAP_CAPTURE_UNITSIZE,
495 /* TODO: Better description. */
496 /** The device supports setting the number of probes. */
497 SR_HWCAP_CAPTURE_NUM_PROBES,
499 /*--- Acquisition modes ---------------------------------------------*/
502 * The device supports setting a sample time limit (how long
503 * the sample acquisition should run, in ms).
505 SR_HWCAP_LIMIT_MSEC = 40000,
508 * The device supports setting a sample number limit (how many
509 * samples should be acquired).
511 SR_HWCAP_LIMIT_SAMPLES,
514 * The device supports setting a frame limit (how many
515 * frames should be acquired).
517 SR_HWCAP_LIMIT_FRAMES,
520 * The device supports continuous sampling. Neither a time limit
521 * nor a sample number limit has to be supplied, it will just acquire
522 * samples continuously, until explicitly stopped by a certain command.
527 struct sr_hwcap_option {
535 struct sr_dev_driver *driver;
546 /** Types of device instances (sr_dev_inst). */
548 /** Device instance type for USB devices. */
550 /** Device instance type for serial port devices. */
554 /** Device instance status. */
556 /** The device instance was not found. */
557 SR_ST_NOT_FOUND = 10000,
558 /** The device instance was found, but is still booting. */
560 /** The device instance is live, but not in use. */
562 /** The device instance is actively in use in a session. */
564 /** The device is winding down its session. */
569 * TODO: This sucks, you just kinda have to "know" the returned type.
570 * TODO: Need a DI to return the number of trigger stages supported.
573 /** Device info IDs. */
575 /** A list of options supported by the driver. */
576 SR_DI_HWOPTS = 10000,
577 /** A list of capabilities supported by the device. */
579 /** The number of probes connected to this device. */
581 /** The probe names on this device. */
583 /** Samplerates supported by this device (struct sr_samplerates). */
585 /** Types of logic trigger supported, out of "01crf" (char *). */
587 /** The currently set samplerate in Hz (uint64_t). */
588 SR_DI_CUR_SAMPLERATE,
589 /** Supported patterns (in pattern generator mode). */
591 /** Supported buffer sizes. */
593 /** Supported time bases. */
595 /** Supported trigger sources. */
596 SR_DI_TRIGGER_SOURCES,
597 /** Supported filter targets. */
599 /** Valid volts/div values. */
601 /** Coupling options. */
606 * A device supports either a range of samplerates with steps of a given
607 * granularity, or is limited to a set of defined samplerates. Use either
608 * step or list, but not both.
610 struct sr_samplerates {
614 const uint64_t *list;
617 struct sr_dev_driver {
618 /* Driver-specific */
622 int (*init) (struct sr_context *sr_ctx);
623 int (*cleanup) (void);
624 GSList *(*scan) (GSList *options);
625 GSList *(*dev_list) (void);
626 int (*dev_clear) (void);
628 /* Device-specific */
629 int (*dev_open) (struct sr_dev_inst *sdi);
630 int (*dev_close) (struct sr_dev_inst *sdi);
631 int (*info_get) (int info_id, const void **data,
632 const struct sr_dev_inst *sdi);
633 int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
635 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
637 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
645 /** List of struct sr_dev pointers. */
647 /** List of sr_receive_data_callback_t items. */
648 GSList *datafeed_callbacks;
651 unsigned int num_sources;
654 * Both "sources" and "pollfds" are of the same size and contain pairs
655 * of descriptor and callback function. We can not embed the GPollFD
656 * into the source struct since we want to be able to pass the array
657 * of all poll descriptors to g_poll().
659 struct source *sources;