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