]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> | |
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 LIBSIGROK_SIGROK_H | |
21 | #define LIBSIGROK_SIGROK_H | |
22 | ||
23 | #include <stdio.h> | |
24 | #include <sys/time.h> | |
25 | #include <stdint.h> | |
26 | #include <inttypes.h> | |
27 | #include <glib.h> | |
28 | ||
29 | #ifdef __cplusplus | |
30 | extern "C" { | |
31 | #endif | |
32 | ||
33 | /* | |
34 | * Package version macros (can be used for conditional compilation). | |
35 | */ | |
36 | ||
37 | /** The libsigrok package 'major' version number. */ | |
38 | #define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@ | |
39 | ||
40 | /** The libsigrok package 'minor' version number. */ | |
41 | #define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@ | |
42 | ||
43 | /** The libsigrok package 'micro' version number. */ | |
44 | #define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@ | |
45 | ||
46 | /** The libsigrok package version ("major.minor.micro") as string. */ | |
47 | #define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@" | |
48 | ||
49 | /* | |
50 | * Library/libtool version macros (can be used for conditional compilation). | |
51 | */ | |
52 | ||
53 | /** The libsigrok libtool 'current' version number. */ | |
54 | #define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@ | |
55 | ||
56 | /** The libsigrok libtool 'revision' version number. */ | |
57 | #define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@ | |
58 | ||
59 | /** The libsigrok libtool 'age' version number. */ | |
60 | #define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@ | |
61 | ||
62 | /** The libsigrok libtool version ("current:revision:age") as string. */ | |
63 | #define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@" | |
64 | ||
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 | |
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". | |
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 | */ | |
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 */ | |
85 | #define SR_ERR_ARG -3 /* Function argument error */ | |
86 | #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ | |
87 | #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ | |
88 | ||
89 | #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ | |
90 | #define SR_MAX_PROBENAME_LEN 32 | |
91 | ||
92 | /* Handy little macros */ | |
93 | #define SR_HZ(n) (n) | |
94 | #define SR_KHZ(n) ((n) * 1000) | |
95 | #define SR_MHZ(n) ((n) * 1000000) | |
96 | #define SR_GHZ(n) ((n) * 1000000000) | |
97 | ||
98 | #define SR_HZ_TO_NS(n) (1000000000 / (n)) | |
99 | ||
100 | /* libsigrok loglevels. */ | |
101 | #define SR_LOG_NONE 0 /**< Output no messages at all. */ | |
102 | #define SR_LOG_ERR 1 /**< Output error messages. */ | |
103 | #define SR_LOG_WARN 2 /**< Output warnings. */ | |
104 | #define SR_LOG_INFO 3 /**< Output informational messages. */ | |
105 | #define SR_LOG_DBG 4 /**< Output debug messages. */ | |
106 | #define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */ | |
107 | ||
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 | * This feature is not available on MinGW/Windows, as it is a feature of | |
119 | * ELF files and MinGW/Windows uses PE files. | |
120 | * | |
121 | * Details: http://gcc.gnu.org/wiki/Visibility | |
122 | */ | |
123 | ||
124 | /* Marks public libsigrok API symbols. */ | |
125 | #ifndef _WIN32 | |
126 | #define SR_API __attribute__((visibility("default"))) | |
127 | #else | |
128 | #define SR_API | |
129 | #endif | |
130 | ||
131 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
132 | #ifndef _WIN32 | |
133 | #define SR_PRIV __attribute__((visibility("hidden"))) | |
134 | #else | |
135 | #define SR_PRIV | |
136 | #endif | |
137 | ||
138 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); | |
139 | ||
140 | /* Data types used by hardware drivers for dev_config_set() */ | |
141 | enum { | |
142 | SR_T_UINT64, | |
143 | SR_T_CHAR, | |
144 | SR_T_BOOL, | |
145 | }; | |
146 | ||
147 | /* sr_datafeed_packet.type values */ | |
148 | enum { | |
149 | SR_DF_HEADER, | |
150 | SR_DF_END, | |
151 | SR_DF_TRIGGER, | |
152 | SR_DF_LOGIC, | |
153 | SR_DF_META_LOGIC, | |
154 | SR_DF_ANALOG, | |
155 | SR_DF_META_ANALOG, | |
156 | }; | |
157 | ||
158 | struct sr_datafeed_packet { | |
159 | uint16_t type; | |
160 | void *payload; | |
161 | }; | |
162 | ||
163 | struct sr_datafeed_header { | |
164 | int feed_version; | |
165 | struct timeval starttime; | |
166 | }; | |
167 | ||
168 | struct sr_datafeed_meta_logic { | |
169 | int num_probes; | |
170 | uint64_t samplerate; | |
171 | }; | |
172 | ||
173 | struct sr_datafeed_logic { | |
174 | uint64_t length; | |
175 | uint16_t unitsize; | |
176 | void *data; | |
177 | }; | |
178 | ||
179 | struct sr_datafeed_meta_analog { | |
180 | int num_probes; | |
181 | }; | |
182 | ||
183 | struct sr_datafeed_analog { | |
184 | int num_samples; | |
185 | float *data; | |
186 | }; | |
187 | ||
188 | struct sr_input { | |
189 | struct sr_input_format *format; | |
190 | char *param; | |
191 | struct sr_dev *vdev; | |
192 | }; | |
193 | ||
194 | struct sr_input_format { | |
195 | char *id; | |
196 | char *description; | |
197 | int (*format_match) (const char *filename); | |
198 | int (*init) (struct sr_input *in); | |
199 | int (*loadfile) (struct sr_input *in, const char *filename); | |
200 | }; | |
201 | ||
202 | struct sr_output { | |
203 | struct sr_output_format *format; | |
204 | struct sr_dev *dev; | |
205 | char *param; | |
206 | void *internal; | |
207 | }; | |
208 | ||
209 | struct sr_output_format { | |
210 | char *id; | |
211 | char *description; | |
212 | int df_type; | |
213 | int (*init) (struct sr_output *o); | |
214 | int (*data) (struct sr_output *o, const uint8_t *data_in, | |
215 | uint64_t length_in, uint8_t **data_out, | |
216 | uint64_t *length_out); | |
217 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
218 | uint64_t *length_out); | |
219 | }; | |
220 | ||
221 | struct sr_datastore { | |
222 | /* Size in bytes of the number of units stored in this datastore */ | |
223 | int ds_unitsize; | |
224 | unsigned int num_units; /* TODO: uint64_t */ | |
225 | GSList *chunklist; | |
226 | }; | |
227 | ||
228 | /* | |
229 | * This represents a generic device connected to the system. | |
230 | * For device-specific information, ask the driver. The driver_index refers | |
231 | * to the device index within that driver; it may be handling more than one | |
232 | * device. All relevant driver calls take a dev_index parameter for this. | |
233 | */ | |
234 | struct sr_dev { | |
235 | /* Which driver handles this device */ | |
236 | struct sr_dev_driver *driver; | |
237 | /* A driver may handle multiple devices of the same type */ | |
238 | int driver_index; | |
239 | /* List of struct sr_probe* */ | |
240 | GSList *probes; | |
241 | /* Data acquired by this device, if any */ | |
242 | struct sr_datastore *datastore; | |
243 | }; | |
244 | ||
245 | enum { | |
246 | SR_PROBE_TYPE_LOGIC, | |
247 | }; | |
248 | ||
249 | struct sr_probe { | |
250 | int index; | |
251 | int type; | |
252 | gboolean enabled; | |
253 | char *name; | |
254 | char *trigger; | |
255 | }; | |
256 | ||
257 | /* Hardware driver capabilities */ | |
258 | enum { | |
259 | SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ | |
260 | ||
261 | /*--- Device classes ------------------------------------------------*/ | |
262 | ||
263 | /** The device can act as logic analyzer. */ | |
264 | SR_HWCAP_LOGIC_ANALYZER, | |
265 | ||
266 | /** The device can act as an oscilloscope. */ | |
267 | SR_HWCAP_OSCILLOSCOPE, | |
268 | ||
269 | /*--- Device types --------------------------------------------------*/ | |
270 | ||
271 | /** The device is demo device. */ | |
272 | SR_HWCAP_DEMO_DEV, | |
273 | ||
274 | /*--- Device options ------------------------------------------------*/ | |
275 | ||
276 | /** The device supports setting/changing its samplerate. */ | |
277 | SR_HWCAP_SAMPLERATE, | |
278 | ||
279 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
280 | /** The device supports setting a probe mask. */ | |
281 | SR_HWCAP_PROBECONFIG, | |
282 | ||
283 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
284 | SR_HWCAP_CAPTURE_RATIO, | |
285 | ||
286 | /* TODO? */ | |
287 | /** The device supports setting a pattern (pattern generator mode). */ | |
288 | SR_HWCAP_PATTERN_MODE, | |
289 | ||
290 | /** The device supports Run Length Encoding. */ | |
291 | SR_HWCAP_RLE, | |
292 | ||
293 | /** The device supports setting trigger slope. */ | |
294 | SR_HWCAP_TRIGGERSLOPE, | |
295 | ||
296 | /*--- Special stuff -------------------------------------------------*/ | |
297 | ||
298 | /* TODO: Better description. */ | |
299 | /** The device supports specifying a capturefile to inject. */ | |
300 | SR_HWCAP_CAPTUREFILE, | |
301 | ||
302 | /* TODO: Better description. */ | |
303 | /** The device supports specifying the capturefile unit size. */ | |
304 | SR_HWCAP_CAPTURE_UNITSIZE, | |
305 | ||
306 | /* TODO: Better description. */ | |
307 | /** The device supports setting the number of probes. */ | |
308 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
309 | ||
310 | /*--- Acquisition modes ---------------------------------------------*/ | |
311 | ||
312 | /** | |
313 | * The device supports setting a sample time limit, i.e. how long the | |
314 | * sample acquisition should run (in ms). | |
315 | */ | |
316 | SR_HWCAP_LIMIT_MSEC, | |
317 | ||
318 | /** | |
319 | * The device supports setting a sample number limit, i.e. how many | |
320 | * samples should be acquired. | |
321 | */ | |
322 | SR_HWCAP_LIMIT_SAMPLES, | |
323 | ||
324 | /** | |
325 | * The device supports continuous sampling, i.e. neither a time limit | |
326 | * nor a sample number limit has to be supplied, it will just acquire | |
327 | * samples continuously, until explicitly stopped by a certain command. | |
328 | */ | |
329 | SR_HWCAP_CONTINUOUS, | |
330 | ||
331 | }; | |
332 | ||
333 | struct sr_hwcap_option { | |
334 | int hwcap; | |
335 | int type; | |
336 | char *description; | |
337 | char *shortname; | |
338 | }; | |
339 | ||
340 | struct sr_dev_inst { | |
341 | int index; | |
342 | int status; | |
343 | int inst_type; | |
344 | char *vendor; | |
345 | char *model; | |
346 | char *version; | |
347 | void *priv; | |
348 | }; | |
349 | ||
350 | /* sr_dev_inst types */ | |
351 | enum { | |
352 | /** Device instance type for USB devices. */ | |
353 | SR_INST_USB, | |
354 | /** Device instance type for serial port devices. */ | |
355 | SR_INST_SERIAL, | |
356 | }; | |
357 | ||
358 | /* Device instance status */ | |
359 | enum { | |
360 | SR_ST_NOT_FOUND, | |
361 | /* Found, but still booting */ | |
362 | SR_ST_INITIALIZING, | |
363 | /* Live, but not in use */ | |
364 | SR_ST_INACTIVE, | |
365 | /* Actively in use in a session */ | |
366 | SR_ST_ACTIVE, | |
367 | }; | |
368 | ||
369 | /* | |
370 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
371 | * TODO: Need a DI to return the number of trigger stages supported. | |
372 | */ | |
373 | ||
374 | /* Device info IDs */ | |
375 | enum { | |
376 | /* struct sr_dev_inst for this specific device */ | |
377 | SR_DI_INST, | |
378 | /* The number of probes connected to this device */ | |
379 | SR_DI_NUM_PROBES, | |
380 | /* The probe names on this device */ | |
381 | SR_DI_PROBE_NAMES, | |
382 | /* Samplerates supported by this device, (struct sr_samplerates) */ | |
383 | SR_DI_SAMPLERATES, | |
384 | /* Types of trigger supported, out of "01crf" (char *) */ | |
385 | SR_DI_TRIGGER_TYPES, | |
386 | /* The currently set samplerate in Hz (uint64_t) */ | |
387 | SR_DI_CUR_SAMPLERATE, | |
388 | /* Supported patterns (in pattern generator mode) */ | |
389 | SR_DI_PATTERNS, | |
390 | }; | |
391 | ||
392 | /* | |
393 | * A device supports either a range of samplerates with steps of a given | |
394 | * granularity, or is limited to a set of defined samplerates. Use either | |
395 | * step or list, but not both. | |
396 | */ | |
397 | struct sr_samplerates { | |
398 | uint64_t low; | |
399 | uint64_t high; | |
400 | uint64_t step; | |
401 | uint64_t *list; | |
402 | }; | |
403 | ||
404 | struct sr_dev_driver { | |
405 | /* Driver-specific */ | |
406 | char *name; | |
407 | char *longname; | |
408 | int api_version; | |
409 | int (*init) (const char *devinfo); | |
410 | int (*cleanup) (void); | |
411 | ||
412 | /* Device-specific */ | |
413 | int (*dev_open) (int dev_index); | |
414 | int (*dev_close) (int dev_index); | |
415 | void *(*dev_info_get) (int dev_index, int dev_info_id); | |
416 | int (*dev_status_get) (int dev_index); | |
417 | int *(*hwcap_get_all) (void); | |
418 | int (*dev_config_set) (int dev_index, int hwcap, void *value); | |
419 | int (*dev_acquisition_start) (int dev_index, void *session_dev_id); | |
420 | int (*dev_acquisition_stop) (int dev_index, void *session_dev_id); | |
421 | }; | |
422 | ||
423 | struct sr_session { | |
424 | /* List of struct sr_dev* */ | |
425 | GSList *devs; | |
426 | /* list of sr_receive_data_callback_t */ | |
427 | GSList *datafeed_callbacks; | |
428 | GTimeVal starttime; | |
429 | gboolean running; | |
430 | }; | |
431 | ||
432 | #include "sigrok-proto.h" | |
433 | ||
434 | #ifdef __cplusplus | |
435 | } | |
436 | #endif | |
437 | ||
438 | #endif |