]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 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 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> | |
22b02383 | 28 | #ifdef HAVE_LIBUSB_1_0 |
a1bb33af | 29 | #include <libusb.h> |
22b02383 | 30 | #endif |
a1bb33af | 31 | |
a00b530c UH |
32 | #ifdef __cplusplus |
33 | extern "C" { | |
34 | #endif | |
35 | ||
e31b636d UH |
36 | /* |
37 | * Status/error codes returned by libsigrok functions. | |
38 | * | |
39 | * All possible return codes of libsigrok functions must be listed here. | |
40 | * Functions should never return hardcoded numbers as status, but rather | |
41 | * use these #defines instead. All error codes are negative numbers. | |
42 | * | |
43 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
44 | * libsigrok functions returns a "malloc error" it must be exactly the same |
45 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
46 | * There must be no functions which indicate two different errors via the |
47 | * same return code. | |
48 | * | |
49 | * Also, for compatibility reasons, no defined return codes are ever removed | |
50 | * or reused for different #defines later. You can only add new #defines and | |
51 | * return codes, but never remove or redefine existing ones. | |
52 | */ | |
e46b8fb1 UH |
53 | #define SR_OK 0 /* No error */ |
54 | #define SR_ERR -1 /* Generic/unspecified error */ | |
55 | #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ | |
f7d2982d | 56 | #define SR_ERR_ARG -3 /* Function argument error */ |
e0508e67 UH |
57 | #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ |
58 | #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ | |
a1bb33af | 59 | |
9688b443 UH |
60 | #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ |
61 | #define SR_MAX_PROBENAME_LEN 32 | |
2a3f9541 | 62 | |
a1bb33af | 63 | /* Handy little macros */ |
c9140419 | 64 | #define SR_HZ(n) (n) |
59df0c77 UH |
65 | #define SR_KHZ(n) ((n) * 1000) |
66 | #define SR_MHZ(n) ((n) * 1000000) | |
67 | #define SR_GHZ(n) ((n) * 1000000000) | |
a1bb33af | 68 | |
59df0c77 | 69 | #define SR_HZ_TO_NS(n) (1000000000 / (n)) |
3677f3ec | 70 | |
1352eedd | 71 | /* libsigrok loglevels. */ |
8e49cebd BV |
72 | #define SR_LOG_NONE 0 |
73 | #define SR_LOG_ERR 1 | |
74 | #define SR_LOG_WARN 2 | |
75 | #define SR_LOG_INFO 3 | |
76 | #define SR_LOG_DBG 4 | |
77 | #define SR_LOG_SPEW 5 | |
1352eedd | 78 | |
a887e3da | 79 | typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); |
882e2075 | 80 | |
882e2075 | 81 | /* Data types used by hardware plugins for set_configuration() */ |
a1bb33af | 82 | enum { |
5a2326a7 UH |
83 | SR_T_UINT64, |
84 | SR_T_CHAR, | |
4d436e71 | 85 | SR_T_BOOL, |
a1bb33af UH |
86 | }; |
87 | ||
b9c735a2 | 88 | /* sr_datafeed_packet.type values */ |
a1bb33af | 89 | enum { |
5a2326a7 UH |
90 | SR_DF_HEADER, |
91 | SR_DF_END, | |
92 | SR_DF_TRIGGER, | |
93 | SR_DF_LOGIC, | |
94 | SR_DF_ANALOG, | |
95 | SR_DF_PD, | |
a1bb33af UH |
96 | }; |
97 | ||
b9c735a2 | 98 | struct sr_datafeed_packet { |
a1bb33af | 99 | uint16_t type; |
38ab3ee7 BV |
100 | /* timeoffset since start, in picoseconds */ |
101 | uint64_t timeoffset; | |
102 | /* duration of data in this packet, in picoseconds */ | |
103 | uint64_t duration; | |
a1bb33af UH |
104 | void *payload; |
105 | }; | |
106 | ||
b9c735a2 | 107 | struct sr_datafeed_header { |
a1bb33af UH |
108 | int feed_version; |
109 | struct timeval starttime; | |
4c100f32 | 110 | uint64_t samplerate; |
921e753f DR |
111 | int num_analog_probes; |
112 | int num_logic_probes; | |
a1bb33af UH |
113 | }; |
114 | ||
38ab3ee7 BV |
115 | struct sr_datafeed_logic { |
116 | uint64_t length; | |
117 | uint16_t unitsize; | |
9c939c51 | 118 | void *data; |
38ab3ee7 BV |
119 | }; |
120 | ||
f50f3f40 UH |
121 | struct sr_input { |
122 | struct sr_input_format *format; | |
13a12913 | 123 | char *param; |
5c2d46d1 | 124 | struct sr_device *vdevice; |
34e4813f BV |
125 | }; |
126 | ||
f50f3f40 | 127 | struct sr_input_format { |
cdb3573c | 128 | char *id; |
34e4813f | 129 | char *description; |
757b8c62 | 130 | int (*format_match) (const char *filename); |
f50f3f40 UH |
131 | int (*init) (struct sr_input *in); |
132 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
133 | }; |
134 | ||
f50f3f40 UH |
135 | struct sr_output { |
136 | struct sr_output_format *format; | |
5c2d46d1 | 137 | struct sr_device *device; |
a1bb33af UH |
138 | char *param; |
139 | void *internal; | |
140 | }; | |
141 | ||
f50f3f40 | 142 | struct sr_output_format { |
cdb3573c | 143 | char *id; |
a1bb33af | 144 | char *description; |
f0411b1d | 145 | int df_type; |
f50f3f40 | 146 | int (*init) (struct sr_output *o); |
54ac5277 UH |
147 | int (*data) (struct sr_output *o, const char *data_in, |
148 | uint64_t length_in, char **data_out, uint64_t *length_out); | |
f50f3f40 | 149 | int (*event) (struct sr_output *o, int event_type, char **data_out, |
a1bb33af UH |
150 | uint64_t *length_out); |
151 | }; | |
152 | ||
c4911129 | 153 | struct sr_datastore { |
a1bb33af UH |
154 | /* Size in bytes of the number of units stored in this datastore */ |
155 | int ds_unitsize; | |
33247d6a | 156 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
157 | GSList *chunklist; |
158 | }; | |
159 | ||
a1bb33af UH |
160 | /* |
161 | * This represents a generic device connected to the system. | |
162 | * For device-specific information, ask the plugin. The plugin_index refers | |
163 | * to the device index within that plugin; it may be handling more than one | |
164 | * device. All relevant plugin calls take a device_index parameter for this. | |
165 | */ | |
5c2d46d1 | 166 | struct sr_device { |
a1bb33af | 167 | /* Which plugin handles this device */ |
5c2d46d1 | 168 | struct sr_device_plugin *plugin; |
a1bb33af UH |
169 | /* A plugin may handle multiple devices of the same type */ |
170 | int plugin_index; | |
1afe8989 | 171 | /* List of struct sr_probe* */ |
a1bb33af UH |
172 | GSList *probes; |
173 | /* Data acquired by this device, if any */ | |
c4911129 | 174 | struct sr_datastore *datastore; |
a1bb33af UH |
175 | }; |
176 | ||
921e753f | 177 | enum { |
5a2326a7 UH |
178 | SR_PROBE_TYPE_LOGIC, |
179 | SR_PROBE_TYPE_ANALOG, | |
921e753f DR |
180 | }; |
181 | ||
1afe8989 | 182 | struct sr_probe { |
a1bb33af | 183 | int index; |
6ea7e235 | 184 | int type; |
a1bb33af UH |
185 | gboolean enabled; |
186 | char *name; | |
187 | char *trigger; | |
188 | }; | |
189 | ||
a1bb33af UH |
190 | /* Hardware plugin capabilities */ |
191 | enum { | |
5a2326a7 | 192 | SR_HWCAP_DUMMY, /* Used to terminate lists */ |
e88dadd7 UH |
193 | |
194 | /*--- Device classes ------------------------------------------------*/ | |
195 | ||
196 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 197 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 198 | |
e88dadd7 UH |
199 | /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ |
200 | ||
a141db8c AS |
201 | /*--- Device types --------------------------------------------------*/ |
202 | ||
203 | /** The device is demo device. */ | |
204 | SR_HWCAP_DEMO_DEVICE, | |
205 | ||
e88dadd7 UH |
206 | /*--- Device options ------------------------------------------------*/ |
207 | ||
208 | /** The device supports setting/changing its samplerate. */ | |
209 | SR_HWCAP_SAMPLERATE, | |
210 | ||
211 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
212 | /** The device supports setting a probe mask. */ | |
213 | SR_HWCAP_PROBECONFIG, | |
214 | ||
215 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
216 | SR_HWCAP_CAPTURE_RATIO, | |
217 | ||
218 | /* TODO? */ | |
219 | /** The device supports setting a pattern (pattern generator mode). */ | |
220 | SR_HWCAP_PATTERN_MODE, | |
221 | ||
3a4d09c0 GM |
222 | /** The device supports Run Length Encoding. */ |
223 | SR_HWCAP_RLE, | |
224 | ||
e88dadd7 UH |
225 | /*--- Special stuff -------------------------------------------------*/ |
226 | ||
227 | /* TODO: Better description. */ | |
228 | /** The device supports specifying a capturefile to inject. */ | |
229 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 230 | |
e88dadd7 UH |
231 | /* TODO: Better description. */ |
232 | /** The device supports specifying the capturefile unit size. */ | |
233 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 234 | |
e88dadd7 UH |
235 | /* TODO: Better description. */ |
236 | /** The device supports setting the number of probes. */ | |
237 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
238 | ||
239 | /*--- Acquisition modes ---------------------------------------------*/ | |
240 | ||
241 | /** | |
242 | * The device supports setting a sample time limit, i.e. how long the | |
243 | * sample acquisition should run (in ms). | |
244 | */ | |
245 | SR_HWCAP_LIMIT_MSEC, | |
246 | ||
247 | /** | |
248 | * The device supports setting a sample number limit, i.e. how many | |
249 | * samples should be acquired. | |
250 | */ | |
251 | SR_HWCAP_LIMIT_SAMPLES, | |
252 | ||
253 | /** | |
254 | * The device supports continuous sampling, i.e. neither a time limit | |
255 | * nor a sample number limit has to be supplied, it will just acquire | |
256 | * samples continuously, until explicitly stopped by a certain command. | |
257 | */ | |
5a2326a7 | 258 | SR_HWCAP_CONTINUOUS, |
e88dadd7 UH |
259 | |
260 | /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ | |
a1bb33af UH |
261 | }; |
262 | ||
a65de030 | 263 | struct sr_hwcap_option { |
a1bb33af UH |
264 | int capability; |
265 | int type; | |
266 | char *description; | |
267 | char *shortname; | |
268 | }; | |
269 | ||
a00ba012 | 270 | struct sr_device_instance { |
a1bb33af UH |
271 | int index; |
272 | int status; | |
273 | int instance_type; | |
274 | char *vendor; | |
275 | char *model; | |
276 | char *version; | |
8d672550 | 277 | void *priv; |
a1bb33af | 278 | union { |
6c290072 UH |
279 | struct sr_usb_device_instance *usb; |
280 | struct sr_serial_device_instance *serial; | |
a1bb33af UH |
281 | }; |
282 | }; | |
283 | ||
a00ba012 | 284 | /* sr_device_instance types */ |
a1bb33af | 285 | enum { |
5a2326a7 UH |
286 | SR_USB_INSTANCE, |
287 | SR_SERIAL_INSTANCE, | |
a1bb33af UH |
288 | }; |
289 | ||
22b02383 | 290 | #ifdef HAVE_LIBUSB_1_0 |
6c290072 | 291 | struct sr_usb_device_instance { |
a1bb33af UH |
292 | uint8_t bus; |
293 | uint8_t address; | |
294 | struct libusb_device_handle *devhdl; | |
295 | }; | |
22b02383 | 296 | #endif |
a1bb33af | 297 | |
6c290072 | 298 | struct sr_serial_device_instance { |
a1bb33af UH |
299 | char *port; |
300 | int fd; | |
301 | }; | |
302 | ||
303 | /* Device instance status */ | |
304 | enum { | |
5a2326a7 | 305 | SR_ST_NOT_FOUND, |
a1bb33af | 306 | /* Found, but still booting */ |
5a2326a7 | 307 | SR_ST_INITIALIZING, |
a1bb33af | 308 | /* Live, but not in use */ |
5a2326a7 | 309 | SR_ST_INACTIVE, |
a1bb33af | 310 | /* Actively in use in a session */ |
5a2326a7 | 311 | SR_ST_ACTIVE, |
a1bb33af UH |
312 | }; |
313 | ||
314 | /* | |
315 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
316 | * TODO: Need a DI to return the number of trigger stages supported. | |
317 | */ | |
318 | ||
319 | /* Device info IDs */ | |
320 | enum { | |
a00ba012 | 321 | /* struct sr_device_instance for this specific device */ |
5a2326a7 | 322 | SR_DI_INSTANCE, |
a1bb33af | 323 | /* The number of probes connected to this device */ |
5a2326a7 | 324 | SR_DI_NUM_PROBES, |
464d12c7 KS |
325 | /* The probe names on this device */ |
326 | SR_DI_PROBE_NAMES, | |
60679b18 | 327 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 328 | SR_DI_SAMPLERATES, |
a1bb33af | 329 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 330 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 331 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 332 | SR_DI_CUR_SAMPLERATE, |
925dbf9f | 333 | /* Supported pattern generator modes */ |
5a2326a7 | 334 | SR_DI_PATTERNMODES, |
a1bb33af UH |
335 | }; |
336 | ||
1b452b85 UH |
337 | /* |
338 | * A device supports either a range of samplerates with steps of a given | |
339 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
340 | * step or list, but not both. |
341 | */ | |
60679b18 | 342 | struct sr_samplerates { |
a1bb33af UH |
343 | uint64_t low; |
344 | uint64_t high; | |
345 | uint64_t step; | |
346 | uint64_t *list; | |
347 | }; | |
348 | ||
5c2d46d1 | 349 | struct sr_device_plugin { |
1b452b85 | 350 | /* Plugin-specific */ |
a1bb33af | 351 | char *name; |
9f8274a5 | 352 | char *longname; |
a1bb33af | 353 | int api_version; |
54ac5277 | 354 | int (*init) (const char *deviceinfo); |
a1bb33af UH |
355 | void (*cleanup) (void); |
356 | ||
1b452b85 | 357 | /* Device-specific */ |
86f5e3d8 | 358 | int (*opendev) (int device_index); |
697785d1 | 359 | int (*closedev) (int device_index); |
a1bb33af UH |
360 | void *(*get_device_info) (int device_index, int device_info_id); |
361 | int (*get_status) (int device_index); | |
362 | int *(*get_capabilities) (void); | |
363 | int (*set_configuration) (int device_index, int capability, void *value); | |
364 | int (*start_acquisition) (int device_index, gpointer session_device_id); | |
365 | void (*stop_acquisition) (int device_index, gpointer session_device_id); | |
366 | }; | |
367 | ||
2872d21e | 368 | struct sr_session { |
5c2d46d1 | 369 | /* List of struct sr_device* */ |
a1bb33af | 370 | GSList *devices; |
a887e3da | 371 | /* list of sr_receive_data_callback */ |
a1bb33af UH |
372 | GSList *datafeed_callbacks; |
373 | GTimeVal starttime; | |
544a4582 | 374 | gboolean running; |
a1bb33af UH |
375 | }; |
376 | ||
882e2075 | 377 | #include "sigrok-proto.h" |
c2bd92ec | 378 | |
a00b530c UH |
379 | #ifdef __cplusplus |
380 | } | |
381 | #endif | |
382 | ||
a1bb33af | 383 | #endif |