]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
01469707 | 4 | * Copyright (C) 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 | ||
20 | #ifndef SIGROK_SIGROK_H | |
21 | #define SIGROK_SIGROK_H | |
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 | |
9688b443 UH |
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. */ |
8e49cebd BV |
69 | #define SR_LOG_NONE 0 |
70 | #define SR_LOG_ERR 1 | |
71 | #define SR_LOG_WARN 2 | |
72 | #define SR_LOG_INFO 3 | |
73 | #define SR_LOG_DBG 4 | |
74 | #define SR_LOG_SPEW 5 | |
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 | * | |
86 | * Details: http://gcc.gnu.org/wiki/Visibility | |
87 | */ | |
88 | ||
89 | /* Marks public libsigrok API symbols. */ | |
90 | #define SR_API __attribute__((visibility("default"))) | |
91 | ||
92 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
93 | #define SR_PRIV __attribute__((visibility("hidden"))) | |
94 | ||
a887e3da | 95 | typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); |
882e2075 | 96 | |
882e2075 | 97 | /* Data types used by hardware plugins for set_configuration() */ |
a1bb33af | 98 | enum { |
5a2326a7 UH |
99 | SR_T_UINT64, |
100 | SR_T_CHAR, | |
4d436e71 | 101 | SR_T_BOOL, |
a1bb33af UH |
102 | }; |
103 | ||
b9c735a2 | 104 | /* sr_datafeed_packet.type values */ |
a1bb33af | 105 | enum { |
5a2326a7 UH |
106 | SR_DF_HEADER, |
107 | SR_DF_END, | |
108 | SR_DF_TRIGGER, | |
109 | SR_DF_LOGIC, | |
110 | SR_DF_ANALOG, | |
111 | SR_DF_PD, | |
a1bb33af UH |
112 | }; |
113 | ||
b9c735a2 | 114 | struct sr_datafeed_packet { |
a1bb33af | 115 | uint16_t type; |
a1bb33af UH |
116 | void *payload; |
117 | }; | |
118 | ||
b9c735a2 | 119 | struct sr_datafeed_header { |
a1bb33af UH |
120 | int feed_version; |
121 | struct timeval starttime; | |
4c100f32 | 122 | uint64_t samplerate; |
921e753f DR |
123 | int num_analog_probes; |
124 | int num_logic_probes; | |
a1bb33af UH |
125 | }; |
126 | ||
38ab3ee7 BV |
127 | struct sr_datafeed_logic { |
128 | uint64_t length; | |
129 | uint16_t unitsize; | |
9c939c51 | 130 | void *data; |
38ab3ee7 BV |
131 | }; |
132 | ||
f50f3f40 UH |
133 | struct sr_input { |
134 | struct sr_input_format *format; | |
13a12913 | 135 | char *param; |
5c2d46d1 | 136 | struct sr_device *vdevice; |
34e4813f BV |
137 | }; |
138 | ||
f50f3f40 | 139 | struct sr_input_format { |
cdb3573c | 140 | char *id; |
34e4813f | 141 | char *description; |
757b8c62 | 142 | int (*format_match) (const char *filename); |
f50f3f40 UH |
143 | int (*init) (struct sr_input *in); |
144 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
145 | }; |
146 | ||
f50f3f40 UH |
147 | struct sr_output { |
148 | struct sr_output_format *format; | |
5c2d46d1 | 149 | struct sr_device *device; |
a1bb33af UH |
150 | char *param; |
151 | void *internal; | |
152 | }; | |
153 | ||
f50f3f40 | 154 | struct sr_output_format { |
cdb3573c | 155 | char *id; |
a1bb33af | 156 | char *description; |
f0411b1d | 157 | int df_type; |
f50f3f40 | 158 | int (*init) (struct sr_output *o); |
54ac5277 UH |
159 | int (*data) (struct sr_output *o, const char *data_in, |
160 | uint64_t length_in, char **data_out, uint64_t *length_out); | |
f50f3f40 | 161 | int (*event) (struct sr_output *o, int event_type, char **data_out, |
a1bb33af UH |
162 | uint64_t *length_out); |
163 | }; | |
164 | ||
c4911129 | 165 | struct sr_datastore { |
a1bb33af UH |
166 | /* Size in bytes of the number of units stored in this datastore */ |
167 | int ds_unitsize; | |
33247d6a | 168 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
169 | GSList *chunklist; |
170 | }; | |
171 | ||
a1bb33af UH |
172 | /* |
173 | * This represents a generic device connected to the system. | |
174 | * For device-specific information, ask the plugin. The plugin_index refers | |
175 | * to the device index within that plugin; it may be handling more than one | |
176 | * device. All relevant plugin calls take a device_index parameter for this. | |
177 | */ | |
5c2d46d1 | 178 | struct sr_device { |
a1bb33af | 179 | /* Which plugin handles this device */ |
5c2d46d1 | 180 | struct sr_device_plugin *plugin; |
a1bb33af UH |
181 | /* A plugin may handle multiple devices of the same type */ |
182 | int plugin_index; | |
1afe8989 | 183 | /* List of struct sr_probe* */ |
a1bb33af UH |
184 | GSList *probes; |
185 | /* Data acquired by this device, if any */ | |
c4911129 | 186 | struct sr_datastore *datastore; |
a1bb33af UH |
187 | }; |
188 | ||
921e753f | 189 | enum { |
5a2326a7 UH |
190 | SR_PROBE_TYPE_LOGIC, |
191 | SR_PROBE_TYPE_ANALOG, | |
921e753f DR |
192 | }; |
193 | ||
1afe8989 | 194 | struct sr_probe { |
a1bb33af | 195 | int index; |
6ea7e235 | 196 | int type; |
a1bb33af UH |
197 | gboolean enabled; |
198 | char *name; | |
199 | char *trigger; | |
200 | }; | |
201 | ||
a1bb33af UH |
202 | /* Hardware plugin capabilities */ |
203 | enum { | |
fb93625d | 204 | SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ |
e88dadd7 UH |
205 | |
206 | /*--- Device classes ------------------------------------------------*/ | |
207 | ||
208 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 209 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 210 | |
e88dadd7 UH |
211 | /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ |
212 | ||
a141db8c AS |
213 | /*--- Device types --------------------------------------------------*/ |
214 | ||
215 | /** The device is demo device. */ | |
216 | SR_HWCAP_DEMO_DEVICE, | |
217 | ||
e88dadd7 UH |
218 | /*--- Device options ------------------------------------------------*/ |
219 | ||
220 | /** The device supports setting/changing its samplerate. */ | |
221 | SR_HWCAP_SAMPLERATE, | |
222 | ||
223 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
224 | /** The device supports setting a probe mask. */ | |
225 | SR_HWCAP_PROBECONFIG, | |
226 | ||
227 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
228 | SR_HWCAP_CAPTURE_RATIO, | |
229 | ||
230 | /* TODO? */ | |
231 | /** The device supports setting a pattern (pattern generator mode). */ | |
232 | SR_HWCAP_PATTERN_MODE, | |
233 | ||
3a4d09c0 GM |
234 | /** The device supports Run Length Encoding. */ |
235 | SR_HWCAP_RLE, | |
236 | ||
e88dadd7 UH |
237 | /*--- Special stuff -------------------------------------------------*/ |
238 | ||
239 | /* TODO: Better description. */ | |
240 | /** The device supports specifying a capturefile to inject. */ | |
241 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 242 | |
e88dadd7 UH |
243 | /* TODO: Better description. */ |
244 | /** The device supports specifying the capturefile unit size. */ | |
245 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 246 | |
e88dadd7 UH |
247 | /* TODO: Better description. */ |
248 | /** The device supports setting the number of probes. */ | |
249 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
250 | ||
251 | /*--- Acquisition modes ---------------------------------------------*/ | |
252 | ||
253 | /** | |
254 | * The device supports setting a sample time limit, i.e. how long the | |
255 | * sample acquisition should run (in ms). | |
256 | */ | |
257 | SR_HWCAP_LIMIT_MSEC, | |
258 | ||
259 | /** | |
260 | * The device supports setting a sample number limit, i.e. how many | |
261 | * samples should be acquired. | |
262 | */ | |
263 | SR_HWCAP_LIMIT_SAMPLES, | |
264 | ||
265 | /** | |
266 | * The device supports continuous sampling, i.e. neither a time limit | |
267 | * nor a sample number limit has to be supplied, it will just acquire | |
268 | * samples continuously, until explicitly stopped by a certain command. | |
269 | */ | |
5a2326a7 | 270 | SR_HWCAP_CONTINUOUS, |
e88dadd7 UH |
271 | |
272 | /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ | |
a1bb33af UH |
273 | }; |
274 | ||
a65de030 | 275 | struct sr_hwcap_option { |
a1bb33af UH |
276 | int capability; |
277 | int type; | |
278 | char *description; | |
279 | char *shortname; | |
280 | }; | |
281 | ||
a00ba012 | 282 | struct sr_device_instance { |
a1bb33af UH |
283 | int index; |
284 | int status; | |
285 | int instance_type; | |
286 | char *vendor; | |
287 | char *model; | |
288 | char *version; | |
8d672550 | 289 | void *priv; |
a1bb33af UH |
290 | }; |
291 | ||
a00ba012 | 292 | /* sr_device_instance types */ |
a1bb33af | 293 | enum { |
5a2326a7 UH |
294 | SR_USB_INSTANCE, |
295 | SR_SERIAL_INSTANCE, | |
a1bb33af UH |
296 | }; |
297 | ||
a1bb33af UH |
298 | /* Device instance status */ |
299 | enum { | |
5a2326a7 | 300 | SR_ST_NOT_FOUND, |
a1bb33af | 301 | /* Found, but still booting */ |
5a2326a7 | 302 | SR_ST_INITIALIZING, |
a1bb33af | 303 | /* Live, but not in use */ |
5a2326a7 | 304 | SR_ST_INACTIVE, |
a1bb33af | 305 | /* Actively in use in a session */ |
5a2326a7 | 306 | SR_ST_ACTIVE, |
a1bb33af UH |
307 | }; |
308 | ||
309 | /* | |
310 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
311 | * TODO: Need a DI to return the number of trigger stages supported. | |
312 | */ | |
313 | ||
314 | /* Device info IDs */ | |
315 | enum { | |
a00ba012 | 316 | /* struct sr_device_instance for this specific device */ |
5a2326a7 | 317 | SR_DI_INSTANCE, |
a1bb33af | 318 | /* The number of probes connected to this device */ |
5a2326a7 | 319 | SR_DI_NUM_PROBES, |
464d12c7 KS |
320 | /* The probe names on this device */ |
321 | SR_DI_PROBE_NAMES, | |
60679b18 | 322 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 323 | SR_DI_SAMPLERATES, |
a1bb33af | 324 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 325 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 326 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 327 | SR_DI_CUR_SAMPLERATE, |
925dbf9f | 328 | /* Supported pattern generator modes */ |
5a2326a7 | 329 | SR_DI_PATTERNMODES, |
a1bb33af UH |
330 | }; |
331 | ||
1b452b85 UH |
332 | /* |
333 | * A device supports either a range of samplerates with steps of a given | |
334 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
335 | * step or list, but not both. |
336 | */ | |
60679b18 | 337 | struct sr_samplerates { |
a1bb33af UH |
338 | uint64_t low; |
339 | uint64_t high; | |
340 | uint64_t step; | |
341 | uint64_t *list; | |
342 | }; | |
343 | ||
5c2d46d1 | 344 | struct sr_device_plugin { |
1b452b85 | 345 | /* Plugin-specific */ |
a1bb33af | 346 | char *name; |
9f8274a5 | 347 | char *longname; |
a1bb33af | 348 | int api_version; |
54ac5277 | 349 | int (*init) (const char *deviceinfo); |
a1bb33af UH |
350 | void (*cleanup) (void); |
351 | ||
1b452b85 | 352 | /* Device-specific */ |
86f5e3d8 | 353 | int (*opendev) (int device_index); |
697785d1 | 354 | int (*closedev) (int device_index); |
a1bb33af UH |
355 | void *(*get_device_info) (int device_index, int device_info_id); |
356 | int (*get_status) (int device_index); | |
357 | int *(*get_capabilities) (void); | |
358 | int (*set_configuration) (int device_index, int capability, void *value); | |
359 | int (*start_acquisition) (int device_index, gpointer session_device_id); | |
360 | void (*stop_acquisition) (int device_index, gpointer session_device_id); | |
361 | }; | |
362 | ||
2872d21e | 363 | struct sr_session { |
5c2d46d1 | 364 | /* List of struct sr_device* */ |
a1bb33af | 365 | GSList *devices; |
a887e3da | 366 | /* list of sr_receive_data_callback */ |
a1bb33af UH |
367 | GSList *datafeed_callbacks; |
368 | GTimeVal starttime; | |
544a4582 | 369 | gboolean running; |
a1bb33af UH |
370 | }; |
371 | ||
882e2075 | 372 | #include "sigrok-proto.h" |
c2bd92ec | 373 | |
a00b530c UH |
374 | #ifdef __cplusplus |
375 | } | |
376 | #endif | |
377 | ||
a1bb33af | 378 | #endif |