]>
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, | |
801c7800 AG |
213 | /** |
214 | * Normalized (0 to 1) concentration of a substance or compound with 0 | |
215 | * representing a concentration of 0%, and 1 being 100%. This is | |
216 | * represented as the fraction of number of particles of the substance. | |
217 | */ | |
4f3bd685 | 218 | SR_UNIT_CONCENTRATION, |
aff5a729 BV |
219 | }; |
220 | ||
3c0839d5 | 221 | /** Values for sr_datafeed_analog.flags. */ |
02e864d0 | 222 | enum { |
3c0839d5 | 223 | /** Voltage measurement is alternating current (AC). */ |
02e864d0 | 224 | SR_MQFLAG_AC = 0x01, |
3c0839d5 | 225 | /** Voltage measurement is direct current (DC). */ |
02e864d0 BV |
226 | SR_MQFLAG_DC = 0x02, |
227 | /** This is a true RMS measurement. */ | |
228 | SR_MQFLAG_RMS = 0x04, | |
229 | /** Value is voltage drop across a diode, or NAN. */ | |
230 | SR_MQFLAG_DIODE = 0x08, | |
a02d77bc | 231 | /** Device is in "hold" mode (repeating the last measurement). */ |
02e864d0 | 232 | SR_MQFLAG_HOLD = 0x10, |
3c0839d5 | 233 | /** Device is in "max" mode, only updating upon a new max value. */ |
02e864d0 | 234 | SR_MQFLAG_MAX = 0x20, |
3c0839d5 | 235 | /** Device is in "min" mode, only updating upon a new min value. */ |
02e864d0 BV |
236 | SR_MQFLAG_MIN = 0x40, |
237 | /** Device is in autoranging mode. */ | |
238 | SR_MQFLAG_AUTORANGE = 0x80, | |
239 | /** Device is in relative mode. */ | |
240 | SR_MQFLAG_RELATIVE = 0x100, | |
fc19c288 | 241 | /** Sound pressure level is A-weighted in the frequency domain, |
2244356d | 242 | * according to IEC 61672:2003. */ |
fc19c288 BV |
243 | SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200, |
244 | /** Sound pressure level is C-weighted in the frequency domain, | |
2244356d | 245 | * according to IEC 61672:2003. */ |
fc19c288 BV |
246 | SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400, |
247 | /** Sound pressure level is Z-weighted (i.e. not at all) in the | |
2244356d | 248 | * frequency domain, according to IEC 61672:2003. */ |
fc19c288 BV |
249 | SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800, |
250 | /** Sound pressure level is not weighted in the frequency domain, | |
251 | * albeit without standards-defined low and high frequency limits. */ | |
252 | SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000, | |
253 | /** Sound pressure level measurement is S-weighted (1s) in the | |
254 | * time domain. */ | |
255 | SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000, | |
256 | /** Sound pressure level measurement is F-weighted (125ms) in the | |
257 | * time domain. */ | |
258 | SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000, | |
259 | /** Sound pressure level is time-averaged (LAT), also known as | |
260 | * Equivalent Continuous A-weighted Sound Level (LEQ). */ | |
261 | SR_MQFLAG_SPL_LAT = 0x8000, | |
262 | /** Sound pressure level represented as a percentage of measurements | |
263 | * that were over a preset alarm level. */ | |
264 | SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, | |
02e864d0 BV |
265 | }; |
266 | ||
b8072700 PS |
267 | struct sr_context; |
268 | ||
b9c735a2 | 269 | struct sr_datafeed_packet { |
a1bb33af | 270 | uint16_t type; |
bf53457d | 271 | const void *payload; |
a1bb33af UH |
272 | }; |
273 | ||
b9c735a2 | 274 | struct sr_datafeed_header { |
a1bb33af UH |
275 | int feed_version; |
276 | struct timeval starttime; | |
ee7489d2 BV |
277 | }; |
278 | ||
279 | struct sr_datafeed_meta_logic { | |
280 | int num_probes; | |
4c100f32 | 281 | uint64_t samplerate; |
a1bb33af UH |
282 | }; |
283 | ||
38ab3ee7 BV |
284 | struct sr_datafeed_logic { |
285 | uint64_t length; | |
286 | uint16_t unitsize; | |
9c939c51 | 287 | void *data; |
38ab3ee7 BV |
288 | }; |
289 | ||
ee7489d2 BV |
290 | struct sr_datafeed_meta_analog { |
291 | int num_probes; | |
292 | }; | |
293 | ||
294 | struct sr_datafeed_analog { | |
295 | int num_samples; | |
a02d77bc | 296 | /** Measured quantity (voltage, current, temperature, and so on). */ |
02e864d0 BV |
297 | int mq; |
298 | /** Unit in which the MQ is measured. */ | |
299 | int unit; | |
300 | /** Bitmap with extra information about the MQ. */ | |
301 | uint64_t mqflags; | |
3c0839d5 | 302 | /** The analog value. */ |
ee7489d2 BV |
303 | float *data; |
304 | }; | |
305 | ||
f50f3f40 UH |
306 | struct sr_input { |
307 | struct sr_input_format *format; | |
3dafb92b | 308 | GHashTable *param; |
5c3c1241 | 309 | struct sr_dev_inst *sdi; |
3dafb92b | 310 | void *internal; |
34e4813f BV |
311 | }; |
312 | ||
f50f3f40 | 313 | struct sr_input_format { |
cdb3573c | 314 | char *id; |
34e4813f | 315 | char *description; |
757b8c62 | 316 | int (*format_match) (const char *filename); |
f50f3f40 UH |
317 | int (*init) (struct sr_input *in); |
318 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
319 | }; |
320 | ||
f50f3f40 UH |
321 | struct sr_output { |
322 | struct sr_output_format *format; | |
5c3c1241 | 323 | struct sr_dev_inst *sdi; |
a1bb33af UH |
324 | char *param; |
325 | void *internal; | |
326 | }; | |
327 | ||
f50f3f40 | 328 | struct sr_output_format { |
cdb3573c | 329 | char *id; |
a1bb33af | 330 | char *description; |
f0411b1d | 331 | int df_type; |
f50f3f40 | 332 | int (*init) (struct sr_output *o); |
054e6709 UH |
333 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
334 | uint64_t length_in, uint8_t **data_out, | |
335 | uint64_t *length_out); | |
336 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
a1bb33af | 337 | uint64_t *length_out); |
f45b7590 | 338 | GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, |
bf53457d | 339 | const struct sr_datafeed_packet *packet); |
f45b7590 | 340 | int (*cleanup) (struct sr_output *o); |
a1bb33af UH |
341 | }; |
342 | ||
c4911129 | 343 | struct sr_datastore { |
3c0839d5 | 344 | /** Size in bytes of the number of units stored in this datastore. */ |
a1bb33af | 345 | int ds_unitsize; |
33247d6a | 346 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
347 | GSList *chunklist; |
348 | }; | |
349 | ||
a1bb33af UH |
350 | /* |
351 | * This represents a generic device connected to the system. | |
c09f0b57 UH |
352 | * For device-specific information, ask the driver. The driver_index refers |
353 | * to the device index within that driver; it may be handling more than one | |
354 | * device. All relevant driver calls take a dev_index parameter for this. | |
a1bb33af | 355 | */ |
bb7ef793 | 356 | struct sr_dev { |
3c0839d5 | 357 | /** Which driver handles this device. */ |
c09f0b57 | 358 | struct sr_dev_driver *driver; |
3c0839d5 | 359 | /** A driver may handle multiple devices of the same type. */ |
c09f0b57 | 360 | int driver_index; |
3c0839d5 | 361 | /** List of struct sr_probe pointers. */ |
a1bb33af | 362 | GSList *probes; |
3c0839d5 | 363 | /** Data acquired by this device, if any. */ |
c4911129 | 364 | struct sr_datastore *datastore; |
a1bb33af UH |
365 | }; |
366 | ||
921e753f | 367 | enum { |
24d04d1e | 368 | SR_PROBE_LOGIC = 10000, |
87ca93c5 | 369 | SR_PROBE_ANALOG, |
921e753f DR |
370 | }; |
371 | ||
1afe8989 | 372 | struct sr_probe { |
a1bb33af | 373 | int index; |
6ea7e235 | 374 | int type; |
a1bb33af UH |
375 | gboolean enabled; |
376 | char *name; | |
377 | char *trigger; | |
378 | }; | |
379 | ||
b159add3 BV |
380 | struct sr_hwopt { |
381 | int hwopt; | |
382 | const void *value; | |
383 | }; | |
384 | ||
3c0839d5 | 385 | /** Hardware driver options. */ |
b159add3 | 386 | enum { |
9c5332d2 UH |
387 | /** |
388 | * Some drivers cannot detect the exact model they're talking to | |
389 | * (may be phased out). | |
390 | */ | |
24d04d1e | 391 | SR_HWOPT_MODEL = 10000, |
b159add3 | 392 | |
9c5332d2 | 393 | /** |
a02d77bc UH |
394 | * Specification on how to connect to a device. |
395 | * | |
396 | * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in | |
397 | * the form which makes sense to the OS (e.g., /dev/ttyS0). | |
777bbd5b | 398 | * Otherwise this specifies a USB device, either in the form of |
a02d77bc UH |
399 | * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or |
400 | * @verbatim <vendorid>.<productid> @endverbatim | |
9c5332d2 UH |
401 | * (hexadecimal, e.g. 1d6b.0001). |
402 | */ | |
b159add3 BV |
403 | SR_HWOPT_CONN, |
404 | ||
9c5332d2 UH |
405 | /** |
406 | * Serial communication specification, in the form: | |
a02d77bc UH |
407 | * |
408 | * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim | |
409 | * | |
410 | * Example: 9600/8n1 | |
9c5332d2 | 411 | * |
777bbd5b | 412 | * This is always an optional parameter, since a driver typically |
9c5332d2 UH |
413 | * knows the speed at which the device wants to communicate. |
414 | */ | |
b159add3 BV |
415 | SR_HWOPT_SERIALCOMM, |
416 | }; | |
417 | ||
3c0839d5 | 418 | /** Hardware device capabilities. */ |
a1bb33af | 419 | enum { |
e88dadd7 UH |
420 | /*--- Device classes ------------------------------------------------*/ |
421 | ||
422 | /** The device can act as logic analyzer. */ | |
24d04d1e | 423 | SR_HWCAP_LOGIC_ANALYZER = 10000, |
925dbf9f | 424 | |
ee7489d2 BV |
425 | /** The device can act as an oscilloscope. */ |
426 | SR_HWCAP_OSCILLOSCOPE, | |
e88dadd7 | 427 | |
ca3d84cc BV |
428 | /** The device can act as a multimeter. */ |
429 | SR_HWCAP_MULTIMETER, | |
a141db8c | 430 | |
ca3d84cc | 431 | /** The device is a demo device. */ |
bb7ef793 | 432 | SR_HWCAP_DEMO_DEV, |
a141db8c | 433 | |
fc19c288 BV |
434 | /** The device can act as a sound level meter. */ |
435 | SR_HWCAP_SOUNDLEVELMETER, | |
ca3d84cc | 436 | |
40270444 BV |
437 | /** The device can measure temperature. */ |
438 | SR_HWCAP_THERMOMETER, | |
439 | ||
440 | /** The device can measure humidity. */ | |
441 | SR_HWCAP_HYGROMETER, | |
442 | ||
ca3d84cc | 443 | /*--- Device configuration ------------------------------------------*/ |
e88dadd7 UH |
444 | |
445 | /** The device supports setting/changing its samplerate. */ | |
24d04d1e | 446 | SR_HWCAP_SAMPLERATE = 20000, |
e88dadd7 | 447 | |
e88dadd7 UH |
448 | /** The device supports setting a pre/post-trigger capture ratio. */ |
449 | SR_HWCAP_CAPTURE_RATIO, | |
450 | ||
451 | /* TODO? */ | |
452 | /** The device supports setting a pattern (pattern generator mode). */ | |
453 | SR_HWCAP_PATTERN_MODE, | |
454 | ||
3a4d09c0 GM |
455 | /** The device supports Run Length Encoding. */ |
456 | SR_HWCAP_RLE, | |
457 | ||
ee7489d2 | 458 | /** The device supports setting trigger slope. */ |
0fe11789 BV |
459 | SR_HWCAP_TRIGGER_SLOPE, |
460 | ||
461 | /** Trigger source. */ | |
462 | SR_HWCAP_TRIGGER_SOURCE, | |
463 | ||
3c0839d5 | 464 | /** Horizontal trigger position. */ |
0fe11789 BV |
465 | SR_HWCAP_HORIZ_TRIGGERPOS, |
466 | ||
467 | /** Buffer size. */ | |
468 | SR_HWCAP_BUFFERSIZE, | |
469 | ||
470 | /** Time base. */ | |
471 | SR_HWCAP_TIMEBASE, | |
ee7489d2 | 472 | |
3c4976c9 BV |
473 | /** Filter. */ |
474 | SR_HWCAP_FILTER, | |
475 | ||
bd8db307 BV |
476 | /** Volts/div. */ |
477 | SR_HWCAP_VDIV, | |
478 | ||
e1c8b2ab BV |
479 | /** Coupling. */ |
480 | SR_HWCAP_COUPLING, | |
481 | ||
e88dadd7 UH |
482 | /*--- Special stuff -------------------------------------------------*/ |
483 | ||
3c0839d5 | 484 | /** Session filename. */ |
24d04d1e | 485 | SR_HWCAP_SESSIONFILE = 30000, |
40dda2c3 | 486 | |
e88dadd7 UH |
487 | /* TODO: Better description. */ |
488 | /** The device supports specifying a capturefile to inject. */ | |
489 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 490 | |
e88dadd7 UH |
491 | /* TODO: Better description. */ |
492 | /** The device supports specifying the capturefile unit size. */ | |
493 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 494 | |
e88dadd7 UH |
495 | /* TODO: Better description. */ |
496 | /** The device supports setting the number of probes. */ | |
497 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
498 | ||
499 | /*--- Acquisition modes ---------------------------------------------*/ | |
500 | ||
501 | /** | |
a02d77bc UH |
502 | * The device supports setting a sample time limit (how long |
503 | * the sample acquisition should run, in ms). | |
e88dadd7 | 504 | */ |
24d04d1e | 505 | SR_HWCAP_LIMIT_MSEC = 40000, |
e88dadd7 UH |
506 | |
507 | /** | |
a02d77bc UH |
508 | * The device supports setting a sample number limit (how many |
509 | * samples should be acquired). | |
e88dadd7 UH |
510 | */ |
511 | SR_HWCAP_LIMIT_SAMPLES, | |
512 | ||
6ea7669c | 513 | /** |
a02d77bc UH |
514 | * The device supports setting a frame limit (how many |
515 | * frames should be acquired). | |
6ea7669c BV |
516 | */ |
517 | SR_HWCAP_LIMIT_FRAMES, | |
518 | ||
e88dadd7 | 519 | /** |
a02d77bc | 520 | * The device supports continuous sampling. Neither a time limit |
e88dadd7 UH |
521 | * nor a sample number limit has to be supplied, it will just acquire |
522 | * samples continuously, until explicitly stopped by a certain command. | |
523 | */ | |
5a2326a7 | 524 | SR_HWCAP_CONTINUOUS, |
a1bb33af UH |
525 | }; |
526 | ||
a65de030 | 527 | struct sr_hwcap_option { |
ffedd0bf | 528 | int hwcap; |
a1bb33af UH |
529 | int type; |
530 | char *description; | |
531 | char *shortname; | |
532 | }; | |
533 | ||
d68e2d1a | 534 | struct sr_dev_inst { |
9e41fdba | 535 | struct sr_dev_driver *driver; |
a1bb33af UH |
536 | int index; |
537 | int status; | |
1d9a8a5f | 538 | int inst_type; |
a1bb33af UH |
539 | char *vendor; |
540 | char *model; | |
541 | char *version; | |
47211d65 | 542 | GSList *probes; |
8d672550 | 543 | void *priv; |
a1bb33af UH |
544 | }; |
545 | ||
3c0839d5 | 546 | /** Types of device instances (sr_dev_inst). */ |
a1bb33af | 547 | enum { |
4101f961 | 548 | /** Device instance type for USB devices. */ |
24d04d1e | 549 | SR_INST_USB = 10000, |
4101f961 UH |
550 | /** Device instance type for serial port devices. */ |
551 | SR_INST_SERIAL, | |
a1bb33af UH |
552 | }; |
553 | ||
3c0839d5 | 554 | /** Device instance status. */ |
a1bb33af | 555 | enum { |
3c0839d5 | 556 | /** The device instance was not found. */ |
24d04d1e | 557 | SR_ST_NOT_FOUND = 10000, |
3c0839d5 | 558 | /** The device instance was found, but is still booting. */ |
5a2326a7 | 559 | SR_ST_INITIALIZING, |
3c0839d5 | 560 | /** The device instance is live, but not in use. */ |
5a2326a7 | 561 | SR_ST_INACTIVE, |
3c0839d5 | 562 | /** The device instance is actively in use in a session. */ |
5a2326a7 | 563 | SR_ST_ACTIVE, |
69b07d14 BV |
564 | /** The device is winding down its session. */ |
565 | SR_ST_STOPPING, | |
a1bb33af UH |
566 | }; |
567 | ||
568 | /* | |
569 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
570 | * TODO: Need a DI to return the number of trigger stages supported. | |
571 | */ | |
572 | ||
3c0839d5 | 573 | /** Device info IDs. */ |
a1bb33af | 574 | enum { |
3c0839d5 | 575 | /** A list of options supported by the driver. */ |
24d04d1e | 576 | SR_DI_HWOPTS = 10000, |
3c0839d5 | 577 | /** A list of capabilities supported by the device. */ |
be34a1c7 | 578 | SR_DI_HWCAPS, |
3c0839d5 | 579 | /** The number of probes connected to this device. */ |
5a2326a7 | 580 | SR_DI_NUM_PROBES, |
3c0839d5 | 581 | /** The probe names on this device. */ |
464d12c7 | 582 | SR_DI_PROBE_NAMES, |
3c0839d5 | 583 | /** Samplerates supported by this device (struct sr_samplerates). */ |
5a2326a7 | 584 | SR_DI_SAMPLERATES, |
3c0839d5 | 585 | /** Types of logic trigger supported, out of "01crf" (char *). */ |
5a2326a7 | 586 | SR_DI_TRIGGER_TYPES, |
3c0839d5 | 587 | /** The currently set samplerate in Hz (uint64_t). */ |
5a2326a7 | 588 | SR_DI_CUR_SAMPLERATE, |
3c0839d5 | 589 | /** Supported patterns (in pattern generator mode). */ |
eb0a3731 | 590 | SR_DI_PATTERNS, |
3c0839d5 | 591 | /** Supported buffer sizes. */ |
0fe11789 | 592 | SR_DI_BUFFERSIZES, |
3c0839d5 | 593 | /** Supported time bases. */ |
0fe11789 | 594 | SR_DI_TIMEBASES, |
3c0839d5 | 595 | /** Supported trigger sources. */ |
0fe11789 | 596 | SR_DI_TRIGGER_SOURCES, |
3c0839d5 | 597 | /** Supported filter targets. */ |
3c4976c9 | 598 | SR_DI_FILTERS, |
3c0839d5 | 599 | /** Valid volts/div values. */ |
bd8db307 | 600 | SR_DI_VDIVS, |
3c0839d5 | 601 | /** Coupling options. */ |
e1c8b2ab | 602 | SR_DI_COUPLING, |
a1bb33af UH |
603 | }; |
604 | ||
1b452b85 UH |
605 | /* |
606 | * A device supports either a range of samplerates with steps of a given | |
607 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
608 | * step or list, but not both. |
609 | */ | |
60679b18 | 610 | struct sr_samplerates { |
a1bb33af UH |
611 | uint64_t low; |
612 | uint64_t high; | |
613 | uint64_t step; | |
a533743d | 614 | const uint64_t *list; |
a1bb33af UH |
615 | }; |
616 | ||
c09f0b57 UH |
617 | struct sr_dev_driver { |
618 | /* Driver-specific */ | |
a1bb33af | 619 | char *name; |
9f8274a5 | 620 | char *longname; |
a1bb33af | 621 | int api_version; |
34f06b90 | 622 | int (*init) (struct sr_context *sr_ctx); |
57ab7d9f | 623 | int (*cleanup) (void); |
80bf0426 | 624 | GSList *(*scan) (GSList *options); |
811deee4 BV |
625 | GSList *(*dev_list) (void); |
626 | int (*dev_clear) (void); | |
a1bb33af | 627 | |
1b452b85 | 628 | /* Device-specific */ |
25a0f108 BV |
629 | int (*dev_open) (struct sr_dev_inst *sdi); |
630 | int (*dev_close) (struct sr_dev_inst *sdi); | |
9e90dcba | 631 | int (*info_get) (int info_id, const void **data, |
f92f4eab | 632 | const struct sr_dev_inst *sdi); |
6f4b1868 BV |
633 | int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap, |
634 | const void *value); | |
3ffb6964 BV |
635 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, |
636 | void *cb_data); | |
69b07d14 | 637 | int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, |
3ffb6964 | 638 | void *cb_data); |
dd34b8d3 BV |
639 | |
640 | /* Dynamic */ | |
c259726a | 641 | void *priv; |
a1bb33af UH |
642 | }; |
643 | ||
2872d21e | 644 | struct sr_session { |
3c0839d5 | 645 | /** List of struct sr_dev pointers. */ |
bb7ef793 | 646 | GSList *devs; |
3c0839d5 | 647 | /** List of sr_receive_data_callback_t items. */ |
a1bb33af UH |
648 | GSList *datafeed_callbacks; |
649 | GTimeVal starttime; | |
b7e94111 LPC |
650 | |
651 | unsigned int num_sources; | |
652 | ||
3c0839d5 UH |
653 | /* |
654 | * Both "sources" and "pollfds" are of the same size and contain pairs | |
655 | * of descriptor and callback function. We can not embed the GPollFD | |
656 | * into the source struct since we want to be able to pass the array | |
657 | * of all poll descriptors to g_poll(). | |
b7e94111 LPC |
658 | */ |
659 | struct source *sources; | |
660 | GPollFD *pollfds; | |
661 | int source_timeout; | |
a1bb33af UH |
662 | }; |
663 | ||
45c59c8b BV |
664 | #include "proto.h" |
665 | #include "version.h" | |
c2bd92ec | 666 | |
a00b530c UH |
667 | #ifdef __cplusplus |
668 | } | |
669 | #endif | |
670 | ||
a1bb33af | 671 | #endif |