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