]>
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 | ||
e31b636d UH |
33 | /* |
34 | * Status/error codes returned by libsigrok functions. | |
35 | * | |
36 | * All possible return codes of libsigrok functions must be listed here. | |
37 | * Functions should never return hardcoded numbers as status, but rather | |
38 | * use these #defines instead. All error codes are negative numbers. | |
39 | * | |
40 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
41 | * libsigrok functions returns a "malloc error" it must be exactly the same |
42 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
43 | * There must be no functions which indicate two different errors via the |
44 | * same return code. | |
45 | * | |
46 | * Also, for compatibility reasons, no defined return codes are ever removed | |
47 | * or reused for different #defines later. You can only add new #defines and | |
48 | * return codes, but never remove or redefine existing ones. | |
49 | */ | |
e46b8fb1 UH |
50 | #define SR_OK 0 /* No error */ |
51 | #define SR_ERR -1 /* Generic/unspecified error */ | |
52 | #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ | |
f7d2982d | 53 | #define SR_ERR_ARG -3 /* Function argument error */ |
e0508e67 UH |
54 | #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ |
55 | #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ | |
a1bb33af | 56 | |
b2ff9506 BV |
57 | #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ |
58 | #define SR_MAX_PROBENAME_LEN 32 | |
2a3f9541 | 59 | |
a1bb33af | 60 | /* Handy little macros */ |
c9140419 | 61 | #define SR_HZ(n) (n) |
59df0c77 UH |
62 | #define SR_KHZ(n) ((n) * 1000) |
63 | #define SR_MHZ(n) ((n) * 1000000) | |
64 | #define SR_GHZ(n) ((n) * 1000000000) | |
a1bb33af | 65 | |
59df0c77 | 66 | #define SR_HZ_TO_NS(n) (1000000000 / (n)) |
3677f3ec | 67 | |
1352eedd | 68 | /* libsigrok loglevels. */ |
44dae539 | 69 | #define SR_LOG_NONE 0 /**< Output no messages at all. */ |
b2ff9506 | 70 | #define SR_LOG_ERR 1 /**< Output error messages. */ |
44dae539 UH |
71 | #define SR_LOG_WARN 2 /**< Output warnings. */ |
72 | #define SR_LOG_INFO 3 /**< Output informational messages. */ | |
b2ff9506 | 73 | #define SR_LOG_DBG 4 /**< Output debug messages. */ |
44dae539 | 74 | #define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */ |
1352eedd | 75 | |
1a081ca6 UH |
76 | /* |
77 | * Use SR_API to mark public API symbols, and SR_PRIV for private symbols. | |
78 | * | |
79 | * Variables and functions marked 'static' are private already and don't | |
80 | * need SR_PRIV. However, functions which are not static (because they need | |
81 | * to be used in other libsigrok-internal files) but are also not meant to | |
82 | * be part of the public libsigrok API, must use SR_PRIV. | |
83 | * | |
84 | * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). | |
85 | * | |
69e70c23 UH |
86 | * This feature is not available on MinGW/Windows, as it is a feature of |
87 | * ELF files and MinGW/Windows uses PE files. | |
88 | * | |
1a081ca6 UH |
89 | * Details: http://gcc.gnu.org/wiki/Visibility |
90 | */ | |
91 | ||
92 | /* Marks public libsigrok API symbols. */ | |
69e70c23 | 93 | #ifndef _WIN32 |
1a081ca6 | 94 | #define SR_API __attribute__((visibility("default"))) |
69e70c23 UH |
95 | #else |
96 | #define SR_API | |
97 | #endif | |
1a081ca6 UH |
98 | |
99 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
69e70c23 | 100 | #ifndef _WIN32 |
1a081ca6 | 101 | #define SR_PRIV __attribute__((visibility("hidden"))) |
69e70c23 UH |
102 | #else |
103 | #define SR_PRIV | |
104 | #endif | |
1a081ca6 | 105 | |
1f9813eb | 106 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); |
882e2075 | 107 | |
c09f0b57 | 108 | /* Data types used by hardware drivers for dev_config_set() */ |
a1bb33af | 109 | enum { |
5a2326a7 UH |
110 | SR_T_UINT64, |
111 | SR_T_CHAR, | |
4d436e71 | 112 | SR_T_BOOL, |
0fe11789 | 113 | SR_T_FLOAT, |
c1e48618 | 114 | SR_T_RATIONAL_PERIOD, |
bd8db307 | 115 | SR_T_RATIONAL_VOLT, |
45edd0b2 | 116 | SR_T_KEYVALUE, |
0fe11789 BV |
117 | }; |
118 | ||
119 | struct sr_rational { | |
120 | /* numerator */ | |
121 | uint64_t p; | |
122 | /* denominator */ | |
123 | uint64_t q; | |
a1bb33af UH |
124 | }; |
125 | ||
b9c735a2 | 126 | /* sr_datafeed_packet.type values */ |
a1bb33af | 127 | enum { |
5a2326a7 UH |
128 | SR_DF_HEADER, |
129 | SR_DF_END, | |
130 | SR_DF_TRIGGER, | |
131 | SR_DF_LOGIC, | |
ee7489d2 BV |
132 | SR_DF_META_LOGIC, |
133 | SR_DF_ANALOG, | |
134 | SR_DF_META_ANALOG, | |
6ea7669c BV |
135 | SR_DF_FRAME_BEGIN, |
136 | SR_DF_FRAME_END, | |
a1bb33af UH |
137 | }; |
138 | ||
9956f285 UH |
139 | /* sr_datafeed_analog.mq values */ |
140 | enum { | |
141 | SR_MQ_VOLTAGE, | |
142 | SR_MQ_CURRENT, | |
143 | SR_MQ_RESISTANCE, | |
144 | SR_MQ_CAPACITANCE, | |
145 | SR_MQ_TEMPERATURE, | |
146 | SR_MQ_FREQUENCY, | |
147 | SR_MQ_DUTY_CYCLE, | |
64591be2 | 148 | SR_MQ_CONTINUITY, |
9956f285 UH |
149 | }; |
150 | ||
aff5a729 BV |
151 | /* sr_datafeed_analog.unit values */ |
152 | enum { | |
9956f285 UH |
153 | SR_UNIT_VOLT, |
154 | SR_UNIT_AMPERE, | |
155 | SR_UNIT_OHM, | |
156 | SR_UNIT_FARAD, | |
9956f285 | 157 | SR_UNIT_KELVIN, |
edb000eb BV |
158 | SR_UNIT_CELSIUS, |
159 | SR_UNIT_FAHRENHEIT, | |
9956f285 UH |
160 | SR_UNIT_HERTZ, |
161 | SR_UNIT_PERCENTAGE, | |
edb000eb | 162 | SR_UNIT_BOOLEAN, |
aff5a729 BV |
163 | }; |
164 | ||
02e864d0 BV |
165 | /** sr_datafeed_analog.flags values */ |
166 | enum { | |
167 | /** Voltage measurement is alternating current. */ | |
168 | SR_MQFLAG_AC = 0x01, | |
169 | /** Voltage measurement is direct current. */ | |
170 | SR_MQFLAG_DC = 0x02, | |
171 | /** This is a true RMS measurement. */ | |
172 | SR_MQFLAG_RMS = 0x04, | |
173 | /** Value is voltage drop across a diode, or NAN. */ | |
174 | SR_MQFLAG_DIODE = 0x08, | |
175 | /** Device is in "hold" mode, i.e. repeating the last measurement. */ | |
176 | SR_MQFLAG_HOLD = 0x10, | |
177 | /** Device is in "max" mode, only updating when a new max value is found. */ | |
178 | SR_MQFLAG_MAX = 0x20, | |
179 | /** Device is in "min" mode, only updating when a new min value is found. */ | |
180 | SR_MQFLAG_MIN = 0x40, | |
181 | /** Device is in autoranging mode. */ | |
182 | SR_MQFLAG_AUTORANGE = 0x80, | |
183 | /** Device is in relative mode. */ | |
184 | SR_MQFLAG_RELATIVE = 0x100, | |
185 | }; | |
186 | ||
b9c735a2 | 187 | struct sr_datafeed_packet { |
a1bb33af | 188 | uint16_t type; |
a1bb33af UH |
189 | void *payload; |
190 | }; | |
191 | ||
b9c735a2 | 192 | struct sr_datafeed_header { |
a1bb33af UH |
193 | int feed_version; |
194 | struct timeval starttime; | |
ee7489d2 BV |
195 | }; |
196 | ||
197 | struct sr_datafeed_meta_logic { | |
198 | int num_probes; | |
4c100f32 | 199 | uint64_t samplerate; |
a1bb33af UH |
200 | }; |
201 | ||
38ab3ee7 BV |
202 | struct sr_datafeed_logic { |
203 | uint64_t length; | |
204 | uint16_t unitsize; | |
9c939c51 | 205 | void *data; |
38ab3ee7 BV |
206 | }; |
207 | ||
ee7489d2 BV |
208 | struct sr_datafeed_meta_analog { |
209 | int num_probes; | |
210 | }; | |
211 | ||
212 | struct sr_datafeed_analog { | |
213 | int num_samples; | |
02e864d0 BV |
214 | /** Measured quantity (e.g. voltage, current, temperature) */ |
215 | int mq; | |
216 | /** Unit in which the MQ is measured. */ | |
217 | int unit; | |
218 | /** Bitmap with extra information about the MQ. */ | |
219 | uint64_t mqflags; | |
ee7489d2 BV |
220 | float *data; |
221 | }; | |
222 | ||
f50f3f40 UH |
223 | struct sr_input { |
224 | struct sr_input_format *format; | |
3dafb92b | 225 | GHashTable *param; |
5c3c1241 | 226 | struct sr_dev_inst *sdi; |
3dafb92b | 227 | void *internal; |
34e4813f BV |
228 | }; |
229 | ||
f50f3f40 | 230 | struct sr_input_format { |
cdb3573c | 231 | char *id; |
34e4813f | 232 | char *description; |
757b8c62 | 233 | int (*format_match) (const char *filename); |
f50f3f40 UH |
234 | int (*init) (struct sr_input *in); |
235 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
236 | }; |
237 | ||
f50f3f40 UH |
238 | struct sr_output { |
239 | struct sr_output_format *format; | |
5c3c1241 | 240 | struct sr_dev_inst *sdi; |
a1bb33af UH |
241 | char *param; |
242 | void *internal; | |
243 | }; | |
244 | ||
f50f3f40 | 245 | struct sr_output_format { |
cdb3573c | 246 | char *id; |
a1bb33af | 247 | char *description; |
f0411b1d | 248 | int df_type; |
f50f3f40 | 249 | int (*init) (struct sr_output *o); |
054e6709 UH |
250 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
251 | uint64_t length_in, uint8_t **data_out, | |
252 | uint64_t *length_out); | |
253 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
a1bb33af | 254 | uint64_t *length_out); |
f45b7590 BV |
255 | GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, |
256 | struct sr_datafeed_packet *packet); | |
257 | int (*cleanup) (struct sr_output *o); | |
a1bb33af UH |
258 | }; |
259 | ||
c4911129 | 260 | struct sr_datastore { |
a1bb33af UH |
261 | /* Size in bytes of the number of units stored in this datastore */ |
262 | int ds_unitsize; | |
33247d6a | 263 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
264 | GSList *chunklist; |
265 | }; | |
266 | ||
a1bb33af UH |
267 | /* |
268 | * This represents a generic device connected to the system. | |
c09f0b57 UH |
269 | * For device-specific information, ask the driver. The driver_index refers |
270 | * to the device index within that driver; it may be handling more than one | |
271 | * device. All relevant driver calls take a dev_index parameter for this. | |
a1bb33af | 272 | */ |
bb7ef793 | 273 | struct sr_dev { |
c09f0b57 UH |
274 | /* Which driver handles this device */ |
275 | struct sr_dev_driver *driver; | |
276 | /* A driver may handle multiple devices of the same type */ | |
277 | int driver_index; | |
1afe8989 | 278 | /* List of struct sr_probe* */ |
a1bb33af UH |
279 | GSList *probes; |
280 | /* Data acquired by this device, if any */ | |
c4911129 | 281 | struct sr_datastore *datastore; |
a1bb33af UH |
282 | }; |
283 | ||
921e753f | 284 | enum { |
47211d65 | 285 | SR_PROBE_LOGIC, |
87ca93c5 | 286 | SR_PROBE_ANALOG, |
921e753f DR |
287 | }; |
288 | ||
1afe8989 | 289 | struct sr_probe { |
a1bb33af | 290 | int index; |
6ea7e235 | 291 | int type; |
a1bb33af UH |
292 | gboolean enabled; |
293 | char *name; | |
294 | char *trigger; | |
295 | }; | |
296 | ||
b159add3 BV |
297 | struct sr_hwopt { |
298 | int hwopt; | |
299 | const void *value; | |
300 | }; | |
301 | ||
302 | /* Hardware driver options */ | |
303 | enum { | |
8bfdc8c4 BV |
304 | SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */ |
305 | ||
b159add3 BV |
306 | /** Some drivers cannot detect the exact model they're talking to. */ |
307 | SR_HWOPT_MODEL, | |
308 | ||
309 | /** Specification on how to connect to a device */ | |
310 | SR_HWOPT_CONN, | |
311 | ||
312 | /** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */ | |
313 | SR_HWOPT_SERIALCOMM, | |
314 | }; | |
315 | ||
316 | /* Hardware device capabilities */ | |
a1bb33af | 317 | enum { |
fb93625d | 318 | SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ |
e88dadd7 UH |
319 | |
320 | /*--- Device classes ------------------------------------------------*/ | |
321 | ||
322 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 323 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 324 | |
ee7489d2 BV |
325 | /** The device can act as an oscilloscope. */ |
326 | SR_HWCAP_OSCILLOSCOPE, | |
e88dadd7 | 327 | |
ca3d84cc BV |
328 | /** The device can act as a multimeter. */ |
329 | SR_HWCAP_MULTIMETER, | |
a141db8c | 330 | |
ca3d84cc | 331 | /** The device is a demo device. */ |
bb7ef793 | 332 | SR_HWCAP_DEMO_DEV, |
a141db8c | 333 | |
ca3d84cc | 334 | |
ca3d84cc | 335 | /*--- Device configuration ------------------------------------------*/ |
e88dadd7 UH |
336 | |
337 | /** The device supports setting/changing its samplerate. */ | |
338 | SR_HWCAP_SAMPLERATE, | |
339 | ||
e88dadd7 UH |
340 | /** The device supports setting a pre/post-trigger capture ratio. */ |
341 | SR_HWCAP_CAPTURE_RATIO, | |
342 | ||
343 | /* TODO? */ | |
344 | /** The device supports setting a pattern (pattern generator mode). */ | |
345 | SR_HWCAP_PATTERN_MODE, | |
346 | ||
3a4d09c0 GM |
347 | /** The device supports Run Length Encoding. */ |
348 | SR_HWCAP_RLE, | |
349 | ||
ee7489d2 | 350 | /** The device supports setting trigger slope. */ |
0fe11789 BV |
351 | SR_HWCAP_TRIGGER_SLOPE, |
352 | ||
353 | /** Trigger source. */ | |
354 | SR_HWCAP_TRIGGER_SOURCE, | |
355 | ||
356 | /** Horizontal trigger position */ | |
357 | SR_HWCAP_HORIZ_TRIGGERPOS, | |
358 | ||
359 | /** Buffer size. */ | |
360 | SR_HWCAP_BUFFERSIZE, | |
361 | ||
362 | /** Time base. */ | |
363 | SR_HWCAP_TIMEBASE, | |
ee7489d2 | 364 | |
3c4976c9 BV |
365 | /** Filter. */ |
366 | SR_HWCAP_FILTER, | |
367 | ||
bd8db307 BV |
368 | /** Volts/div. */ |
369 | SR_HWCAP_VDIV, | |
370 | ||
e1c8b2ab BV |
371 | /** Coupling. */ |
372 | SR_HWCAP_COUPLING, | |
373 | ||
ca3d84cc | 374 | |
e88dadd7 UH |
375 | /*--- Special stuff -------------------------------------------------*/ |
376 | ||
40dda2c3 BV |
377 | /** Session filename */ |
378 | SR_HWCAP_SESSIONFILE, | |
379 | ||
e88dadd7 UH |
380 | /* TODO: Better description. */ |
381 | /** The device supports specifying a capturefile to inject. */ | |
382 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 383 | |
e88dadd7 UH |
384 | /* TODO: Better description. */ |
385 | /** The device supports specifying the capturefile unit size. */ | |
386 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 387 | |
e88dadd7 UH |
388 | /* TODO: Better description. */ |
389 | /** The device supports setting the number of probes. */ | |
390 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
391 | ||
ca3d84cc | 392 | |
e88dadd7 UH |
393 | /*--- Acquisition modes ---------------------------------------------*/ |
394 | ||
395 | /** | |
396 | * The device supports setting a sample time limit, i.e. how long the | |
397 | * sample acquisition should run (in ms). | |
398 | */ | |
399 | SR_HWCAP_LIMIT_MSEC, | |
400 | ||
401 | /** | |
402 | * The device supports setting a sample number limit, i.e. how many | |
403 | * samples should be acquired. | |
404 | */ | |
405 | SR_HWCAP_LIMIT_SAMPLES, | |
406 | ||
6ea7669c BV |
407 | /** |
408 | * The device supports setting a frame limit, i.e. how many | |
409 | * frames should be acquired. | |
410 | */ | |
411 | SR_HWCAP_LIMIT_FRAMES, | |
412 | ||
e88dadd7 UH |
413 | /** |
414 | * The device supports continuous sampling, i.e. neither a time limit | |
415 | * nor a sample number limit has to be supplied, it will just acquire | |
416 | * samples continuously, until explicitly stopped by a certain command. | |
417 | */ | |
5a2326a7 | 418 | SR_HWCAP_CONTINUOUS, |
e88dadd7 | 419 | |
a1bb33af UH |
420 | }; |
421 | ||
a65de030 | 422 | struct sr_hwcap_option { |
ffedd0bf | 423 | int hwcap; |
a1bb33af UH |
424 | int type; |
425 | char *description; | |
426 | char *shortname; | |
427 | }; | |
428 | ||
d68e2d1a | 429 | struct sr_dev_inst { |
9e41fdba | 430 | struct sr_dev_driver *driver; |
a1bb33af UH |
431 | int index; |
432 | int status; | |
1d9a8a5f | 433 | int inst_type; |
a1bb33af UH |
434 | char *vendor; |
435 | char *model; | |
436 | char *version; | |
47211d65 | 437 | GSList *probes; |
8d672550 | 438 | void *priv; |
a1bb33af UH |
439 | }; |
440 | ||
d68e2d1a | 441 | /* sr_dev_inst types */ |
a1bb33af | 442 | enum { |
4101f961 UH |
443 | /** Device instance type for USB devices. */ |
444 | SR_INST_USB, | |
445 | /** Device instance type for serial port devices. */ | |
446 | SR_INST_SERIAL, | |
a1bb33af UH |
447 | }; |
448 | ||
a1bb33af UH |
449 | /* Device instance status */ |
450 | enum { | |
5a2326a7 | 451 | SR_ST_NOT_FOUND, |
a1bb33af | 452 | /* Found, but still booting */ |
5a2326a7 | 453 | SR_ST_INITIALIZING, |
a1bb33af | 454 | /* Live, but not in use */ |
5a2326a7 | 455 | SR_ST_INACTIVE, |
a1bb33af | 456 | /* Actively in use in a session */ |
5a2326a7 | 457 | SR_ST_ACTIVE, |
a1bb33af UH |
458 | }; |
459 | ||
460 | /* | |
461 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
462 | * TODO: Need a DI to return the number of trigger stages supported. | |
463 | */ | |
464 | ||
465 | /* Device info IDs */ | |
466 | enum { | |
be34a1c7 BV |
467 | /* A list of options supported by the driver. */ |
468 | SR_DI_HWOPTS, | |
469 | /* A list of capabilities supported by the device. */ | |
470 | SR_DI_HWCAPS, | |
a1bb33af | 471 | /* The number of probes connected to this device */ |
5a2326a7 | 472 | SR_DI_NUM_PROBES, |
464d12c7 KS |
473 | /* The probe names on this device */ |
474 | SR_DI_PROBE_NAMES, | |
60679b18 | 475 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 476 | SR_DI_SAMPLERATES, |
0fe11789 | 477 | /* Types of logic trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 478 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 479 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 480 | SR_DI_CUR_SAMPLERATE, |
eb0a3731 UH |
481 | /* Supported patterns (in pattern generator mode) */ |
482 | SR_DI_PATTERNS, | |
0fe11789 BV |
483 | /* Supported buffer sizes */ |
484 | SR_DI_BUFFERSIZES, | |
485 | /* Supported time bases */ | |
486 | SR_DI_TIMEBASES, | |
487 | /* Supported trigger sources */ | |
488 | SR_DI_TRIGGER_SOURCES, | |
3c4976c9 BV |
489 | /* Supported filter targets */ |
490 | SR_DI_FILTERS, | |
bd8db307 BV |
491 | /* Valid volts/div values */ |
492 | SR_DI_VDIVS, | |
e1c8b2ab BV |
493 | /* Coupling options */ |
494 | SR_DI_COUPLING, | |
a1bb33af UH |
495 | }; |
496 | ||
1b452b85 UH |
497 | /* |
498 | * A device supports either a range of samplerates with steps of a given | |
499 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
500 | * step or list, but not both. |
501 | */ | |
60679b18 | 502 | struct sr_samplerates { |
a1bb33af UH |
503 | uint64_t low; |
504 | uint64_t high; | |
505 | uint64_t step; | |
a533743d | 506 | const uint64_t *list; |
a1bb33af UH |
507 | }; |
508 | ||
c09f0b57 UH |
509 | struct sr_dev_driver { |
510 | /* Driver-specific */ | |
a1bb33af | 511 | char *name; |
9f8274a5 | 512 | char *longname; |
a1bb33af | 513 | int api_version; |
40dda2c3 | 514 | int (*init) (void); |
57ab7d9f | 515 | int (*cleanup) (void); |
80bf0426 | 516 | GSList *(*scan) (GSList *options); |
811deee4 BV |
517 | GSList *(*dev_list) (void); |
518 | int (*dev_clear) (void); | |
a1bb33af | 519 | |
1b452b85 | 520 | /* Device-specific */ |
25a0f108 BV |
521 | int (*dev_open) (struct sr_dev_inst *sdi); |
522 | int (*dev_close) (struct sr_dev_inst *sdi); | |
9e90dcba | 523 | int (*info_get) (int info_id, const void **data, |
f92f4eab | 524 | const struct sr_dev_inst *sdi); |
6f4b1868 BV |
525 | int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap, |
526 | const void *value); | |
3ffb6964 BV |
527 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, |
528 | void *cb_data); | |
529 | int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi, | |
530 | void *cb_data); | |
dd34b8d3 BV |
531 | |
532 | /* Dynamic */ | |
c259726a | 533 | void *priv; |
a1bb33af UH |
534 | }; |
535 | ||
e9022f59 BV |
536 | /* Private driver context. */ |
537 | struct drv_context { | |
538 | GSList *instances; | |
539 | }; | |
540 | ||
2872d21e | 541 | struct sr_session { |
bb7ef793 UH |
542 | /* List of struct sr_dev* */ |
543 | GSList *devs; | |
d08490aa | 544 | /* list of sr_receive_data_callback_t */ |
a1bb33af UH |
545 | GSList *datafeed_callbacks; |
546 | GTimeVal starttime; | |
b7e94111 LPC |
547 | |
548 | unsigned int num_sources; | |
549 | ||
550 | /* Both "sources" and "pollfds" are of the same size and contain pairs of | |
551 | * descriptor and callback function. We can not embed the GPollFD into the | |
552 | * source struct since we want to be able to pass the array of all poll | |
553 | * descriptors to g_poll. | |
554 | */ | |
555 | struct source *sources; | |
556 | GPollFD *pollfds; | |
557 | int source_timeout; | |
a1bb33af UH |
558 | }; |
559 | ||
45c59c8b BV |
560 | #include "proto.h" |
561 | #include "version.h" | |
c2bd92ec | 562 | |
a00b530c UH |
563 | #ifdef __cplusplus |
564 | } | |
565 | #endif | |
566 | ||
a1bb33af | 567 | #endif |