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. */
78 * Note: When adding entries here, don't forget to also update the
79 * sr_strerror() and sr_strerror_name() functions in error.c.
83 #define SR_MAX_PROBENAME_LEN 32
85 /* Handy little macros */
87 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
88 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
89 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
91 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
93 /** libsigrok loglevels. */
95 SR_LOG_NONE = 0, /**< Output no messages at all. */
96 SR_LOG_ERR = 1, /**< Output error messages. */
97 SR_LOG_WARN = 2, /**< Output warnings. */
98 SR_LOG_INFO = 3, /**< Output informational messages. */
99 SR_LOG_DBG = 4, /**< Output debug messages. */
100 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
104 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
106 * Variables and functions marked 'static' are private already and don't
107 * need SR_PRIV. However, functions which are not static (because they need
108 * to be used in other libsigrok-internal files) but are also not meant to
109 * be part of the public libsigrok API, must use SR_PRIV.
111 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
113 * This feature is not available on MinGW/Windows, as it is a feature of
114 * ELF files and MinGW/Windows uses PE files.
116 * Details: http://gcc.gnu.org/wiki/Visibility
119 /* Marks public libsigrok API symbols. */
121 #define SR_API __attribute__((visibility("default")))
126 /* Marks private, non-public libsigrok symbols (not part of the API). */
128 #define SR_PRIV __attribute__((visibility("hidden")))
133 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
135 /** Data types used by sr_config_info(). */
141 SR_T_RATIONAL_PERIOD,
148 /** Value for sr_datafeed_packet.type. */
150 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,
219 SR_UNIT_REVOLUTIONS_PER_MINUTE,
225 /** Values for sr_datafeed_analog.flags. */
227 /** Voltage measurement is alternating current (AC). */
229 /** Voltage measurement is direct current (DC). */
231 /** This is a true RMS measurement. */
232 SR_MQFLAG_RMS = 0x04,
233 /** Value is voltage drop across a diode, or NAN. */
234 SR_MQFLAG_DIODE = 0x08,
235 /** Device is in "hold" mode (repeating the last measurement). */
236 SR_MQFLAG_HOLD = 0x10,
237 /** Device is in "max" mode, only updating upon a new max value. */
238 SR_MQFLAG_MAX = 0x20,
239 /** Device is in "min" mode, only updating upon a new min value. */
240 SR_MQFLAG_MIN = 0x40,
241 /** Device is in autoranging mode. */
242 SR_MQFLAG_AUTORANGE = 0x80,
243 /** Device is in relative mode. */
244 SR_MQFLAG_RELATIVE = 0x100,
245 /** Sound pressure level is A-weighted in the frequency domain,
246 * according to IEC 61672:2003. */
247 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
248 /** Sound pressure level is C-weighted in the frequency domain,
249 * according to IEC 61672:2003. */
250 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
251 /** Sound pressure level is Z-weighted (i.e. not at all) in the
252 * frequency domain, according to IEC 61672:2003. */
253 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
254 /** Sound pressure level is not weighted in the frequency domain,
255 * albeit without standards-defined low and high frequency limits. */
256 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
257 /** Sound pressure level measurement is S-weighted (1s) in the
259 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
260 /** Sound pressure level measurement is F-weighted (125ms) in the
262 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
263 /** Sound pressure level is time-averaged (LAT), also known as
264 * Equivalent Continuous A-weighted Sound Level (LEQ). */
265 SR_MQFLAG_SPL_LAT = 0x8000,
266 /** Sound pressure level represented as a percentage of measurements
267 * that were over a preset alarm level. */
268 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
273 struct sr_datafeed_packet {
278 struct sr_datafeed_header {
280 struct timeval starttime;
283 struct sr_datafeed_meta {
287 struct sr_datafeed_logic {
293 struct sr_datafeed_analog {
294 /** The probes for which data is included in this packet. */
297 /** Measured quantity (voltage, current, temperature, and so on). */
299 /** Unit in which the MQ is measured. */
301 /** Bitmap with extra information about the MQ. */
303 /** The analog value(s). The data is interleaved according to
304 * the probes list. */
308 /** Input (file) format struct. */
311 * A pointer to this input format's 'struct sr_input_format'.
312 * The frontend can use this to call the module's callbacks.
314 struct sr_input_format *format;
318 struct sr_dev_inst *sdi;
323 struct sr_input_format {
324 /** The unique ID for this input format. Must not be NULL. */
328 * A short description of the input format, which can (for example)
329 * be displayed to the user by frontends. Must not be NULL.
334 * Check if this input module can load and parse the specified file.
336 * @param filename The name (and path) of the file to check.
338 * @return TRUE if this module knows the format, FALSE if it doesn't.
340 int (*format_match) (const char *filename);
343 * Initialize the input module.
345 * @param in A pointer to a valid 'struct sr_input' that the caller
346 * has to allocate and provide to this function. It is also
347 * the responsibility of the caller to free it later.
348 * @param filename The name (and path) of the file to use.
350 * @return SR_OK upon success, a negative error code upon failure.
352 int (*init) (struct sr_input *in, const char *filename);
355 * Load a file, parsing the input according to the file's format.
357 * This function will send datafeed packets to the session bus, so
358 * the calling frontend must have registered its session callbacks
361 * The packet types sent across the session bus by this function must
362 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
363 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
366 * @param in A pointer to a valid 'struct sr_input' that the caller
367 * has to allocate and provide to this function. It is also
368 * the responsibility of the caller to free it later.
369 * @param filename The name (and path) of the file to use.
371 * @return SR_OK upon success, a negative error code upon failure.
373 int (*loadfile) (struct sr_input *in, const char *filename);
376 /** Output (file) format struct. */
379 * A pointer to this output format's 'struct sr_output_format'.
380 * The frontend can use this to call the module's callbacks.
382 struct sr_output_format *format;
385 * The device for which this output module is creating output. This
386 * can be used by the module to find out probe names and numbers.
388 struct sr_dev_inst *sdi;
391 * An optional parameter which the frontend can pass in to the
392 * output module. How the string is interpreted is entirely up to
398 * A generic pointer which can be used by the module to keep internal
399 * state between calls into its callback functions.
401 * For example, the module might store a pointer to a chunk of output
402 * there, and only flush it when it reaches a certain size.
407 struct sr_output_format {
409 * A unique ID for this output format. Must not be NULL.
411 * It can be used by frontends to select this output format for use.
413 * For example, calling sigrok-cli with <code>-O hex</code> will
414 * select the hexadecimal text output format.
419 * A short description of the output format. Must not be NULL.
421 * This can be displayed by frontends, e.g. when selecting the output
422 * format for saving a file.
429 * This function is called once, at the beginning of an output stream.
431 * The device struct will be available in the output struct passed in,
432 * as well as the param field -- which may be NULL or an empty string,
433 * if no parameter was passed.
435 * The module can use this to initialize itself, create a struct for
436 * keeping state and storing it in the <code>internal</code> field.
438 * @param o Pointer to the respective 'struct sr_output'.
440 * @return SR_OK upon success, a negative error code otherwise.
442 int (*init) (struct sr_output *o);
445 * Whenever a chunk of data comes in, it will be passed to the
446 * output module via this function. The <code>data_in</code> and
447 * <code>length_in</code> values refers to this data; the module
448 * must not alter or g_free() this buffer.
450 * The function must allocate a buffer for storing its output, and
451 * pass along a pointer to this buffer in the <code>data_out</code>
452 * parameter, as well as storing the length of the buffer in
453 * <code>length_out</code>. The calling frontend will g_free()
454 * this buffer when it's done with it.
456 * IMPORTANT: The memory allocation much happen using a glib memory
457 * allocation call (not a "normal" malloc) since g_free() will be
458 * used to free the memory!
460 * If there is no output, this function MUST store NULL in the
461 * <code>data_out</code> parameter, so the caller knows not to try
464 * Note: This API call is obsolete, use receive() instead.
466 * @param o Pointer to the respective 'struct sr_output'.
467 * @param data_in Pointer to the input data buffer.
468 * @param length_in Length of the input.
469 * @param data_out Pointer to the allocated output buffer.
470 * @param length_out Length (in bytes) of the output.
472 * @return SR_OK upon success, a negative error code otherwise.
474 int (*data) (struct sr_output *o, const uint8_t *data_in,
475 uint64_t length_in, uint8_t **data_out,
476 uint64_t *length_out);
479 * This function is called when an event occurs in the datafeed
480 * which the output module may need to be aware of. No data is
481 * passed in, only the fact that the event occurs. The following
482 * events can currently be passed in:
484 * - SR_DF_TRIGGER: At this point in the datafeed, the trigger
485 * matched. The output module may mark this in some way, e.g. by
486 * plotting a red line on a graph.
488 * - SR_DF_END: This marks the end of the datafeed. No more calls
489 * into the output module will be done, so this is a good time to
490 * free up any memory used to keep state, for example.
492 * Any output generated by this function must have a reference to
493 * it stored in the <code>data_out</code> and <code>length_out</code>
494 * parameters, or NULL if no output was generated.
496 * Note: This API call is obsolete, use receive() instead.
498 * @param o Pointer to the respective 'struct sr_output'.
499 * @param event_type Type of event that occured.
500 * @param data_out Pointer to the allocated output buffer.
501 * @param length_out Length (in bytes) of the output.
503 * @return SR_OK upon success, a negative error code otherwise.
505 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
506 uint64_t *length_out);
509 * This function is passed a copy of every packed in the data feed.
510 * Any output generated by the output module in response to the
511 * packet should be returned in a newly allocated GString
512 * <code>out</code>, which will be freed by the caller.
514 * Packets not of interest to the output module can just be ignored,
515 * and the <code>out</code> parameter set to NULL.
517 * @param o Pointer to the respective 'struct sr_output'.
518 * @param sdi The device instance that generated the packet.
519 * @param packet The complete packet.
520 * @param out A pointer where a GString * should be stored if
521 * the module generates output, or NULL if not.
523 * @return SR_OK upon success, a negative error code otherwise.
525 int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
526 const struct sr_datafeed_packet *packet, GString **out);
529 * This function is called after the caller is finished using
530 * the output module, and can be used to free any internal
531 * resources the module may keep.
533 * @return SR_OK upon success, a negative error code otherwise.
535 int (*cleanup) (struct sr_output *o);
539 SR_PROBE_LOGIC = 10000,
544 /* The index field will go: use g_slist_length(sdi->probes) instead. */
552 struct sr_probe_group {
553 /* List of sr_probe structs. */
555 /* Private data for driver use. */
564 struct sr_config_info {
573 /*--- Device classes ------------------------------------------------*/
575 /** The device can act as logic analyzer. */
576 SR_CONF_LOGIC_ANALYZER = 10000,
578 /** The device can act as an oscilloscope. */
579 SR_CONF_OSCILLOSCOPE,
581 /** The device can act as a multimeter. */
584 /** The device is a demo device. */
587 /** The device can act as a sound level meter. */
588 SR_CONF_SOUNDLEVELMETER,
590 /** The device can measure temperature. */
593 /** The device can measure humidity. */
596 /** The device can measure energy consumption. */
599 /*--- Driver scan options -------------------------------------------*/
602 * Specification on how to connect to a device.
604 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
605 * the form which makes sense to the OS (e.g., /dev/ttyS0).
606 * Otherwise this specifies a USB device, either in the form of
607 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
608 * @verbatim <vendorid>.<productid> @endverbatim
609 * (hexadecimal, e.g. 1d6b.0001).
611 SR_CONF_CONN = 20000,
614 * Serial communication specification, in the form:
616 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
620 * The string may also be followed by one or more special settings,
621 * in the form "/key=value". Supported keys and their values are:
623 * rts 0,1 set the port's RTS pin to low or high
624 * dtr 0,1 set the port's DTR pin to low or high
625 * flow 0 no flow control
626 * 1 hardware-based (RTS/CTS) flow control
627 * 2 software-based (XON/XOFF) flow control
629 * This is always an optional parameter, since a driver typically
630 * knows the speed at which the device wants to communicate.
634 /*--- Device configuration ------------------------------------------*/
636 /** The device supports setting its samplerate, in Hz. */
637 SR_CONF_SAMPLERATE = 30000,
639 /** The device supports setting a pre/post-trigger capture ratio. */
640 SR_CONF_CAPTURE_RATIO,
642 /** The device supports setting a pattern (pattern generator mode). */
643 SR_CONF_PATTERN_MODE,
645 /** The device supports Run Length Encoding. */
648 /** The device supports setting trigger slope. */
649 SR_CONF_TRIGGER_SLOPE,
651 /** Trigger source. */
652 SR_CONF_TRIGGER_SOURCE,
654 /** Horizontal trigger position. */
655 SR_CONF_HORIZ_TRIGGERPOS,
672 /** Trigger types. */
673 SR_CONF_TRIGGER_TYPE,
675 /** The device supports setting its sample interval, in ms. */
676 SR_CONF_SAMPLE_INTERVAL,
678 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
679 SR_CONF_NUM_TIMEBASE,
681 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
684 /** Sound pressure level frequency weighting. */
685 SR_CONF_SPL_WEIGHT_FREQ,
687 /** Sound pressure level time weighting. */
688 SR_CONF_SPL_WEIGHT_TIME,
690 /** Sound pressure level measurement range. */
691 SR_CONF_SPL_MEASUREMENT_RANGE,
693 /** Max hold mode. */
696 /** Min hold mode. */
699 /** Logic low-high threshold range. */
700 SR_CONF_VOLTAGE_THRESHOLD,
702 /** The device supports using a external clock. */
703 SR_CONF_EXTERNAL_CLOCK,
706 * The device supports swapping channels. Typical this is between
707 * buffered and unbuffered channels.
711 /*--- Special stuff -------------------------------------------------*/
713 /** Scan options supported by the driver. */
714 SR_CONF_SCAN_OPTIONS = 40000,
716 /** Device options for a particular device. */
717 SR_CONF_DEVICE_OPTIONS,
719 /** Session filename. */
722 /** The device supports specifying a capturefile to inject. */
725 /** The device supports specifying the capturefile unit size. */
726 SR_CONF_CAPTURE_UNITSIZE,
728 /** The device supports setting the number of probes. */
729 SR_CONF_CAPTURE_NUM_PROBES,
731 /** Power off the device. */
734 /** Data source for acquisition. If not present, acquisition from
735 * the device is always "live", i.e. acquisition starts when the
736 * frontend asks and the results are sent out as soon as possible.
738 * If present, it indicates that either the device has no live
739 * acquisition capability (for example a pure data logger), or
740 * there is a choice. sr_config_list() returns those choices.
742 * In any case if a device has live acquisition capabilities, it
743 * is always the default. */
746 /*--- Acquisition modes ---------------------------------------------*/
749 * The device supports setting a sample time limit (how long
750 * the sample acquisition should run, in ms).
752 SR_CONF_LIMIT_MSEC = 50000,
755 * The device supports setting a sample number limit (how many
756 * samples should be acquired).
758 SR_CONF_LIMIT_SAMPLES,
761 * The device supports setting a frame limit (how many
762 * frames should be acquired).
764 SR_CONF_LIMIT_FRAMES,
767 * The device supports continuous sampling. Neither a time limit
768 * nor a sample number limit has to be supplied, it will just acquire
769 * samples continuously, until explicitly stopped by a certain command.
773 /** The device has internal storage, into which data is logged. This
774 * starts or stops the internal logging. */
779 struct sr_dev_driver *driver;
787 /* List of sr_probe_group structs */
788 GSList *probe_groups;
793 /** Types of device instances (sr_dev_inst). */
795 /** Device instance type for USB devices. */
797 /** Device instance type for serial port devices. */
801 /** Device instance status. */
803 /** The device instance was not found. */
804 SR_ST_NOT_FOUND = 10000,
805 /** The device instance was found, but is still booting. */
807 /** The device instance is live, but not in use. */
809 /** The device instance is actively in use in a session. */
811 /** The device is winding down its session. */
815 struct sr_dev_driver {
816 /* Driver-specific */
820 int (*init) (struct sr_context *sr_ctx);
821 int (*cleanup) (void);
822 GSList *(*scan) (GSList *options);
823 GSList *(*dev_list) (void);
824 int (*dev_clear) (void);
825 int (*config_get) (int id, GVariant **data,
826 const struct sr_dev_inst *sdi,
827 const struct sr_probe_group *probe_group);
828 int (*config_set) (int id, GVariant *data,
829 const struct sr_dev_inst *sdi,
830 const struct sr_probe_group *probe_group);
831 int (*config_list) (int info_id, GVariant **data,
832 const struct sr_dev_inst *sdi,
833 const struct sr_probe_group *probe_group);
835 /* Device-specific */
836 int (*dev_open) (struct sr_dev_inst *sdi);
837 int (*dev_close) (struct sr_dev_inst *sdi);
838 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
840 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
848 /** List of struct sr_dev pointers. */
850 /** List of struct datafeed_callback pointers. */
851 GSList *datafeed_callbacks;
855 unsigned int num_sources;
858 * Both "sources" and "pollfds" are of the same size and contain pairs
859 * of descriptor and callback function. We can not embed the GPollFD
860 * into the source struct since we want to be able to pass the array
861 * of all poll descriptors to g_poll().
863 struct source *sources;
868 * These are our synchronization primitives for stopping the session in
869 * an async fashion. We need to make sure the session is stopped from
870 * within the session thread itself.
873 gboolean abort_session;