]> sigrok.org Git - libsigrok.git/blob - libsigrok.h
doxygen: Add more input format docs.
[libsigrok.git] / libsigrok.h
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010-2012 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 };
74
75 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
76 #define SR_MAX_PROBENAME_LEN 32
77
78 /* Handy little macros */
79 #define SR_HZ(n)  (n)
80 #define SR_KHZ(n) ((n) * 1000)
81 #define SR_MHZ(n) ((n) * 1000000)
82 #define SR_GHZ(n) ((n) * 1000000000)
83
84 #define SR_HZ_TO_NS(n) (1000000000 / (n))
85
86 /** libsigrok loglevels. */
87 enum {
88         SR_LOG_NONE = 0, /**< Output no messages at all. */
89         SR_LOG_ERR  = 1, /**< Output error messages. */
90         SR_LOG_WARN = 2, /**< Output warnings. */
91         SR_LOG_INFO = 3, /**< Output informational messages. */
92         SR_LOG_DBG  = 4, /**< Output debug messages. */
93         SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
94 };
95
96 /*
97  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
98  *
99  * Variables and functions marked 'static' are private already and don't
100  * need SR_PRIV. However, functions which are not static (because they need
101  * to be used in other libsigrok-internal files) but are also not meant to
102  * be part of the public libsigrok API, must use SR_PRIV.
103  *
104  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
105  *
106  * This feature is not available on MinGW/Windows, as it is a feature of
107  * ELF files and MinGW/Windows uses PE files.
108  *
109  * Details: http://gcc.gnu.org/wiki/Visibility
110  */
111
112 /* Marks public libsigrok API symbols. */
113 #ifndef _WIN32
114 #define SR_API __attribute__((visibility("default")))
115 #else
116 #define SR_API
117 #endif
118
119 /* Marks private, non-public libsigrok symbols (not part of the API). */
120 #ifndef _WIN32
121 #define SR_PRIV __attribute__((visibility("hidden")))
122 #else
123 #define SR_PRIV
124 #endif
125
126 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
127
128 /** Data types used by sr_config_info(). */
129 enum {
130         SR_T_UINT64 = 10000,
131         SR_T_CHAR,
132         SR_T_BOOL,
133         SR_T_FLOAT,
134         SR_T_RATIONAL_PERIOD,
135         SR_T_RATIONAL_VOLT,
136         SR_T_KEYVALUE,
137 };
138
139 /** Rational number data type, containing numerator and denominator values. */
140 struct sr_rational {
141         /** Numerator of the rational number. */
142         uint64_t p;
143         /** Denominator of the rational number. */
144         uint64_t q;
145 };
146
147 /** Value for sr_datafeed_packet.type. */
148 enum {
149         SR_DF_HEADER = 10000,
150         SR_DF_END,
151         SR_DF_META,
152         SR_DF_TRIGGER,
153         SR_DF_LOGIC,
154         SR_DF_ANALOG,
155         SR_DF_FRAME_BEGIN,
156         SR_DF_FRAME_END,
157 };
158
159 /** Values for sr_datafeed_analog.mq. */
160 enum {
161         SR_MQ_VOLTAGE = 10000,
162         SR_MQ_CURRENT,
163         SR_MQ_RESISTANCE,
164         SR_MQ_CAPACITANCE,
165         SR_MQ_TEMPERATURE,
166         SR_MQ_FREQUENCY,
167         SR_MQ_DUTY_CYCLE,
168         SR_MQ_CONTINUITY,
169         SR_MQ_PULSE_WIDTH,
170         SR_MQ_CONDUCTANCE,
171         /** Electrical power, usually in W, or dBm. */
172         SR_MQ_POWER,
173         /** Gain (a transistor's gain, or hFE, for example). */
174         SR_MQ_GAIN,
175         /** Logarithmic representation of sound pressure relative to a
176          * reference value. */
177         SR_MQ_SOUND_PRESSURE_LEVEL,
178         SR_MQ_CARBON_MONOXIDE,
179         SR_MQ_RELATIVE_HUMIDITY,
180 };
181
182 /** Values for sr_datafeed_analog.unit. */
183 enum {
184         SR_UNIT_VOLT = 10000,
185         SR_UNIT_AMPERE,
186         SR_UNIT_OHM,
187         SR_UNIT_FARAD,
188         SR_UNIT_KELVIN,
189         SR_UNIT_CELSIUS,
190         SR_UNIT_FAHRENHEIT,
191         SR_UNIT_HERTZ,
192         SR_UNIT_PERCENTAGE,
193         SR_UNIT_BOOLEAN,
194         SR_UNIT_SECOND,
195         /** Unit of conductance, the inverse of resistance. */
196         SR_UNIT_SIEMENS,
197         /**
198          * An absolute measurement of power, in decibels, referenced to
199          * 1 milliwatt (dBu).
200          */
201         SR_UNIT_DECIBEL_MW,
202         /** Voltage in decibel, referenced to 1 volt (dBV). */
203         SR_UNIT_DECIBEL_VOLT,
204         /**
205          * Measurements that intrinsically do not have units attached, such
206          * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
207          * a unitless quantity, for example.
208          */
209         SR_UNIT_UNITLESS,
210         /** Sound pressure level relative so 20 micropascals. */
211         SR_UNIT_DECIBEL_SPL,
212         /**
213          * Normalized (0 to 1) concentration of a substance or compound with 0
214          * representing a concentration of 0%, and 1 being 100%. This is
215          * represented as the fraction of number of particles of the substance.
216          */
217         SR_UNIT_CONCENTRATION,
218 };
219
220 /** Values for sr_datafeed_analog.flags. */
221 enum {
222         /** Voltage measurement is alternating current (AC). */
223         SR_MQFLAG_AC = 0x01,
224         /** Voltage measurement is direct current (DC). */
225         SR_MQFLAG_DC = 0x02,
226         /** This is a true RMS measurement. */
227         SR_MQFLAG_RMS = 0x04,
228         /** Value is voltage drop across a diode, or NAN. */
229         SR_MQFLAG_DIODE = 0x08,
230         /** Device is in "hold" mode (repeating the last measurement). */
231         SR_MQFLAG_HOLD = 0x10,
232         /** Device is in "max" mode, only updating upon a new max value. */
233         SR_MQFLAG_MAX = 0x20,
234         /** Device is in "min" mode, only updating upon a new min value. */
235         SR_MQFLAG_MIN = 0x40,
236         /** Device is in autoranging mode. */
237         SR_MQFLAG_AUTORANGE = 0x80,
238         /** Device is in relative mode. */
239         SR_MQFLAG_RELATIVE = 0x100,
240         /** Sound pressure level is A-weighted in the frequency domain,
241          * according to IEC 61672:2003. */
242         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
243         /** Sound pressure level is C-weighted in the frequency domain,
244          * according to IEC 61672:2003. */
245         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
246         /** Sound pressure level is Z-weighted (i.e. not at all) in the
247          * frequency domain, according to IEC 61672:2003. */
248         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
249         /** Sound pressure level is not weighted in the frequency domain,
250          * albeit without standards-defined low and high frequency limits. */
251         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
252         /** Sound pressure level measurement is S-weighted (1s) in the
253          * time domain. */
254         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
255         /** Sound pressure level measurement is F-weighted (125ms) in the
256          * time domain. */
257         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
258         /** Sound pressure level is time-averaged (LAT), also known as
259          * Equivalent Continuous A-weighted Sound Level (LEQ). */
260         SR_MQFLAG_SPL_LAT = 0x8000,
261         /** Sound pressure level represented as a percentage of measurements
262          * that were over a preset alarm level. */
263         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
264 };
265
266 struct sr_context;
267
268 struct sr_datafeed_packet {
269         uint16_t type;
270         const void *payload;
271 };
272
273 struct sr_datafeed_header {
274         int feed_version;
275         struct timeval starttime;
276 };
277
278 struct sr_datafeed_meta {
279         GSList *config;
280 };
281
282 struct sr_datafeed_logic {
283         uint64_t length;
284         uint16_t unitsize;
285         void *data;
286 };
287
288 struct sr_datafeed_analog {
289         /** The probes for which data is included in this packet. */
290         GSList *probes;
291         int num_samples;
292         /** Measured quantity (voltage, current, temperature, and so on). */
293         int mq;
294         /** Unit in which the MQ is measured. */
295         int unit;
296         /** Bitmap with extra information about the MQ. */
297         uint64_t mqflags;
298         /** The analog value(s). The data is interleaved according to
299          * the probes list. */
300         float *data;
301 };
302
303 /** Input (file) format struct. */
304 struct sr_input {
305         /**
306          * A pointer to this input format's 'struct sr_input_format'.
307          * The frontend can use this to call the module's callbacks.
308          */
309         struct sr_input_format *format;
310
311         GHashTable *param;
312
313         struct sr_dev_inst *sdi;
314
315         void *internal;
316 };
317
318 struct sr_input_format {
319         /** The unique ID for this input format. Must not be NULL. */
320         char *id;
321
322         /**
323          * A short description of the input format, which can (for example)
324          * be displayed to the user by frontends. Must not be NULL.
325          */
326         char *description;
327
328         /**
329          * Check if this input module can load and parse the specified file.
330          *
331          * @param filename The name (and path) of the file to check.
332          *
333          * @return TRUE if this module knows the format, FALSE if it doesn't.
334          */
335         int (*format_match) (const char *filename);
336
337         /**
338          * Initialize the input module.
339          *
340          * @param in A pointer to a valid 'struct sr_input' that the caller
341          *           has to allocate and provide to this function. It is also
342          *           the responsibility of the caller to free it later.
343          * @param filename The name (and path) of the file to use.
344          *
345          * @return SR_OK upon success, a negative error code upon failure.
346          */
347         int (*init) (struct sr_input *in, const char *filename);
348
349         /**
350          * Load a file, parsing the input according to the file's format.
351          *
352          * This function will send datafeed packets to the session bus, so
353          * the calling frontend must have registered its session callbacks
354          * beforehand.
355          *
356          * The packet types sent across the session bus by this function must
357          * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
358          * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
359          * if appropriate.
360          *
361          * @param in A pointer to a valid 'struct sr_input' that the caller
362          *           has to allocate and provide to this function. It is also
363          *           the responsibility of the caller to free it later.
364          * @param filename The name (and path) of the file to use.
365          *
366          * @return SR_OK upon success, a negative error code upon failure.
367          */
368         int (*loadfile) (struct sr_input *in, const char *filename);
369 };
370
371 struct sr_output {
372         struct sr_output_format *format;
373         struct sr_dev_inst *sdi;
374         char *param;
375         void *internal;
376 };
377
378 struct sr_output_format {
379         char *id;
380         char *description;
381         int df_type;
382         int (*init) (struct sr_output *o);
383         /* Obsolete, use recv() instead. */
384         int (*data) (struct sr_output *o, const uint8_t *data_in,
385                      uint64_t length_in, uint8_t **data_out,
386                      uint64_t *length_out);
387         /* Obsolete, use recv() instead. */
388         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
389                       uint64_t *length_out);
390         GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
391                         const struct sr_datafeed_packet *packet);
392         int (*cleanup) (struct sr_output *o);
393 };
394
395 enum {
396         SR_PROBE_LOGIC = 10000,
397         SR_PROBE_ANALOG,
398 };
399
400 struct sr_probe {
401         /* The index field will go: use g_slist_length(sdi->probes) instead. */
402         int index;
403         int type;
404         gboolean enabled;
405         char *name;
406         char *trigger;
407 };
408
409 struct sr_config {
410         int key;
411         const void *value;
412 };
413
414 struct sr_config_info {
415         int key;
416         int datatype;
417         char *id;
418         char *name;
419         char *description;
420 };
421
422 enum {
423         /*--- Device classes ------------------------------------------------*/
424
425         /** The device can act as logic analyzer. */
426         SR_CONF_LOGIC_ANALYZER = 10000,
427
428         /** The device can act as an oscilloscope. */
429         SR_CONF_OSCILLOSCOPE,
430
431         /** The device can act as a multimeter. */
432         SR_CONF_MULTIMETER,
433
434         /** The device is a demo device. */
435         SR_CONF_DEMO_DEV,
436
437         /** The device can act as a sound level meter. */
438         SR_CONF_SOUNDLEVELMETER,
439
440         /** The device can measure temperature. */
441         SR_CONF_THERMOMETER,
442
443         /** The device can measure humidity. */
444         SR_CONF_HYGROMETER,
445
446         /*--- Driver scan options -------------------------------------------*/
447
448         /**
449          * Specification on how to connect to a device.
450          *
451          * In combination with SR_CONF_SERIALCOMM, this is a serial port in
452          * the form which makes sense to the OS (e.g., /dev/ttyS0).
453          * Otherwise this specifies a USB device, either in the form of
454          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
455          * @verbatim <vendorid>.<productid> @endverbatim
456          * (hexadecimal, e.g. 1d6b.0001).
457          */
458         SR_CONF_CONN = 20000,
459
460         /**
461          * Serial communication specification, in the form:
462          *
463          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
464          *
465          * Example: 9600/8n1
466          *
467          * The string may also be followed by one or more special settings,
468          * in the form "/key=value". Supported keys and their values are:
469          *
470          * rts    0,1    set the port's RTS pin to low or high
471          * dtr    0,1    set the port's DTR pin to low or high
472          * flow   0      no flow control
473          *        1      hardware-based (RTS/CTS) flow control
474          *        2      software-based (XON/XOFF) flow control
475          * 
476          * This is always an optional parameter, since a driver typically
477          * knows the speed at which the device wants to communicate.
478          */
479         SR_CONF_SERIALCOMM,
480
481         /*--- Device configuration ------------------------------------------*/
482
483         /** The device supports setting/changing its samplerate. */
484         SR_CONF_SAMPLERATE = 30000,
485
486         /** The device supports setting a pre/post-trigger capture ratio. */
487         SR_CONF_CAPTURE_RATIO,
488
489         /** The device supports setting a pattern (pattern generator mode). */
490         SR_CONF_PATTERN_MODE,
491
492         /** The device supports Run Length Encoding. */
493         SR_CONF_RLE,
494
495         /** The device supports setting trigger slope. */
496         SR_CONF_TRIGGER_SLOPE,
497
498         /** Trigger source. */
499         SR_CONF_TRIGGER_SOURCE,
500
501         /** Horizontal trigger position. */
502         SR_CONF_HORIZ_TRIGGERPOS,
503
504         /** Buffer size. */
505         SR_CONF_BUFFERSIZE,
506
507         /** Time base. */
508         SR_CONF_TIMEBASE,
509
510         /** Filter. */
511         SR_CONF_FILTER,
512
513         /** Volts/div. */
514         SR_CONF_VDIV,
515
516         /** Coupling. */
517         SR_CONF_COUPLING,
518
519         /** Trigger types.  */
520         SR_CONF_TRIGGER_TYPE,
521
522         /*--- Special stuff -------------------------------------------------*/
523
524         /** Scan options supported by the driver. */
525         SR_CONF_SCAN_OPTIONS = 40000,
526
527         /** Device options for a particular device. */
528         SR_CONF_DEVICE_OPTIONS,
529
530         /** Session filename. */
531         SR_CONF_SESSIONFILE,
532
533         /** The device supports specifying a capturefile to inject. */
534         SR_CONF_CAPTUREFILE,
535
536         /** The device supports specifying the capturefile unit size. */
537         SR_CONF_CAPTURE_UNITSIZE,
538
539         /** The device supports setting the number of probes. */
540         SR_CONF_CAPTURE_NUM_PROBES,
541
542         /*--- Acquisition modes ---------------------------------------------*/
543
544         /**
545          * The device supports setting a sample time limit (how long
546          * the sample acquisition should run, in ms).
547          */
548         SR_CONF_LIMIT_MSEC = 50000,
549
550         /**
551          * The device supports setting a sample number limit (how many
552          * samples should be acquired).
553          */
554         SR_CONF_LIMIT_SAMPLES,
555
556         /**
557          * The device supports setting a frame limit (how many
558          * frames should be acquired).
559          */
560         SR_CONF_LIMIT_FRAMES,
561
562         /**
563          * The device supports continuous sampling. Neither a time limit
564          * nor a sample number limit has to be supplied, it will just acquire
565          * samples continuously, until explicitly stopped by a certain command.
566          */
567         SR_CONF_CONTINUOUS,
568 };
569
570 struct sr_dev_inst {
571         struct sr_dev_driver *driver;
572         int index;
573         int status;
574         int inst_type;
575         char *vendor;
576         char *model;
577         char *version;
578         GSList *probes;
579         void *priv;
580 };
581
582 /** Types of device instances (sr_dev_inst). */
583 enum {
584         /** Device instance type for USB devices. */
585         SR_INST_USB = 10000,
586         /** Device instance type for serial port devices. */
587         SR_INST_SERIAL,
588 };
589
590 /** Device instance status. */
591 enum {
592         /** The device instance was not found. */
593         SR_ST_NOT_FOUND = 10000,
594         /** The device instance was found, but is still booting. */
595         SR_ST_INITIALIZING,
596         /** The device instance is live, but not in use. */
597         SR_ST_INACTIVE,
598         /** The device instance is actively in use in a session. */
599         SR_ST_ACTIVE,
600         /** The device is winding down its session. */
601         SR_ST_STOPPING,
602 };
603
604 /*
605  * A device supports either a range of samplerates with steps of a given
606  * granularity, or is limited to a set of defined samplerates. Use either
607  * step or list, but not both.
608  */
609 struct sr_samplerates {
610         uint64_t low;
611         uint64_t high;
612         uint64_t step;
613         const uint64_t *list;
614 };
615
616 struct sr_dev_driver {
617         /* Driver-specific */
618         char *name;
619         char *longname;
620         int api_version;
621         int (*init) (struct sr_context *sr_ctx);
622         int (*cleanup) (void);
623         GSList *(*scan) (GSList *options);
624         GSList *(*dev_list) (void);
625         int (*dev_clear) (void);
626         int (*config_get) (int id, const void **value,
627                         const struct sr_dev_inst *sdi);
628         int (*config_set) (int id, const void *value,
629                         const struct sr_dev_inst *sdi);
630         int (*config_list) (int info_id, const void **data,
631                         const struct sr_dev_inst *sdi);
632
633         /* Device-specific */
634         int (*dev_open) (struct sr_dev_inst *sdi);
635         int (*dev_close) (struct sr_dev_inst *sdi);
636         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
637                         void *cb_data);
638         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
639                         void *cb_data);
640
641         /* Dynamic */
642         void *priv;
643 };
644
645 struct sr_session {
646         /** List of struct sr_dev pointers. */
647         GSList *devs;
648         /** List of sr_receive_data_callback_t items. */
649         GSList *datafeed_callbacks;
650         GTimeVal starttime;
651
652         unsigned int num_sources;
653
654         /*
655          * Both "sources" and "pollfds" are of the same size and contain pairs
656          * of descriptor and callback function. We can not embed the GPollFD
657          * into the source struct since we want to be able to pass the array
658          * of all poll descriptors to g_poll().
659          */
660         struct source *sources;
661         GPollFD *pollfds;
662         int source_timeout;
663 };
664
665 #include "proto.h"
666 #include "version.h"
667
668 #ifdef __cplusplus
669 }
670 #endif
671
672 #endif