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. */
77 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
78 #define SR_MAX_PROBENAME_LEN 32
80 /* Handy little macros */
82 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
83 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
84 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
86 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
88 /** libsigrok loglevels. */
90 SR_LOG_NONE = 0, /**< Output no messages at all. */
91 SR_LOG_ERR = 1, /**< Output error messages. */
92 SR_LOG_WARN = 2, /**< Output warnings. */
93 SR_LOG_INFO = 3, /**< Output informational messages. */
94 SR_LOG_DBG = 4, /**< Output debug messages. */
95 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
99 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
101 * Variables and functions marked 'static' are private already and don't
102 * need SR_PRIV. However, functions which are not static (because they need
103 * to be used in other libsigrok-internal files) but are also not meant to
104 * be part of the public libsigrok API, must use SR_PRIV.
106 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
108 * This feature is not available on MinGW/Windows, as it is a feature of
109 * ELF files and MinGW/Windows uses PE files.
111 * Details: http://gcc.gnu.org/wiki/Visibility
114 /* Marks public libsigrok API symbols. */
116 #define SR_API __attribute__((visibility("default")))
121 /* Marks private, non-public libsigrok symbols (not part of the API). */
123 #define SR_PRIV __attribute__((visibility("hidden")))
128 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
130 /** Data types used by sr_config_info(). */
136 SR_T_RATIONAL_PERIOD,
141 /** Value for sr_datafeed_packet.type. */
143 SR_DF_HEADER = 10000,
153 /** Values for sr_datafeed_analog.mq. */
155 SR_MQ_VOLTAGE = 10000,
165 /** Electrical power, usually in W, or dBm. */
167 /** Gain (a transistor's gain, or hFE, for example). */
169 /** Logarithmic representation of sound pressure relative to a
170 * reference value. */
171 SR_MQ_SOUND_PRESSURE_LEVEL,
172 SR_MQ_CARBON_MONOXIDE,
173 SR_MQ_RELATIVE_HUMIDITY,
176 /** Values for sr_datafeed_analog.unit. */
178 SR_UNIT_VOLT = 10000,
189 /** Unit of conductance, the inverse of resistance. */
192 * An absolute measurement of power, in decibels, referenced to
196 /** Voltage in decibel, referenced to 1 volt (dBV). */
197 SR_UNIT_DECIBEL_VOLT,
199 * Measurements that intrinsically do not have units attached, such
200 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
201 * a unitless quantity, for example.
204 /** Sound pressure level relative so 20 micropascals. */
207 * Normalized (0 to 1) concentration of a substance or compound with 0
208 * representing a concentration of 0%, and 1 being 100%. This is
209 * represented as the fraction of number of particles of the substance.
211 SR_UNIT_CONCENTRATION,
214 /** Values for sr_datafeed_analog.flags. */
216 /** Voltage measurement is alternating current (AC). */
218 /** Voltage measurement is direct current (DC). */
220 /** This is a true RMS measurement. */
221 SR_MQFLAG_RMS = 0x04,
222 /** Value is voltage drop across a diode, or NAN. */
223 SR_MQFLAG_DIODE = 0x08,
224 /** Device is in "hold" mode (repeating the last measurement). */
225 SR_MQFLAG_HOLD = 0x10,
226 /** Device is in "max" mode, only updating upon a new max value. */
227 SR_MQFLAG_MAX = 0x20,
228 /** Device is in "min" mode, only updating upon a new min value. */
229 SR_MQFLAG_MIN = 0x40,
230 /** Device is in autoranging mode. */
231 SR_MQFLAG_AUTORANGE = 0x80,
232 /** Device is in relative mode. */
233 SR_MQFLAG_RELATIVE = 0x100,
234 /** Sound pressure level is A-weighted in the frequency domain,
235 * according to IEC 61672:2003. */
236 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
237 /** Sound pressure level is C-weighted in the frequency domain,
238 * according to IEC 61672:2003. */
239 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
240 /** Sound pressure level is Z-weighted (i.e. not at all) in the
241 * frequency domain, according to IEC 61672:2003. */
242 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
243 /** Sound pressure level is not weighted in the frequency domain,
244 * albeit without standards-defined low and high frequency limits. */
245 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
246 /** Sound pressure level measurement is S-weighted (1s) in the
248 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
249 /** Sound pressure level measurement is F-weighted (125ms) in the
251 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
252 /** Sound pressure level is time-averaged (LAT), also known as
253 * Equivalent Continuous A-weighted Sound Level (LEQ). */
254 SR_MQFLAG_SPL_LAT = 0x8000,
255 /** Sound pressure level represented as a percentage of measurements
256 * that were over a preset alarm level. */
257 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
262 struct sr_datafeed_packet {
267 struct sr_datafeed_header {
269 struct timeval starttime;
272 struct sr_datafeed_meta {
276 struct sr_datafeed_logic {
282 struct sr_datafeed_analog {
283 /** The probes for which data is included in this packet. */
286 /** Measured quantity (voltage, current, temperature, and so on). */
288 /** Unit in which the MQ is measured. */
290 /** Bitmap with extra information about the MQ. */
292 /** The analog value(s). The data is interleaved according to
293 * the probes list. */
297 /** Input (file) format struct. */
300 * A pointer to this input format's 'struct sr_input_format'.
301 * The frontend can use this to call the module's callbacks.
303 struct sr_input_format *format;
307 struct sr_dev_inst *sdi;
312 struct sr_input_format {
313 /** The unique ID for this input format. Must not be NULL. */
317 * A short description of the input format, which can (for example)
318 * be displayed to the user by frontends. Must not be NULL.
323 * Check if this input module can load and parse the specified file.
325 * @param filename The name (and path) of the file to check.
327 * @return TRUE if this module knows the format, FALSE if it doesn't.
329 int (*format_match) (const char *filename);
332 * Initialize the input module.
334 * @param in A pointer to a valid 'struct sr_input' that the caller
335 * has to allocate and provide to this function. It is also
336 * the responsibility of the caller to free it later.
337 * @param filename The name (and path) of the file to use.
339 * @return SR_OK upon success, a negative error code upon failure.
341 int (*init) (struct sr_input *in, const char *filename);
344 * Load a file, parsing the input according to the file's format.
346 * This function will send datafeed packets to the session bus, so
347 * the calling frontend must have registered its session callbacks
350 * The packet types sent across the session bus by this function must
351 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
352 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
355 * @param in A pointer to a valid 'struct sr_input' that the caller
356 * has to allocate and provide to this function. It is also
357 * the responsibility of the caller to free it later.
358 * @param filename The name (and path) of the file to use.
360 * @return SR_OK upon success, a negative error code upon failure.
362 int (*loadfile) (struct sr_input *in, const char *filename);
365 /** Output (file) format struct. */
368 * A pointer to this output format's 'struct sr_output_format'.
369 * The frontend can use this to call the module's callbacks.
371 struct sr_output_format *format;
374 * The device for which this output module is creating output. This
375 * can be used by the module to find out probe names and numbers.
377 struct sr_dev_inst *sdi;
380 * An optional parameter which the frontend can pass in to the
381 * output module. How the string is interpreted is entirely up to
387 * A generic pointer which can be used by the module to keep internal
388 * state between calls into its callback functions.
390 * For example, the module might store a pointer to a chunk of output
391 * there, and only flush it when it reaches a certain size.
396 struct sr_output_format {
398 * A unique ID for this output format. Must not be NULL.
400 * It can be used by frontends to select this output format for use.
402 * For example, calling sigrok-cli with <code>-O hex</code> will
403 * select the hexadecimal text output format.
408 * A short description of the output format. Must not be NULL.
410 * This can be displayed by frontends, e.g. when selecting the output
411 * format for saving a file.
418 * This function is called once, at the beginning of an output stream.
420 * The device struct will be available in the output struct passed in,
421 * as well as the param field -- which may be NULL or an empty string,
422 * if no parameter was passed.
424 * The module can use this to initialize itself, create a struct for
425 * keeping state and storing it in the <code>internal</code> field.
427 * @param o Pointer to the respective 'struct sr_output'.
429 * @return SR_OK upon success, a negative error code otherwise.
431 int (*init) (struct sr_output *o);
434 * Whenever a chunk of data comes in, it will be passed to the
435 * output module via this function. The <code>data_in</code> and
436 * <code>length_in</code> values refers to this data; the module
437 * must not alter or g_free() this buffer.
439 * The function must allocate a buffer for storing its output, and
440 * pass along a pointer to this buffer in the <code>data_out</code>
441 * parameter, as well as storing the length of the buffer in
442 * <code>length_out</code>. The calling frontend will g_free()
443 * this buffer when it's done with it.
445 * IMPORTANT: The memory allocation much happen using a glib memory
446 * allocation call (not a "normal" malloc) since g_free() will be
447 * used to free the memory!
449 * If there is no output, this function MUST store NULL in the
450 * <code>data_out</code> parameter, so the caller knows not to try
453 * Note: This API call is obsolete, use recv() instead.
455 * @param o Pointer to the respective 'struct sr_output'.
456 * @param data_in Pointer to the input data buffer.
457 * @param length_in Length of the input.
458 * @param data_out Pointer to the allocated output buffer.
459 * @param length_out Length (in bytes) of the output.
461 * @return SR_OK upon success, a negative error code otherwise.
463 int (*data) (struct sr_output *o, const uint8_t *data_in,
464 uint64_t length_in, uint8_t **data_out,
465 uint64_t *length_out);
468 * This function is called when an event occurs in the datafeed
469 * which the output module may need to be aware of. No data is
470 * passed in, only the fact that the event occurs. The following
471 * events can currently be passed in:
473 * - SR_DF_TRIGGER: At this point in the datafeed, the trigger
474 * matched. The output module may mark this in some way, e.g. by
475 * plotting a red line on a graph.
477 * - SR_DF_END: This marks the end of the datafeed. No more calls
478 * into the output module will be done, so this is a good time to
479 * free up any memory used to keep state, for example.
481 * Any output generated by this function must have a reference to
482 * it stored in the <code>data_out</code> and <code>length_out</code>
483 * parameters, or NULL if no output was generated.
485 * Note: This API call is obsolete, use recv() instead.
487 * @param o Pointer to the respective 'struct sr_output'.
488 * @param event_type Type of event that occured.
489 * @param data_out Pointer to the allocated output buffer.
490 * @param length_out Length (in bytes) of the output.
492 * @return SR_OK upon success, a negative error code otherwise.
494 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
495 uint64_t *length_out);
497 GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
498 const struct sr_datafeed_packet *packet);
500 int (*cleanup) (struct sr_output *o);
504 SR_PROBE_LOGIC = 10000,
509 /* The index field will go: use g_slist_length(sdi->probes) instead. */
522 struct sr_config_info {
531 /*--- Device classes ------------------------------------------------*/
533 /** The device can act as logic analyzer. */
534 SR_CONF_LOGIC_ANALYZER = 10000,
536 /** The device can act as an oscilloscope. */
537 SR_CONF_OSCILLOSCOPE,
539 /** The device can act as a multimeter. */
542 /** The device is a demo device. */
545 /** The device can act as a sound level meter. */
546 SR_CONF_SOUNDLEVELMETER,
548 /** The device can measure temperature. */
551 /** The device can measure humidity. */
554 /*--- Driver scan options -------------------------------------------*/
557 * Specification on how to connect to a device.
559 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
560 * the form which makes sense to the OS (e.g., /dev/ttyS0).
561 * Otherwise this specifies a USB device, either in the form of
562 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
563 * @verbatim <vendorid>.<productid> @endverbatim
564 * (hexadecimal, e.g. 1d6b.0001).
566 SR_CONF_CONN = 20000,
569 * Serial communication specification, in the form:
571 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
575 * The string may also be followed by one or more special settings,
576 * in the form "/key=value". Supported keys and their values are:
578 * rts 0,1 set the port's RTS pin to low or high
579 * dtr 0,1 set the port's DTR pin to low or high
580 * flow 0 no flow control
581 * 1 hardware-based (RTS/CTS) flow control
582 * 2 software-based (XON/XOFF) flow control
584 * This is always an optional parameter, since a driver typically
585 * knows the speed at which the device wants to communicate.
589 /*--- Device configuration ------------------------------------------*/
591 /** The device supports setting its samplerate, in Hz. */
592 SR_CONF_SAMPLERATE = 30000,
594 /** The device supports setting a pre/post-trigger capture ratio. */
595 SR_CONF_CAPTURE_RATIO,
597 /** The device supports setting a pattern (pattern generator mode). */
598 SR_CONF_PATTERN_MODE,
600 /** The device supports Run Length Encoding. */
603 /** The device supports setting trigger slope. */
604 SR_CONF_TRIGGER_SLOPE,
606 /** Trigger source. */
607 SR_CONF_TRIGGER_SOURCE,
609 /** Horizontal trigger position. */
610 SR_CONF_HORIZ_TRIGGERPOS,
627 /** Trigger types. */
628 SR_CONF_TRIGGER_TYPE,
630 /** The device supports setting its sample interval, in ms. */
631 SR_CONF_SAMPLE_INTERVAL,
633 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
634 SR_CONF_NUM_TIMEBASE,
636 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
639 /*--- Special stuff -------------------------------------------------*/
641 /** Scan options supported by the driver. */
642 SR_CONF_SCAN_OPTIONS = 40000,
644 /** Device options for a particular device. */
645 SR_CONF_DEVICE_OPTIONS,
647 /** Session filename. */
650 /** The device supports specifying a capturefile to inject. */
653 /** The device supports specifying the capturefile unit size. */
654 SR_CONF_CAPTURE_UNITSIZE,
656 /** The device supports setting the number of probes. */
657 SR_CONF_CAPTURE_NUM_PROBES,
659 /*--- Acquisition modes ---------------------------------------------*/
662 * The device supports setting a sample time limit (how long
663 * the sample acquisition should run, in ms).
665 SR_CONF_LIMIT_MSEC = 50000,
668 * The device supports setting a sample number limit (how many
669 * samples should be acquired).
671 SR_CONF_LIMIT_SAMPLES,
674 * The device supports setting a frame limit (how many
675 * frames should be acquired).
677 SR_CONF_LIMIT_FRAMES,
680 * The device supports continuous sampling. Neither a time limit
681 * nor a sample number limit has to be supplied, it will just acquire
682 * samples continuously, until explicitly stopped by a certain command.
686 /** The device has internal storage, into which data is logged. This
687 * starts or stops the internal logging. */
692 struct sr_dev_driver *driver;
704 /** Types of device instances (sr_dev_inst). */
706 /** Device instance type for USB devices. */
708 /** Device instance type for serial port devices. */
712 /** Device instance status. */
714 /** The device instance was not found. */
715 SR_ST_NOT_FOUND = 10000,
716 /** The device instance was found, but is still booting. */
718 /** The device instance is live, but not in use. */
720 /** The device instance is actively in use in a session. */
722 /** The device is winding down its session. */
726 struct sr_dev_driver {
727 /* Driver-specific */
731 int (*init) (struct sr_context *sr_ctx);
732 int (*cleanup) (void);
733 GSList *(*scan) (GSList *options);
734 GSList *(*dev_list) (void);
735 int (*dev_clear) (void);
736 int (*config_get) (int id, GVariant **data,
737 const struct sr_dev_inst *sdi);
738 int (*config_set) (int id, GVariant *data,
739 const struct sr_dev_inst *sdi);
740 int (*config_list) (int info_id, GVariant **data,
741 const struct sr_dev_inst *sdi);
743 /* Device-specific */
744 int (*dev_open) (struct sr_dev_inst *sdi);
745 int (*dev_close) (struct sr_dev_inst *sdi);
746 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
748 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
756 /** List of struct sr_dev pointers. */
758 /** List of struct datafeed_callback pointers. */
759 GSList *datafeed_callbacks;
762 unsigned int num_sources;
765 * Both "sources" and "pollfds" are of the same size and contain pairs
766 * of descriptor and callback function. We can not embed the GPollFD
767 * into the source struct since we want to be able to pass the array
768 * of all poll descriptors to g_poll().
770 struct source *sources;
775 * These are our synchronization primitives for stopping the session in
776 * an async fashion. We need to make sure the session is stopped from
777 * within the session thread itself.
780 gboolean abort_session;