2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 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. */
73 SR_ERR_NA = -6, /**< Not applicable. */
74 SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
75 SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
76 SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
79 * Note: When adding entries here, don't forget to also update the
80 * sr_strerror() and sr_strerror_name() functions in error.c.
84 #define SR_MAX_PROBENAME_LEN 32
86 /* Handy little macros */
88 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
89 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
90 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
92 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
94 /** libsigrok loglevels. */
96 SR_LOG_NONE = 0, /**< Output no messages at all. */
97 SR_LOG_ERR = 1, /**< Output error messages. */
98 SR_LOG_WARN = 2, /**< Output warnings. */
99 SR_LOG_INFO = 3, /**< Output informational messages. */
100 SR_LOG_DBG = 4, /**< Output debug messages. */
101 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
105 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
107 * Variables and functions marked 'static' are private already and don't
108 * need SR_PRIV. However, functions which are not static (because they need
109 * to be used in other libsigrok-internal files) but are also not meant to
110 * be part of the public libsigrok API, must use SR_PRIV.
112 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
114 * This feature is not available on MinGW/Windows, as it is a feature of
115 * ELF files and MinGW/Windows uses PE files.
117 * Details: http://gcc.gnu.org/wiki/Visibility
120 /* Marks public libsigrok API symbols. */
122 #define SR_API __attribute__((visibility("default")))
127 /* Marks private, non-public libsigrok symbols (not part of the API). */
129 #define SR_PRIV __attribute__((visibility("hidden")))
134 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
136 /** Data types used by sr_config_info(). */
142 SR_T_RATIONAL_PERIOD,
149 /** Value for sr_datafeed_packet.type. */
151 SR_DF_HEADER = 10000,
161 /** Values for sr_datafeed_analog.mq. */
163 SR_MQ_VOLTAGE = 10000,
173 /** Electrical power, usually in W, or dBm. */
175 /** Gain (a transistor's gain, or hFE, for example). */
177 /** Logarithmic representation of sound pressure relative to a
178 * reference value. */
179 SR_MQ_SOUND_PRESSURE_LEVEL,
180 SR_MQ_CARBON_MONOXIDE,
181 SR_MQ_RELATIVE_HUMIDITY,
182 SR_MQ_TIME, /**< Time */
185 /** Values for sr_datafeed_analog.unit. */
187 SR_UNIT_VOLT = 10000,
198 /** Unit of conductance, the inverse of resistance. */
201 * An absolute measurement of power, in decibels, referenced to
205 /** Voltage in decibel, referenced to 1 volt (dBV). */
206 SR_UNIT_DECIBEL_VOLT,
208 * Measurements that intrinsically do not have units attached, such
209 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
210 * a unitless quantity, for example.
213 /** Sound pressure level relative so 20 micropascals. */
216 * Normalized (0 to 1) concentration of a substance or compound with 0
217 * representing a concentration of 0%, and 1 being 100%. This is
218 * represented as the fraction of number of particles of the substance.
220 SR_UNIT_CONCENTRATION,
221 SR_UNIT_REVOLUTIONS_PER_MINUTE,
227 /** Values for sr_datafeed_analog.flags. */
229 /** Voltage measurement is alternating current (AC). */
231 /** Voltage measurement is direct current (DC). */
233 /** This is a true RMS measurement. */
234 SR_MQFLAG_RMS = 0x04,
235 /** Value is voltage drop across a diode, or NAN. */
236 SR_MQFLAG_DIODE = 0x08,
237 /** Device is in "hold" mode (repeating the last measurement). */
238 SR_MQFLAG_HOLD = 0x10,
239 /** Device is in "max" mode, only updating upon a new max value. */
240 SR_MQFLAG_MAX = 0x20,
241 /** Device is in "min" mode, only updating upon a new min value. */
242 SR_MQFLAG_MIN = 0x40,
243 /** Device is in autoranging mode. */
244 SR_MQFLAG_AUTORANGE = 0x80,
245 /** Device is in relative mode. */
246 SR_MQFLAG_RELATIVE = 0x100,
247 /** Sound pressure level is A-weighted in the frequency domain,
248 * according to IEC 61672:2003. */
249 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
250 /** Sound pressure level is C-weighted in the frequency domain,
251 * according to IEC 61672:2003. */
252 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
253 /** Sound pressure level is Z-weighted (i.e. not at all) in the
254 * frequency domain, according to IEC 61672:2003. */
255 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
256 /** Sound pressure level is not weighted in the frequency domain,
257 * albeit without standards-defined low and high frequency limits. */
258 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
259 /** Sound pressure level measurement is S-weighted (1s) in the
261 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
262 /** Sound pressure level measurement is F-weighted (125ms) in the
264 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
265 /** Sound pressure level is time-averaged (LAT), also known as
266 * Equivalent Continuous A-weighted Sound Level (LEQ). */
267 SR_MQFLAG_SPL_LAT = 0x8000,
268 /** Sound pressure level represented as a percentage of measurements
269 * that were over a preset alarm level. */
270 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
271 /** Time is duration (as opposed to epoch, ...). */
272 SR_MQFLAG_DURATION = 0x20000,
277 struct sr_datafeed_packet {
282 struct sr_datafeed_header {
284 struct timeval starttime;
287 struct sr_datafeed_meta {
291 struct sr_datafeed_logic {
297 struct sr_datafeed_analog {
298 /** The probes for which data is included in this packet. */
301 /** Measured quantity (voltage, current, temperature, and so on). */
303 /** Unit in which the MQ is measured. */
305 /** Bitmap with extra information about the MQ. */
307 /** The analog value(s). The data is interleaved according to
308 * the probes list. */
312 /** Input (file) format struct. */
315 * A pointer to this input format's 'struct sr_input_format'.
316 * The frontend can use this to call the module's callbacks.
318 struct sr_input_format *format;
322 struct sr_dev_inst *sdi;
327 struct sr_input_format {
328 /** The unique ID for this input format. Must not be NULL. */
332 * A short description of the input format, which can (for example)
333 * be displayed to the user by frontends. Must not be NULL.
338 * Check if this input module can load and parse the specified file.
340 * @param filename The name (and path) of the file to check.
342 * @return TRUE if this module knows the format, FALSE if it doesn't.
344 int (*format_match) (const char *filename);
347 * Initialize the input module.
349 * @param in A pointer to a valid 'struct sr_input' that the caller
350 * has to allocate and provide to this function. It is also
351 * the responsibility of the caller to free it later.
352 * @param filename The name (and path) of the file to use.
354 * @return SR_OK upon success, a negative error code upon failure.
356 int (*init) (struct sr_input *in, const char *filename);
359 * Load a file, parsing the input according to the file's format.
361 * This function will send datafeed packets to the session bus, so
362 * the calling frontend must have registered its session callbacks
365 * The packet types sent across the session bus by this function must
366 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
367 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
370 * @param in A pointer to a valid 'struct sr_input' that the caller
371 * has to allocate and provide to this function. It is also
372 * the responsibility of the caller to free it later.
373 * @param filename The name (and path) of the file to use.
375 * @return SR_OK upon success, a negative error code upon failure.
377 int (*loadfile) (struct sr_input *in, const char *filename);
380 /** Output (file) format struct. */
383 * A pointer to this output format's 'struct sr_output_format'.
384 * The frontend can use this to call the module's callbacks.
386 struct sr_output_format *format;
389 * The device for which this output module is creating output. This
390 * can be used by the module to find out probe names and numbers.
392 struct sr_dev_inst *sdi;
395 * An optional parameter which the frontend can pass in to the
396 * output module. How the string is interpreted is entirely up to
402 * A generic pointer which can be used by the module to keep internal
403 * state between calls into its callback functions.
405 * For example, the module might store a pointer to a chunk of output
406 * there, and only flush it when it reaches a certain size.
411 struct sr_output_format {
413 * A unique ID for this output format. Must not be NULL.
415 * It can be used by frontends to select this output format for use.
417 * For example, calling sigrok-cli with <code>-O hex</code> will
418 * select the hexadecimal text output format.
423 * A short description of the output format. Must not be NULL.
425 * This can be displayed by frontends, e.g. when selecting the output
426 * format for saving a file.
433 * This function is called once, at the beginning of an output stream.
435 * The device struct will be available in the output struct passed in,
436 * as well as the param field -- which may be NULL or an empty string,
437 * if no parameter was passed.
439 * The module can use this to initialize itself, create a struct for
440 * keeping state and storing it in the <code>internal</code> field.
442 * @param o Pointer to the respective 'struct sr_output'.
444 * @return SR_OK upon success, a negative error code otherwise.
446 int (*init) (struct sr_output *o);
449 * Whenever a chunk of data comes in, it will be passed to the
450 * output module via this function. The <code>data_in</code> and
451 * <code>length_in</code> values refers to this data; the module
452 * must not alter or g_free() this buffer.
454 * The function must allocate a buffer for storing its output, and
455 * pass along a pointer to this buffer in the <code>data_out</code>
456 * parameter, as well as storing the length of the buffer in
457 * <code>length_out</code>. The calling frontend will g_free()
458 * this buffer when it's done with it.
460 * IMPORTANT: The memory allocation much happen using a glib memory
461 * allocation call (not a "normal" malloc) since g_free() will be
462 * used to free the memory!
464 * If there is no output, this function MUST store NULL in the
465 * <code>data_out</code> parameter, so the caller knows not to try
468 * Note: This API call is obsolete, use receive() instead.
470 * @param o Pointer to the respective 'struct sr_output'.
471 * @param data_in Pointer to the input data buffer.
472 * @param length_in Length of the input.
473 * @param data_out Pointer to the allocated output buffer.
474 * @param length_out Length (in bytes) of the output.
476 * @return SR_OK upon success, a negative error code otherwise.
478 int (*data) (struct sr_output *o, const uint8_t *data_in,
479 uint64_t length_in, uint8_t **data_out,
480 uint64_t *length_out);
483 * This function is called when an event occurs in the datafeed
484 * which the output module may need to be aware of. No data is
485 * passed in, only the fact that the event occurs. The following
486 * events can currently be passed in:
488 * - SR_DF_TRIGGER: At this point in the datafeed, the trigger
489 * matched. The output module may mark this in some way, e.g. by
490 * plotting a red line on a graph.
492 * - SR_DF_END: This marks the end of the datafeed. No more calls
493 * into the output module will be done, so this is a good time to
494 * free up any memory used to keep state, for example.
496 * Any output generated by this function must have a reference to
497 * it stored in the <code>data_out</code> and <code>length_out</code>
498 * parameters, or NULL if no output was generated.
500 * Note: This API call is obsolete, use receive() instead.
502 * @param o Pointer to the respective 'struct sr_output'.
503 * @param event_type Type of event that occured.
504 * @param data_out Pointer to the allocated output buffer.
505 * @param length_out Length (in bytes) of the output.
507 * @return SR_OK upon success, a negative error code otherwise.
509 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
510 uint64_t *length_out);
513 * This function is passed a copy of every packed in the data feed.
514 * Any output generated by the output module in response to the
515 * packet should be returned in a newly allocated GString
516 * <code>out</code>, which will be freed by the caller.
518 * Packets not of interest to the output module can just be ignored,
519 * and the <code>out</code> parameter set to NULL.
521 * @param o Pointer to the respective 'struct sr_output'.
522 * @param sdi The device instance that generated the packet.
523 * @param packet The complete packet.
524 * @param out A pointer where a GString * should be stored if
525 * the module generates output, or NULL if not.
527 * @return SR_OK upon success, a negative error code otherwise.
529 int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
530 const struct sr_datafeed_packet *packet, GString **out);
533 * This function is called after the caller is finished using
534 * the output module, and can be used to free any internal
535 * resources the module may keep.
537 * @return SR_OK upon success, a negative error code otherwise.
539 int (*cleanup) (struct sr_output *o);
543 SR_PROBE_LOGIC = 10000,
548 /* The index field will go: use g_slist_length(sdi->probes) instead. */
556 /** Structure for groups of probes that have common properties. */
557 struct sr_probe_group {
558 /** Name of the probe group. */
560 /** List of sr_probe structs of the probes belonging to this group. */
562 /** Private data for driver use. */
571 struct sr_config_info {
580 /*--- Device classes ------------------------------------------------*/
582 /** The device can act as logic analyzer. */
583 SR_CONF_LOGIC_ANALYZER = 10000,
585 /** The device can act as an oscilloscope. */
586 SR_CONF_OSCILLOSCOPE,
588 /** The device can act as a multimeter. */
591 /** The device is a demo device. */
594 /** The device can act as a sound level meter. */
595 SR_CONF_SOUNDLEVELMETER,
597 /** The device can measure temperature. */
600 /** The device can measure humidity. */
603 /** The device can measure energy consumption. */
606 /*--- Driver scan options -------------------------------------------*/
609 * Specification on how to connect to a device.
611 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
612 * the form which makes sense to the OS (e.g., /dev/ttyS0).
613 * Otherwise this specifies a USB device, either in the form of
614 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
615 * @verbatim <vendorid>.<productid> @endverbatim
616 * (hexadecimal, e.g. 1d6b.0001).
618 SR_CONF_CONN = 20000,
621 * Serial communication specification, in the form:
623 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
627 * The string may also be followed by one or more special settings,
628 * in the form "/key=value". Supported keys and their values are:
630 * rts 0,1 set the port's RTS pin to low or high
631 * dtr 0,1 set the port's DTR pin to low or high
632 * flow 0 no flow control
633 * 1 hardware-based (RTS/CTS) flow control
634 * 2 software-based (XON/XOFF) flow control
636 * This is always an optional parameter, since a driver typically
637 * knows the speed at which the device wants to communicate.
641 /*--- Device configuration ------------------------------------------*/
643 /** The device supports setting its samplerate, in Hz. */
644 SR_CONF_SAMPLERATE = 30000,
646 /** The device supports setting a pre/post-trigger capture ratio. */
647 SR_CONF_CAPTURE_RATIO,
649 /** The device supports setting a pattern (pattern generator mode). */
650 SR_CONF_PATTERN_MODE,
652 /** The device supports Run Length Encoding. */
655 /** The device supports setting trigger slope. */
656 SR_CONF_TRIGGER_SLOPE,
658 /** Trigger source. */
659 SR_CONF_TRIGGER_SOURCE,
661 /** Horizontal trigger position. */
662 SR_CONF_HORIZ_TRIGGERPOS,
679 /** Trigger types. */
680 SR_CONF_TRIGGER_TYPE,
682 /** The device supports setting its sample interval, in ms. */
683 SR_CONF_SAMPLE_INTERVAL,
685 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
686 SR_CONF_NUM_TIMEBASE,
688 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
691 /** Sound pressure level frequency weighting. */
692 SR_CONF_SPL_WEIGHT_FREQ,
694 /** Sound pressure level time weighting. */
695 SR_CONF_SPL_WEIGHT_TIME,
697 /** Sound pressure level measurement range. */
698 SR_CONF_SPL_MEASUREMENT_RANGE,
700 /** Max hold mode. */
703 /** Min hold mode. */
706 /** Logic low-high threshold range. */
707 SR_CONF_VOLTAGE_THRESHOLD,
709 /** The device supports using a external clock. */
710 SR_CONF_EXTERNAL_CLOCK,
713 * The device supports swapping channels. Typical this is between
714 * buffered and unbuffered channels.
718 /*--- Special stuff -------------------------------------------------*/
720 /** Scan options supported by the driver. */
721 SR_CONF_SCAN_OPTIONS = 40000,
723 /** Device options for a particular device. */
724 SR_CONF_DEVICE_OPTIONS,
726 /** Session filename. */
729 /** The device supports specifying a capturefile to inject. */
732 /** The device supports specifying the capturefile unit size. */
733 SR_CONF_CAPTURE_UNITSIZE,
735 /** The device supports setting the number of probes. */
736 SR_CONF_CAPTURE_NUM_PROBES,
738 /** Power off the device. */
741 /** Data source for acquisition. If not present, acquisition from
742 * the device is always "live", i.e. acquisition starts when the
743 * frontend asks and the results are sent out as soon as possible.
745 * If present, it indicates that either the device has no live
746 * acquisition capability (for example a pure data logger), or
747 * there is a choice. sr_config_list() returns those choices.
749 * In any case if a device has live acquisition capabilities, it
750 * is always the default. */
753 /*--- Acquisition modes ---------------------------------------------*/
756 * The device supports setting a sample time limit (how long
757 * the sample acquisition should run, in ms).
759 SR_CONF_LIMIT_MSEC = 50000,
762 * The device supports setting a sample number limit (how many
763 * samples should be acquired).
765 SR_CONF_LIMIT_SAMPLES,
768 * The device supports setting a frame limit (how many
769 * frames should be acquired).
771 SR_CONF_LIMIT_FRAMES,
774 * The device supports continuous sampling. Neither a time limit
775 * nor a sample number limit has to be supplied, it will just acquire
776 * samples continuously, until explicitly stopped by a certain command.
780 /** The device has internal storage, into which data is logged. This
781 * starts or stops the internal logging. */
786 struct sr_dev_driver *driver;
794 /* List of sr_probe_group structs */
795 GSList *probe_groups;
800 /** Types of device instances (sr_dev_inst). */
802 /** Device instance type for USB devices. */
804 /** Device instance type for serial port devices. */
806 /** Device instance type for SCPI devices. */
810 /** Device instance status. */
812 /** The device instance was not found. */
813 SR_ST_NOT_FOUND = 10000,
814 /** The device instance was found, but is still booting. */
816 /** The device instance is live, but not in use. */
818 /** The device instance is actively in use in a session. */
820 /** The device is winding down its session. */
824 struct sr_dev_driver {
825 /* Driver-specific */
829 int (*init) (struct sr_context *sr_ctx);
830 int (*cleanup) (void);
831 GSList *(*scan) (GSList *options);
832 GSList *(*dev_list) (void);
833 int (*dev_clear) (void);
834 int (*config_get) (int id, GVariant **data,
835 const struct sr_dev_inst *sdi,
836 const struct sr_probe_group *probe_group);
837 int (*config_set) (int id, GVariant *data,
838 const struct sr_dev_inst *sdi,
839 const struct sr_probe_group *probe_group);
840 int (*config_list) (int info_id, GVariant **data,
841 const struct sr_dev_inst *sdi,
842 const struct sr_probe_group *probe_group);
844 /* Device-specific */
845 int (*dev_open) (struct sr_dev_inst *sdi);
846 int (*dev_close) (struct sr_dev_inst *sdi);
847 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
849 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
857 * Opaque data structure representing a libsigrok session. None of the fields
858 * of this structure are meant to be accessed directly.