]> sigrok.org Git - libsigrok.git/blame_incremental - include/libsigrok/libsigrok.h
libsigrok.h: add new type of device: ELECTRONIC_LOAD.
[libsigrok.git] / include / libsigrok / libsigrok.h
... / ...
CommitLineData
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_LIBSIGROK_H
21#define LIBSIGROK_LIBSIGROK_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
30extern "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. */
66enum sr_error_code {
67 SR_OK_CONTINUE = 1, /**< Keep going. */
68 SR_OK = 0, /**< No error. */
69 SR_ERR = -1, /**< Generic/unspecified error. */
70 SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
71 SR_ERR_ARG = -3, /**< Function argument error. */
72 SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */
73 SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
74 SR_ERR_NA = -6, /**< Not applicable. */
75 SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but must be open. */
76 SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
77 SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
78 SR_ERR_DATA =-10, /**< Data is invalid. */
79 SR_ERR_IO =-11, /**< Input/output error. */
80
81 /*
82 * Note: When adding entries here, don't forget to also update the
83 * sr_strerror() and sr_strerror_name() functions in error.c.
84 */
85};
86
87#define SR_MAX_CHANNELNAME_LEN 32
88
89/* Handy little macros */
90#define SR_HZ(n) (n)
91#define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
92#define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
93#define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
94
95#define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
96
97/** libsigrok loglevels. */
98enum sr_loglevel {
99 SR_LOG_NONE = 0, /**< Output no messages at all. */
100 SR_LOG_ERR = 1, /**< Output error messages. */
101 SR_LOG_WARN = 2, /**< Output warnings. */
102 SR_LOG_INFO = 3, /**< Output informational messages. */
103 SR_LOG_DBG = 4, /**< Output debug messages. */
104 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
105};
106
107/*
108 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
109 *
110 * Variables and functions marked 'static' are private already and don't
111 * need SR_PRIV. However, functions which are not static (because they need
112 * to be used in other libsigrok-internal files) but are also not meant to
113 * be part of the public libsigrok API, must use SR_PRIV.
114 *
115 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
116 *
117 * This feature is not available on MinGW/Windows, as it is a feature of
118 * ELF files and MinGW/Windows uses PE files.
119 *
120 * Details: http://gcc.gnu.org/wiki/Visibility
121 */
122
123/* Marks public libsigrok API symbols. */
124#ifndef _WIN32
125#define SR_API __attribute__((visibility("default")))
126#else
127#define SR_API
128#endif
129
130/* Marks private, non-public libsigrok symbols (not part of the API). */
131#ifndef _WIN32
132#define SR_PRIV __attribute__((visibility("hidden")))
133#else
134#define SR_PRIV
135#endif
136
137/** Type definition for callback function for data reception. */
138typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
139
140/** Data types used by sr_config_info(). */
141enum sr_datatype {
142 SR_T_UINT64 = 10000,
143 SR_T_STRING,
144 SR_T_BOOL,
145 SR_T_FLOAT,
146 SR_T_RATIONAL_PERIOD,
147 SR_T_RATIONAL_VOLT,
148 SR_T_KEYVALUE,
149 SR_T_UINT64_RANGE,
150 SR_T_DOUBLE_RANGE,
151 SR_T_INT32,
152};
153
154/** Value for sr_datafeed_packet.type. */
155enum sr_packettype {
156 /** Payload is sr_datafeed_header. */
157 SR_DF_HEADER = 10000,
158 /** End of stream (no further data). */
159 SR_DF_END,
160 /** Payload is struct sr_datafeed_meta */
161 SR_DF_META,
162 /** The trigger matched at this point in the data feed. No payload. */
163 SR_DF_TRIGGER,
164 /** Payload is struct sr_datafeed_logic. */
165 SR_DF_LOGIC,
166 /** Payload is struct sr_datafeed_analog. */
167 SR_DF_ANALOG,
168 /** Beginning of frame. No payload. */
169 SR_DF_FRAME_BEGIN,
170 /** End of frame. No payload. */
171 SR_DF_FRAME_END,
172 /** Payload is struct sr_datafeed_analog2. */
173 SR_DF_ANALOG2,
174};
175
176/** Measured quantity, sr_datafeed_analog.mq. */
177enum sr_mq {
178 SR_MQ_VOLTAGE = 10000,
179 SR_MQ_CURRENT,
180 SR_MQ_RESISTANCE,
181 SR_MQ_CAPACITANCE,
182 SR_MQ_TEMPERATURE,
183 SR_MQ_FREQUENCY,
184 /** Duty cycle, e.g. on/off ratio. */
185 SR_MQ_DUTY_CYCLE,
186 /** Continuity test. */
187 SR_MQ_CONTINUITY,
188 SR_MQ_PULSE_WIDTH,
189 SR_MQ_CONDUCTANCE,
190 /** Electrical power, usually in W, or dBm. */
191 SR_MQ_POWER,
192 /** Gain (a transistor's gain, or hFE, for example). */
193 SR_MQ_GAIN,
194 /** Logarithmic representation of sound pressure relative to a
195 * reference value. */
196 SR_MQ_SOUND_PRESSURE_LEVEL,
197 /** Carbon monoxide level */
198 SR_MQ_CARBON_MONOXIDE,
199 /** Humidity */
200 SR_MQ_RELATIVE_HUMIDITY,
201 /** Time */
202 SR_MQ_TIME,
203 /** Wind speed */
204 SR_MQ_WIND_SPEED,
205 /** Pressure */
206 SR_MQ_PRESSURE,
207 /** Parallel inductance (LCR meter model). */
208 SR_MQ_PARALLEL_INDUCTANCE,
209 /** Parallel capacitance (LCR meter model). */
210 SR_MQ_PARALLEL_CAPACITANCE,
211 /** Parallel resistance (LCR meter model). */
212 SR_MQ_PARALLEL_RESISTANCE,
213 /** Series inductance (LCR meter model). */
214 SR_MQ_SERIES_INDUCTANCE,
215 /** Series capacitance (LCR meter model). */
216 SR_MQ_SERIES_CAPACITANCE,
217 /** Series resistance (LCR meter model). */
218 SR_MQ_SERIES_RESISTANCE,
219 /** Dissipation factor. */
220 SR_MQ_DISSIPATION_FACTOR,
221 /** Quality factor. */
222 SR_MQ_QUALITY_FACTOR,
223 /** Phase angle. */
224 SR_MQ_PHASE_ANGLE,
225 /** Difference from reference value. */
226 SR_MQ_DIFFERENCE,
227 /** Count. */
228 SR_MQ_COUNT,
229 /** Power factor. */
230 SR_MQ_POWER_FACTOR,
231 /** Apparent power */
232 SR_MQ_APPARENT_POWER,
233};
234
235/** Unit of measured quantity, sr_datafeed_analog.unit. */
236enum sr_unit {
237 /** Volt */
238 SR_UNIT_VOLT = 10000,
239 /** Ampere (current). */
240 SR_UNIT_AMPERE,
241 /** Ohm (resistance). */
242 SR_UNIT_OHM,
243 /** Farad (capacity). */
244 SR_UNIT_FARAD,
245 /** Kelvin (temperature). */
246 SR_UNIT_KELVIN,
247 /** Degrees Celsius (temperature). */
248 SR_UNIT_CELSIUS,
249 /** Degrees Fahrenheit (temperature). */
250 SR_UNIT_FAHRENHEIT,
251 /** Hertz (frequency, 1/s, [Hz]). */
252 SR_UNIT_HERTZ,
253 /** Percent value. */
254 SR_UNIT_PERCENTAGE,
255 /** Boolean value. */
256 SR_UNIT_BOOLEAN,
257 /** Time in seconds. */
258 SR_UNIT_SECOND,
259 /** Unit of conductance, the inverse of resistance. */
260 SR_UNIT_SIEMENS,
261 /**
262 * An absolute measurement of power, in decibels, referenced to
263 * 1 milliwatt (dBu).
264 */
265 SR_UNIT_DECIBEL_MW,
266 /** Voltage in decibel, referenced to 1 volt (dBV). */
267 SR_UNIT_DECIBEL_VOLT,
268 /**
269 * Measurements that intrinsically do not have units attached, such
270 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
271 * a unitless quantity, for example.
272 */
273 SR_UNIT_UNITLESS,
274 /** Sound pressure level, in decibels, relative to 20 micropascals. */
275 SR_UNIT_DECIBEL_SPL,
276 /**
277 * Normalized (0 to 1) concentration of a substance or compound with 0
278 * representing a concentration of 0%, and 1 being 100%. This is
279 * represented as the fraction of number of particles of the substance.
280 */
281 SR_UNIT_CONCENTRATION,
282 /** Revolutions per minute. */
283 SR_UNIT_REVOLUTIONS_PER_MINUTE,
284 /** Apparent power [VA]. */
285 SR_UNIT_VOLT_AMPERE,
286 /** Real power [W]. */
287 SR_UNIT_WATT,
288 /** Consumption [Wh]. */
289 SR_UNIT_WATT_HOUR,
290 /** Wind speed in meters per second. */
291 SR_UNIT_METER_SECOND,
292 /** Pressure in hectopascal */
293 SR_UNIT_HECTOPASCAL,
294 /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
295 SR_UNIT_HUMIDITY_293K,
296 /** Plane angle in 1/360th of a full circle. */
297 SR_UNIT_DEGREE,
298 /** Henry (inductance). */
299 SR_UNIT_HENRY,
300};
301
302/** Values for sr_datafeed_analog.flags. */
303enum sr_mqflag {
304 /** Voltage measurement is alternating current (AC). */
305 SR_MQFLAG_AC = 0x01,
306 /** Voltage measurement is direct current (DC). */
307 SR_MQFLAG_DC = 0x02,
308 /** This is a true RMS measurement. */
309 SR_MQFLAG_RMS = 0x04,
310 /** Value is voltage drop across a diode, or NAN. */
311 SR_MQFLAG_DIODE = 0x08,
312 /** Device is in "hold" mode (repeating the last measurement). */
313 SR_MQFLAG_HOLD = 0x10,
314 /** Device is in "max" mode, only updating upon a new max value. */
315 SR_MQFLAG_MAX = 0x20,
316 /** Device is in "min" mode, only updating upon a new min value. */
317 SR_MQFLAG_MIN = 0x40,
318 /** Device is in autoranging mode. */
319 SR_MQFLAG_AUTORANGE = 0x80,
320 /** Device is in relative mode. */
321 SR_MQFLAG_RELATIVE = 0x100,
322 /** Sound pressure level is A-weighted in the frequency domain,
323 * according to IEC 61672:2003. */
324 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
325 /** Sound pressure level is C-weighted in the frequency domain,
326 * according to IEC 61672:2003. */
327 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
328 /** Sound pressure level is Z-weighted (i.e. not at all) in the
329 * frequency domain, according to IEC 61672:2003. */
330 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
331 /** Sound pressure level is not weighted in the frequency domain,
332 * albeit without standards-defined low and high frequency limits. */
333 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
334 /** Sound pressure level measurement is S-weighted (1s) in the
335 * time domain. */
336 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
337 /** Sound pressure level measurement is F-weighted (125ms) in the
338 * time domain. */
339 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
340 /** Sound pressure level is time-averaged (LAT), also known as
341 * Equivalent Continuous A-weighted Sound Level (LEQ). */
342 SR_MQFLAG_SPL_LAT = 0x8000,
343 /** Sound pressure level represented as a percentage of measurements
344 * that were over a preset alarm level. */
345 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
346 /** Time is duration (as opposed to epoch, ...). */
347 SR_MQFLAG_DURATION = 0x20000,
348 /** Device is in "avg" mode, averaging upon each new value. */
349 SR_MQFLAG_AVG = 0x40000,
350 /** Reference value shown. */
351 SR_MQFLAG_REFERENCE = 0x80000,
352};
353
354enum sr_trigger_matches {
355 SR_TRIGGER_ZERO = 1,
356 SR_TRIGGER_ONE,
357 SR_TRIGGER_RISING,
358 SR_TRIGGER_FALLING,
359 SR_TRIGGER_EDGE,
360 SR_TRIGGER_OVER,
361 SR_TRIGGER_UNDER,
362};
363
364/** The representation of a trigger, consisting of one or more stages
365 * containing one or more matches on a channel.
366 */
367struct sr_trigger {
368 /** A name for this trigger. This may be NULL if none is needed. */
369 char *name;
370 /** List of pointers to struct sr_trigger_stage. */
371 GSList *stages;
372};
373
374/** A trigger stage. */
375struct sr_trigger_stage {
376 /** Starts at 0. */
377 int stage;
378 /** List of pointers to struct sr_trigger_match. */
379 GSList *matches;
380};
381
382/** A channel to match and what to match it on. */
383struct sr_trigger_match {
384 /** The channel to trigger on. */
385 struct sr_channel *channel;
386 /** The trigger match to use.
387 * For logic channels, only the following matches may be used:
388 * SR_TRIGGER_ZERO
389 * SR_TRIGGER_ONE
390 * SR_TRIGGER_RISING
391 * SR_TRIGGER_FALLING
392 * SR_TRIGGER_EDGE
393 *
394 * For analog channels, only these matches may be used:
395 * SR_TRIGGER_RISING
396 * SR_TRIGGER_FALLING
397 * SR_TRIGGER_OVER
398 * SR_TRIGGER_UNDER
399 *
400 */
401 int match;
402 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
403 * this contains the value to compare against. */
404 float value;
405};
406
407/**
408 * @struct sr_context
409 * Opaque structure representing a libsigrok context.
410 *
411 * None of the fields of this structure are meant to be accessed directly.
412 *
413 * @see sr_init(), sr_exit().
414 */
415struct sr_context;
416
417/**
418 * @struct sr_session
419 * Opaque structure representing a libsigrok session.
420 *
421 * None of the fields of this structure are meant to be accessed directly.
422 *
423 * @see sr_session_new(), sr_session_destroy().
424 */
425struct sr_session;
426
427struct sr_rational {
428 /** Numerator of the rational number. */
429 uint64_t p;
430 /** Denominator of the rational number. */
431 uint64_t q;
432};
433
434/** Packet in a sigrok data feed. */
435struct sr_datafeed_packet {
436 uint16_t type;
437 const void *payload;
438};
439
440/** Header of a sigrok data feed. */
441struct sr_datafeed_header {
442 int feed_version;
443 struct timeval starttime;
444};
445
446/** Datafeed payload for type SR_DF_META. */
447struct sr_datafeed_meta {
448 GSList *config;
449};
450
451/** Logic datafeed payload for type SR_DF_LOGIC. */
452struct sr_datafeed_logic {
453 uint64_t length;
454 uint16_t unitsize;
455 void *data;
456};
457
458/** Analog datafeed payload for type SR_DF_ANALOG. */
459struct sr_datafeed_analog {
460 /** The channels for which data is included in this packet. */
461 GSList *channels;
462 /** Number of samples in data */
463 int num_samples;
464 /** Measured quantity (voltage, current, temperature, and so on).
465 * Use SR_MQ_VOLTAGE, ... */
466 int mq;
467 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
468 int unit;
469 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
470 uint64_t mqflags;
471 /** The analog value(s). The data is interleaved according to
472 * the channels list. */
473 float *data;
474};
475
476/** Analog datafeed payload for type SR_DF_ANALOG2. */
477struct sr_datafeed_analog2 {
478 void *data;
479 uint32_t num_samples;
480 struct sr_analog_encoding *encoding;
481 struct sr_analog_meaning *meaning;
482 struct sr_analog_spec *spec;
483};
484
485struct sr_analog_encoding {
486 uint8_t unitsize;
487 gboolean is_signed;
488 gboolean is_float;
489 gboolean is_bigendian;
490 uint8_t digits;
491 gboolean is_digits_decimal;
492 struct sr_rational scale;
493 struct sr_rational offset;
494};
495
496struct sr_analog_meaning {
497 enum sr_mq mq;
498 enum sr_unit unit;
499 enum sr_mqflag mqflags;
500 GSList *channels;
501};
502
503struct sr_analog_spec {
504 uint8_t spec_digits;
505};
506
507/** Generic option struct used by various subsystems. */
508struct sr_option {
509 /* Short name suitable for commandline usage, [a-z0-9-]. */
510 char *id;
511 /* Short name suitable for GUI usage, can contain UTF-8. */
512 char *name;
513 /* Description of the option, in a sentence. */
514 char *desc;
515 /* Default value for this option. */
516 GVariant *def;
517 /* List of possible values, if this is an option with few values. */
518 GSList *values;
519};
520
521struct sr_input;
522struct sr_input_module;
523struct sr_output;
524struct sr_output_module;
525struct sr_transform;
526struct sr_transform_module;
527
528/** Constants for channel type. */
529enum sr_channeltype {
530 /** Channel type is logic channel. */
531 SR_CHANNEL_LOGIC = 10000,
532 /** Channel type is analog channel. */
533 SR_CHANNEL_ANALOG,
534};
535
536/** Information on single channel. */
537struct sr_channel {
538 /** The device this channel is attached to. */
539 struct sr_dev_inst *sdi;
540 /** The index of this channel, starting at 0. Logic channels will
541 * be encoded according to this index in SR_DF_LOGIC packets. */
542 int index;
543 /** Channel type (SR_CHANNEL_LOGIC, ...) */
544 int type;
545 /** Is this channel enabled? */
546 gboolean enabled;
547 /** Name of channel. */
548 char *name;
549 /** Private data for driver use. */
550 void *priv;
551};
552
553/** Structure for groups of channels that have common properties. */
554struct sr_channel_group {
555 /** Name of the channel group. */
556 char *name;
557 /** List of sr_channel structs of the channels belonging to this group. */
558 GSList *channels;
559 /** Private data for driver use. */
560 void *priv;
561};
562
563/** Used for setting or getting value of a config item. */
564struct sr_config {
565 /** Config key like SR_CONF_CONN, etc. */
566 uint32_t key;
567 /** Key-specific data. */
568 GVariant *data;
569};
570
571/** Information about a config key. */
572struct sr_config_info {
573 /** Config key like SR_CONF_CONN, etc. */
574 uint32_t key;
575 /** Data type like SR_T_STRING, etc. */
576 int datatype;
577 /** Id string, e.g. "serialcomm". */
578 char *id;
579 /** Name, e.g. "Serial communication". */
580 char *name;
581 /** Verbose description (unused currently). */
582 char *description;
583};
584
585#define SR_CONF_GET (1 << 31)
586#define SR_CONF_SET (1 << 30)
587#define SR_CONF_LIST (1 << 29)
588#define SR_CONF_MASK 0x1fffffff
589
590/** Configuration keys */
591enum sr_configkey {
592 /*--- Device classes ------------------------------------------------*/
593
594 /** The device can act as logic analyzer. */
595 SR_CONF_LOGIC_ANALYZER = 10000,
596
597 /** The device can act as an oscilloscope. */
598 SR_CONF_OSCILLOSCOPE,
599
600 /** The device can act as a multimeter. */
601 SR_CONF_MULTIMETER,
602
603 /** The device is a demo device. */
604 SR_CONF_DEMO_DEV,
605
606 /** The device can act as a sound level meter. */
607 SR_CONF_SOUNDLEVELMETER,
608
609 /** The device can measure temperature. */
610 SR_CONF_THERMOMETER,
611
612 /** The device can measure humidity. */
613 SR_CONF_HYGROMETER,
614
615 /** The device can measure energy consumption. */
616 SR_CONF_ENERGYMETER,
617
618 /** The device can act as a signal demodulator. */
619 SR_CONF_DEMODULATOR,
620
621 /** The device can act as a programmable power supply. */
622 SR_CONF_POWER_SUPPLY,
623
624 /** The device can act as an LCR meter. */
625 SR_CONF_LCRMETER,
626
627 /** The device can act as an LCR meter. */
628 SR_CONF_ELECTRONIC_LOAD,
629
630 /*--- Driver scan options -------------------------------------------*/
631
632 /**
633 * Specification on how to connect to a device.
634 *
635 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
636 * the form which makes sense to the OS (e.g., /dev/ttyS0).
637 * Otherwise this specifies a USB device, either in the form of
638 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
639 * @verbatim <vendorid>.<productid> @endverbatim
640 * (hexadecimal, e.g. 1d6b.0001).
641 */
642 SR_CONF_CONN = 20000,
643
644 /**
645 * Serial communication specification, in the form:
646 *
647 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
648 *
649 * Example: 9600/8n1
650 *
651 * The string may also be followed by one or more special settings,
652 * in the form "/key=value". Supported keys and their values are:
653 *
654 * rts 0,1 set the port's RTS pin to low or high
655 * dtr 0,1 set the port's DTR pin to low or high
656 * flow 0 no flow control
657 * 1 hardware-based (RTS/CTS) flow control
658 * 2 software-based (XON/XOFF) flow control
659 *
660 * This is always an optional parameter, since a driver typically
661 * knows the speed at which the device wants to communicate.
662 */
663 SR_CONF_SERIALCOMM,
664
665 /**
666 * Modbus slave address specification.
667 *
668 * This is always an optional parameter, since a driver typically
669 * knows the default slave address of the device.
670 */
671 SR_CONF_MODBUSADDR,
672
673 /*--- Device (or channel group) configuration -----------------------*/
674
675 /** The device supports setting its samplerate, in Hz. */
676 SR_CONF_SAMPLERATE = 30000,
677
678 /** The device supports setting a pre/post-trigger capture ratio. */
679 SR_CONF_CAPTURE_RATIO,
680
681 /** The device supports setting a pattern (pattern generator mode). */
682 SR_CONF_PATTERN_MODE,
683
684 /** The device supports run-length encoding (RLE). */
685 SR_CONF_RLE,
686
687 /** The device supports setting trigger slope. */
688 SR_CONF_TRIGGER_SLOPE,
689
690 /** The device supports averaging. */
691 SR_CONF_AVERAGING,
692
693 /**
694 * The device supports setting number of samples to be
695 * averaged over.
696 */
697 SR_CONF_AVG_SAMPLES,
698
699 /** Trigger source. */
700 SR_CONF_TRIGGER_SOURCE,
701
702 /** Horizontal trigger position. */
703 SR_CONF_HORIZ_TRIGGERPOS,
704
705 /** Buffer size. */
706 SR_CONF_BUFFERSIZE,
707
708 /** Time base. */
709 SR_CONF_TIMEBASE,
710
711 /** Filter. */
712 SR_CONF_FILTER,
713
714 /** Volts/div. */
715 SR_CONF_VDIV,
716
717 /** Coupling. */
718 SR_CONF_COUPLING,
719
720 /** Trigger matches. */
721 SR_CONF_TRIGGER_MATCH,
722
723 /** The device supports setting its sample interval, in ms. */
724 SR_CONF_SAMPLE_INTERVAL,
725
726 /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
727 SR_CONF_NUM_HDIV,
728
729 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
730 SR_CONF_NUM_VDIV,
731
732 /** Sound pressure level frequency weighting. */
733 SR_CONF_SPL_WEIGHT_FREQ,
734
735 /** Sound pressure level time weighting. */
736 SR_CONF_SPL_WEIGHT_TIME,
737
738 /** Sound pressure level measurement range. */
739 SR_CONF_SPL_MEASUREMENT_RANGE,
740
741 /** Max hold mode. */
742 SR_CONF_HOLD_MAX,
743
744 /** Min hold mode. */
745 SR_CONF_HOLD_MIN,
746
747 /** Logic low-high threshold range. */
748 SR_CONF_VOLTAGE_THRESHOLD,
749
750 /** The device supports using an external clock. */
751 SR_CONF_EXTERNAL_CLOCK,
752
753 /**
754 * The device supports swapping channels. Typical this is between
755 * buffered and unbuffered channels.
756 */
757 SR_CONF_SWAP,
758
759 /** Center frequency.
760 * The input signal is downmixed by this frequency before the ADC
761 * anti-aliasing filter.
762 */
763 SR_CONF_CENTER_FREQUENCY,
764
765 /** The device supports setting the number of logic channels. */
766 SR_CONF_NUM_LOGIC_CHANNELS,
767
768 /** The device supports setting the number of analog channels. */
769 SR_CONF_NUM_ANALOG_CHANNELS,
770
771 /**
772 * Current voltage.
773 * @arg type: double
774 * @arg get: get measured voltage
775 */
776 SR_CONF_VOLTAGE,
777
778 /**
779 * Maximum target voltage.
780 * @arg type: double
781 * @arg get: get target voltage
782 * @arg set: change target voltage
783 */
784 SR_CONF_VOLTAGE_TARGET,
785
786 /**
787 * Current current.
788 * @arg type: double
789 * @arg get: get measured current
790 */
791 SR_CONF_CURRENT,
792
793 /**
794 * Current limit.
795 * @arg type: double
796 * @arg get: get current limit
797 * @arg set: change current limit
798 */
799 SR_CONF_CURRENT_LIMIT,
800
801 /**
802 * Enabling/disabling channel.
803 * @arg type: boolean
804 * @arg get: @b true if currently enabled
805 * @arg set: enable/disable
806 */
807 SR_CONF_ENABLED,
808
809 /**
810 * Channel configuration.
811 * @arg type: string
812 * @arg get: get current setting
813 * @arg set: change current setting
814 * @arg list: array of possible values
815 */
816 SR_CONF_CHANNEL_CONFIG,
817
818 /**
819 * Over-voltage protection (OVP) feature
820 * @arg type: boolean
821 * @arg get: @b true if currently enabled
822 * @arg set: enable/disable
823 */
824 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
825
826 /**
827 * Over-voltage protection (OVP) active
828 * @arg type: boolean
829 * @arg get: @b true if device has activated OVP, i.e. the output voltage
830 * exceeds the over-voltage protection threshold.
831 */
832 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
833
834 /**
835 * Over-voltage protection (OVP) threshold
836 * @arg type: double (voltage)
837 * @arg get: get current threshold
838 * @arg set: set new threshold
839 */
840 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
841
842 /**
843 * Over-current protection (OCP) feature
844 * @arg type: boolean
845 * @arg get: @b true if currently enabled
846 * @arg set: enable/disable
847 */
848 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
849
850 /**
851 * Over-current protection (OCP) active
852 * @arg type: boolean
853 * @arg get: @b true if device has activated OCP, i.e. the current current
854 * exceeds the over-current protection threshold.
855 */
856 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
857
858 /**
859 * Over-current protection (OCP) threshold
860 * @arg type: double (current)
861 * @arg get: get current threshold
862 * @arg set: set new threshold
863 */
864 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
865
866 /** Choice of clock edge for external clock ("r" or "f"). */
867 SR_CONF_CLOCK_EDGE,
868
869 /** Amplitude of a source without strictly-defined MQ. */
870 SR_CONF_AMPLITUDE,
871
872 /**
873 * Channel regulation
874 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
875 * or unregulated.
876 */
877 SR_CONF_REGULATION,
878
879 /** Over-temperature protection (OTP) */
880 SR_CONF_OVER_TEMPERATURE_PROTECTION,
881
882 /** Output frequency in Hz. */
883 SR_CONF_OUTPUT_FREQUENCY,
884
885 /** Measured quantity. */
886 SR_CONF_MEASURED_QUANTITY,
887
888 /** Measured secondary quantity. */
889 SR_CONF_MEASURED_2ND_QUANTITY,
890
891 /** Equivalent circuit model. */
892 SR_CONF_EQUIV_CIRCUIT_MODEL,
893
894 /* Output frequency target in Hz. */
895 SR_CONF_OUTPUT_FREQUENCY_TARGET,
896
897 /** Over-temperature protection (OTP) active. */
898 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
899
900 /*--- Special stuff -------------------------------------------------*/
901
902 /** Scan options supported by the driver. */
903 SR_CONF_SCAN_OPTIONS = 40000,
904
905 /** Device options for a particular device. */
906 SR_CONF_DEVICE_OPTIONS,
907
908 /** Session filename. */
909 SR_CONF_SESSIONFILE,
910
911 /** The device supports specifying a capturefile to inject. */
912 SR_CONF_CAPTUREFILE,
913
914 /** The device supports specifying the capturefile unit size. */
915 SR_CONF_CAPTURE_UNITSIZE,
916
917 /** Power off the device. */
918 SR_CONF_POWER_OFF,
919
920 /**
921 * Data source for acquisition. If not present, acquisition from
922 * the device is always "live", i.e. acquisition starts when the
923 * frontend asks and the results are sent out as soon as possible.
924 *
925 * If present, it indicates that either the device has no live
926 * acquisition capability (for example a pure data logger), or
927 * there is a choice. sr_config_list() returns those choices.
928 *
929 * In any case if a device has live acquisition capabilities, it
930 * is always the default.
931 */
932 SR_CONF_DATA_SOURCE,
933
934 /** The device supports setting a probe factor. */
935 SR_CONF_PROBE_FACTOR,
936
937 /*--- Acquisition modes, sample limiting ----------------------------*/
938
939 /**
940 * The device supports setting a sample time limit (how long
941 * the sample acquisition should run, in ms).
942 */
943 SR_CONF_LIMIT_MSEC = 50000,
944
945 /**
946 * The device supports setting a sample number limit (how many
947 * samples should be acquired).
948 */
949 SR_CONF_LIMIT_SAMPLES,
950
951 /**
952 * The device supports setting a frame limit (how many
953 * frames should be acquired).
954 */
955 SR_CONF_LIMIT_FRAMES,
956
957 /**
958 * The device supports continuous sampling. Neither a time limit
959 * nor a sample number limit has to be supplied, it will just acquire
960 * samples continuously, until explicitly stopped by a certain command.
961 */
962 SR_CONF_CONTINUOUS,
963
964 /** The device has internal storage, into which data is logged. This
965 * starts or stops the internal logging. */
966 SR_CONF_DATALOG,
967
968 /** Device mode for multi-function devices. */
969 SR_CONF_DEVICE_MODE,
970
971 /** Self test mode. */
972 SR_CONF_TEST_MODE,
973};
974
975/**
976 * Opaque structure representing a libsigrok device instance.
977 *
978 * None of the fields of this structure are meant to be accessed directly.
979 */
980struct sr_dev_inst;
981
982/** Types of device instance, struct sr_dev_inst.type */
983enum sr_dev_inst_type {
984 /** Device instance type for USB devices. */
985 SR_INST_USB = 10000,
986 /** Device instance type for serial port devices. */
987 SR_INST_SERIAL,
988 /** Device instance type for SCPI devices. */
989 SR_INST_SCPI,
990 /** Device-instance type for user-created "devices". */
991 SR_INST_USER,
992 /** Device instance type for modbus devices. */
993 SR_INST_MODBUS,
994};
995
996/** Device instance status, struct sr_dev_inst.status */
997enum sr_dev_inst_status {
998 /** The device instance was not found. */
999 SR_ST_NOT_FOUND = 10000,
1000 /** The device instance was found, but is still booting. */
1001 SR_ST_INITIALIZING,
1002 /** The device instance is live, but not in use. */
1003 SR_ST_INACTIVE,
1004 /** The device instance is actively in use in a session. */
1005 SR_ST_ACTIVE,
1006 /** The device is winding down its session. */
1007 SR_ST_STOPPING,
1008};
1009
1010/** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1011struct sr_dev_driver {
1012 /* Driver-specific */
1013 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1014 char *name;
1015 /** Long name. Verbose driver name shown to user. */
1016 char *longname;
1017 /** API version (currently 1). */
1018 int api_version;
1019 /** Called when driver is loaded, e.g. program startup. */
1020 int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1021 /** Called before driver is unloaded.
1022 * Driver must free all resources held by it. */
1023 int (*cleanup) (const struct sr_dev_driver *driver);
1024 /** Scan for devices. Driver should do all initialisation required.
1025 * Can be called several times, e.g. with different port options.
1026 * \retval NULL Error or no devices found.
1027 * \retval other GSList of a struct sr_dev_inst for each device.
1028 * Must be freed by caller!
1029 */
1030 GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1031 /** Get list of device instances the driver knows about.
1032 * \returns NULL or GSList of a struct sr_dev_inst for each device.
1033 * Must not be freed by caller!
1034 */
1035 GSList *(*dev_list) (const struct sr_dev_driver *driver);
1036 /** Clear list of devices the driver knows about. */
1037 int (*dev_clear) (const struct sr_dev_driver *driver);
1038 /** Query value of a configuration key in driver or given device instance.
1039 * @see sr_config_get().
1040 */
1041 int (*config_get) (uint32_t key, GVariant **data,
1042 const struct sr_dev_inst *sdi,
1043 const struct sr_channel_group *cg);
1044 /** Set value of a configuration key in driver or a given device instance.
1045 * @see sr_config_set(). */
1046 int (*config_set) (uint32_t key, GVariant *data,
1047 const struct sr_dev_inst *sdi,
1048 const struct sr_channel_group *cg);
1049 /** Channel status change.
1050 * @see sr_dev_channel_enable(). */
1051 int (*config_channel_set) (const struct sr_dev_inst *sdi,
1052 struct sr_channel *ch, unsigned int changes);
1053 /** Apply configuration settings to the device hardware.
1054 * @see sr_config_commit().*/
1055 int (*config_commit) (const struct sr_dev_inst *sdi);
1056 /** List all possible values for a configuration key in a device instance.
1057 * @see sr_config_list().
1058 */
1059 int (*config_list) (uint32_t key, GVariant **data,
1060 const struct sr_dev_inst *sdi,
1061 const struct sr_channel_group *cg);
1062
1063 /* Device-specific */
1064 /** Open device */
1065 int (*dev_open) (struct sr_dev_inst *sdi);
1066 /** Close device */
1067 int (*dev_close) (struct sr_dev_inst *sdi);
1068 /** Begin data acquisition on the specified device. */
1069 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1070 void *cb_data);
1071 /** End data acquisition on the specified device. */
1072 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1073 void *cb_data);
1074
1075 /* Dynamic */
1076 /** Device driver private data. Initialized by init(). */
1077 void *priv;
1078};
1079
1080/**
1081 * @struct sr_session
1082 *
1083 * Opaque data structure representing a libsigrok session. None of the fields
1084 * of this structure are meant to be accessed directly.
1085 */
1086struct sr_session;
1087
1088/** Serial port descriptor. */
1089struct sr_serial_port {
1090 /** The OS dependent name of the serial port. */
1091 char *name;
1092 /** An end user friendly description for the serial port. */
1093 char *description;
1094};
1095
1096#include "proto.h"
1097#include "version.h"
1098
1099#ifdef __cplusplus
1100}
1101#endif
1102
1103#endif