]> sigrok.org Git - libsigrok.git/blob - libsigrok.h
fx2lafw: Tidied probe_names
[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 hardware drivers for dev_config_set(). */
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_TRIGGER,
152         SR_DF_LOGIC,
153         SR_DF_META_LOGIC,
154         SR_DF_ANALOG,
155         SR_DF_META_ANALOG,
156         SR_DF_FRAME_BEGIN,
157         SR_DF_FRAME_END,
158 };
159
160 /** Values for sr_datafeed_analog.mq. */
161 enum {
162         SR_MQ_VOLTAGE = 10000,
163         SR_MQ_CURRENT,
164         SR_MQ_RESISTANCE,
165         SR_MQ_CAPACITANCE,
166         SR_MQ_TEMPERATURE,
167         SR_MQ_FREQUENCY,
168         SR_MQ_DUTY_CYCLE,
169         SR_MQ_CONTINUITY,
170         SR_MQ_PULSE_WIDTH,
171         SR_MQ_CONDUCTANCE,
172         /** Electrical power, usually in W, or dBm. */
173         SR_MQ_POWER,
174         /** Gain (a transistor's gain, or hFE, for example). */
175         SR_MQ_GAIN,
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,
181 };
182
183 /** Values for sr_datafeed_analog.unit. */
184 enum {
185         SR_UNIT_VOLT = 10000,
186         SR_UNIT_AMPERE,
187         SR_UNIT_OHM,
188         SR_UNIT_FARAD,
189         SR_UNIT_KELVIN,
190         SR_UNIT_CELSIUS,
191         SR_UNIT_FAHRENHEIT,
192         SR_UNIT_HERTZ,
193         SR_UNIT_PERCENTAGE,
194         SR_UNIT_BOOLEAN,
195         SR_UNIT_SECOND,
196         /** Unit of conductance, the inverse of resistance. */
197         SR_UNIT_SIEMENS,
198         /**
199          * An absolute measurement of power, in decibels, referenced to
200          * 1 milliwatt (dBu).
201          */
202         SR_UNIT_DECIBEL_MW,
203         /** Voltage in decibel, referenced to 1 volt (dBV). */
204         SR_UNIT_DECIBEL_VOLT,
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          */
210         SR_UNIT_UNITLESS,
211         /** Sound pressure level relative so 20 micropascals. */
212         SR_UNIT_DECIBEL_SPL,
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          */
218         SR_UNIT_CONCENTRATION,
219 };
220
221 /** Values for sr_datafeed_analog.flags. */
222 enum {
223         /** Voltage measurement is alternating current (AC). */
224         SR_MQFLAG_AC = 0x01,
225         /** Voltage measurement is direct current (DC). */
226         SR_MQFLAG_DC = 0x02,
227         /** This is a true RMS measurement. */
228         SR_MQFLAG_RMS = 0x04,
229         /** Value is voltage drop across a diode, or NAN. */
230         SR_MQFLAG_DIODE = 0x08,
231         /** Device is in "hold" mode (repeating the last measurement). */
232         SR_MQFLAG_HOLD = 0x10,
233         /** Device is in "max" mode, only updating upon a new max value. */
234         SR_MQFLAG_MAX = 0x20,
235         /** Device is in "min" mode, only updating upon a new min value. */
236         SR_MQFLAG_MIN = 0x40,
237         /** Device is in autoranging mode. */
238         SR_MQFLAG_AUTORANGE = 0x80,
239         /** Device is in relative mode. */
240         SR_MQFLAG_RELATIVE = 0x100,
241         /** Sound pressure level is A-weighted in the frequency domain,
242          * according to IEC 61672:2003. */
243         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
244         /** Sound pressure level is C-weighted in the frequency domain,
245          * according to IEC 61672:2003. */
246         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
247         /** Sound pressure level is Z-weighted (i.e. not at all) in the
248          * frequency domain, according to IEC 61672:2003. */
249         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
250         /** Sound pressure level is not weighted in the frequency domain,
251          * albeit without standards-defined low and high frequency limits. */
252         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
253         /** Sound pressure level measurement is S-weighted (1s) in the
254          * time domain. */
255         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
256         /** Sound pressure level measurement is F-weighted (125ms) in the
257          * time domain. */
258         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
259         /** Sound pressure level is time-averaged (LAT), also known as
260          * Equivalent Continuous A-weighted Sound Level (LEQ). */
261         SR_MQFLAG_SPL_LAT = 0x8000,
262         /** Sound pressure level represented as a percentage of measurements
263          * that were over a preset alarm level. */
264         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
265 };
266
267 struct sr_context;
268
269 struct sr_datafeed_packet {
270         uint16_t type;
271         const void *payload;
272 };
273
274 struct sr_datafeed_header {
275         int feed_version;
276         struct timeval starttime;
277 };
278
279 struct sr_datafeed_meta_logic {
280         int num_probes;
281         uint64_t samplerate;
282 };
283
284 struct sr_datafeed_logic {
285         uint64_t length;
286         uint16_t unitsize;
287         void *data;
288 };
289
290 struct sr_datafeed_meta_analog {
291         int num_probes;
292 };
293
294 struct sr_datafeed_analog {
295         int num_samples;
296         /** Measured quantity (voltage, current, temperature, and so on). */
297         int mq;
298         /** Unit in which the MQ is measured. */
299         int unit;
300         /** Bitmap with extra information about the MQ. */
301         uint64_t mqflags;
302         /** The analog value. */
303         float *data;
304 };
305
306 struct sr_input {
307         struct sr_input_format *format;
308         GHashTable *param;
309         struct sr_dev_inst *sdi;
310         void *internal;
311 };
312
313 struct sr_input_format {
314         char *id;
315         char *description;
316         int (*format_match) (const char *filename);
317         int (*init) (struct sr_input *in);
318         int (*loadfile) (struct sr_input *in, const char *filename);
319 };
320
321 struct sr_output {
322         struct sr_output_format *format;
323         struct sr_dev_inst *sdi;
324         char *param;
325         void *internal;
326 };
327
328 struct sr_output_format {
329         char *id;
330         char *description;
331         int df_type;
332         int (*init) (struct sr_output *o);
333         int (*data) (struct sr_output *o, const uint8_t *data_in,
334                      uint64_t length_in, uint8_t **data_out,
335                      uint64_t *length_out);
336         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
337                       uint64_t *length_out);
338         GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
339                         const struct sr_datafeed_packet *packet);
340         int (*cleanup) (struct sr_output *o);
341 };
342
343 struct sr_datastore {
344         /** Size in bytes of the number of units stored in this datastore. */
345         int ds_unitsize;
346         unsigned int num_units; /* TODO: uint64_t */
347         GSList *chunklist;
348 };
349
350 /*
351  * This represents a generic device connected to the system.
352  * For device-specific information, ask the driver. The driver_index refers
353  * to the device index within that driver; it may be handling more than one
354  * device. All relevant driver calls take a dev_index parameter for this.
355  */
356 struct sr_dev {
357         /** Which driver handles this device. */
358         struct sr_dev_driver *driver;
359         /** A driver may handle multiple devices of the same type. */
360         int driver_index;
361         /** List of struct sr_probe pointers. */
362         GSList *probes;
363         /** Data acquired by this device, if any. */
364         struct sr_datastore *datastore;
365 };
366
367 enum {
368         SR_PROBE_LOGIC = 10000,
369         SR_PROBE_ANALOG,
370 };
371
372 struct sr_probe {
373         int index;
374         int type;
375         gboolean enabled;
376         char *name;
377         char *trigger;
378 };
379
380 struct sr_hwopt {
381         int hwopt;
382         const void *value;
383 };
384
385 /** Hardware driver options. */
386 enum {
387         /**
388          * Some drivers cannot detect the exact model they're talking to
389          * (may be phased out).
390          */
391         SR_HWOPT_MODEL = 10000,
392
393         /**
394          * Specification on how to connect to a device.
395          *
396          * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
397          * the form which makes sense to the OS (e.g., /dev/ttyS0).
398          * Otherwise this specifies a USB device, either in the form of
399          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
400          * @verbatim <vendorid>.<productid> @endverbatim
401          * (hexadecimal, e.g. 1d6b.0001).
402          */
403         SR_HWOPT_CONN,
404
405         /**
406          * Serial communication specification, in the form:
407          *
408          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
409          *
410          * Example: 9600/8n1
411          *
412          * This is always an optional parameter, since a driver typically
413          * knows the speed at which the device wants to communicate.
414          */
415         SR_HWOPT_SERIALCOMM,
416 };
417
418 /** Hardware device capabilities. */
419 enum {
420         /*--- Device classes ------------------------------------------------*/
421
422         /** The device can act as logic analyzer. */
423         SR_HWCAP_LOGIC_ANALYZER = 10000,
424
425         /** The device can act as an oscilloscope. */
426         SR_HWCAP_OSCILLOSCOPE,
427
428         /** The device can act as a multimeter. */
429         SR_HWCAP_MULTIMETER,
430
431         /** The device is a demo device. */
432         SR_HWCAP_DEMO_DEV,
433
434         /** The device can act as a sound level meter. */
435         SR_HWCAP_SOUNDLEVELMETER,
436
437         /** The device can measure temperature. */
438         SR_HWCAP_THERMOMETER,
439
440         /** The device can measure humidity. */
441         SR_HWCAP_HYGROMETER,
442
443         /*--- Device configuration ------------------------------------------*/
444
445         /** The device supports setting/changing its samplerate. */
446         SR_HWCAP_SAMPLERATE = 20000,
447
448         /** The device supports setting a pre/post-trigger capture ratio. */
449         SR_HWCAP_CAPTURE_RATIO,
450
451         /* TODO? */
452         /** The device supports setting a pattern (pattern generator mode). */
453         SR_HWCAP_PATTERN_MODE,
454
455         /** The device supports Run Length Encoding. */
456         SR_HWCAP_RLE,
457
458         /** The device supports setting trigger slope. */
459         SR_HWCAP_TRIGGER_SLOPE,
460
461         /** Trigger source. */
462         SR_HWCAP_TRIGGER_SOURCE,
463
464         /** Horizontal trigger position. */
465         SR_HWCAP_HORIZ_TRIGGERPOS,
466
467         /** Buffer size. */
468         SR_HWCAP_BUFFERSIZE,
469
470         /** Time base. */
471         SR_HWCAP_TIMEBASE,
472
473         /** Filter. */
474         SR_HWCAP_FILTER,
475
476         /** Volts/div. */
477         SR_HWCAP_VDIV,
478
479         /** Coupling. */
480         SR_HWCAP_COUPLING,
481
482         /*--- Special stuff -------------------------------------------------*/
483
484         /** Session filename. */
485         SR_HWCAP_SESSIONFILE = 30000,
486
487         /* TODO: Better description. */
488         /** The device supports specifying a capturefile to inject. */
489         SR_HWCAP_CAPTUREFILE,
490
491         /* TODO: Better description. */
492         /** The device supports specifying the capturefile unit size. */
493         SR_HWCAP_CAPTURE_UNITSIZE,
494
495         /* TODO: Better description. */
496         /** The device supports setting the number of probes. */
497         SR_HWCAP_CAPTURE_NUM_PROBES,
498
499         /*--- Acquisition modes ---------------------------------------------*/
500
501         /**
502          * The device supports setting a sample time limit (how long
503          * the sample acquisition should run, in ms).
504          */
505         SR_HWCAP_LIMIT_MSEC = 40000,
506
507         /**
508          * The device supports setting a sample number limit (how many
509          * samples should be acquired).
510          */
511         SR_HWCAP_LIMIT_SAMPLES,
512
513         /**
514          * The device supports setting a frame limit (how many
515          * frames should be acquired).
516          */
517         SR_HWCAP_LIMIT_FRAMES,
518
519         /**
520          * The device supports continuous sampling. Neither a time limit
521          * nor a sample number limit has to be supplied, it will just acquire
522          * samples continuously, until explicitly stopped by a certain command.
523          */
524         SR_HWCAP_CONTINUOUS,
525 };
526
527 struct sr_hwcap_option {
528         int hwcap;
529         int type;
530         char *description;
531         char *shortname;
532 };
533
534 struct sr_dev_inst {
535         struct sr_dev_driver *driver;
536         int index;
537         int status;
538         int inst_type;
539         char *vendor;
540         char *model;
541         char *version;
542         GSList *probes;
543         void *priv;
544 };
545
546 /** Types of device instances (sr_dev_inst). */
547 enum {
548         /** Device instance type for USB devices. */
549         SR_INST_USB = 10000,
550         /** Device instance type for serial port devices. */
551         SR_INST_SERIAL,
552 };
553
554 /** Device instance status. */
555 enum {
556         /** The device instance was not found. */
557         SR_ST_NOT_FOUND = 10000,
558         /** The device instance was found, but is still booting. */
559         SR_ST_INITIALIZING,
560         /** The device instance is live, but not in use. */
561         SR_ST_INACTIVE,
562         /** The device instance is actively in use in a session. */
563         SR_ST_ACTIVE,
564         /** The device is winding down its session. */
565         SR_ST_STOPPING,
566 };
567
568 /*
569  * TODO: This sucks, you just kinda have to "know" the returned type.
570  * TODO: Need a DI to return the number of trigger stages supported.
571  */
572
573 /** Device info IDs. */
574 enum {
575         /** A list of options supported by the driver. */
576         SR_DI_HWOPTS = 10000,
577         /** A list of capabilities supported by the device. */
578         SR_DI_HWCAPS,
579         /** The number of probes connected to this device. */
580         SR_DI_NUM_PROBES,
581         /** The probe names on this device. */
582         SR_DI_PROBE_NAMES,
583         /** Samplerates supported by this device (struct sr_samplerates). */
584         SR_DI_SAMPLERATES,
585         /** Types of logic trigger supported, out of "01crf" (char *). */
586         SR_DI_TRIGGER_TYPES,
587         /** The currently set samplerate in Hz (uint64_t). */
588         SR_DI_CUR_SAMPLERATE,
589         /** Supported patterns (in pattern generator mode). */
590         SR_DI_PATTERNS,
591         /** Supported buffer sizes. */
592         SR_DI_BUFFERSIZES,
593         /** Supported time bases. */
594         SR_DI_TIMEBASES,
595         /** Supported trigger sources. */
596         SR_DI_TRIGGER_SOURCES,
597         /** Supported filter targets. */
598         SR_DI_FILTERS,
599         /** Valid volts/div values. */
600         SR_DI_VDIVS,
601         /** Coupling options. */
602         SR_DI_COUPLING,
603 };
604
605 /*
606  * A device supports either a range of samplerates with steps of a given
607  * granularity, or is limited to a set of defined samplerates. Use either
608  * step or list, but not both.
609  */
610 struct sr_samplerates {
611         uint64_t low;
612         uint64_t high;
613         uint64_t step;
614         const uint64_t *list;
615 };
616
617 struct sr_dev_driver {
618         /* Driver-specific */
619         char *name;
620         char *longname;
621         int api_version;
622         int (*init) (struct sr_context *sr_ctx);
623         int (*cleanup) (void);
624         GSList *(*scan) (GSList *options);
625         GSList *(*dev_list) (void);
626         int (*dev_clear) (void);
627
628         /* Device-specific */
629         int (*dev_open) (struct sr_dev_inst *sdi);
630         int (*dev_close) (struct sr_dev_inst *sdi);
631         int (*info_get) (int info_id, const void **data,
632                         const struct sr_dev_inst *sdi);
633         int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
634                         const void *value);
635         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
636                         void *cb_data);
637         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
638                         void *cb_data);
639
640         /* Dynamic */
641         void *priv;
642 };
643
644 struct sr_session {
645         /** List of struct sr_dev pointers. */
646         GSList *devs;
647         /** List of sr_receive_data_callback_t items. */
648         GSList *datafeed_callbacks;
649         GTimeVal starttime;
650
651         unsigned int num_sources;
652
653         /*
654          * Both "sources" and "pollfds" are of the same size and contain pairs
655          * of descriptor and callback function. We can not embed the GPollFD
656          * into the source struct since we want to be able to pass the array
657          * of all poll descriptors to g_poll().
658          */
659         struct source *sources;
660         GPollFD *pollfds;
661         int source_timeout;
662 };
663
664 #include "proto.h"
665 #include "version.h"
666
667 #ifdef __cplusplus
668 }
669 #endif
670
671 #endif