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