]>
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 | ||
85a77720 UH |
33 | /* |
34 | * Package version macros (can be used for conditional compilation). | |
35 | */ | |
36 | ||
37 | /** The libsigrok package 'major' version number. */ | |
6dddd902 | 38 | #define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@ |
85a77720 UH |
39 | |
40 | /** The libsigrok package 'minor' version number. */ | |
6dddd902 | 41 | #define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@ |
85a77720 UH |
42 | |
43 | /** The libsigrok package 'micro' version number. */ | |
6dddd902 | 44 | #define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@ |
85a77720 UH |
45 | |
46 | /** The libsigrok package version ("major.minor.micro") as string. */ | |
6dddd902 | 47 | #define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@" |
85a77720 UH |
48 | |
49 | /* | |
50 | * Library/libtool version macros (can be used for conditional compilation). | |
51 | */ | |
52 | ||
53 | /** The libsigrok libtool 'current' version number. */ | |
6dddd902 | 54 | #define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@ |
85a77720 UH |
55 | |
56 | /** The libsigrok libtool 'revision' version number. */ | |
6dddd902 | 57 | #define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@ |
85a77720 UH |
58 | |
59 | /** The libsigrok libtool 'age' version number. */ | |
6dddd902 | 60 | #define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@ |
85a77720 UH |
61 | |
62 | /** The libsigrok libtool version ("current:revision:age") as string. */ | |
6dddd902 | 63 | #define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@" |
85a77720 | 64 | |
e31b636d UH |
65 | /* |
66 | * Status/error codes returned by libsigrok functions. | |
67 | * | |
68 | * All possible return codes of libsigrok functions must be listed here. | |
69 | * Functions should never return hardcoded numbers as status, but rather | |
70 | * use these #defines instead. All error codes are negative numbers. | |
71 | * | |
72 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
73 | * libsigrok functions returns a "malloc error" it must be exactly the same |
74 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
75 | * There must be no functions which indicate two different errors via the |
76 | * same return code. | |
77 | * | |
78 | * Also, for compatibility reasons, no defined return codes are ever removed | |
79 | * or reused for different #defines later. You can only add new #defines and | |
80 | * return codes, but never remove or redefine existing ones. | |
81 | */ | |
e46b8fb1 UH |
82 | #define SR_OK 0 /* No error */ |
83 | #define SR_ERR -1 /* Generic/unspecified error */ | |
84 | #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ | |
f7d2982d | 85 | #define SR_ERR_ARG -3 /* Function argument error */ |
e0508e67 UH |
86 | #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ |
87 | #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ | |
a1bb33af | 88 | |
b2ff9506 BV |
89 | #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ |
90 | #define SR_MAX_PROBENAME_LEN 32 | |
2a3f9541 | 91 | |
a1bb33af | 92 | /* Handy little macros */ |
c9140419 | 93 | #define SR_HZ(n) (n) |
59df0c77 UH |
94 | #define SR_KHZ(n) ((n) * 1000) |
95 | #define SR_MHZ(n) ((n) * 1000000) | |
96 | #define SR_GHZ(n) ((n) * 1000000000) | |
a1bb33af | 97 | |
59df0c77 | 98 | #define SR_HZ_TO_NS(n) (1000000000 / (n)) |
3677f3ec | 99 | |
1352eedd | 100 | /* libsigrok loglevels. */ |
44dae539 | 101 | #define SR_LOG_NONE 0 /**< Output no messages at all. */ |
b2ff9506 | 102 | #define SR_LOG_ERR 1 /**< Output error messages. */ |
44dae539 UH |
103 | #define SR_LOG_WARN 2 /**< Output warnings. */ |
104 | #define SR_LOG_INFO 3 /**< Output informational messages. */ | |
b2ff9506 | 105 | #define SR_LOG_DBG 4 /**< Output debug messages. */ |
44dae539 | 106 | #define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */ |
1352eedd | 107 | |
1a081ca6 UH |
108 | /* |
109 | * Use SR_API to mark public API symbols, and SR_PRIV for private symbols. | |
110 | * | |
111 | * Variables and functions marked 'static' are private already and don't | |
112 | * need SR_PRIV. However, functions which are not static (because they need | |
113 | * to be used in other libsigrok-internal files) but are also not meant to | |
114 | * be part of the public libsigrok API, must use SR_PRIV. | |
115 | * | |
116 | * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). | |
117 | * | |
69e70c23 UH |
118 | * This feature is not available on MinGW/Windows, as it is a feature of |
119 | * ELF files and MinGW/Windows uses PE files. | |
120 | * | |
1a081ca6 UH |
121 | * Details: http://gcc.gnu.org/wiki/Visibility |
122 | */ | |
123 | ||
124 | /* Marks public libsigrok API symbols. */ | |
69e70c23 | 125 | #ifndef _WIN32 |
1a081ca6 | 126 | #define SR_API __attribute__((visibility("default"))) |
69e70c23 UH |
127 | #else |
128 | #define SR_API | |
129 | #endif | |
1a081ca6 UH |
130 | |
131 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
69e70c23 | 132 | #ifndef _WIN32 |
1a081ca6 | 133 | #define SR_PRIV __attribute__((visibility("hidden"))) |
69e70c23 UH |
134 | #else |
135 | #define SR_PRIV | |
136 | #endif | |
1a081ca6 | 137 | |
1f9813eb | 138 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); |
882e2075 | 139 | |
c09f0b57 | 140 | /* Data types used by hardware drivers for dev_config_set() */ |
a1bb33af | 141 | enum { |
5a2326a7 UH |
142 | SR_T_UINT64, |
143 | SR_T_CHAR, | |
4d436e71 | 144 | SR_T_BOOL, |
a1bb33af UH |
145 | }; |
146 | ||
b9c735a2 | 147 | /* sr_datafeed_packet.type values */ |
a1bb33af | 148 | enum { |
5a2326a7 UH |
149 | SR_DF_HEADER, |
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 | ||
b9c735a2 | 160 | struct sr_datafeed_packet { |
a1bb33af | 161 | uint16_t type; |
a1bb33af UH |
162 | void *payload; |
163 | }; | |
164 | ||
b9c735a2 | 165 | struct sr_datafeed_header { |
a1bb33af UH |
166 | int feed_version; |
167 | struct timeval starttime; | |
ee7489d2 BV |
168 | }; |
169 | ||
170 | struct sr_datafeed_meta_logic { | |
171 | int num_probes; | |
4c100f32 | 172 | uint64_t samplerate; |
a1bb33af UH |
173 | }; |
174 | ||
38ab3ee7 BV |
175 | struct sr_datafeed_logic { |
176 | uint64_t length; | |
177 | uint16_t unitsize; | |
9c939c51 | 178 | void *data; |
38ab3ee7 BV |
179 | }; |
180 | ||
ee7489d2 BV |
181 | struct sr_datafeed_meta_analog { |
182 | int num_probes; | |
183 | }; | |
184 | ||
185 | struct sr_datafeed_analog { | |
186 | int num_samples; | |
187 | float *data; | |
188 | }; | |
189 | ||
f50f3f40 UH |
190 | struct sr_input { |
191 | struct sr_input_format *format; | |
13a12913 | 192 | char *param; |
bb7ef793 | 193 | struct sr_dev *vdev; |
34e4813f BV |
194 | }; |
195 | ||
f50f3f40 | 196 | struct sr_input_format { |
cdb3573c | 197 | char *id; |
34e4813f | 198 | char *description; |
757b8c62 | 199 | int (*format_match) (const char *filename); |
f50f3f40 UH |
200 | int (*init) (struct sr_input *in); |
201 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
202 | }; |
203 | ||
f50f3f40 UH |
204 | struct sr_output { |
205 | struct sr_output_format *format; | |
bb7ef793 | 206 | struct sr_dev *dev; |
a1bb33af UH |
207 | char *param; |
208 | void *internal; | |
209 | }; | |
210 | ||
f50f3f40 | 211 | struct sr_output_format { |
cdb3573c | 212 | char *id; |
a1bb33af | 213 | char *description; |
f0411b1d | 214 | int df_type; |
f50f3f40 | 215 | int (*init) (struct sr_output *o); |
054e6709 UH |
216 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
217 | uint64_t length_in, uint8_t **data_out, | |
218 | uint64_t *length_out); | |
219 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
a1bb33af UH |
220 | uint64_t *length_out); |
221 | }; | |
222 | ||
c4911129 | 223 | struct sr_datastore { |
a1bb33af UH |
224 | /* Size in bytes of the number of units stored in this datastore */ |
225 | int ds_unitsize; | |
33247d6a | 226 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
227 | GSList *chunklist; |
228 | }; | |
229 | ||
a1bb33af UH |
230 | /* |
231 | * This represents a generic device connected to the system. | |
c09f0b57 UH |
232 | * For device-specific information, ask the driver. The driver_index refers |
233 | * to the device index within that driver; it may be handling more than one | |
234 | * device. All relevant driver calls take a dev_index parameter for this. | |
a1bb33af | 235 | */ |
bb7ef793 | 236 | struct sr_dev { |
c09f0b57 UH |
237 | /* Which driver handles this device */ |
238 | struct sr_dev_driver *driver; | |
239 | /* A driver may handle multiple devices of the same type */ | |
240 | int driver_index; | |
1afe8989 | 241 | /* List of struct sr_probe* */ |
a1bb33af UH |
242 | GSList *probes; |
243 | /* Data acquired by this device, if any */ | |
c4911129 | 244 | struct sr_datastore *datastore; |
a1bb33af UH |
245 | }; |
246 | ||
921e753f | 247 | enum { |
5a2326a7 | 248 | SR_PROBE_TYPE_LOGIC, |
921e753f DR |
249 | }; |
250 | ||
1afe8989 | 251 | struct sr_probe { |
a1bb33af | 252 | int index; |
6ea7e235 | 253 | int type; |
a1bb33af UH |
254 | gboolean enabled; |
255 | char *name; | |
256 | char *trigger; | |
257 | }; | |
258 | ||
c09f0b57 | 259 | /* Hardware driver capabilities */ |
a1bb33af | 260 | enum { |
fb93625d | 261 | SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ |
e88dadd7 UH |
262 | |
263 | /*--- Device classes ------------------------------------------------*/ | |
264 | ||
265 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 266 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 267 | |
ee7489d2 BV |
268 | /** The device can act as an oscilloscope. */ |
269 | SR_HWCAP_OSCILLOSCOPE, | |
e88dadd7 | 270 | |
a141db8c AS |
271 | /*--- Device types --------------------------------------------------*/ |
272 | ||
273 | /** The device is demo device. */ | |
bb7ef793 | 274 | SR_HWCAP_DEMO_DEV, |
a141db8c | 275 | |
e88dadd7 UH |
276 | /*--- Device options ------------------------------------------------*/ |
277 | ||
278 | /** The device supports setting/changing its samplerate. */ | |
279 | SR_HWCAP_SAMPLERATE, | |
280 | ||
281 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
282 | /** The device supports setting a probe mask. */ | |
283 | SR_HWCAP_PROBECONFIG, | |
284 | ||
285 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
286 | SR_HWCAP_CAPTURE_RATIO, | |
287 | ||
288 | /* TODO? */ | |
289 | /** The device supports setting a pattern (pattern generator mode). */ | |
290 | SR_HWCAP_PATTERN_MODE, | |
291 | ||
3a4d09c0 GM |
292 | /** The device supports Run Length Encoding. */ |
293 | SR_HWCAP_RLE, | |
294 | ||
ee7489d2 BV |
295 | /** The device supports setting trigger slope. */ |
296 | SR_HWCAP_TRIGGERSLOPE, | |
297 | ||
e88dadd7 UH |
298 | /*--- Special stuff -------------------------------------------------*/ |
299 | ||
300 | /* TODO: Better description. */ | |
301 | /** The device supports specifying a capturefile to inject. */ | |
302 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 303 | |
e88dadd7 UH |
304 | /* TODO: Better description. */ |
305 | /** The device supports specifying the capturefile unit size. */ | |
306 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 307 | |
e88dadd7 UH |
308 | /* TODO: Better description. */ |
309 | /** The device supports setting the number of probes. */ | |
310 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
311 | ||
312 | /*--- Acquisition modes ---------------------------------------------*/ | |
313 | ||
314 | /** | |
315 | * The device supports setting a sample time limit, i.e. how long the | |
316 | * sample acquisition should run (in ms). | |
317 | */ | |
318 | SR_HWCAP_LIMIT_MSEC, | |
319 | ||
320 | /** | |
321 | * The device supports setting a sample number limit, i.e. how many | |
322 | * samples should be acquired. | |
323 | */ | |
324 | SR_HWCAP_LIMIT_SAMPLES, | |
325 | ||
6ea7669c BV |
326 | /** |
327 | * The device supports setting a frame limit, i.e. how many | |
328 | * frames should be acquired. | |
329 | */ | |
330 | SR_HWCAP_LIMIT_FRAMES, | |
331 | ||
e88dadd7 UH |
332 | /** |
333 | * The device supports continuous sampling, i.e. neither a time limit | |
334 | * nor a sample number limit has to be supplied, it will just acquire | |
335 | * samples continuously, until explicitly stopped by a certain command. | |
336 | */ | |
5a2326a7 | 337 | SR_HWCAP_CONTINUOUS, |
e88dadd7 | 338 | |
a1bb33af UH |
339 | }; |
340 | ||
a65de030 | 341 | struct sr_hwcap_option { |
ffedd0bf | 342 | int hwcap; |
a1bb33af UH |
343 | int type; |
344 | char *description; | |
345 | char *shortname; | |
346 | }; | |
347 | ||
d68e2d1a | 348 | struct sr_dev_inst { |
a1bb33af UH |
349 | int index; |
350 | int status; | |
1d9a8a5f | 351 | int inst_type; |
a1bb33af UH |
352 | char *vendor; |
353 | char *model; | |
354 | char *version; | |
8d672550 | 355 | void *priv; |
a1bb33af UH |
356 | }; |
357 | ||
d68e2d1a | 358 | /* sr_dev_inst types */ |
a1bb33af | 359 | enum { |
4101f961 UH |
360 | /** Device instance type for USB devices. */ |
361 | SR_INST_USB, | |
362 | /** Device instance type for serial port devices. */ | |
363 | SR_INST_SERIAL, | |
a1bb33af UH |
364 | }; |
365 | ||
a1bb33af UH |
366 | /* Device instance status */ |
367 | enum { | |
5a2326a7 | 368 | SR_ST_NOT_FOUND, |
a1bb33af | 369 | /* Found, but still booting */ |
5a2326a7 | 370 | SR_ST_INITIALIZING, |
a1bb33af | 371 | /* Live, but not in use */ |
5a2326a7 | 372 | SR_ST_INACTIVE, |
a1bb33af | 373 | /* Actively in use in a session */ |
5a2326a7 | 374 | SR_ST_ACTIVE, |
a1bb33af UH |
375 | }; |
376 | ||
377 | /* | |
378 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
379 | * TODO: Need a DI to return the number of trigger stages supported. | |
380 | */ | |
381 | ||
382 | /* Device info IDs */ | |
383 | enum { | |
d68e2d1a | 384 | /* struct sr_dev_inst for this specific device */ |
1d9a8a5f | 385 | SR_DI_INST, |
a1bb33af | 386 | /* The number of probes connected to this device */ |
5a2326a7 | 387 | SR_DI_NUM_PROBES, |
464d12c7 KS |
388 | /* The probe names on this device */ |
389 | SR_DI_PROBE_NAMES, | |
60679b18 | 390 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 391 | SR_DI_SAMPLERATES, |
a1bb33af | 392 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 393 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 394 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 395 | SR_DI_CUR_SAMPLERATE, |
eb0a3731 UH |
396 | /* Supported patterns (in pattern generator mode) */ |
397 | SR_DI_PATTERNS, | |
a1bb33af UH |
398 | }; |
399 | ||
1b452b85 UH |
400 | /* |
401 | * A device supports either a range of samplerates with steps of a given | |
402 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
403 | * step or list, but not both. |
404 | */ | |
60679b18 | 405 | struct sr_samplerates { |
a1bb33af UH |
406 | uint64_t low; |
407 | uint64_t high; | |
408 | uint64_t step; | |
409 | uint64_t *list; | |
410 | }; | |
411 | ||
c09f0b57 UH |
412 | struct sr_dev_driver { |
413 | /* Driver-specific */ | |
a1bb33af | 414 | char *name; |
9f8274a5 | 415 | char *longname; |
a1bb33af | 416 | int api_version; |
bb7ef793 | 417 | int (*init) (const char *devinfo); |
57ab7d9f | 418 | int (*cleanup) (void); |
a1bb33af | 419 | |
1b452b85 | 420 | /* Device-specific */ |
e7eb703f UH |
421 | int (*dev_open) (int dev_index); |
422 | int (*dev_close) (int dev_index); | |
5097b0d0 | 423 | void *(*dev_info_get) (int dev_index, int dev_info_id); |
e7eb703f | 424 | int (*dev_status_get) (int dev_index); |
ffedd0bf | 425 | int *(*hwcap_get_all) (void); |
a9a245b4 | 426 | int (*dev_config_set) (int dev_index, int hwcap, void *value); |
1f9813eb UH |
427 | int (*dev_acquisition_start) (int dev_index, void *session_dev_id); |
428 | int (*dev_acquisition_stop) (int dev_index, void *session_dev_id); | |
a1bb33af UH |
429 | }; |
430 | ||
2872d21e | 431 | struct sr_session { |
bb7ef793 UH |
432 | /* List of struct sr_dev* */ |
433 | GSList *devs; | |
d08490aa | 434 | /* list of sr_receive_data_callback_t */ |
a1bb33af UH |
435 | GSList *datafeed_callbacks; |
436 | GTimeVal starttime; | |
544a4582 | 437 | gboolean running; |
a1bb33af UH |
438 | }; |
439 | ||
882e2075 | 440 | #include "sigrok-proto.h" |
c2bd92ec | 441 | |
a00b530c UH |
442 | #ifdef __cplusplus |
443 | } | |
444 | #endif | |
445 | ||
a1bb33af | 446 | #endif |