libsigrok  0.2.2
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs Enumerator Macros Groups Pages
libsigrok.h
Go to the documentation of this file.
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19 
20 #ifndef LIBSIGROK_SIGROK_H
21 #define LIBSIGROK_SIGROK_H
22 
23 #include <stdio.h>
24 #include <sys/time.h>
25 #include <stdint.h>
26 #include <inttypes.h>
27 #include <glib.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /**
34  * @file
35  *
36  * The public libsigrok header file to be used by frontends.
37  *
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.
41  *
42  * The correct way to get/use the libsigrok API functions is:
43  *
44  * @code{.c}
45  * #include <libsigrok/libsigrok.h>
46  * @endcode
47  */
48 
49 /*
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.
53  *
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
58  * same return code.
59  *
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.
63  */
64 
65 /** Status/error codes returned by libsigrok functions. */
66 enum {
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 
77  /*
78  * Note: When adding entries here, don't forget to also update the
79  * sr_strerror() and sr_strerror_name() functions in error.c.
80  */
81 };
82 
83 #define SR_MAX_PROBENAME_LEN 32
84 
85 /* Handy little macros */
86 #define SR_HZ(n) (n)
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))
90 
91 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
92 
93 /** libsigrok loglevels. */
94 enum {
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. */
101 };
102 
103 /*
104  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
105  *
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.
110  *
111  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
112  *
113  * This feature is not available on MinGW/Windows, as it is a feature of
114  * ELF files and MinGW/Windows uses PE files.
115  *
116  * Details: http://gcc.gnu.org/wiki/Visibility
117  */
118 
119 /* Marks public libsigrok API symbols. */
120 #ifndef _WIN32
121 #define SR_API __attribute__((visibility("default")))
122 #else
123 #define SR_API
124 #endif
125 
126 /* Marks private, non-public libsigrok symbols (not part of the API). */
127 #ifndef _WIN32
128 #define SR_PRIV __attribute__((visibility("hidden")))
129 #else
130 #define SR_PRIV
131 #endif
132 
133 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
134 
135 /** Data types used by sr_config_info(). */
136 enum {
137  SR_T_UINT64 = 10000,
146 };
147 
148 /** Value for sr_datafeed_packet.type. */
149 enum {
150  SR_DF_HEADER = 10000,
158 };
159 
160 /** Values for sr_datafeed_analog.mq. */
161 enum {
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. */
181 };
182 
183 /** Values for sr_datafeed_analog.unit. */
184 enum {
185  SR_UNIT_VOLT = 10000,
196  /** Unit of conductance, the inverse of resistance. */
198  /**
199  * An absolute measurement of power, in decibels, referenced to
200  * 1 milliwatt (dBu).
201  */
203  /** Voltage in decibel, referenced to 1 volt (dBV). */
205  /**
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.
209  */
211  /** Sound pressure level relative so 20 micropascals. */
213  /**
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.
217  */
223 };
224 
225 /** Values for sr_datafeed_analog.flags. */
226 enum {
227  /** Voltage measurement is alternating current (AC). */
228  SR_MQFLAG_AC = 0x01,
229  /** Voltage measurement is direct current (DC). */
230  SR_MQFLAG_DC = 0x02,
231  /** This is a true RMS measurement. */
233  /** Value is voltage drop across a diode, or NAN. */
235  /** Device is in "hold" mode (repeating the last measurement). */
237  /** Device is in "max" mode, only updating upon a new max value. */
239  /** Device is in "min" mode, only updating upon a new min value. */
241  /** Device is in autoranging mode. */
243  /** Device is in relative mode. */
245  /** Sound pressure level is A-weighted in the frequency domain,
246  * according to IEC 61672:2003. */
248  /** Sound pressure level is C-weighted in the frequency domain,
249  * according to IEC 61672:2003. */
251  /** Sound pressure level is Z-weighted (i.e. not at all) in the
252  * frequency domain, according to IEC 61672:2003. */
254  /** Sound pressure level is not weighted in the frequency domain,
255  * albeit without standards-defined low and high frequency limits. */
257  /** Sound pressure level measurement is S-weighted (1s) in the
258  * time domain. */
260  /** Sound pressure level measurement is F-weighted (125ms) in the
261  * time domain. */
263  /** Sound pressure level is time-averaged (LAT), also known as
264  * Equivalent Continuous A-weighted Sound Level (LEQ). */
266  /** Sound pressure level represented as a percentage of measurements
267  * that were over a preset alarm level. */
269 };
270 
271 struct sr_context;
272 
274  uint16_t type;
275  const void *payload;
276 };
277 
280  struct timeval starttime;
281 };
282 
284  GSList *config;
285 };
286 
288  uint64_t length;
289  uint16_t unitsize;
290  void *data;
291 };
292 
294  /** The probes for which data is included in this packet. */
295  GSList *probes;
297  /** Measured quantity (voltage, current, temperature, and so on). */
298  int mq;
299  /** Unit in which the MQ is measured. */
300  int unit;
301  /** Bitmap with extra information about the MQ. */
302  uint64_t mqflags;
303  /** The analog value(s). The data is interleaved according to
304  * the probes list. */
305  float *data;
306 };
307 
308 /** Input (file) format struct. */
309 struct sr_input {
310  /**
311  * A pointer to this input format's 'struct sr_input_format'.
312  * The frontend can use this to call the module's callbacks.
313  */
315 
316  GHashTable *param;
317 
318  struct sr_dev_inst *sdi;
319 
320  void *internal;
321 };
322 
324  /** The unique ID for this input format. Must not be NULL. */
325  char *id;
326 
327  /**
328  * A short description of the input format, which can (for example)
329  * be displayed to the user by frontends. Must not be NULL.
330  */
331  char *description;
332 
333  /**
334  * Check if this input module can load and parse the specified file.
335  *
336  * @param filename The name (and path) of the file to check.
337  *
338  * @return TRUE if this module knows the format, FALSE if it doesn't.
339  */
340  int (*format_match) (const char *filename);
341 
342  /**
343  * Initialize the input module.
344  *
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.
349  *
350  * @return SR_OK upon success, a negative error code upon failure.
351  */
352  int (*init) (struct sr_input *in, const char *filename);
353 
354  /**
355  * Load a file, parsing the input according to the file's format.
356  *
357  * This function will send datafeed packets to the session bus, so
358  * the calling frontend must have registered its session callbacks
359  * beforehand.
360  *
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
364  * if appropriate.
365  *
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.
370  *
371  * @return SR_OK upon success, a negative error code upon failure.
372  */
373  int (*loadfile) (struct sr_input *in, const char *filename);
374 };
375 
376 /** Output (file) format struct. */
377 struct sr_output {
378  /**
379  * A pointer to this output format's 'struct sr_output_format'.
380  * The frontend can use this to call the module's callbacks.
381  */
383 
384  /**
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.
387  */
388  struct sr_dev_inst *sdi;
389 
390  /**
391  * An optional parameter which the frontend can pass in to the
392  * output module. How the string is interpreted is entirely up to
393  * the module.
394  */
395  char *param;
396 
397  /**
398  * A generic pointer which can be used by the module to keep internal
399  * state between calls into its callback functions.
400  *
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.
403  */
404  void *internal;
405 };
406 
408  /**
409  * A unique ID for this output format. Must not be NULL.
410  *
411  * It can be used by frontends to select this output format for use.
412  *
413  * For example, calling sigrok-cli with <code>-O hex</code> will
414  * select the hexadecimal text output format.
415  */
416  char *id;
417 
418  /**
419  * A short description of the output format. Must not be NULL.
420  *
421  * This can be displayed by frontends, e.g. when selecting the output
422  * format for saving a file.
423  */
424  char *description;
425 
426  int df_type;
427 
428  /**
429  * This function is called once, at the beginning of an output stream.
430  *
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.
434  *
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.
437  *
438  * @param o Pointer to the respective 'struct sr_output'.
439  *
440  * @return SR_OK upon success, a negative error code otherwise.
441  */
442  int (*init) (struct sr_output *o);
443 
444  /**
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.
449  *
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.
455  *
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!
459  *
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
462  * and g_free() it.
463  *
464  * Note: This API call is obsolete, use receive() instead.
465  *
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.
471  *
472  * @return SR_OK upon success, a negative error code otherwise.
473  */
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);
477 
478  /**
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:
483  *
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.
487  *
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.
491  *
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.
495  *
496  * Note: This API call is obsolete, use receive() instead.
497  *
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.
502  *
503  * @return SR_OK upon success, a negative error code otherwise.
504  */
505  int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
506  uint64_t *length_out);
507 
508  /**
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.
513  *
514  * Packets not of interest to the output module can just be ignored,
515  * and the <code>out</code> parameter set to NULL.
516  *
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.
522  *
523  * @return SR_OK upon success, a negative error code otherwise.
524  */
525  int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
526  const struct sr_datafeed_packet *packet, GString **out);
527 
528  /**
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.
532  *
533  * @return SR_OK upon success, a negative error code otherwise.
534  */
535  int (*cleanup) (struct sr_output *o);
536 };
537 
538 enum {
539  SR_PROBE_LOGIC = 10000,
541 };
542 
543 struct sr_probe {
544  /* The index field will go: use g_slist_length(sdi->probes) instead. */
545  int index;
546  int type;
547  gboolean enabled;
548  char *name;
549  char *trigger;
550 };
551 
552 struct sr_config {
553  int key;
554  GVariant *data;
555 };
556 
558  int key;
559  int datatype;
560  char *id;
561  char *name;
562  char *description;
563 };
564 
565 enum {
566  /*--- Device classes ------------------------------------------------*/
567 
568  /** The device can act as logic analyzer. */
570 
571  /** The device can act as an oscilloscope. */
573 
574  /** The device can act as a multimeter. */
576 
577  /** The device is a demo device. */
579 
580  /** The device can act as a sound level meter. */
582 
583  /** The device can measure temperature. */
585 
586  /** The device can measure humidity. */
588 
589  /** The device can measure energy consumption. */
591 
592  /*--- Driver scan options -------------------------------------------*/
593 
594  /**
595  * Specification on how to connect to a device.
596  *
597  * In combination with SR_CONF_SERIALCOMM, this is a serial port in
598  * the form which makes sense to the OS (e.g., /dev/ttyS0).
599  * Otherwise this specifies a USB device, either in the form of
600  * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
601  * @verbatim <vendorid>.<productid> @endverbatim
602  * (hexadecimal, e.g. 1d6b.0001).
603  */
604  SR_CONF_CONN = 20000,
605 
606  /**
607  * Serial communication specification, in the form:
608  *
609  * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
610  *
611  * Example: 9600/8n1
612  *
613  * The string may also be followed by one or more special settings,
614  * in the form "/key=value". Supported keys and their values are:
615  *
616  * rts 0,1 set the port's RTS pin to low or high
617  * dtr 0,1 set the port's DTR pin to low or high
618  * flow 0 no flow control
619  * 1 hardware-based (RTS/CTS) flow control
620  * 2 software-based (XON/XOFF) flow control
621  *
622  * This is always an optional parameter, since a driver typically
623  * knows the speed at which the device wants to communicate.
624  */
626 
627  /*--- Device configuration ------------------------------------------*/
628 
629  /** The device supports setting its samplerate, in Hz. */
631 
632  /** The device supports setting a pre/post-trigger capture ratio. */
634 
635  /** The device supports setting a pattern (pattern generator mode). */
637 
638  /** The device supports Run Length Encoding. */
640 
641  /** The device supports setting trigger slope. */
643 
644  /** Trigger source. */
646 
647  /** Horizontal trigger position. */
649 
650  /** Buffer size. */
652 
653  /** Time base. */
655 
656  /** Filter. */
658 
659  /** Volts/div. */
661 
662  /** Coupling. */
664 
665  /** Trigger types. */
667 
668  /** The device supports setting its sample interval, in ms. */
670 
671  /** Number of timebases, as related to SR_CONF_TIMEBASE. */
673 
674  /** Number of vertical divisions, as related to SR_CONF_VDIV. */
676 
677  /** Sound pressure level frequency weighting. */
679 
680  /** Sound pressure level time weighting. */
682 
683  /** Sound pressure level measurement range. */
685 
686  /** Max hold mode. */
688 
689  /** Min hold mode. */
691 
692  /** Logic low-high threshold range. */
694 
695  /** The device supports using a external clock. */
697 
698  /**
699  * The device supports swapping channels. Typical this is between
700  * buffered and unbuffered channels.
701  */
703 
704  /*--- Special stuff -------------------------------------------------*/
705 
706  /** Scan options supported by the driver. */
708 
709  /** Device options for a particular device. */
711 
712  /** Session filename. */
714 
715  /** The device supports specifying a capturefile to inject. */
717 
718  /** The device supports specifying the capturefile unit size. */
720 
721  /** The device supports setting the number of probes. */
723 
724  /** Power off the device. */
726 
727  /** Data source for acquisition. If not present, acquisition from
728  * the device is always "live", i.e. acquisition starts when the
729  * frontend asks and the results are sent out as soon as possible.
730  *
731  * If present, it indicates that either the device has no live
732  * acquisition capability (for example a pure data logger), or
733  * there is a choice. sr_config_list() returns those choices.
734  *
735  * In any case if a device has live acquisition capabilities, it
736  * is always the default. */
738 
739  /*--- Acquisition modes ---------------------------------------------*/
740 
741  /**
742  * The device supports setting a sample time limit (how long
743  * the sample acquisition should run, in ms).
744  */
746 
747  /**
748  * The device supports setting a sample number limit (how many
749  * samples should be acquired).
750  */
752 
753  /**
754  * The device supports setting a frame limit (how many
755  * frames should be acquired).
756  */
758 
759  /**
760  * The device supports continuous sampling. Neither a time limit
761  * nor a sample number limit has to be supplied, it will just acquire
762  * samples continuously, until explicitly stopped by a certain command.
763  */
765 
766  /** The device has internal storage, into which data is logged. This
767  * starts or stops the internal logging. */
769 };
770 
771 struct sr_dev_inst {
773  int index;
774  int status;
776  char *vendor;
777  char *model;
778  char *version;
779  GSList *probes;
780  void *conn;
781  void *priv;
782 };
783 
784 /** Types of device instances (sr_dev_inst). */
785 enum {
786  /** Device instance type for USB devices. */
787  SR_INST_USB = 10000,
788  /** Device instance type for serial port devices. */
790 };
791 
792 /** Device instance status. */
793 enum {
794  /** The device instance was not found. */
796  /** The device instance was found, but is still booting. */
798  /** The device instance is live, but not in use. */
800  /** The device instance is actively in use in a session. */
802  /** The device is winding down its session. */
804 };
805 
807  /* Driver-specific */
808  char *name;
809  char *longname;
811  int (*init) (struct sr_context *sr_ctx);
812  int (*cleanup) (void);
813  GSList *(*scan) (GSList *options);
814  GSList *(*dev_list) (void);
815  int (*dev_clear) (void);
816  int (*config_get) (int id, GVariant **data,
817  const struct sr_dev_inst *sdi);
818  int (*config_set) (int id, GVariant *data,
819  const struct sr_dev_inst *sdi);
820  int (*config_list) (int info_id, GVariant **data,
821  const struct sr_dev_inst *sdi);
822 
823  /* Device-specific */
824  int (*dev_open) (struct sr_dev_inst *sdi);
825  int (*dev_close) (struct sr_dev_inst *sdi);
826  int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
827  void *cb_data);
828  int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
829  void *cb_data);
830 
831  /* Dynamic */
832  void *priv;
833 };
834 
835 struct sr_session {
836  /** List of struct sr_dev pointers. */
837  GSList *devs;
838  /** List of struct datafeed_callback pointers. */
840  GTimeVal starttime;
841  gboolean running;
842 
843  unsigned int num_sources;
844 
845  /*
846  * Both "sources" and "pollfds" are of the same size and contain pairs
847  * of descriptor and callback function. We can not embed the GPollFD
848  * into the source struct since we want to be able to pass the array
849  * of all poll descriptors to g_poll().
850  */
851  struct source *sources;
852  GPollFD *pollfds;
854 
855  /*
856  * These are our synchronization primitives for stopping the session in
857  * an async fashion. We need to make sure the session is stopped from
858  * within the session thread itself.
859  */
860  GMutex stop_mutex;
861  gboolean abort_session;
862 };
863 
864 #include "proto.h"
865 #include "version.h"
866 
867 #ifdef __cplusplus
868 }
869 #endif
870 
871 #endif
Trigger types.
Definition: libsigrok.h:666
The device instance is actively in use in a session.
Definition: libsigrok.h:801
Sound pressure level is C-weighted in the frequency domain, according to IEC 61672:2003.
Definition: libsigrok.h:250
Sound pressure level relative so 20 micropascals.
Definition: libsigrok.h:212
Device options for a particular device.
Definition: libsigrok.h:710
int(* init)(struct sr_context *sr_ctx)
Definition: libsigrok.h:811
int inst_type
Definition: libsigrok.h:775
gboolean running
Definition: libsigrok.h:841
GMutex stop_mutex
Definition: libsigrok.h:860
struct sr_dev_inst * sdi
Definition: libsigrok.h:318
A timeout occurred.
Definition: libsigrok.h:75
int(* config_list)(int info_id, GVariant **data, const struct sr_dev_inst *sdi)
Definition: libsigrok.h:820
uint64_t mqflags
Bitmap with extra information about the MQ.
Definition: libsigrok.h:302
The device supports setting a sample time limit (how long the sample acquisition should run...
Definition: libsigrok.h:745
Sound pressure level is A-weighted in the frequency domain, according to IEC 61672:2003.
Definition: libsigrok.h:247
The device supports Run Length Encoding.
Definition: libsigrok.h:639
Output very noisy debug messages.
Definition: libsigrok.h:100
The device supports continuous sampling.
Definition: libsigrok.h:764
int(* dev_open)(struct sr_dev_inst *sdi)
Definition: libsigrok.h:824
Filter.
Definition: libsigrok.h:657
GTimeVal starttime
Definition: libsigrok.h:840
struct sr_dev_inst * sdi
The device for which this output module is creating output.
Definition: libsigrok.h:388
int(* format_match)(const char *filename)
Check if this input module can load and parse the specified file.
Definition: libsigrok.h:340
Time base.
Definition: libsigrok.h:654
char * model
Definition: libsigrok.h:777
unsigned int num_sources
Definition: libsigrok.h:843
Serial communication specification, in the form:
Definition: libsigrok.h:625
Specification on how to connect to a device.
Definition: libsigrok.h:604
Not applicable.
Definition: libsigrok.h:73
char * id
The unique ID for this input format.
Definition: libsigrok.h:325
int(* config_get)(int id, GVariant **data, const struct sr_dev_inst *sdi)
Definition: libsigrok.h:816
int(* init)(struct sr_output *o)
This function is called once, at the beginning of an output stream.
Definition: libsigrok.h:442
struct timeval starttime
Definition: libsigrok.h:280
char * param
An optional parameter which the frontend can pass in to the output module.
Definition: libsigrok.h:395
The device supports setting its samplerate, in Hz.
Definition: libsigrok.h:630
Sound pressure level is Z-weighted (i.e.
Definition: libsigrok.h:253
int(* loadfile)(struct sr_input *in, const char *filename)
Load a file, parsing the input according to the file&#39;s format.
Definition: libsigrok.h:373
Malloc/calloc/realloc error.
Definition: libsigrok.h:69
Normalized (0 to 1) concentration of a substance or compound with 0 representing a concentration of 0...
Definition: libsigrok.h:218
Measurements that intrinsically do not have units attached, such as ratios, gains, etc.
Definition: libsigrok.h:210
gboolean enabled
Definition: libsigrok.h:547
Data source for acquisition.
Definition: libsigrok.h:737
Sound pressure level represented as a percentage of measurements that were over a preset alarm level...
Definition: libsigrok.h:268
Coupling.
Definition: libsigrok.h:663
GHashTable * param
Definition: libsigrok.h:316
The device instance is live, but not in use.
Definition: libsigrok.h:799
Buffer size.
Definition: libsigrok.h:651
uint16_t unitsize
Definition: libsigrok.h:289
int(* config_set)(int id, GVariant *data, const struct sr_dev_inst *sdi)
Definition: libsigrok.h:818
Device is in &quot;max&quot; mode, only updating upon a new max value.
Definition: libsigrok.h:238
The device can act as a sound level meter.
Definition: libsigrok.h:581
Gain (a transistor&#39;s gain, or hFE, for example).
Definition: libsigrok.h:175
int mq
Measured quantity (voltage, current, temperature, and so on).
Definition: libsigrok.h:298
Volts/div.
Definition: libsigrok.h:660
Power off the device.
Definition: libsigrok.h:725
Sound pressure level is not weighted in the frequency domain, albeit without standards-defined low an...
Definition: libsigrok.h:256
The device supports specifying a capturefile to inject.
Definition: libsigrok.h:716
Generic/unspecified error.
Definition: libsigrok.h:68
Electrical power, usually in W, or dBm.
Definition: libsigrok.h:173
Session filename.
Definition: libsigrok.h:713
Device is closed, but needs to be open.
Definition: libsigrok.h:74
int type
Definition: libsigrok.h:546
gboolean abort_session
Definition: libsigrok.h:861
const void * payload
Definition: libsigrok.h:275
int(* cleanup)(void)
Definition: libsigrok.h:812
void * priv
Definition: libsigrok.h:781
The device supports setting a sample number limit (how many samples should be acquired).
Definition: libsigrok.h:751
Device is in &quot;min&quot; mode, only updating upon a new min value.
Definition: libsigrok.h:240
Sound pressure level time weighting.
Definition: libsigrok.h:681
struct sr_dev_driver * driver
Definition: libsigrok.h:772
Voltage measurement is direct current (DC).
Definition: libsigrok.h:230
The device is winding down its session.
Definition: libsigrok.h:803
char * id
A unique ID for this output format.
Definition: libsigrok.h:416
The device supports setting trigger slope.
Definition: libsigrok.h:642
The device can measure humidity.
Definition: libsigrok.h:587
The device can act as a multimeter.
Definition: libsigrok.h:575
Header file containing API function prototypes.
struct sr_output_format * format
A pointer to this output format&#39;s &#39;struct sr_output_format&#39;.
Definition: libsigrok.h:382
Logic low-high threshold range.
Definition: libsigrok.h:693
Voltage measurement is alternating current (AC).
Definition: libsigrok.h:228
The device supports swapping channels.
Definition: libsigrok.h:702
Logarithmic representation of sound pressure relative to a reference value.
Definition: libsigrok.h:178
Device is in relative mode.
Definition: libsigrok.h:244
No error.
Definition: libsigrok.h:67
Scan options supported by the driver.
Definition: libsigrok.h:707
char * description
A short description of the output format.
Definition: libsigrok.h:424
The device instance was not found.
Definition: libsigrok.h:795
int(* dev_clear)(void)
Definition: libsigrok.h:815
int(* dev_acquisition_stop)(struct sr_dev_inst *sdi, void *cb_data)
Definition: libsigrok.h:828
The device instance was found, but is still booting.
Definition: libsigrok.h:797
uint64_t length
Definition: libsigrok.h:288
This is a true RMS measurement.
Definition: libsigrok.h:232
The device supports setting its sample interval, in ms.
Definition: libsigrok.h:669
char * trigger
Definition: libsigrok.h:549
char * longname
Definition: libsigrok.h:809
The device supports setting a pre/post-trigger capture ratio.
Definition: libsigrok.h:633
int(* init)(struct sr_input *in, const char *filename)
Initialize the input module.
Definition: libsigrok.h:352
char * vendor
Definition: libsigrok.h:776
int(* data)(struct sr_output *o, const uint8_t *data_in, uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
Whenever a chunk of data comes in, it will be passed to the output module via this function...
Definition: libsigrok.h:474
Number of timebases, as related to SR_CONF_TIMEBASE.
Definition: libsigrok.h:672
GVariant * data
Definition: libsigrok.h:554
Sound pressure level measurement is F-weighted (125ms) in the time domain.
Definition: libsigrok.h:262
int(* sr_receive_data_callback_t)(int fd, int revents, void *cb_data)
Definition: libsigrok.h:133
GPollFD * pollfds
Definition: libsigrok.h:852
Device is in &quot;hold&quot; mode (repeating the last measurement).
Definition: libsigrok.h:236
struct source * sources
Definition: libsigrok.h:851
int(* dev_close)(struct sr_dev_inst *sdi)
Definition: libsigrok.h:825
Output no messages at all.
Definition: libsigrok.h:95
Device instance type for serial port devices.
Definition: libsigrok.h:789
char * name
Definition: libsigrok.h:548
char * description
A short description of the input format, which can (for example) be displayed to the user by frontend...
Definition: libsigrok.h:331
Device is in autoranging mode.
Definition: libsigrok.h:242
The device has internal storage, into which data is logged.
Definition: libsigrok.h:768
int(* event)(struct sr_output *o, int event_type, uint8_t **data_out, uint64_t *length_out)
This function is called when an event occurs in the datafeed which the output module may need to be a...
Definition: libsigrok.h:505
The device can measure temperature.
Definition: libsigrok.h:584
Output (file) format struct.
Definition: libsigrok.h:377
Incorrect samplerate.
Definition: libsigrok.h:72
Trigger source.
Definition: libsigrok.h:645
struct sr_input_format * format
A pointer to this input format&#39;s &#39;struct sr_input_format&#39;.
Definition: libsigrok.h:314
Input (file) format struct.
Definition: libsigrok.h:309
Unit of conductance, the inverse of resistance.
Definition: libsigrok.h:197
int index
Definition: libsigrok.h:545
The device can measure energy consumption.
Definition: libsigrok.h:590
The device supports setting a pattern (pattern generator mode).
Definition: libsigrok.h:636
The device is a demo device.
Definition: libsigrok.h:578
Output debug messages.
Definition: libsigrok.h:99
Sound pressure level measurement range.
Definition: libsigrok.h:684
Voltage in decibel, referenced to 1 volt (dBV).
Definition: libsigrok.h:204
Number of vertical divisions, as related to SR_CONF_VDIV.
Definition: libsigrok.h:675
Sound pressure level frequency weighting.
Definition: libsigrok.h:678
int(* receive)(struct sr_output *o, const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *packet, GString **out)
This function is passed a copy of every packed in the data feed.
Definition: libsigrok.h:525
Value is voltage drop across a diode, or NAN.
Definition: libsigrok.h:234
GSList * devs
List of struct sr_dev pointers.
Definition: libsigrok.h:837
The device supports setting the number of probes.
Definition: libsigrok.h:722
An absolute measurement of power, in decibels, referenced to 1 milliwatt (dBu).
Definition: libsigrok.h:202
GSList * datafeed_callbacks
List of struct datafeed_callback pointers.
Definition: libsigrok.h:839
Output warnings.
Definition: libsigrok.h:97
int source_timeout
Definition: libsigrok.h:853
The device can act as an oscilloscope.
Definition: libsigrok.h:572
The device supports specifying the capturefile unit size.
Definition: libsigrok.h:719
Min hold mode.
Definition: libsigrok.h:690
Version number definitions and macros.
Max hold mode.
Definition: libsigrok.h:687
void * priv
Definition: libsigrok.h:832
Sound pressure level is time-averaged (LAT), also known as Equivalent Continuous A-weighted Sound Lev...
Definition: libsigrok.h:265
The device supports setting a frame limit (how many frames should be acquired).
Definition: libsigrok.h:757
Sound pressure level measurement is S-weighted (1s) in the time domain.
Definition: libsigrok.h:259
char * description
Definition: libsigrok.h:562
char * version
Definition: libsigrok.h:778
char * name
Definition: libsigrok.h:808
Horizontal trigger position.
Definition: libsigrok.h:648
Function argument error.
Definition: libsigrok.h:70
GSList * probes
The probes for which data is included in this packet.
Definition: libsigrok.h:295
int(* dev_acquisition_start)(const struct sr_dev_inst *sdi, void *cb_data)
Definition: libsigrok.h:826
The device supports using a external clock.
Definition: libsigrok.h:696
The device can act as logic analyzer.
Definition: libsigrok.h:569
Errors hinting at internal bugs.
Definition: libsigrok.h:71
Device instance type for USB devices.
Definition: libsigrok.h:787
GSList * probes
Definition: libsigrok.h:779
Output informational messages.
Definition: libsigrok.h:98
Output error messages.
Definition: libsigrok.h:96
void * conn
Definition: libsigrok.h:780
GSList * config
Definition: libsigrok.h:284
int(* cleanup)(struct sr_output *o)
This function is called after the caller is finished using the output module, and can be used to free...
Definition: libsigrok.h:535
float * data
The analog value(s).
Definition: libsigrok.h:305
int unit
Unit in which the MQ is measured.
Definition: libsigrok.h:300