]>
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 | * | |
118 | * Details: http://gcc.gnu.org/wiki/Visibility | |
119 | */ | |
120 | ||
121 | /* Marks public libsigrok API symbols. */ | |
122 | #define SR_API __attribute__((visibility("default"))) | |
123 | ||
124 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
125 | #define SR_PRIV __attribute__((visibility("hidden"))) | |
126 | ||
1f9813eb | 127 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); |
882e2075 | 128 | |
c09f0b57 | 129 | /* Data types used by hardware drivers for dev_config_set() */ |
a1bb33af | 130 | enum { |
5a2326a7 UH |
131 | SR_T_UINT64, |
132 | SR_T_CHAR, | |
4d436e71 | 133 | SR_T_BOOL, |
a1bb33af UH |
134 | }; |
135 | ||
b9c735a2 | 136 | /* sr_datafeed_packet.type values */ |
a1bb33af | 137 | enum { |
5a2326a7 UH |
138 | SR_DF_HEADER, |
139 | SR_DF_END, | |
140 | SR_DF_TRIGGER, | |
141 | SR_DF_LOGIC, | |
5a2326a7 | 142 | SR_DF_PD, |
a1bb33af UH |
143 | }; |
144 | ||
b9c735a2 | 145 | struct sr_datafeed_packet { |
a1bb33af | 146 | uint16_t type; |
a1bb33af UH |
147 | void *payload; |
148 | }; | |
149 | ||
b9c735a2 | 150 | struct sr_datafeed_header { |
a1bb33af UH |
151 | int feed_version; |
152 | struct timeval starttime; | |
4c100f32 | 153 | uint64_t samplerate; |
921e753f | 154 | int num_logic_probes; |
a1bb33af UH |
155 | }; |
156 | ||
38ab3ee7 BV |
157 | struct sr_datafeed_logic { |
158 | uint64_t length; | |
159 | uint16_t unitsize; | |
9c939c51 | 160 | void *data; |
38ab3ee7 BV |
161 | }; |
162 | ||
f50f3f40 UH |
163 | struct sr_input { |
164 | struct sr_input_format *format; | |
13a12913 | 165 | char *param; |
bb7ef793 | 166 | struct sr_dev *vdev; |
34e4813f BV |
167 | }; |
168 | ||
f50f3f40 | 169 | struct sr_input_format { |
cdb3573c | 170 | char *id; |
34e4813f | 171 | char *description; |
757b8c62 | 172 | int (*format_match) (const char *filename); |
f50f3f40 UH |
173 | int (*init) (struct sr_input *in); |
174 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
175 | }; |
176 | ||
f50f3f40 UH |
177 | struct sr_output { |
178 | struct sr_output_format *format; | |
bb7ef793 | 179 | struct sr_dev *dev; |
a1bb33af UH |
180 | char *param; |
181 | void *internal; | |
182 | }; | |
183 | ||
f50f3f40 | 184 | struct sr_output_format { |
cdb3573c | 185 | char *id; |
a1bb33af | 186 | char *description; |
f0411b1d | 187 | int df_type; |
f50f3f40 | 188 | int (*init) (struct sr_output *o); |
054e6709 UH |
189 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
190 | uint64_t length_in, uint8_t **data_out, | |
191 | uint64_t *length_out); | |
192 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
a1bb33af UH |
193 | uint64_t *length_out); |
194 | }; | |
195 | ||
c4911129 | 196 | struct sr_datastore { |
a1bb33af UH |
197 | /* Size in bytes of the number of units stored in this datastore */ |
198 | int ds_unitsize; | |
33247d6a | 199 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
200 | GSList *chunklist; |
201 | }; | |
202 | ||
a1bb33af UH |
203 | /* |
204 | * This represents a generic device connected to the system. | |
c09f0b57 UH |
205 | * For device-specific information, ask the driver. The driver_index refers |
206 | * to the device index within that driver; it may be handling more than one | |
207 | * device. All relevant driver calls take a dev_index parameter for this. | |
a1bb33af | 208 | */ |
bb7ef793 | 209 | struct sr_dev { |
c09f0b57 UH |
210 | /* Which driver handles this device */ |
211 | struct sr_dev_driver *driver; | |
212 | /* A driver may handle multiple devices of the same type */ | |
213 | int driver_index; | |
1afe8989 | 214 | /* List of struct sr_probe* */ |
a1bb33af UH |
215 | GSList *probes; |
216 | /* Data acquired by this device, if any */ | |
c4911129 | 217 | struct sr_datastore *datastore; |
a1bb33af UH |
218 | }; |
219 | ||
921e753f | 220 | enum { |
5a2326a7 | 221 | SR_PROBE_TYPE_LOGIC, |
921e753f DR |
222 | }; |
223 | ||
1afe8989 | 224 | struct sr_probe { |
a1bb33af | 225 | int index; |
6ea7e235 | 226 | int type; |
a1bb33af UH |
227 | gboolean enabled; |
228 | char *name; | |
229 | char *trigger; | |
230 | }; | |
231 | ||
c09f0b57 | 232 | /* Hardware driver capabilities */ |
a1bb33af | 233 | enum { |
fb93625d | 234 | SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ |
e88dadd7 UH |
235 | |
236 | /*--- Device classes ------------------------------------------------*/ | |
237 | ||
238 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 239 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 240 | |
e88dadd7 UH |
241 | /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ |
242 | ||
a141db8c AS |
243 | /*--- Device types --------------------------------------------------*/ |
244 | ||
245 | /** The device is demo device. */ | |
bb7ef793 | 246 | SR_HWCAP_DEMO_DEV, |
a141db8c | 247 | |
e88dadd7 UH |
248 | /*--- Device options ------------------------------------------------*/ |
249 | ||
250 | /** The device supports setting/changing its samplerate. */ | |
251 | SR_HWCAP_SAMPLERATE, | |
252 | ||
253 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
254 | /** The device supports setting a probe mask. */ | |
255 | SR_HWCAP_PROBECONFIG, | |
256 | ||
257 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
258 | SR_HWCAP_CAPTURE_RATIO, | |
259 | ||
260 | /* TODO? */ | |
261 | /** The device supports setting a pattern (pattern generator mode). */ | |
262 | SR_HWCAP_PATTERN_MODE, | |
263 | ||
3a4d09c0 GM |
264 | /** The device supports Run Length Encoding. */ |
265 | SR_HWCAP_RLE, | |
266 | ||
e88dadd7 UH |
267 | /*--- Special stuff -------------------------------------------------*/ |
268 | ||
269 | /* TODO: Better description. */ | |
270 | /** The device supports specifying a capturefile to inject. */ | |
271 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 272 | |
e88dadd7 UH |
273 | /* TODO: Better description. */ |
274 | /** The device supports specifying the capturefile unit size. */ | |
275 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 276 | |
e88dadd7 UH |
277 | /* TODO: Better description. */ |
278 | /** The device supports setting the number of probes. */ | |
279 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
280 | ||
281 | /*--- Acquisition modes ---------------------------------------------*/ | |
282 | ||
283 | /** | |
284 | * The device supports setting a sample time limit, i.e. how long the | |
285 | * sample acquisition should run (in ms). | |
286 | */ | |
287 | SR_HWCAP_LIMIT_MSEC, | |
288 | ||
289 | /** | |
290 | * The device supports setting a sample number limit, i.e. how many | |
291 | * samples should be acquired. | |
292 | */ | |
293 | SR_HWCAP_LIMIT_SAMPLES, | |
294 | ||
295 | /** | |
296 | * The device supports continuous sampling, i.e. neither a time limit | |
297 | * nor a sample number limit has to be supplied, it will just acquire | |
298 | * samples continuously, until explicitly stopped by a certain command. | |
299 | */ | |
5a2326a7 | 300 | SR_HWCAP_CONTINUOUS, |
e88dadd7 UH |
301 | |
302 | /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ | |
a1bb33af UH |
303 | }; |
304 | ||
a65de030 | 305 | struct sr_hwcap_option { |
ffedd0bf | 306 | int hwcap; |
a1bb33af UH |
307 | int type; |
308 | char *description; | |
309 | char *shortname; | |
310 | }; | |
311 | ||
d68e2d1a | 312 | struct sr_dev_inst { |
a1bb33af UH |
313 | int index; |
314 | int status; | |
1d9a8a5f | 315 | int inst_type; |
a1bb33af UH |
316 | char *vendor; |
317 | char *model; | |
318 | char *version; | |
8d672550 | 319 | void *priv; |
a1bb33af UH |
320 | }; |
321 | ||
d68e2d1a | 322 | /* sr_dev_inst types */ |
a1bb33af | 323 | enum { |
4101f961 UH |
324 | /** Device instance type for USB devices. */ |
325 | SR_INST_USB, | |
326 | /** Device instance type for serial port devices. */ | |
327 | SR_INST_SERIAL, | |
a1bb33af UH |
328 | }; |
329 | ||
a1bb33af UH |
330 | /* Device instance status */ |
331 | enum { | |
5a2326a7 | 332 | SR_ST_NOT_FOUND, |
a1bb33af | 333 | /* Found, but still booting */ |
5a2326a7 | 334 | SR_ST_INITIALIZING, |
a1bb33af | 335 | /* Live, but not in use */ |
5a2326a7 | 336 | SR_ST_INACTIVE, |
a1bb33af | 337 | /* Actively in use in a session */ |
5a2326a7 | 338 | SR_ST_ACTIVE, |
a1bb33af UH |
339 | }; |
340 | ||
341 | /* | |
342 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
343 | * TODO: Need a DI to return the number of trigger stages supported. | |
344 | */ | |
345 | ||
346 | /* Device info IDs */ | |
347 | enum { | |
d68e2d1a | 348 | /* struct sr_dev_inst for this specific device */ |
1d9a8a5f | 349 | SR_DI_INST, |
a1bb33af | 350 | /* The number of probes connected to this device */ |
5a2326a7 | 351 | SR_DI_NUM_PROBES, |
464d12c7 KS |
352 | /* The probe names on this device */ |
353 | SR_DI_PROBE_NAMES, | |
60679b18 | 354 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 355 | SR_DI_SAMPLERATES, |
a1bb33af | 356 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 357 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 358 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 359 | SR_DI_CUR_SAMPLERATE, |
eb0a3731 UH |
360 | /* Supported patterns (in pattern generator mode) */ |
361 | SR_DI_PATTERNS, | |
a1bb33af UH |
362 | }; |
363 | ||
1b452b85 UH |
364 | /* |
365 | * A device supports either a range of samplerates with steps of a given | |
366 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
367 | * step or list, but not both. |
368 | */ | |
60679b18 | 369 | struct sr_samplerates { |
a1bb33af UH |
370 | uint64_t low; |
371 | uint64_t high; | |
372 | uint64_t step; | |
373 | uint64_t *list; | |
374 | }; | |
375 | ||
c09f0b57 UH |
376 | struct sr_dev_driver { |
377 | /* Driver-specific */ | |
a1bb33af | 378 | char *name; |
9f8274a5 | 379 | char *longname; |
a1bb33af | 380 | int api_version; |
bb7ef793 | 381 | int (*init) (const char *devinfo); |
57ab7d9f | 382 | int (*cleanup) (void); |
a1bb33af | 383 | |
1b452b85 | 384 | /* Device-specific */ |
e7eb703f UH |
385 | int (*dev_open) (int dev_index); |
386 | int (*dev_close) (int dev_index); | |
5097b0d0 | 387 | void *(*dev_info_get) (int dev_index, int dev_info_id); |
e7eb703f | 388 | int (*dev_status_get) (int dev_index); |
ffedd0bf | 389 | int *(*hwcap_get_all) (void); |
a9a245b4 | 390 | int (*dev_config_set) (int dev_index, int hwcap, void *value); |
1f9813eb UH |
391 | int (*dev_acquisition_start) (int dev_index, void *session_dev_id); |
392 | int (*dev_acquisition_stop) (int dev_index, void *session_dev_id); | |
a1bb33af UH |
393 | }; |
394 | ||
2872d21e | 395 | struct sr_session { |
bb7ef793 UH |
396 | /* List of struct sr_dev* */ |
397 | GSList *devs; | |
d08490aa | 398 | /* list of sr_receive_data_callback_t */ |
a1bb33af UH |
399 | GSList *datafeed_callbacks; |
400 | GTimeVal starttime; | |
544a4582 | 401 | gboolean running; |
a1bb33af UH |
402 | }; |
403 | ||
882e2075 | 404 | #include "sigrok-proto.h" |
c2bd92ec | 405 | |
a00b530c UH |
406 | #ifdef __cplusplus |
407 | } | |
408 | #endif | |
409 | ||
a1bb33af | 410 | #endif |