]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> |
a1bb33af UH |
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 | ||
0f8522bf UH |
20 | #ifndef LIBSIGROK_SIGROK_H |
21 | #define LIBSIGROK_SIGROK_H | |
a1bb33af UH |
22 | |
23 | #include <stdio.h> | |
24 | #include <sys/time.h> | |
25 | #include <stdint.h> | |
26 | #include <inttypes.h> | |
27 | #include <glib.h> | |
a1bb33af | 28 | |
a00b530c UH |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
393fb9cb UH |
33 | /** |
34 | * @file | |
35 | * | |
36 | * The public libsigrok header file to be used by frontends. | |
1f345a21 UH |
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 | |
393fb9cb UH |
47 | */ |
48 | ||
e31b636d | 49 | /* |
e31b636d UH |
50 | * All possible return codes of libsigrok functions must be listed here. |
51 | * Functions should never return hardcoded numbers as status, but rather | |
3c0839d5 | 52 | * use these enum values. All error codes are negative numbers. |
e31b636d UH |
53 | * |
54 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
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". | |
e31b636d UH |
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 | |
3c0839d5 | 61 | * or reused for different errors later. You can only add new entries and |
e31b636d UH |
62 | * return codes, but never remove or redefine existing ones. |
63 | */ | |
3c0839d5 UH |
64 | |
65 | /** Status/error codes returned by libsigrok functions. */ | |
66 | enum { | |
67 | SR_OK = 0, /**< No error. */ | |
68 | SR_ERR = -1, /**< Generic/unspecified error. */ | |
69 | SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */ | |
70 | SR_ERR_ARG = -3, /**< Function argument error. */ | |
71 | SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */ | |
72 | SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */ | |
73 | }; | |
a1bb33af | 74 | |
b2ff9506 BV |
75 | #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ |
76 | #define SR_MAX_PROBENAME_LEN 32 | |
2a3f9541 | 77 | |
a1bb33af | 78 | /* Handy little macros */ |
c9140419 | 79 | #define SR_HZ(n) (n) |
59df0c77 UH |
80 | #define SR_KHZ(n) ((n) * 1000) |
81 | #define SR_MHZ(n) ((n) * 1000000) | |
82 | #define SR_GHZ(n) ((n) * 1000000000) | |
a1bb33af | 83 | |
59df0c77 | 84 | #define SR_HZ_TO_NS(n) (1000000000 / (n)) |
3677f3ec | 85 | |
3c0839d5 UH |
86 | /** libsigrok loglevels. */ |
87 | enum { | |
88 | SR_LOG_NONE = 0, /**< Output no messages at all. */ | |
89 | SR_LOG_ERR = 1, /**< Output error messages. */ | |
90 | SR_LOG_WARN = 2, /**< Output warnings. */ | |
91 | SR_LOG_INFO = 3, /**< Output informational messages. */ | |
92 | SR_LOG_DBG = 4, /**< Output debug messages. */ | |
93 | SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */ | |
94 | }; | |
1352eedd | 95 | |
1a081ca6 UH |
96 | /* |
97 | * Use SR_API to mark public API symbols, and SR_PRIV for private symbols. | |
98 | * | |
99 | * Variables and functions marked 'static' are private already and don't | |
100 | * need SR_PRIV. However, functions which are not static (because they need | |
101 | * to be used in other libsigrok-internal files) but are also not meant to | |
102 | * be part of the public libsigrok API, must use SR_PRIV. | |
103 | * | |
104 | * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). | |
105 | * | |
69e70c23 UH |
106 | * This feature is not available on MinGW/Windows, as it is a feature of |
107 | * ELF files and MinGW/Windows uses PE files. | |
108 | * | |
1a081ca6 UH |
109 | * Details: http://gcc.gnu.org/wiki/Visibility |
110 | */ | |
111 | ||
112 | /* Marks public libsigrok API symbols. */ | |
69e70c23 | 113 | #ifndef _WIN32 |
1a081ca6 | 114 | #define SR_API __attribute__((visibility("default"))) |
69e70c23 UH |
115 | #else |
116 | #define SR_API | |
117 | #endif | |
1a081ca6 UH |
118 | |
119 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
69e70c23 | 120 | #ifndef _WIN32 |
1a081ca6 | 121 | #define SR_PRIV __attribute__((visibility("hidden"))) |
69e70c23 UH |
122 | #else |
123 | #define SR_PRIV | |
124 | #endif | |
1a081ca6 | 125 | |
1f9813eb | 126 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); |
882e2075 | 127 | |
3c0839d5 | 128 | /** Data types used by hardware drivers for dev_config_set(). */ |
a1bb33af | 129 | enum { |
24d04d1e | 130 | SR_T_UINT64 = 10000, |
5a2326a7 | 131 | SR_T_CHAR, |
4d436e71 | 132 | SR_T_BOOL, |
0fe11789 | 133 | SR_T_FLOAT, |
c1e48618 | 134 | SR_T_RATIONAL_PERIOD, |
bd8db307 | 135 | SR_T_RATIONAL_VOLT, |
45edd0b2 | 136 | SR_T_KEYVALUE, |
0fe11789 BV |
137 | }; |
138 | ||
3c0839d5 | 139 | /** Rational number data type, containing numerator and denominator values. */ |
0fe11789 | 140 | struct sr_rational { |
3c0839d5 | 141 | /** Numerator of the rational number. */ |
0fe11789 | 142 | uint64_t p; |
3c0839d5 | 143 | /** Denominator of the rational number. */ |
0fe11789 | 144 | uint64_t q; |
a1bb33af UH |
145 | }; |
146 | ||
3c0839d5 | 147 | /** Value for sr_datafeed_packet.type. */ |
a1bb33af | 148 | enum { |
24d04d1e | 149 | SR_DF_HEADER = 10000, |
5a2326a7 UH |
150 | SR_DF_END, |
151 | SR_DF_TRIGGER, | |
152 | SR_DF_LOGIC, | |
ee7489d2 BV |
153 | SR_DF_META_LOGIC, |
154 | SR_DF_ANALOG, | |
155 | SR_DF_META_ANALOG, | |
6ea7669c BV |
156 | SR_DF_FRAME_BEGIN, |
157 | SR_DF_FRAME_END, | |
a1bb33af UH |
158 | }; |
159 | ||
3c0839d5 | 160 | /** Values for sr_datafeed_analog.mq. */ |
9956f285 | 161 | enum { |
24d04d1e | 162 | SR_MQ_VOLTAGE = 10000, |
9956f285 UH |
163 | SR_MQ_CURRENT, |
164 | SR_MQ_RESISTANCE, | |
165 | SR_MQ_CAPACITANCE, | |
166 | SR_MQ_TEMPERATURE, | |
167 | SR_MQ_FREQUENCY, | |
168 | SR_MQ_DUTY_CYCLE, | |
64591be2 | 169 | SR_MQ_CONTINUITY, |
aa839a5c | 170 | SR_MQ_PULSE_WIDTH, |
96b3b3d5 | 171 | SR_MQ_CONDUCTANCE, |
3c0839d5 | 172 | /** Electrical power, usually in W, or dBm. */ |
b82a17d3 | 173 | SR_MQ_POWER, |
a02d77bc | 174 | /** Gain (a transistor's gain, or hFE, for example). */ |
b82a17d3 | 175 | SR_MQ_GAIN, |
fc19c288 BV |
176 | /** Logarithmic representation of sound pressure relative to a |
177 | * reference value. */ | |
178 | SR_MQ_SOUND_PRESSURE_LEVEL, | |
4f3bd685 | 179 | SR_MQ_CARBON_MONOXIDE, |
ef4344e7 | 180 | SR_MQ_RELATIVE_HUMIDITY, |
9956f285 UH |
181 | }; |
182 | ||
3c0839d5 | 183 | /** Values for sr_datafeed_analog.unit. */ |
aff5a729 | 184 | enum { |
24d04d1e | 185 | SR_UNIT_VOLT = 10000, |
9956f285 UH |
186 | SR_UNIT_AMPERE, |
187 | SR_UNIT_OHM, | |
188 | SR_UNIT_FARAD, | |
9956f285 | 189 | SR_UNIT_KELVIN, |
edb000eb BV |
190 | SR_UNIT_CELSIUS, |
191 | SR_UNIT_FAHRENHEIT, | |
9956f285 UH |
192 | SR_UNIT_HERTZ, |
193 | SR_UNIT_PERCENTAGE, | |
edb000eb | 194 | SR_UNIT_BOOLEAN, |
aa839a5c | 195 | SR_UNIT_SECOND, |
3c0839d5 | 196 | /** Unit of conductance, the inverse of resistance. */ |
96b3b3d5 | 197 | SR_UNIT_SIEMENS, |
3c0839d5 UH |
198 | /** |
199 | * An absolute measurement of power, in decibels, referenced to | |
200 | * 1 milliwatt (dBu). | |
201 | */ | |
b82a17d3 | 202 | SR_UNIT_DECIBEL_MW, |
6b869234 BV |
203 | /** Voltage in decibel, referenced to 1 volt (dBV). */ |
204 | SR_UNIT_DECIBEL_VOLT, | |
3c0839d5 UH |
205 | /** |
206 | * Measurements that intrinsically do not have units attached, such | |
6b869234 | 207 | * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is |
3c0839d5 UH |
208 | * a unitless quantity, for example. |
209 | */ | |
b82a17d3 | 210 | SR_UNIT_UNITLESS, |
fc19c288 BV |
211 | /** Sound pressure level relative so 20 micropascals. */ |
212 | SR_UNIT_DECIBEL_SPL, | |
4f3bd685 | 213 | SR_UNIT_CONCENTRATION, |
aff5a729 BV |
214 | }; |
215 | ||
3c0839d5 | 216 | /** Values for sr_datafeed_analog.flags. */ |
02e864d0 | 217 | enum { |
3c0839d5 | 218 | /** Voltage measurement is alternating current (AC). */ |
02e864d0 | 219 | SR_MQFLAG_AC = 0x01, |
3c0839d5 | 220 | /** Voltage measurement is direct current (DC). */ |
02e864d0 BV |
221 | SR_MQFLAG_DC = 0x02, |
222 | /** This is a true RMS measurement. */ | |
223 | SR_MQFLAG_RMS = 0x04, | |
224 | /** Value is voltage drop across a diode, or NAN. */ | |
225 | SR_MQFLAG_DIODE = 0x08, | |
a02d77bc | 226 | /** Device is in "hold" mode (repeating the last measurement). */ |
02e864d0 | 227 | SR_MQFLAG_HOLD = 0x10, |
3c0839d5 | 228 | /** Device is in "max" mode, only updating upon a new max value. */ |
02e864d0 | 229 | SR_MQFLAG_MAX = 0x20, |
3c0839d5 | 230 | /** Device is in "min" mode, only updating upon a new min value. */ |
02e864d0 BV |
231 | SR_MQFLAG_MIN = 0x40, |
232 | /** Device is in autoranging mode. */ | |
233 | SR_MQFLAG_AUTORANGE = 0x80, | |
234 | /** Device is in relative mode. */ | |
235 | SR_MQFLAG_RELATIVE = 0x100, | |
fc19c288 | 236 | /** Sound pressure level is A-weighted in the frequency domain, |
2244356d | 237 | * according to IEC 61672:2003. */ |
fc19c288 BV |
238 | SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200, |
239 | /** Sound pressure level is C-weighted in the frequency domain, | |
2244356d | 240 | * according to IEC 61672:2003. */ |
fc19c288 BV |
241 | SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400, |
242 | /** Sound pressure level is Z-weighted (i.e. not at all) in the | |
2244356d | 243 | * frequency domain, according to IEC 61672:2003. */ |
fc19c288 BV |
244 | SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800, |
245 | /** Sound pressure level is not weighted in the frequency domain, | |
246 | * albeit without standards-defined low and high frequency limits. */ | |
247 | SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000, | |
248 | /** Sound pressure level measurement is S-weighted (1s) in the | |
249 | * time domain. */ | |
250 | SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000, | |
251 | /** Sound pressure level measurement is F-weighted (125ms) in the | |
252 | * time domain. */ | |
253 | SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000, | |
254 | /** Sound pressure level is time-averaged (LAT), also known as | |
255 | * Equivalent Continuous A-weighted Sound Level (LEQ). */ | |
256 | SR_MQFLAG_SPL_LAT = 0x8000, | |
257 | /** Sound pressure level represented as a percentage of measurements | |
258 | * that were over a preset alarm level. */ | |
259 | SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, | |
02e864d0 BV |
260 | }; |
261 | ||
b8072700 PS |
262 | struct sr_context; |
263 | ||
b9c735a2 | 264 | struct sr_datafeed_packet { |
a1bb33af | 265 | uint16_t type; |
a1bb33af UH |
266 | void *payload; |
267 | }; | |
268 | ||
b9c735a2 | 269 | struct sr_datafeed_header { |
a1bb33af UH |
270 | int feed_version; |
271 | struct timeval starttime; | |
ee7489d2 BV |
272 | }; |
273 | ||
274 | struct sr_datafeed_meta_logic { | |
275 | int num_probes; | |
4c100f32 | 276 | uint64_t samplerate; |
a1bb33af UH |
277 | }; |
278 | ||
38ab3ee7 BV |
279 | struct sr_datafeed_logic { |
280 | uint64_t length; | |
281 | uint16_t unitsize; | |
9c939c51 | 282 | void *data; |
38ab3ee7 BV |
283 | }; |
284 | ||
ee7489d2 BV |
285 | struct sr_datafeed_meta_analog { |
286 | int num_probes; | |
287 | }; | |
288 | ||
289 | struct sr_datafeed_analog { | |
290 | int num_samples; | |
a02d77bc | 291 | /** Measured quantity (voltage, current, temperature, and so on). */ |
02e864d0 BV |
292 | int mq; |
293 | /** Unit in which the MQ is measured. */ | |
294 | int unit; | |
295 | /** Bitmap with extra information about the MQ. */ | |
296 | uint64_t mqflags; | |
3c0839d5 | 297 | /** The analog value. */ |
ee7489d2 BV |
298 | float *data; |
299 | }; | |
300 | ||
f50f3f40 UH |
301 | struct sr_input { |
302 | struct sr_input_format *format; | |
3dafb92b | 303 | GHashTable *param; |
5c3c1241 | 304 | struct sr_dev_inst *sdi; |
3dafb92b | 305 | void *internal; |
34e4813f BV |
306 | }; |
307 | ||
f50f3f40 | 308 | struct sr_input_format { |
cdb3573c | 309 | char *id; |
34e4813f | 310 | char *description; |
757b8c62 | 311 | int (*format_match) (const char *filename); |
f50f3f40 UH |
312 | int (*init) (struct sr_input *in); |
313 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
314 | }; |
315 | ||
f50f3f40 UH |
316 | struct sr_output { |
317 | struct sr_output_format *format; | |
5c3c1241 | 318 | struct sr_dev_inst *sdi; |
a1bb33af UH |
319 | char *param; |
320 | void *internal; | |
321 | }; | |
322 | ||
f50f3f40 | 323 | struct sr_output_format { |
cdb3573c | 324 | char *id; |
a1bb33af | 325 | char *description; |
f0411b1d | 326 | int df_type; |
f50f3f40 | 327 | int (*init) (struct sr_output *o); |
054e6709 UH |
328 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
329 | uint64_t length_in, uint8_t **data_out, | |
330 | uint64_t *length_out); | |
331 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
a1bb33af | 332 | uint64_t *length_out); |
f45b7590 BV |
333 | GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, |
334 | struct sr_datafeed_packet *packet); | |
335 | int (*cleanup) (struct sr_output *o); | |
a1bb33af UH |
336 | }; |
337 | ||
c4911129 | 338 | struct sr_datastore { |
3c0839d5 | 339 | /** Size in bytes of the number of units stored in this datastore. */ |
a1bb33af | 340 | int ds_unitsize; |
33247d6a | 341 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
342 | GSList *chunklist; |
343 | }; | |
344 | ||
a1bb33af UH |
345 | /* |
346 | * This represents a generic device connected to the system. | |
c09f0b57 UH |
347 | * For device-specific information, ask the driver. The driver_index refers |
348 | * to the device index within that driver; it may be handling more than one | |
349 | * device. All relevant driver calls take a dev_index parameter for this. | |
a1bb33af | 350 | */ |
bb7ef793 | 351 | struct sr_dev { |
3c0839d5 | 352 | /** Which driver handles this device. */ |
c09f0b57 | 353 | struct sr_dev_driver *driver; |
3c0839d5 | 354 | /** A driver may handle multiple devices of the same type. */ |
c09f0b57 | 355 | int driver_index; |
3c0839d5 | 356 | /** List of struct sr_probe pointers. */ |
a1bb33af | 357 | GSList *probes; |
3c0839d5 | 358 | /** Data acquired by this device, if any. */ |
c4911129 | 359 | struct sr_datastore *datastore; |
a1bb33af UH |
360 | }; |
361 | ||
921e753f | 362 | enum { |
24d04d1e | 363 | SR_PROBE_LOGIC = 10000, |
87ca93c5 | 364 | SR_PROBE_ANALOG, |
921e753f DR |
365 | }; |
366 | ||
1afe8989 | 367 | struct sr_probe { |
a1bb33af | 368 | int index; |
6ea7e235 | 369 | int type; |
a1bb33af UH |
370 | gboolean enabled; |
371 | char *name; | |
372 | char *trigger; | |
373 | }; | |
374 | ||
b159add3 BV |
375 | struct sr_hwopt { |
376 | int hwopt; | |
377 | const void *value; | |
378 | }; | |
379 | ||
3c0839d5 | 380 | /** Hardware driver options. */ |
b159add3 | 381 | enum { |
9c5332d2 UH |
382 | /** |
383 | * Some drivers cannot detect the exact model they're talking to | |
384 | * (may be phased out). | |
385 | */ | |
24d04d1e | 386 | SR_HWOPT_MODEL = 10000, |
b159add3 | 387 | |
9c5332d2 | 388 | /** |
a02d77bc UH |
389 | * Specification on how to connect to a device. |
390 | * | |
391 | * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in | |
392 | * the form which makes sense to the OS (e.g., /dev/ttyS0). | |
777bbd5b | 393 | * Otherwise this specifies a USB device, either in the form of |
a02d77bc UH |
394 | * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or |
395 | * @verbatim <vendorid>.<productid> @endverbatim | |
9c5332d2 UH |
396 | * (hexadecimal, e.g. 1d6b.0001). |
397 | */ | |
b159add3 BV |
398 | SR_HWOPT_CONN, |
399 | ||
9c5332d2 UH |
400 | /** |
401 | * Serial communication specification, in the form: | |
a02d77bc UH |
402 | * |
403 | * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim | |
404 | * | |
405 | * Example: 9600/8n1 | |
9c5332d2 | 406 | * |
777bbd5b | 407 | * This is always an optional parameter, since a driver typically |
9c5332d2 UH |
408 | * knows the speed at which the device wants to communicate. |
409 | */ | |
b159add3 BV |
410 | SR_HWOPT_SERIALCOMM, |
411 | }; | |
412 | ||
3c0839d5 | 413 | /** Hardware device capabilities. */ |
a1bb33af | 414 | enum { |
e88dadd7 UH |
415 | /*--- Device classes ------------------------------------------------*/ |
416 | ||
417 | /** The device can act as logic analyzer. */ | |
24d04d1e | 418 | SR_HWCAP_LOGIC_ANALYZER = 10000, |
925dbf9f | 419 | |
ee7489d2 BV |
420 | /** The device can act as an oscilloscope. */ |
421 | SR_HWCAP_OSCILLOSCOPE, | |
e88dadd7 | 422 | |
ca3d84cc BV |
423 | /** The device can act as a multimeter. */ |
424 | SR_HWCAP_MULTIMETER, | |
a141db8c | 425 | |
ca3d84cc | 426 | /** The device is a demo device. */ |
bb7ef793 | 427 | SR_HWCAP_DEMO_DEV, |
a141db8c | 428 | |
fc19c288 BV |
429 | /** The device can act as a sound level meter. */ |
430 | SR_HWCAP_SOUNDLEVELMETER, | |
ca3d84cc | 431 | |
40270444 BV |
432 | /** The device can measure temperature. */ |
433 | SR_HWCAP_THERMOMETER, | |
434 | ||
435 | /** The device can measure humidity. */ | |
436 | SR_HWCAP_HYGROMETER, | |
437 | ||
ca3d84cc | 438 | /*--- Device configuration ------------------------------------------*/ |
e88dadd7 UH |
439 | |
440 | /** The device supports setting/changing its samplerate. */ | |
24d04d1e | 441 | SR_HWCAP_SAMPLERATE = 20000, |
e88dadd7 | 442 | |
e88dadd7 UH |
443 | /** The device supports setting a pre/post-trigger capture ratio. */ |
444 | SR_HWCAP_CAPTURE_RATIO, | |
445 | ||
446 | /* TODO? */ | |
447 | /** The device supports setting a pattern (pattern generator mode). */ | |
448 | SR_HWCAP_PATTERN_MODE, | |
449 | ||
3a4d09c0 GM |
450 | /** The device supports Run Length Encoding. */ |
451 | SR_HWCAP_RLE, | |
452 | ||
ee7489d2 | 453 | /** The device supports setting trigger slope. */ |
0fe11789 BV |
454 | SR_HWCAP_TRIGGER_SLOPE, |
455 | ||
456 | /** Trigger source. */ | |
457 | SR_HWCAP_TRIGGER_SOURCE, | |
458 | ||
3c0839d5 | 459 | /** Horizontal trigger position. */ |
0fe11789 BV |
460 | SR_HWCAP_HORIZ_TRIGGERPOS, |
461 | ||
462 | /** Buffer size. */ | |
463 | SR_HWCAP_BUFFERSIZE, | |
464 | ||
465 | /** Time base. */ | |
466 | SR_HWCAP_TIMEBASE, | |
ee7489d2 | 467 | |
3c4976c9 BV |
468 | /** Filter. */ |
469 | SR_HWCAP_FILTER, | |
470 | ||
bd8db307 BV |
471 | /** Volts/div. */ |
472 | SR_HWCAP_VDIV, | |
473 | ||
e1c8b2ab BV |
474 | /** Coupling. */ |
475 | SR_HWCAP_COUPLING, | |
476 | ||
e88dadd7 UH |
477 | /*--- Special stuff -------------------------------------------------*/ |
478 | ||
3c0839d5 | 479 | /** Session filename. */ |
24d04d1e | 480 | SR_HWCAP_SESSIONFILE = 30000, |
40dda2c3 | 481 | |
e88dadd7 UH |
482 | /* TODO: Better description. */ |
483 | /** The device supports specifying a capturefile to inject. */ | |
484 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 485 | |
e88dadd7 UH |
486 | /* TODO: Better description. */ |
487 | /** The device supports specifying the capturefile unit size. */ | |
488 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 489 | |
e88dadd7 UH |
490 | /* TODO: Better description. */ |
491 | /** The device supports setting the number of probes. */ | |
492 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
493 | ||
494 | /*--- Acquisition modes ---------------------------------------------*/ | |
495 | ||
496 | /** | |
a02d77bc UH |
497 | * The device supports setting a sample time limit (how long |
498 | * the sample acquisition should run, in ms). | |
e88dadd7 | 499 | */ |
24d04d1e | 500 | SR_HWCAP_LIMIT_MSEC = 40000, |
e88dadd7 UH |
501 | |
502 | /** | |
a02d77bc UH |
503 | * The device supports setting a sample number limit (how many |
504 | * samples should be acquired). | |
e88dadd7 UH |
505 | */ |
506 | SR_HWCAP_LIMIT_SAMPLES, | |
507 | ||
6ea7669c | 508 | /** |
a02d77bc UH |
509 | * The device supports setting a frame limit (how many |
510 | * frames should be acquired). | |
6ea7669c BV |
511 | */ |
512 | SR_HWCAP_LIMIT_FRAMES, | |
513 | ||
e88dadd7 | 514 | /** |
a02d77bc | 515 | * The device supports continuous sampling. Neither a time limit |
e88dadd7 UH |
516 | * nor a sample number limit has to be supplied, it will just acquire |
517 | * samples continuously, until explicitly stopped by a certain command. | |
518 | */ | |
5a2326a7 | 519 | SR_HWCAP_CONTINUOUS, |
a1bb33af UH |
520 | }; |
521 | ||
a65de030 | 522 | struct sr_hwcap_option { |
ffedd0bf | 523 | int hwcap; |
a1bb33af UH |
524 | int type; |
525 | char *description; | |
526 | char *shortname; | |
527 | }; | |
528 | ||
d68e2d1a | 529 | struct sr_dev_inst { |
9e41fdba | 530 | struct sr_dev_driver *driver; |
a1bb33af UH |
531 | int index; |
532 | int status; | |
1d9a8a5f | 533 | int inst_type; |
a1bb33af UH |
534 | char *vendor; |
535 | char *model; | |
536 | char *version; | |
47211d65 | 537 | GSList *probes; |
8d672550 | 538 | void *priv; |
a1bb33af UH |
539 | }; |
540 | ||
3c0839d5 | 541 | /** Types of device instances (sr_dev_inst). */ |
a1bb33af | 542 | enum { |
4101f961 | 543 | /** Device instance type for USB devices. */ |
24d04d1e | 544 | SR_INST_USB = 10000, |
4101f961 UH |
545 | /** Device instance type for serial port devices. */ |
546 | SR_INST_SERIAL, | |
a1bb33af UH |
547 | }; |
548 | ||
3c0839d5 | 549 | /** Device instance status. */ |
a1bb33af | 550 | enum { |
3c0839d5 | 551 | /** The device instance was not found. */ |
24d04d1e | 552 | SR_ST_NOT_FOUND = 10000, |
3c0839d5 | 553 | /** The device instance was found, but is still booting. */ |
5a2326a7 | 554 | SR_ST_INITIALIZING, |
3c0839d5 | 555 | /** The device instance is live, but not in use. */ |
5a2326a7 | 556 | SR_ST_INACTIVE, |
3c0839d5 | 557 | /** The device instance is actively in use in a session. */ |
5a2326a7 | 558 | SR_ST_ACTIVE, |
69b07d14 BV |
559 | /** The device is winding down its session. */ |
560 | SR_ST_STOPPING, | |
a1bb33af UH |
561 | }; |
562 | ||
563 | /* | |
564 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
565 | * TODO: Need a DI to return the number of trigger stages supported. | |
566 | */ | |
567 | ||
3c0839d5 | 568 | /** Device info IDs. */ |
a1bb33af | 569 | enum { |
3c0839d5 | 570 | /** A list of options supported by the driver. */ |
24d04d1e | 571 | SR_DI_HWOPTS = 10000, |
3c0839d5 | 572 | /** A list of capabilities supported by the device. */ |
be34a1c7 | 573 | SR_DI_HWCAPS, |
3c0839d5 | 574 | /** The number of probes connected to this device. */ |
5a2326a7 | 575 | SR_DI_NUM_PROBES, |
3c0839d5 | 576 | /** The probe names on this device. */ |
464d12c7 | 577 | SR_DI_PROBE_NAMES, |
3c0839d5 | 578 | /** Samplerates supported by this device (struct sr_samplerates). */ |
5a2326a7 | 579 | SR_DI_SAMPLERATES, |
3c0839d5 | 580 | /** Types of logic trigger supported, out of "01crf" (char *). */ |
5a2326a7 | 581 | SR_DI_TRIGGER_TYPES, |
3c0839d5 | 582 | /** The currently set samplerate in Hz (uint64_t). */ |
5a2326a7 | 583 | SR_DI_CUR_SAMPLERATE, |
3c0839d5 | 584 | /** Supported patterns (in pattern generator mode). */ |
eb0a3731 | 585 | SR_DI_PATTERNS, |
3c0839d5 | 586 | /** Supported buffer sizes. */ |
0fe11789 | 587 | SR_DI_BUFFERSIZES, |
3c0839d5 | 588 | /** Supported time bases. */ |
0fe11789 | 589 | SR_DI_TIMEBASES, |
3c0839d5 | 590 | /** Supported trigger sources. */ |
0fe11789 | 591 | SR_DI_TRIGGER_SOURCES, |
3c0839d5 | 592 | /** Supported filter targets. */ |
3c4976c9 | 593 | SR_DI_FILTERS, |
3c0839d5 | 594 | /** Valid volts/div values. */ |
bd8db307 | 595 | SR_DI_VDIVS, |
3c0839d5 | 596 | /** Coupling options. */ |
e1c8b2ab | 597 | SR_DI_COUPLING, |
a1bb33af UH |
598 | }; |
599 | ||
1b452b85 UH |
600 | /* |
601 | * A device supports either a range of samplerates with steps of a given | |
602 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
603 | * step or list, but not both. |
604 | */ | |
60679b18 | 605 | struct sr_samplerates { |
a1bb33af UH |
606 | uint64_t low; |
607 | uint64_t high; | |
608 | uint64_t step; | |
a533743d | 609 | const uint64_t *list; |
a1bb33af UH |
610 | }; |
611 | ||
c09f0b57 UH |
612 | struct sr_dev_driver { |
613 | /* Driver-specific */ | |
a1bb33af | 614 | char *name; |
9f8274a5 | 615 | char *longname; |
a1bb33af | 616 | int api_version; |
34f06b90 | 617 | int (*init) (struct sr_context *sr_ctx); |
57ab7d9f | 618 | int (*cleanup) (void); |
80bf0426 | 619 | GSList *(*scan) (GSList *options); |
811deee4 BV |
620 | GSList *(*dev_list) (void); |
621 | int (*dev_clear) (void); | |
a1bb33af | 622 | |
1b452b85 | 623 | /* Device-specific */ |
25a0f108 BV |
624 | int (*dev_open) (struct sr_dev_inst *sdi); |
625 | int (*dev_close) (struct sr_dev_inst *sdi); | |
9e90dcba | 626 | int (*info_get) (int info_id, const void **data, |
f92f4eab | 627 | const struct sr_dev_inst *sdi); |
6f4b1868 BV |
628 | int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap, |
629 | const void *value); | |
3ffb6964 BV |
630 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, |
631 | void *cb_data); | |
69b07d14 | 632 | int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, |
3ffb6964 | 633 | void *cb_data); |
dd34b8d3 BV |
634 | |
635 | /* Dynamic */ | |
c259726a | 636 | void *priv; |
a1bb33af UH |
637 | }; |
638 | ||
2872d21e | 639 | struct sr_session { |
3c0839d5 | 640 | /** List of struct sr_dev pointers. */ |
bb7ef793 | 641 | GSList *devs; |
3c0839d5 | 642 | /** List of sr_receive_data_callback_t items. */ |
a1bb33af UH |
643 | GSList *datafeed_callbacks; |
644 | GTimeVal starttime; | |
b7e94111 LPC |
645 | |
646 | unsigned int num_sources; | |
647 | ||
3c0839d5 UH |
648 | /* |
649 | * Both "sources" and "pollfds" are of the same size and contain pairs | |
650 | * of descriptor and callback function. We can not embed the GPollFD | |
651 | * into the source struct since we want to be able to pass the array | |
652 | * of all poll descriptors to g_poll(). | |
b7e94111 LPC |
653 | */ |
654 | struct source *sources; | |
655 | GPollFD *pollfds; | |
656 | int source_timeout; | |
a1bb33af UH |
657 | }; |
658 | ||
45c59c8b BV |
659 | #include "proto.h" |
660 | #include "version.h" | |
c2bd92ec | 661 | |
a00b530c UH |
662 | #ifdef __cplusplus |
663 | } | |
664 | #endif | |
665 | ||
a1bb33af | 666 | #endif |